Create an artifact deployment record
POST
/orgs/{org}/artifacts/metadata/deployment-record https://api.github.com
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.
Parameters
path Path Parameters
| Name | Type |
|---|---|
org
required
The organization name. The name is not case sensitive. | string |
Request Body
application/json
required
{
name: string;
digest: `sha256:${string}`;
version?: string;
status: "deployed" | "decommissioned";
logical_environment: string;
physical_environment?: string;
cluster?: string;
deployment_name: string;
tags?: { };
runtime_risks?: ("critical-resource" | "internet-exposed" | "lateral-movement" | "sensitive-data")[];
github_repository?: string;
}
name: string;
digest: `sha256:${string}`;
version?: string;
status: "deployed" | "decommissioned";
logical_environment: string;
physical_environment?: string;
cluster?: string;
deployment_name: string;
tags?: { };
runtime_risks?: ("critical-resource" | "internet-exposed" | "lateral-movement" | "sensitive-data")[];
github_repository?: string;
}
Responses
200 application/json
Artifact deployment record stored successfully.
{ total_count?: number;deployment_records?: ArtifactDeploymentRecord []; }