Impressum · Privacy Policy
Documentation generated
at 04.02.2023 23:29:04

Client Hosting

Plesk licenses
GET client/plesk/licenses

Returns all Plesk licenses, available and used

curl -X GET \
-G 'https://api.pph.sh/client/plesk/licenses' \
-H 'Content-Type=application/json' \
-H 'Accept=application/json' \
-H 'Accept-Language=de; *;q=0.5' | jq
{
    "data": {
        "used": [],
        "unused": []
    }
}
List Hostings
GET client/hostings
API Token required
read access_hostings

Returns a list of a clients hostings.

Query-Parameter

Feld Datentyp Beschreibung
status string Filter by status.
active boolean Filter by active. Example: true
ip string Filter by ip. Example:
password string Include default password.
per_page integer Number of results per page. Defaults to 15. Example: 15
curl -X GET \
-G 'https://api.pph.sh/client/hostings' \
-H 'Authorization: Bearer ${ACCESS_TOKEN}' \
-H 'Content-Type=application/json' \
-H 'Accept=application/json' \
-H 'Accept-Language=de; *;q=0.5' | jq
{
    "data": [
        {
            "id": 41986,
            "product_name": "KVM Root Server",
            "product_group": "AMD SSD KVM vServer",
            "label": "",
            "module": "virtualizor",
            "package_id": 269,
            "order_id": 74457,
            "ipaddress": "45.145.225.180",
            "active": true,
            "suspended": false,
            "domain": "92351-62462.pph-server.de",
            "status": "Active",
            "billingcycle": "Monthly",
            "created_at": "2023-01-30T23:00:00.000000Z",
            "next_due_date": "2023-03-02T23:00:00.000000Z",
            "next_due_in": 28,
            "next_due_human": "in 1 Mon.",
            "amount": 8.26,
            "firstpaymentamount": 8.26,
            "has_invoice": true,
            "has_unpaid_invoices": false,
            "cancellation": false,
            "promotion": {
                "code": "PPH10",
                "label": "PPH10 = wiederkehrend 10%",
                "recurring": true,
                "recurring_for": true,
                "value": 10,
                "type": "Percentage"
            },
            "management_url": "https:\/\/api.pph.sh\/client\/webinterface?hosting=41986&tab=main",
            "options": [
                {
                    "config": {
                        "id": 296,
                        "label": "Betriebssystem",
                        "default": 910
                    },
                    "option": {
                        "id": 910,
                        "label": "Linux"
                    }
                },
                {
                    "config": {
                        "id": 293,
                        "label": "Prozessor",
                        "default": 880
                    },
                    "option": {
                        "id": 880,
                        "label": "2 Kerne garantiert"
                    }
                },
                {
                    "config": {
                        "id": 294,
                        "label": "RAM",
                        "default": 985
                    },
                    "option": {
                        "id": 985,
                        "label": "2GB RAM garantiert"
                    }
                },
                {
                    "config": {
                        "id": 295,
                        "label": "NVMe SSD Speicher",
                        "default": 912
                    },
                    "option": {
                        "id": 912,
                        "label": "50GB SSD"
                    }
                },
                {
                    "config": {
                        "id": 297,
                        "label": "Netzwerkgeschwindigkeit",
                        "default": 927
                    },
                    "option": {
                        "id": 927,
                        "label": "bis zu 600 MBit\/s"
                    }
                },
                {
                    "config": {
                        "id": 310,
                        "label": "IP-Adressen",
                        "default": 990
                    },
                    "option": {
                        "id": 991,
                        "label": "2 IP Adressen"
                    }
                }
            ]
        },
        {
            "id": 41905,
            "product_name": "KVM Root Server",
            "product_group": "AMD SSD KVM vServer",
            "label": "",
            "module": "virtualizor",
            "package_id": 269,
            "order_id": 74335,
            "ipaddress": "45.84.199.31",
            "active": true,
            "suspended": false,
            "domain": "88836-41003.pph-server.de",
            "status": "Active",
            "billingcycle": "Monthly",
            "created_at": "2023-01-27T23:00:00.000000Z",
            "next_due_date": "2023-03-04T23:00:00.000000Z",
            "next_due_in": 30,
            "next_due_human": "in 1 Mon.",
            "amount": 11.72,
            "firstpaymentamount": 0,
            "has_invoice": true,
            "has_unpaid_invoices": false,
            "cancellation": false,
            "promotion": {
                "code": "GANZSCHOENEPYC20",
                "label": "GANZSCHOENEPYC20 = wiederkehrend 20%",
                "recurring": true,
                "recurring_for": true,
                "value": 20,
                "type": "Percentage"
            },
            "management_url": "https:\/\/api.pph.sh\/client\/webinterface?hosting=41905&tab=main",
            "options": [
                {
                    "config": {
                        "id": 296,
                        "label": "Betriebssystem",
                        "default": 910
                    },
                    "option": {
                        "id": 910,
                        "label": "Linux"
                    }
                },
                {
                    "config": {
                        "id": 293,
                        "label": "Prozessor",
                        "default": 880
                    },
                    "option": {
                        "id": 883,
                        "label": "4 Kerne garantiert"
                    }
                },
                {
                    "config": {
                        "id": 294,
                        "label": "RAM",
                        "default": 985
                    },
                    "option": {
                        "id": 895,
                        "label": "8GB RAM garantiert"
                    }
                },
                {
                    "config": {
                        "id": 295,
                        "label": "NVMe SSD Speicher",
                        "default": 912
                    },
                    "option": {
                        "id": 912,
                        "label": "50GB SSD"
                    }
                },
                {
                    "config": {
                        "id": 297,
                        "label": "Netzwerkgeschwindigkeit",
                        "default": 927
                    },
                    "option": {
                        "id": 927,
                        "label": "bis zu 600 MBit\/s"
                    }
                }
            ]
        },
        {
            "id": 41922,
            "product_name": "KVM Root Server",
            "product_group": "AMD SSD KVM vServer",
            "label": "",
            "module": "virtualizor",
            "package_id": 269,
            "order_id": 74356,
            "ipaddress": "45.84.199.118",
            "active": true,
            "suspended": false,
            "domain": "88042-41003.pph-server.de",
            "status": "Active",
            "billingcycle": "Monthly",
            "created_at": "2023-01-27T23:00:00.000000Z",
            "next_due_date": "2023-02-27T23:00:00.000000Z",
            "next_due_in": 25,
            "next_due_human": "in 3 Wo.",
            "amount": 5.34,
            "firstpaymentamount": 5.34,
            "has_invoice": true,
            "has_unpaid_invoices": false,
            "cancellation": false,
            "promotion": {
                "code": "GANZSCHOENEPYC20",
                "label": "GANZSCHOENEPYC20 = wiederkehrend 20%",
                "recurring": true,
                "recurring_for": true,
                "value": 20,
                "type": "Percentage"
            },
            "management_url": "https:\/\/api.pph.sh\/client\/webinterface?hosting=41922&tab=main",
            "options": [
                {
                    "config": {
                        "id": 296,
                        "label": "Betriebssystem",
                        "default": 910
                    },
                    "option": {
                        "id": 910,
                        "label": "Linux"
                    }
                },
                {
                    "config": {
                        "id": 293,
                        "label": "Prozessor",
                        "default": 880
                    },
                    "option": {
                        "id": 880,
                        "label": "2 Kerne garantiert"
                    }
                },
                {
                    "config": {
                        "id": 294,
                        "label": "RAM",
                        "default": 985
                    },
                    "option": {
                        "id": 985,
                        "label": "2GB RAM garantiert"
                    }
                },
                {
                    "config": {
                        "id": 295,
                        "label": "NVMe SSD Speicher",
                        "default": 912
                    },
                    "option": {
                        "id": 912,
                        "label": "50GB SSD"
                    }
                },
                {
                    "config": {
                        "id": 297,
                        "label": "Netzwerkgeschwindigkeit",
                        "default": 927
                    },
                    "option": {
                        "id": 927,
                        "label": "bis zu 600 MBit\/s"
                    }
                }
            ]
        }
    ],
    "links": {
        "first": "https:\/\/fsn-01.api.pph.sh\/client\/hostings?page=1",
        "last": "https:\/\/fsn-01.api.pph.sh\/client\/hostings?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "« Previous",
                "active": false
            },
            {
                "url": "https:\/\/fsn-01.api.pph.sh\/client\/hostings?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Next »",
                "active": false
            }
        ],
        "path": "https:\/\/fsn-01.api.pph.sh\/client\/hostings",
        "per_page": 15,
        "to": 3,
        "total": 3
    }
}
Hosting details
GET client/hostings/:hostingId
API Token required
read access_hostings

