Tasks

get

Return a task's status

🔒 Requires the read:task permission

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

taskIdstring · uuidRequired

The task's ID e.g. f27d96be-c486-4075-a926-0ee96775119e

Query parameters

expandbooleanOptional

If true, return elaborated version of the status. Otherwise, return a summarized version

Responses

200

Task details

application/json

Task details

taskstring · uuidRequired

The task's ID e.g. f27d96be-c486-4075-a926-0ee96775119e

statusstring · enumRequired

The task status (aka "stage") e.g. pending

Possible values:

commandstring · enumRequired

The type of command performed by the task e.g. install

Possible values:

planOnlybooleanRequired

Indicator if the task is a plan-only task

autoApplybooleanRequired

errorsone ofRequired

nullOptional

or

createdstring · date-timeRequired

The date and time the resource was created e.g. 2022-01-01T00:00:00.000Z

updatedstring · nullableRequired

The date and time the resource was updated e.g. 2022-01-01T00:00:00.000Z

completedstring · nullableRequired

The task completion date e.g. 2021-08-17T10:00:00Z or null if the task is not complete

400

Failed to get task status

application/json

401

Failed to authenticate user

application/json

403

Missing required scopes. 🔒 Requires the read:task permission

application/json

404

Task not found

application/json

429

Too many requests

application/json

get

/api/v1/task/{taskId}/status

HTTPcURLJavaScriptPython

GET /api/v1/task/{taskId}/status HTTP/1.1
Host: api.bluebricks.co
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "task": "123e4567-e89b-12d3-a456-426614174000",
  "status": "pending",
  "command": "force_install",
  "planOnly": true,
  "autoApply": true,
  "deployments": {
    "total": 1,
    "states": {
      "pending": 1,
      "planning": 1,
      "no_change": 1,
      "planned": 1,
      "plan_approved": 1,
      "installing": 1,
      "skipped": 1,
      "canceled": 1,
      "completed": 1,
      "error": 1
    }
  },
  "statusTimestamps": {
    "pending": "2026-03-03T03:04:27.839Z",
    "planning": "2026-03-03T03:04:27.839Z",
    "no_change": "2026-03-03T03:04:27.839Z",
    "planned": "2026-03-03T03:04:27.839Z",
    "plan_approved": "2026-03-03T03:04:27.839Z",
    "installing": "2026-03-03T03:04:27.839Z",
    "completed": "2026-03-03T03:04:27.839Z",
    "canceled": "2026-03-03T03:04:27.839Z",
    "skipped": "2026-03-03T03:04:27.839Z",
    "error": "2026-03-03T03:04:27.839Z"
  },
  "errors": null,
  "created": "2026-03-03T03:04:27.839Z",
  "updated": null,
  "completed": null
}