v1

latestOpenAPI 3.1.02026-07-175096.6 KB
Desktop

Stop a running desktop instance

Stops a running desktop instance and cleans up resources

post/v1/desktop/{id}/stop

Path parameters

idstring required

Desktop instance ID to stop

Example:desktop_12345

Headers

x-api-keystring required

API key for authentication

Example:api_12345

Response

Desktop stopped successfully

status'pending' | 'running' | 'terminated' | 'error' required

Status of the desktop instance after stopping

Example response

{
  "status": "terminated"
}