Return details of a hosting.

URL-Parameter

Feld Datentyp Beschreibung
hostingId int The hosting ID. Example: 37688 required

Response-Params

Feld Datentyp Beschreibung
data array Hosting details.
data.id int Hosting ID.
data.product_name string Product name.
data.product_group string Product group.
data.label string Label of the product.
data.module string The internal module for this hosting.
data.package_id string The product ID.
data.order_id string The order ID of this hosting.
data.ipaddress string The primary IP address for this hosting.
data.assigned_ips string[] Additional IP addresses assigned to this hosting.
data.active boolean Whether the hosting is active.
data.suspended boolean Whether the hosting is suspended.
data.domain string The internal subdomain for this hosting.
data.status string The status for this hosting. Can be one of Active, Suspended, Cancelled, Terminated, Pending, Fraud.
data.billingcycle string The Billing cycle for this hosting. Can be one of Monthly, Quarterly, Semi-Annually, Annually.
data.created_at string The order date for this hosting.
data.next_due_date string The next due date for this hosting.
data.next_due_in int Number of days until next due date.
data.next_due_human string Next due date in human format, translatable.
data.firstpaymentamount float The first payment amount for this hosting.
data.amount float The next payment amount for this hosting.
data.has_invoice boolean Whether this hosting as an open invoice.
data.has_unpaid_invoices boolean Whether this hosting as an unpaid invoice.
data.cancellation boolean|array Whether this hosting is cancelled.
data.promotion boolean|array Promotion data for this hosting. False when none.
data.options array Configured options for this hosting.
data.options[].config.id int Configuration id.
data.options[].config.label string Configuration label.
data.options[].config.default int Configuration default option id.
data.options[].option.id int Configuration option id.
data.options[].option.label string Configuration option label.
curl -X GET \
-G 'https://api.pph.sh/client/hostings/<hostingId>' \
-H 'Authorization: Bearer ${ACCESS_TOKEN}' \
-H 'Content-Type=application/json' \
-H 'Accept=application/json' \
-H 'Accept-Language=de; *;q=0.5' | jq
{
    "data": {
        "id": 41986,
        "product_name": "KVM Root Server",
        "product_group": "AMD SSD KVM vServer",
        "label": "",
        "module": "virtualizor",
        "package_id": 269,
        "order_id": 74457,
        "ipaddress": "45.145.225.180",
        "active": true,
        "suspended": false,
        "domain": "92351-62462.pph-server.de",
        "status": "Active",
        "billingcycle": "Monthly",
        "created_at": "2023-01-30T23:00:00.000000Z",
        "next_due_date": "2023-03-02T23:00:00.000000Z",
        "next_due_in": 28,
        "next_due_human": "in 1 Mon.",
        "amount": 8.26,
        "firstpaymentamount": 8.26,
        "has_invoice": true,
        "has_unpaid_invoices": false,
        "cancellation": false,
        "promotion": {
            "code": "PPH10",
            "label": "PPH10 = wiederkehrend 10%",
            "recurring": true,
            "recurring_for": true,
            "value": 10,
            "type": "Percentage"
        },
        "management_url": "https:\/\/api.pph.sh\/client\/webinterface?hosting=41986&tab=main",
        "options": [
            {
                "config": {
                    "id": 296,
                    "label": "Betriebssystem",
                    "default": 910
                },
                "option": {
                    "id": 910,
                    "label": "Linux"
                }
            },
            {
                "config": {
                    "id": 293,
                    "label": "Prozessor",
                    "default": 880
                },
                "option": {
                    "id": 880,
                    "label": "2 Kerne garantiert"
                }
            },
            {
                "config": {
                    "id": 294,
                    "label": "RAM",
                    "default": 985
                },
                "option": {
                    "id": 985,
                    "label": "2GB RAM garantiert"
                }
            },
            {
                "config": {
                    "id": 295,
                    "label": "NVMe SSD Speicher",
                    "default": 912
                },
                "option": {
                    "id": 912,
                    "label": "50GB SSD"
                }
            },
            {
                "config": {
                    "id": 297,
                    "label": "Netzwerkgeschwindigkeit",
                    "default": 927
                },
                "option": {
                    "id": 927,
                    "label": "bis zu 600 MBit\/s"
                }
            },
            {
                "config": {
                    "id": 310,
                    "label": "IP-Adressen",
                    "default": 990
                },
                "option": {
                    "id": 991,
                    "label": "2 IP Adressen"
                }
            }
        ]
    }
}
Hosting invoices
GET client/hostings/:hostingId/invoices
API Token required
read access_hostings access_invoices

