Skip to main content
Stops a running workspace. The workspace will transition through the stopping status before reaching stopped. The workspace volume is preserved.

Authentication

Requires a valid Bearer token.

Path Parameters

id
string
required
Workspace ID (UUID).

Response

status
string
required
The new workspace status.
{
  "status": "stopping"
}

Errors

StatusDescription
400Bad Request — workspace is not in a stoppable state
401Unauthorized — missing or invalid token
404Not Found — workspace does not exist or you do not have access