POST /orgs/{org}/artifacts/metadata/deployment-record
Create or update deployment records for an artifact associated with an organization. This endpoint allows you to record information about a specific artifact, such as its name, digest, environments, cluster, and deployment. The deployment name has to be uniqe within a cluster (i.e a combination of logical, physical environment and cluster) as it identifies unique deployment. Multiple requests for the same combination of logical, physical environment, cluster and deployment name will only create one record, successive request will update the existing record. This allows for a stable tracking of a deployment where the actual deployed artifact can change over time.
Servers
- https://api.github.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
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 |
|---|---|---|---|
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. |
runtime_risks[] |
Array | No |
A list of runtime risks associated with the deployment. |
name |
String | Yes |
The name of the artifact. |
physical_environment |
String | No |
The physical region of the deployment. |
logical_environment |
String | Yes |
The stage of the deployment. |
cluster |
String | No |
The deployment cluster. |
digest |
String | Yes |
The hex encoded digest of the artifact. |
version |
String | No |
The artifact version. |
deployment_name |
String | Yes |
The unique identifier for the deployment represented by the new record. To accommodate differing containers and namespaces within a cluster, the following format is recommended: {namespaceName}-{deploymentName}-{containerName}. |
tags |
Object | No |
The tags associated with the deployment. |
status |
String | Yes |
The status of the artifact. Can be either deployed or decommissioned. Valid values:
|
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.