Returns all invoices related to a hosting.

URL-Parameter

Feld Datentyp Beschreibung
hostingId int The hosting ID. Example: 37688 required

Query-Parameter

Feld Datentyp Beschreibung
latest bool Only return latest invoice. Example: true
curl -X GET \
-G 'https://api.pph.sh/client/hostings/<hostingId>/invoices' \
-H 'Authorization: Bearer ${ACCESS_TOKEN}' \
-H 'Content-Type=application/json' \
-H 'Accept=application/json' \
-H 'Accept-Language=de; *;q=0.5' | jq
{
    "data": {
        "id": 55,
        "duedate": "2014-01-09T23:00:00.000000Z",
        "datepaid": "2014-01-10T21:32:43.000000Z",
        "date": "2014-01-09T23:00:00.000000Z",
        "subtotal": 5.8,
        "credit": 5,
        "tax": 1.1,
        "taxrate": 19,
        "total": 6.9,
        "status": "Paid",
        "status_label": "Bezahlt",
        "is_open": false,
        "items": [
            {
                "id": 55,
                "invoiceid": 55,
                "type": "Hosting",
                "short_description": "V-Server Bronze (OpenVZ) - Prepaid (10.01.2014 - 09.02.2014)",
                "description": "V-Server Bronze (OpenVZ) - Prepaid (10.01.2014 - 09.02.2014)",
                "relid": 52,
                "amount": 6.9,
                "taxed": 1,
                "donation": false
            }
        ],
        "donation_invoice": false,
        "transaction": {
            "id": 5,
            "gateway": "banktransfer",
            "date": "2014-01-10T21:32:43.000000Z",
            "diff_for_humans": "vor 9 Jahren",
            "description": "Invoice Payment",
            "amountin": 1.9,
            "amountout": 0,
            "invoiceid": 55
        },
        "resources": {
            "invoice": "https:\/\/api.pph.sh\/client\/invoices\/55",
            "download": "https:\/\/api.pph.sh\/client\/invoices\/55\/download"
        }
    }
}
Hosting config change
POST client/hostings/:hostingId/upgrade
API Token required
read access_hostings

