From 9c10c44930677bf7febcb78bdc1d6e3c6a6819bd Mon Sep 17 00:00:00 2001 From: Thomas Brinkmann Date: Wed, 1 Jun 2022 19:08:28 +0200 Subject: [PATCH] =?UTF-8?q?=E2=80=9EPOST=20/service/{serviceid}/rescue?= =?UTF-8?q?=E2=80=9C=20=C3=A4ndern?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- POST-%2Fservice%2F%7Bserviceid%7D%2Frescue.md | 92 +++++++++++++++++++++++++++ 1 file changed, 92 insertions(+) create mode 100644 POST-%2Fservice%2F%7Bserviceid%7D%2Frescue.md diff --git a/POST-%2Fservice%2F%7Bserviceid%7D%2Frescue.md b/POST-%2Fservice%2F%7Bserviceid%7D%2Frescue.md new file mode 100644 index 0000000..cbb8579 --- /dev/null +++ b/POST-%2Fservice%2F%7Bserviceid%7D%2Frescue.md @@ -0,0 +1,92 @@ +## **POST /service/{serviceid}/rescue** + + +## **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| +|----------|-----|-------------| +| rootpass | string | Das Root Password welches für das Rescue System gesetzt wird | + + +--- + +### Optionale Parameter + +|Query-String Parameter | Typ | Beschreibung| +|----------|-----|-------------| +|-| -| - + +|Body Parameter | Typ | Beschreibung| +|----------|-----|-------------| +| templateid | integer | Die ID des Rescue Templates das geladen werden soll | + + +--- + +### Beispiel Anfrage + +##### PHP +```php + 'control.local/api/v2/service/12345/rescue', + CURLOPT_CUSTOMREQUEST => 'POST', + CURLOPT_POSTFIELDS =>'{ + "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/rescue' \ +--header 'X-TOKEN: test-token' \ +--header 'Content-Type: application/json' \ +--data-raw '{ + "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! \ No newline at end of file