Start, stop or reboot a server
POST/api/v3/servers/:server_id/power-actions
Required scopes: server:write
Starts a power action on the server, chosen with action; the operation goes on in the background as the returned Task. 403 for an action that the server does not have (physical servers only have reboot); 409 while the server is not ready, its service is not active or is under maintenance, or another operation does not allow the action. Before, each action had its own path (…/start, …/reboot, …/stop, …/hard-reboot, …/hard-stop)
Request
Responses
- 202
- 400
- 401
- 403
- 404
- 409
- 429
- 500
Accepted: the operation goes on in the background, as the returned Task
Response Headers
URL of the Task: /api/v3/tasks/{task_id}. Reading it requires the purchases:read scope
The request is not valid: error 1000 with the errors for each field in meta.errors, error 1001 (or 1) for other invalid input
The access token is missing, invalid, expired or revoked (error 1100): request a new token and retry once
The access token is valid but not enough: missing scope (error 1101), token for the other API (error 1102), missing permission, feature not included in the plan, operation not available to sub-accounts, internal API without administrator privileges or IP address not allowed (error 1601). A new token does not change the result
The resource does not exist or does not belong to the account (error 1200)
The request conflicts with a business rule or with the current state of the resource (error 1400)
Too many requests (error 1300): retry after the seconds in the Retry-After header
Response Headers
Seconds to wait before retrying
Unexpected server error (error 1500)