Sign in

v56

latestOpenAPI 3.0.3MITraw.githubusercontent.com2026-08-011,21696712.2 MB
orgs

Create an artifact 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.

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

Path parameters

orgstring required

The organization name. The name is not case sensitive.

Request body

namestring required

The name of the artifact.

digeststring required

The hex encoded digest of the artifact.

versionstring

The artifact version.

status'deployed' | 'decommissioned' required

The status of the artifact. Can be either deployed or decommissioned.

logical_environmentstring required

The stage of the deployment.

physical_environmentstring

The physical region of the deployment.

clusterstring

The deployment cluster.

deployment_namestring required

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}.

tagsobject

The tags associated with the deployment.

runtime_risksstring[]

A list of runtime risks associated with the deployment.

github_repositorystring

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.

return_recordsboolean

If true, the endpoint will return the created or updated record in the response body.

Example request

{
  "name": "libfoo",
  "version": "1.2.3",
  "github_repository": "my-github-repo"
}

Response

Artifact deployment record stored successfully.

total_countinteger required

The number of deployment records created