Get cluster deployment records job status

3 parameters

orgstringrequired

The organization name. The name is not case sensitive.

clusterstringrequired

The cluster name.

job_idintegerrequired

The ID of the job.

2 status codes

200Job status retrieved successfully.

job_idintegerrequired

The ID of the job.

statusstringrequired

The current status of the job.

Allowed:pendingprocessingcompletedfailed

started_atstringoptional

When the job started processing (only present when processing, completed, or failed).

total_countintegeroptional

The number of records successfully mutated (only present when completed).

errorsarray<object>optional

Processing errors (only present when completed or failed).

404Resource not found

messagestringoptional

documentation_urlstringoptional

urlstringoptional

statusstringoptional

Error handling

A 404 is returned: Resource not found.

import { Client } from "acme-sdk";

const client = new Client({
  baseUrl: "https://api.acme.com",
  auth: { bearer: process.env.API_TOKEN },
  retry: {
    maxAttempts: 3,
    retryOn: [
      408,
      425,
      429,
      500,
      502,
      503,
      504,
    ],
    backoffMs: 500,
    maxBackoffMs: 8000,
  },
  timeoutMs: 30000,
});

const result = await client.jobs.get({
  org: "acme-inc",
  cluster: "example",
  jobId: "c0a80123-4567-89ab-cdef-0123456789ab",
});

{
  "job_id": 123,
  "status": "completed",
  "started_at": "2026-06-10T12:00:00Z",
  "total_count": 5
}

Request

Response

Errors