delete workergroup

Deletes an existing workergroup.

CLI Usage: vastai delete workergroup <id>

DELETE /api/v0/workergroups/{id}

delete workergroup

cURL

curl --request DELETE \
  --url https://console.vast.ai/api/v0/workergroups/{id}/ \
  --header 'Authorization: Bearer <token>'

200

{
  "success": true,
  "deleted_workers": [
    1001,
    1002
  ],
  "failed_workers": [],
  "msg": "Deleted workergroup and 2 workers"
}

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

200

application/json

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"