Returns information about a config option upgrade.

curl -X POST \
-G 'https://api.pph.sh/client/hostings/<hostingId>/upgrade' \
-H 'Authorization: Bearer ${ACCESS_TOKEN}' \
-H 'Content-Type=application/json' \
-H 'Accept=application/json' \
-H 'Accept-Language=de; *;q=0.5' | jq
Apply hosting config change
POST client/hostings/:hostingId/upgrade/do
API Token required
read access_hostings update_hostings

Applies an upgrade of config options.

curl -X POST \
-G 'https://api.pph.sh/client/hostings/<hostingId>/upgrade/do' \
-H 'Authorization: Bearer ${ACCESS_TOKEN}' \
-H 'Content-Type=application/json' \
-H 'Accept=application/json' \
-H 'Accept-Language=de; *;q=0.5' | jq
Get cancellation
GET client/hostings/:hostingId/cancellation
API Token required
read access_hostings access_cancellations

Returns the current cancellation for a hosting, if any.

URL-Parameter

Feld Datentyp Beschreibung
hostingId int The hosting ID. Example: 30910 required
curl -X GET \
-G 'https://api.pph.sh/client/hostings/<hostingId>/cancellation' \
-H 'Authorization: Bearer ${ACCESS_TOKEN}' \
-H 'Content-Type=application/json' \
-H 'Accept=application/json' \
-H 'Accept-Language=de; *;q=0.5' | jq
{
    "data": []
}
Immediate cancellation info
GET client/hostings/:hostingId/cancellation/refund
API Token required
read access_hostings access_cancellations

