„POST /service/{serviceid}/rescue“ ändern

master
Thomas Brinkmann 3 years ago
parent badc23d1c3
commit 9c10c44930
  1. 92
      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
<?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => '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!
Loading…
Cancel
Save