Skip to content

Get cluster deployment records job status

GET
/orgs/{org}/artifacts/metadata/deployment-record/cluster/{cluster}/jobs/{job_id}

Get the status and results of a previously created cluster deployment records job.

API method documentation

org
required
string

The organization name. The name is not case sensitive.

cluster
required
string
>= 1 characters <= 128 characters /^[a-zA-Z0-9._-]+$/

The cluster name.

job_id
required
integer

The ID of the job.

Job status retrieved successfully.

Media typeapplication/json
object
job_id
required

The ID of the job.

integer
status
required

The current status of the job.

string
Allowed values: pending processing completed failed
started_at

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

string format: date-time
total_count

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

integer
errors

Processing errors (only present when completed or failed).

Array<object>
object
Examples
Exampledefault
{
"job_id": 123,
"status": "completed",
"started_at": "2026-06-10T12:00:00Z",
"total_count": 5
}

Resource not found

Media typeapplication/json
Basic Error

Basic Error

object
message
string
documentation_url
string
url
string
status
string
Examplegenerated
{
"message": "example",
"documentation_url": "example",
"url": "example",
"status": "example"
}