If eligible, you will get a refund of unused time less charges. Use this endpoint to get information about it.

URL-Parameter

Feld Datentyp Beschreibung
hostingId int The hosting ID. Example: 30910 required

Response-Params

Feld Datentyp Beschreibung
refundable boolean Whether this hosting is refundable.
last_paid date Date of last invoice payment.
days_left int Number of days left until this hosting is extended.
cycle string The billingcycle set for this hosting.
price_per_day float Cost per day.
price_per_hour float Cost per hour.
credit_used float Credit that has been already used for this hosting and cannot be refunded.
credit_back_now float Credit that will be refunded when this hosting is cancelled immediate.
cancellation_fee float Immediate cancellation fee.
unpaid_invoice object[] Unpaid invoice information.
curl -X GET \
-G 'https://api.pph.sh/client/hostings/<hostingId>/cancellation/refund' \
-H 'Authorization: Bearer ${ACCESS_TOKEN}' \
-H 'Content-Type=application/json' \
-H 'Accept=application/json' \
-H 'Accept-Language=de; *;q=0.5' | jq
{
    "data": {
        "refundable": true,
        "immediate_available": true,
        "immediate_available_msg": false,
        "last_paid": 8.26,
        "days_left": 29,
        "cycle": 28,
        "price_per_day": 0.295,
        "price_per_hour": 0.0123,
        "credit_used": 0,
        "credit_back_now": 7.76,
        "cancellation_fee": 0.5,
        "max_credit_back": 8.26,
        "hosting_amount": 8.26,
        "credit_on_last_invoice": 8.26,
        "unpaid_invoice": null,
        "last_invoice_id": 219960
    }
}
Create a cancellation
POST client/hostings/:hostingId/cancellation/create
API Token required
read access_hostings access_cancellations create_cancellations

Cancel a hosting. You can choose at the end of its billing cycle or immediate. Set immediate to true to cancel the hosting immediately. This cannot be undone! If eligible, you will get a refund of unused time less charges.

URL-Parameter

Feld Datentyp Beschreibung
hostingId int The hosting ID. Example: 30910 required

Query-Parameter

Feld Datentyp Beschreibung
immediate boolean Whether to cancel the hosting immediate. Defaults to false. Example: false
reason.text string A short reason of cancelling. Example: "Not needed anymore"
rating.support int Rating of support. 0 = none, 1 = worst, 10 = best. Example: 0
rating.hostingquality int Rating of hosting quality. 0 = none, 1 = worst, 10 = best. Example: 0
curl -X POST \
-G 'https://api.pph.sh/client/hostings/<hostingId>/cancellation/create' \
-H 'Authorization: Bearer ${ACCESS_TOKEN}' \
-H 'Content-Type=application/json' \
-H 'Accept=application/json' \
-H 'Accept-Language=de; *;q=0.5' | jq
Revoke cancellation
POST client/hostings/:hostingId/cancellation/revoke
API Token required
read access_hostings access_cancellations create_cancellations

When a hosting is pending for cancellation at its expiry date, the cancellation can be revoked with this endpoint.

When the hosting is due for payment, an invoice will be created. Bear in mind that such invoice will be automatically be paid when enough credit is available.

URL-Parameter

Feld Datentyp Beschreibung
hostingId int The hosting ID. Example: 30910 required
curl -X POST \
-G 'https://api.pph.sh/client/hostings/<hostingId>/cancellation/revoke' \
-H 'Authorization: Bearer ${ACCESS_TOKEN}' \
-H 'Content-Type=application/json' \
-H 'Accept=application/json' \
-H 'Accept-Language=de; *;q=0.5' | jq
{
    "revoked": true
}
Get hosting features
GET client/hostings/:hostingId/features
read access_hostings

URL-Parameter

