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.
Servers
- https://api.github.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
cluster |
String | Yes |
The cluster name. |
org |
String | Yes |
The organization name. The name is not case sensitive. |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
physical_environment |
String | No |
The physical region of the deployment. |
logical_environment |
String | Yes |
The stage of the deployment. |
return_records |
Boolean | No |
If true, the endpoint will return the set records in the response body Default value: true |
deployments[] |
Array | Yes |
The list of deployments to record. |
deployments[].github_repository |
String | No |
The name of the GitHub repository associated with the artifact. This should be used when there are no provenance attestations available for the artifact. The repository must belong to the organization specified in the path parameter. If a provenance attestation is available for the artifact, the API will use the repository information from the attestation instead of this parameter. |
deployments[].runtime_risks[] |
Array | No |
A list of runtime risks associated with the deployment. |
deployments[].name |
String | Yes |
The name of the artifact. |
deployments[].digest |
String | Yes |
The hex encoded digest of the artifact. |
deployments[].version |
String | No |
The artifact version. |
deployments[].deployment_name |
String | Yes |
The unique identifier for the deployment represented by the new record. To accommodate differing containers and namespaces within a record set, the following format is recommended: {namespaceName}-{deploymentName}-{containerName}. The deployment_name must be unique across all entries in the deployments array. |
deployments[].tags |
Object | No |
Key-value pairs to tag the deployment record. |
deployments[].status |
String | No |
The deployment status of the artifact. Valid values:
Default value: "deployed" |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.