provider orgs POST /orgs/{org}/artifacts/metadata/deployment-record/cluster/{cluster}
@utdk/github /orgs/{org}/artifacts/metadata/deployment-record/cluster/{cluster}
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.
org path required
The organization name. The name is not case sensitive.
string
cluster path required
The cluster name.
string

Try it

Authentication
Configure credentials for GitHub v3 REST API
orgs.setClusterDeploymentRecords
POST/orgs/{org}/artifacts/metadata/deployment-record/cluster/{cluster}
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.

Parameters

required

The organization name. The name is not case sensitive.

required

The cluster name.

Input

required

The stage of the deployment.

The physical region of the deployment.

required

The list of deployments to record.

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

Configure credentials above to enable sending.

Code snippet
Updates live as you fill in the form above.

TypeScript

import github from '@utdk/github';

await github.orgs.setClusterDeploymentRecords({
  "return_records": true
})