„GET /service/{serviceid}/console“ ändern

master
Thomas Brinkmann 3 years ago
parent 58b4c7b846
commit 4b8e2902eb
  1. 82
      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
<?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => '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
Loading…
Cancel
Save