Server starten, stoppen oder neu starten

Anfrage, Parameter und Antworten für diesen API-Endpunkt.

POST/api/v1/customer/products/{id}/server/power

Überblick

Dieser Endpunkt benötigt einen API-Schlüssel mit Schreibzugriff. Sein Ersteller muss weiterhin der Benutzer des Kundenkontos sein.

Header & Parameter

AuthorizationBearer $SYSTEY_API_KEY · erforderlich

Content-Typeapplication/json

idpath · erforderlich

{"type":"string","format":"uuid"}

Idempotency-Keyheader · erforderlich

{"type":"string","format":"uuid"}

Neue UUID pro Aktion. Bei Wiederholung dieselbe UUID und denselben Inhalt verwenden.

Anfrage-Body

Senden Sie ein JSON-Objekt. Pflichtfelder beziehen sich auf das jeweilige Objekt. Zusätzlich gelten die fachlichen Voraussetzungen des jeweiligen Endpunkts; unbekannte Felder werden abgewiesen.

Schemafelder und Anforderungen
Feld	Typ	Pflicht
`action` "start" \| "stop" \| "restart"	string	Ja

Beispielanfrage

Ersetzen Sie Platzhalter durch eigene Werte. Speichern Sie $REQUEST_UUID vor einer schreibenden Aktion, sofern dieser Endpunkt einen Idempotency-Key benötigt.

cURL

curl -i -X POST "https://systey.com/api/v1/customer/products/<resource UUID>/server/power" \
  -H "Authorization: Bearer $SYSTEY_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $REQUEST_UUID" \
  --data '{
  "action": "restart"
}'

Antwort

HTTP 200

Schemafelder und Anforderungen
Feld	Typ	Pflicht
`data`	object	Ja
`data.message`	string	Ja

Fehler

Fehlerantworten enthalten error sowie optional message und details. Rate-Limit: 120 Anfragen pro Minute und Schlüssel. Bei HTTP 429 den Retry-After-Header beachten.