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.
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
Gateway
The gateway proxies requests and injects credentials server-side. Configure credentials above, then enter your gateway URL.

Saved automatically to browser storage.

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.

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

Enter a gateway URL 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
})