v56

latestOpenAPI 3.0.3MITraw.githubusercontent.com2026-08-011,4581,08113.3 MB

orgs

Set cluster deployment records

Set deployment records for a given cluster. If proposed records in the 'deployments' field have identical 'cluster', 'logical_environment', 'physical_environment', and 'deployment_name' values as existing records, the existing records will be updated. If no existing records match, new records will be created. Note: Artifacts are uniquely identified by the combination of their repository and digest fields. If two entries in the deployments array resolve to the same repository and have identical digest fields but differing name and version fields, the endpoint will use the artifact name and version from the record processed first, since a single artifact (identified by repository and digest) can only have one name and version.

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

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.

partial_successboolean

When enabled, deployments associated with repositories the actor can write to are processed while deployments associated with repositories that cannot be resolved or written to by the actor are skipped and reported in the errors array. When false (the default), the endpoint returns an error if any targeted repository cannot be resolved, the actor lacks write access, or no matching attestation can be found.

return_recordsboolean

If true, the endpoint will return the set records in the response body

Example request

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

Response

Deployment records created or updated successfully.

total_countinteger required

The number of deployment records created