Sample - GitHub REST API
POST/orgs/{org}/artifacts/metadata/deployment-record/cluster/{cluster}/jobs

Create a cluster deployment records job

Create a background job to set deployment records for a given cluster. Performs validation and permission checks synchronously, returning rejected deployments immediately, then enqueues a background job for the actual deployment updates. Use the companion GET endpoint to poll for job status.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

2 parameters · 3 body fields
orgstringrequired
The organization name. The name is not case sensitive.
clusterstringrequired
The cluster name.
logical_environmentstringrequired
The stage of the deployment.
physical_environmentstringoptional
The physical region of the deployment.
deploymentsarray<object>required
The list of deployments to record.

5 status codes
202Job created successfully. Authorized deployments will be processed in the background.
job_idintegerrequired
The ID of the created job.
errorsarray<object>optional
Deployments that were rejected during authorization.
400Bad Request
messagestringoptional
documentation_urlstringoptional
urlstringoptional
statusstringoptional
403Forbidden
messagestringoptional
documentation_urlstringoptional
urlstringoptional
statusstringoptional
404Resource not found
messagestringoptional
documentation_urlstringoptional
urlstringoptional
statusstringoptional
409A job is already in progress for this cluster.
messagestringoptional
documentation_urlstringoptional
urlstringoptional
statusstringoptional

Error handling

A 400 is returned: Bad Request. A 403 is returned: Forbidden. A 404 is returned: Resource not found. A 409 is returned: A job is already in progress for this cluster.