Catalog Tasks

Get task status

API Reference

Zones

Catalog Tasks

Get task status

client.zones.catalogTasks.retrieve(, , ?): Task { id, created_at, operation, 9 more }

GET/zones/{zone_id}/catalog_tasks/{task_id}

Returns 200 with task details when pending, running, or failed. Returns 303 redirect to the install when completed.

ParametersExpand Collapse

taskID: string

params: CatalogTaskRetrieveParams { zone_id, xClientRequestID }

zone_id: string

Path param

xClientRequestID?: string

Header param: Unique request identifier specified by the originating caller and passed along by proxies.

formatuuid

ReturnsExpand Collapse

Task { id, created_at, operation, 9 more }

id: string

created_at: string

formatdate-time

operation: TaskOperation

Accepts one of the following:

"create"

"delete"

status: TaskStatus

Accepts one of the following:

"pending"

"running"

"completed"

"failed"

updated_at: string

formatdate-time

error_message?: string

install_id?: string

links?: Array<Link>

href: string

Target reference.

Fragment URIs (#name) reference other entities in the same graph by their local name (the key in the entity map). Absolute paths and URLs reference external resources outside the graph.

rel: string

Link relation type.

properties?: Record<string, unknown>

Additional metadata keyed by property name.

titles?: Record<string, string>

Human-readable titles keyed by BCP 47 language tag.

type?: string

Media type of the target resource (per RFC 7033 section 4.4.4.3). Applies to external hrefs; typically omitted for intra-graph references.

package_id?: string

package_slug?: string

package_version?: number

warnings?: Array<Warning>

Informational warnings about the task outcome. For delete tasks, warns when adopted entities (pre-existing resources not created by the catalog) will be preserved rather than deleted.

code: "validation_error" | "bad_request" | "unauthorized" | 6 more

Accepts one of the following:

"validation_error"

"bad_request"

"unauthorized"

"forbidden"

"not_found"

"conflict"

"rate_limit_exceeded"

"internal_error"

"service_unavailable"

details: Array<Detail>

code: "validation_error" | "bad_request" | "unauthorized" | 6 more

Accepts one of the following:

"validation_error"

"bad_request"

"unauthorized"

"forbidden"

"not_found"

"conflict"

"rate_limit_exceeded"

"internal_error"

"service_unavailable"

field: string

valid json path for request body

message: string

error message for specific error

message: string

summary of the error

path: string

formaturl

request_id: string

formatuuid

status: number

HTTP Status Code

timestamp: string

formatdate-time

Get task status

import KeycardAPI from '@keycardai/api';

const client = new KeycardAPI();

const task = await client.zones.catalogTasks.retrieve('task_id', { zone_id: 'zone_id' });

console.log(task.id);

{
  "id": "id",
  "created_at": "2019-12-27T18:11:19.117Z",
  "operation": "create",
  "status": "pending",
  "updated_at": "2019-12-27T18:11:19.117Z",
  "error_message": "error_message",
  "install_id": "install_id",
  "links": [
    {
      "href": "href",
      "rel": "rel",
      "properties": {
        "foo": "bar"
      },
      "titles": {
        "foo": "string"
      },
      "type": "type"
    }
  ],
  "package_id": "package_id",
  "package_slug": "package_slug",
  "package_version": 0,
  "warnings": [
    {
      "code": "validation_error",
      "details": [
        {
          "code": "validation_error",
          "field": "field",
          "message": "message"
        }
      ],
      "message": "message",
      "path": "path",
      "request_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "status": 0,
      "timestamp": "2019-12-27T18:11:19.117Z"
    }
  ]
}

Returns Examples

{
  "id": "id",
  "created_at": "2019-12-27T18:11:19.117Z",
  "operation": "create",
  "status": "pending",
  "updated_at": "2019-12-27T18:11:19.117Z",
  "error_message": "error_message",
  "install_id": "install_id",
  "links": [
    {
      "href": "href",
      "rel": "rel",
      "properties": {
        "foo": "bar"
      },
      "titles": {
        "foo": "string"
      },
      "type": "type"
    }
  ],
  "package_id": "package_id",
  "package_slug": "package_slug",
  "package_version": 0,
  "warnings": [
    {
      "code": "validation_error",
      "details": [
        {
          "code": "validation_error",
          "field": "field",
          "message": "message"
        }
      ],
      "message": "message",
      "path": "path",
      "request_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "status": 0,
      "timestamp": "2019-12-27T18:11:19.117Z"
    }
  ]
}