From 4b8e2902eb30328e1f26465a596ad533fc04dc4b Mon Sep 17 00:00:00 2001 From: Thomas Brinkmann Date: Wed, 1 Jun 2022 19:12:42 +0200 Subject: [PATCH] =?UTF-8?q?=E2=80=9EGET=20/service/{serviceid}/console?= =?UTF-8?q?=E2=80=9C=20=C3=A4ndern?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- GET-%2Fservice%2F%7Bserviceid%7D%2Fconsole.md | 82 +++++++++++++++++++++++++++ 1 file changed, 82 insertions(+) create mode 100644 GET-%2Fservice%2F%7Bserviceid%7D%2Fconsole.md diff --git a/GET-%2Fservice%2F%7Bserviceid%7D%2Fconsole.md b/GET-%2Fservice%2F%7Bserviceid%7D%2Fconsole.md new file mode 100644 index 0000000..0fe86b7 --- /dev/null +++ b/GET-%2Fservice%2F%7Bserviceid%7D%2Fconsole.md @@ -0,0 +1,82 @@ +## **GET /service/{serviceid}/console** + + +## **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| +|----------|-----|-------------| +| - | - | - | + + +--- + +### Optionale Parameter + +|Query-String Parameter | Typ | Beschreibung| +|----------|-----|-------------| +|-| -| - + + +--- + +### Beispiel Anfrage + +##### PHP +```php + 'control.local/api/v2/service/12345/console', + CURLOPT_CUSTOMREQUEST => 'GET', + 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 GET 'control.local/api/v2/service/12345/console' \ +--header 'X-TOKEN: test-token' \ +--header 'Content-Type: application/json' +``` + +--- + +### Beispiel Antwort + +```json +{ + "status": "OK", + "URL": "https://XXX.XXX.XXX.XXX:8006/novnc/mgnovnc.html?token=XXXXXXXXXXXXXXXXX&CSRFPreventionToken=XXXXXXXXXXXXXXX&console=qemu&virtualization=qemu&node=XXXXXXX&vmid=12345" +} +``` + +### Mögliche Fehlermeldungen + +> :warning: Status Code **403** - Permission denied + +> :warning: Status Code **500** - This action is not available for this service! + +> :warning: Status Code **500** - Error Processing Request \ No newline at end of file