Feld Datentyp Beschreibung
hostingId int The hosting ID. Example: 30910 required
curl -X GET \
-G 'https://api.pph.sh/client/hostings/<hostingId>/features' \
-H 'Content-Type=application/json' \
-H 'Accept=application/json' \
-H 'Accept-Language=de; *;q=0.5' | jq
{
    "0": {
        "id": "service-info",
        "label": "Service-Info",
        "icon": "fal fa-info-circle"
    },
    "App\\Api\\Support\\Virtualizor\\Features\\CloudManagerFeature": {
        "id": "cloud-manager",
        "label": "Cloud-Manager",
        "icon": "fal fa-dashboard"
    }
}
Get hosting actions
GET client/hostings/:hostingId/actions
read access_hostings access_hosting_actions

URL-Parameter

Feld Datentyp Beschreibung
hostingId int The hosting ID. Example: 30910 required
curl -X GET \
-G 'https://api.pph.sh/client/hostings/<hostingId>/actions' \
-H 'Content-Type=application/json' \
-H 'Accept=application/json' \
-H 'Accept-Language=de; *;q=0.5' | jq
{
    "data": [
        {
            "action": "configuration",
            "description": "",
            "parameters": [],
            "access": "read",
            "url": "https:\/\/api.pph.sh\/client\/hostings\/41986\/actions\/read\/configuration"
        },
        {
            "action": "live",
            "description": "",
            "parameters": {
                "methods": "One or multiple of: cpu-usage, os-type, disk-space, load-average, memory-usage, os-info, processes, processor-info, real-hostname, ssh-port, ssh-root-login, uptime"
            },
            "access": "read",
            "url": "https:\/\/api.pph.sh\/client\/hostings\/41986\/actions\/read\/live"
        },
        {
            "action": "status",
            "description": "Returns the current ",
            "parameters": [],
            "access": "read",
            "url": "https:\/\/api.pph.sh\/client\/hostings\/41986\/actions\/read\/status"
        },
        {
            "action": "ssh-keys",
            "description": "",
            "parameters": [],
            "access": "read",
            "url": "https:\/\/api.pph.sh\/client\/hostings\/41986\/actions\/read\/ssh-keys"
        },
        {
            "action": "os-list",
            "description": "",
            "parameters": [],
            "access": "read",
            "url": "https:\/\/api.pph.sh\/client\/hostings\/41986\/actions\/read\/os-list"
        },
        {
            "action": "screenshot",
            "description": "Returns a screenshot from the virtual server in base64 format.",
            "parameters": [],
            "access": "read",
            "url": "https:\/\/api.pph.sh\/client\/hostings\/41986\/actions\/read\/screenshot"
        },
        {
            "action": "ping",
            "description": "",
            "parameters": [],
            "access": "read",
            "url": "https:\/\/api.pph.sh\/client\/hostings\/41986\/actions\/read\/ping"
        },
        {
            "action": "stats_history",
            "description": "",
            "parameters": [],
            "access": "read",
            "url": "https:\/\/api.pph.sh\/client\/hostings\/41986\/actions\/read\/stats_history"
        },
        {
            "action": "traffic",
            "description": "Returns the current traffic from this vps",
            "parameters": [],
            "access": "read",
            "url": "https:\/\/api.pph.sh\/client\/hostings\/41986\/actions\/read\/traffic"
        },
        {
            "action": "plesk",
            "description": "",
            "parameters": [],
            "access": "read",
            "url": "https:\/\/api.pph.sh\/client\/hostings\/41986\/actions\/read\/plesk"
        },
        {
            "action": "backups",
            "description": "Returns vps backups",
            "parameters": [],
            "access": "read",
            "url": "https:\/\/api.pph.sh\/client\/hostings\/41986\/actions\/read\/backups"
        },
        {
            "action": "vnc",
            "description": "Returns information about vnc access to virtual server",
            "parameters": [],
            "access": "read",
            "url": "https:\/\/api.pph.sh\/client\/hostings\/41986\/actions\/read\/vnc"
        },
        {
            "action": "rdp",
            "description": "Returns information about rdp",
            "parameters": [],
            "access": "read",
            "url": "https:\/\/api.pph.sh\/client\/hostings\/41986\/actions\/read\/rdp"
        },
        {
            "action": "available-updates",
            "description": "",
            "parameters": [],
            "access": "read",
            "url": "https:\/\/api.pph.sh\/client\/hostings\/41986\/actions\/read\/available-updates"
        },
        {
            "action": "auto-update-logs",
            "description": "",
            "parameters": [],
            "access": "read",
            "url": "https:\/\/api.pph.sh\/client\/hostings\/41986\/actions\/read\/auto-update-logs"
        },
        {
            "action": "reset-password",
            "description": "Resets the root\/admin password for this virtual server",
            "parameters": {
                "password": "The password to set. Using default password if empty."
            },
            "access": "write",
            "url": "https:\/\/api.pph.sh\/client\/hostings\/41986\/actions\/write\/reset-password"
        },
        {
            "action": "edit-server",
            "description": "Change parameters\/settings for this virtual server",
            "parameters": {
                "hostname": "The hostname to set. Not changing if empty."
            },
            "access": "write",
            "url": "https:\/\/api.pph.sh\/client\/hostings\/41986\/actions\/write\/edit-server"
        },
        {
            "action": "reboot-server",
            "description": "Reboots this virtual server",
            "parameters": [],
            "access": "write",
            "url": "https:\/\/api.pph.sh\/client\/hostings\/41986\/actions\/write\/reboot-server"
        },
        {
            "action": "start-server",
            "description": "Starts this virtual server",
            "parameters": [],
            "access": "write",
            "url": "https:\/\/api.pph.sh\/client\/hostings\/41986\/actions\/write\/start-server"
        },
        {
            "action": "stop-server",
            "description": "Stops this virtual server",
            "parameters": [],
            "access": "write",
            "url": "https:\/\/api.pph.sh\/client\/hostings\/41986\/actions\/write\/stop-server"
        },
        {
            "action": "reinstall-server",
            "description": "Reinstalls this virtual server",
            "parameters": [],
            "access": "write",
            "url": "https:\/\/api.pph.sh\/client\/hostings\/41986\/actions\/write\/reinstall-server"
        },
        {
            "action": "prepare-iso",
            "description": "Downloads an iso to the server.",
            "parameters": [],
            "access": "write",
            "url": "https:\/\/api.pph.sh\/client\/hostings\/41986\/actions\/write\/prepare-iso"
        },
        {
            "action": "enable-ping",
            "description": "Enables the ICMP protocol (ping) on a windows server",
            "parameters": [],
            "access": "write",
            "url": "https:\/\/api.pph.sh\/client\/hostings\/41986\/actions\/write\/enable-ping"
        },
        {
            "action": "clear-cache",
            "description": "Clears the temporary API cache of this vps",
            "parameters": [],
            "access": "write",
            "url": "https:\/\/api.pph.sh\/client\/hostings\/41986\/actions\/write\/clear-cache"
        },
        {
            "action": "plesk",
            "description": "",
            "parameters": [],
            "access": "write",
            "url": "https:\/\/api.pph.sh\/client\/hostings\/41986\/actions\/write\/plesk"
        },
        {
            "action": "assign-ipv6-subnet",
            "description": "",
            "parameters": [],
            "access": "write",
            "url": "https:\/\/api.pph.sh\/client\/hostings\/41986\/actions\/write\/assign-ipv6-subnet"
        },
        {
            "action": "admin-managed",
            "description": "Changes the admin_managed flag of this server",
            "parameters": [],
            "access": "write",
            "url": "https:\/\/api.pph.sh\/client\/hostings\/41986\/actions\/write\/admin-managed"
        },
        {
            "action": "rescue-mode",
            "description": "Manages rescue mode for this virtual server",
            "parameters": [],
            "access": "write",
            "url": "https:\/\/api.pph.sh\/client\/hostings\/41986\/actions\/write\/rescue-mode"
        },
        {
            "action": "fix-network",
            "description": "Stops this virtual server",
            "parameters": [],
            "access": "write",
            "url": "https:\/\/api.pph.sh\/client\/hostings\/41986\/actions\/write\/fix-network"
        },
        {
            "action": "rdns",
            "description": "Changes the reverse dns of this server",
            "parameters": [],
            "access": "write",
            "url": "https:\/\/api.pph.sh\/client\/hostings\/41986\/actions\/write\/rdns"
        },
        {
            "action": "reset-server",
            "description": "Power-Resets this virtual server",
            "parameters": [],
            "access": "write",
            "url": "https:\/\/api.pph.sh\/client\/hostings\/41986\/actions\/write\/reset-server"
        },
        {
            "action": "execute",
            "description": "Executes a script on the server",
            "parameters": [],
            "access": "write",
            "url": "https:\/\/api.pph.sh\/client\/hostings\/41986\/actions\/write\/execute"
        }
    ]
}
Execute an action on the hosting
GET client/hostings/:hostingId/actions/handle/:key
read access_hostings access_hosting_actions

