Stop all background jobs
curl --request POST \
--url http://127.0.0.1:8765/v1/workspaces/{workspace_id}/kill \
--header 'Authorization: Bearer <token>'import requests
url = "http://127.0.0.1:8765/v1/workspaces/{workspace_id}/kill"
headers = {"Authorization": "Bearer <token>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
fetch('http://127.0.0.1:8765/v1/workspaces/{workspace_id}/kill', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"killed": 1
}Lifecycle
Stop all background jobs
POST
/
v1
/
workspaces
/
{workspace_id}
/
kill
Stop all background jobs
curl --request POST \
--url http://127.0.0.1:8765/v1/workspaces/{workspace_id}/kill \
--header 'Authorization: Bearer <token>'import requests
url = "http://127.0.0.1:8765/v1/workspaces/{workspace_id}/kill"
headers = {"Authorization": "Bearer <token>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
fetch('http://127.0.0.1:8765/v1/workspaces/{workspace_id}/kill', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"killed": 1
}Stop background jobs and the programs machines started across every session. The workspace and sessions remain open.
See error examples and recovery steps. The complete OpenAPI contract includes every response schema.
Errors
Errors
| Status | Meaning |
|---|---|
400 | The request is malformed: the body is not JSON (invalid_json) or not a JSON object, a field is missing (missing_field), unknown (unknown_field) or has a wrong value (invalid_value), or the request is otherwise invalid (invalid_request). param names the field at fault. |
401 | The token is missing or wrong (unauthorized). |
404 | The workspace, session, job, file or route does not exist, or the caller may not see it (not_found). |
429 | Past a rate limit (rate_limited), or a new session past max_sessions (session_limit). |