From 75978d9acd13bb4699b2d357b2c7dda94ee8bfcc Mon Sep 17 00:00:00 2001 From: Thomas Brinkmann Date: Wed, 1 Jun 2022 19:25:41 +0200 Subject: [PATCH] =?UTF-8?q?=E2=80=9EPOST=20/service/{serviceid}/provisioni?= =?UTF-8?q?ng=E2=80=9C=20=C3=A4ndern?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- ...-%2Fservice%2F%7Bserviceid%7D%2Fprovisioning.md | 98 ++++++++++++++++++++++ 1 file changed, 98 insertions(+) create mode 100644 POST-%2Fservice%2F%7Bserviceid%7D%2Fprovisioning.md diff --git a/POST-%2Fservice%2F%7Bserviceid%7D%2Fprovisioning.md b/POST-%2Fservice%2F%7Bserviceid%7D%2Fprovisioning.md new file mode 100644 index 0000000..861e105 --- /dev/null +++ b/POST-%2Fservice%2F%7Bserviceid%7D%2Fprovisioning.md @@ -0,0 +1,98 @@ +## **POST /service/{serviceid}/provisioning** + + +## **Inhalt** +--- +- Parameter +- Optionale Parameter +- Beispiel Anfrage +- Beispiel Antwort +- Mögliche Fehlermeldungen +--- + +### Parameter + +|URL Parameter | Typ | Beschreibung| +|----------|-----|-------------| +|serviceid | integer| Beschreibt die ID des Services + +|Body Parameter | Typ | Beschreibung| +|----------|-----|-------------| +| templateid | integer | Die ID des Templates das geladen werden soll für die Neuinstallation | +| rootpass | string | Das Root Password welches für das System gesetzt wird | + + +> :warning: Für die **KVM SERVER** ändert sich der Parameter ``templateid`` zu ``template`` + +|Body Parameter | Typ | Beschreibung| +|----------|-----|-------------| +| template | string | Der Name des Templates welches verwendet werden soll | +| rootpass | string | Das Root Password welches für das System gesetzt wird | + + +--- + +### Optionale Parameter + +|Query-String Parameter | Typ | Beschreibung| +|----------|-----|-------------| +|-| -| - + + +--- + +### Beispiel Anfrage + +##### PHP +```php + 'control.local/api/v2/service/12345/provisioning', + CURLOPT_CUSTOMREQUEST => 'POST', + CURLOPT_POSTFIELDS =>'{ + "template": "Debian10-64Bit", // templateid for Dedicated Server, Win VPS/Rootservers, Storage VPS + "rootpass": "1qQertzuiopas!d" + }', + CURLOPT_HTTPHEADER => array( + 'X-TOKEN: test-token', + 'Content-Type: application/json' + ), +)); + +$response = curl_exec($curl); + +curl_close($curl); +echo $response; +``` + +##### cURL +```bash +curl --location --request POST 'control.local/api/v2/service/12345/provisioning' \ +--header 'X-TOKEN: test-token' \ +--header 'Content-Type: application/json' \ +--data-raw '{ + "template": "Debian10-64Bit", // templateid for Dedicated Server, Win VPS/Rootservers, Storage VPS + "rootpass": "1qQertzuiopas!d" +}' +``` + +--- + +### Beispiel Antwort + +```json +{ + "status": "OK" +} +``` + +### Mögliche Fehlermeldungen + +> :warning: Status Code **403** - Permission denied + +> :warning: Status Code **400** - Error, installation could not be queued. Is another installation already queued? + +> :warning: Status Code **500** - This action is not available for this service!