Skip to main content
DELETE
/
api
/
v0
/
workergroups
/
{id}
delete workergroup
curl --request DELETE \
  --url https://console.vast.ai/api/v0/workergroups/{id}/ \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "deleted_workers": [
    1001,
    1002
  ],
  "failed_workers": [],
  "msg": "Deleted workergroup and 2 workers"
}

Documentation Index

Fetch the complete documentation index at: https://docs.vast.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

API key must be provided in the Authorization header

Path Parameters

​
id
integer
required

ID of the workergroup to delete

Example:

4242

Response

Workergroup deleted successfully

​
success
boolean
Example:

true

​
deleted_workers
integer[]

List of worker instances that were deleted

Example:
[1001, 1002]
​
failed_workers
integer[]

List of worker instances that failed to delete

Example:
[]
​
msg
string

Additional information about the deletion

Example:

"Deleted workergroup and 2 workers"