v56

latestOpenAPI 3.0.3MITraw.githubusercontent.com2026-08-011,21696712.2 MB

orgs

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.

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

Path parameters

orgstring required

The organization name. The name is not case sensitive.

clusterstring required

The cluster name.

Request body

logical_environmentstring required

The stage of the deployment.

physical_environmentstring

The physical region of the deployment.

Example request

{
  "deployments": [
    {
      "version": "1.2.3",
      "github_repository": "my-github-repo"
    }
  ]
}

Response

Job created successfully. Authorized deployments will be processed in the background.

job_idinteger required

The ID of the created job.

errorsobject[]

Deployments that were rejected during authorization.