Workloads batch

Workload batch operations.

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Body

application/json

The ids and action to perform on a batch of workloads. The number of ids is limited to 100.

idsstring · uuid[] · min: 1Required

List of ids to perform the action on.

actionstring · enumRequired

The action to perform on the list of ids.

Possible values:

Responses

200

Request completed successfully.

application/json

idstring · uuidRequired

The ID of the batch operation.

succeededstring · uuid[] · min: 1Optional

List of ids to perform the action on.

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

500

unexpected error

application/json

503

unexpected error

application/json

post/api/v1/workloads/batch

HTTPcURLJavaScriptPython

POST /api/v1/workloads/batch HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 66

{
  "ids": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "action": "delete"
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "succeeded": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "failed": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "code": 1,
      "message": "text"
    }
  ]
}