URL-Parameter

Feld Datentyp Beschreibung
hostingId int The hosting ID. Example: 30910 required
action string The action. Valid actions are returned by client/hostings/{hostingId}/actions. Example: configuration required
curl -X GET \
-G 'https://api.pph.sh/client/hostings/<hostingId>/actions/handle/<key>' \
-H 'Content-Type=application/json' \
-H 'Accept=application/json' \
-H 'Accept-Language=de; *;q=0.5' | jq
{
    "error": "NotFoundHttpException",
    "message": "The given action was not found"
}

Beispiel-Requests

GET client/hostings/<hostingId>/actions/handle/configuration
Reads the configuration of a virtual server
GET client/hostings/<hostingId>/actions/handle/live
Body param Description
methods One or multiple of: cpu-usage, os-type, disk-space, load-average, memory-usage, os-info, processes, processor-info, real-hostname, ssh-port, ssh-root-login, uptime
Reads the live data of a virtual server
GET client/hostings/<hostingId>/actions/handle/status
Returns the current status of the server
GET client/hostings/<hostingId>/actions/handle/ssh-keys
Reads the public keys of a virtual server
GET client/hostings/<hostingId>/actions/handle/os-list
Reads the list of available operating systems
GET client/hostings/<hostingId>/actions/handle/screenshot
Returns a screenshot from the virtual server in base64 format.
GET client/hostings/<hostingId>/actions/handle/ping
Reads the ping of a virtual server
GET client/hostings/<hostingId>/actions/handle/stats_history
Reads the stats history of a virtual server
GET client/hostings/<hostingId>/actions/handle/traffic
Returns the current traffic from this vps
GET client/hostings/<hostingId>/actions/handle/plesk
Reads the plesk license of a virtual server
GET client/hostings/<hostingId>/actions/handle/backups
Get a list of vps backups
GET client/hostings/<hostingId>/actions/handle/vnc
Returns information about vnc access to virtual server
GET client/hostings/<hostingId>/actions/handle/rdp
Reads information about rdp
GET client/hostings/<hostingId>/actions/handle/available-updates
Reads the available updates of a virtual server
GET client/hostings/<hostingId>/actions/handle/auto-update-logs
Reads the auto-update log of a virtual server (PPH Pro)
POST client/hostings/<hostingId>/actions/handle/reset-password
Body param Description
password The password to set. Using default password if empty.
Resets the root/admin password for this virtual server
POST client/hostings/<hostingId>/actions/handle/edit-server
Body param Description
hostname The hostname to set. Not changing if empty.
Change parameters/settings for this virtual server
POST client/hostings/<hostingId>/actions/handle/reboot-server
Reboots this virtual server
POST client/hostings/<hostingId>/actions/handle/start-server
Starts this virtual server
POST client/hostings/<hostingId>/actions/handle/stop-server
Stops this virtual server
POST client/hostings/<hostingId>/actions/handle/reinstall-server
Reinstalls this virtual server
POST client/hostings/<hostingId>/actions/handle/enable-ping
Enables the ICMP protocol (ping) on a windows server
POST client/hostings/<hostingId>/actions/handle/clear-cache
Clears the temporary API cache of this vps
POST client/hostings/<hostingId>/actions/handle/plesk
POST client/hostings/<hostingId>/actions/handle/rescue-mode
Manages rescue mode for this virtual server
POST client/hostings/<hostingId>/actions/handle/rdns
Changes the reverse dns of this server
POST client/hostings/<hostingId>/actions/handle/reset-server
Power-Resets this virtual server
POST client/hostings/<hostingId>/actions/handle/execute
Executes a script on the server