Start, stop or restart VPS

Request, parameters and responses for this API endpoint.

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

Overview

This endpoint requires an API key with write access. Its creator must still be the user of the customer account.

Headers & parameters

AuthorizationBearer $SYSTEY_API_KEY · required

Content-Typeapplication/json

idpath · required

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

Idempotency-Keyheader · required

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

Use a new UUID per action. Reuse the same UUID and content for retries.

Request body

Send a JSON object. Required fields refer to their containing object. Business requirements for the endpoint also apply; unknown fields are rejected.

Schema fields and requirements
Field	Type	Required
`action` "start" \| "stop" \| "restart"	string	Yes

Example request

Replace placeholders with your own values. Persist $REQUEST_UUID before a mutation if this endpoint requires an Idempotency-Key.

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"
}'

Response

HTTP 200

Schema fields and requirements
Field	Type	Required
`data`	object	Yes
`data.message`	string	Yes

Errors

Error responses contain error and optionally message and details. Rate limit: 120 requests per minute per key. On HTTP 429 respect Retry-After.