5 POST /service/{serviceid}/start
Thomas Brinkmann edited this page 2 years ago

POST /service/{serviceid}/start

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

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://api.dsh.gg/api/v2/service/12345/start',
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_HTTPHEADER => array(
    'X-TOKEN: test-token',
    'Content-Type: application/json'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;
cURL
curl --location --request POST 'https://api.dsh.gg/api/v2/service/12345/start' \
--header 'X-TOKEN: test-token' \
--header 'Content-Type: application/json'

Beispiel Antwort

{
    "status": "OK"
}

Mögliche Fehlermeldungen

Status Code 403 - Permission denied

Status Code 400 - Power on failed. Is the Server already powered on?

Status Code 500 - This action is not available for this service!