Sample - GitHub REST API
POST/orgs/{org}/artifacts/metadata/storage-record

Create artifact metadata storage record

Create metadata storage records for artifacts associated with an organization. This endpoint will create a new artifact storage record on behalf of any artifact matching the provided digest and associated with a repository owned by the organization.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

1 parameter · 10 body fields
orgstringrequired
The organization name. The name is not case sensitive.
namestringrequired
The name of the artifact.
digeststringrequired
The digest of the artifact (algorithm:hex-encoded-digest).
versionstringoptional
The artifact version.
artifact_urlstringoptional
The URL where the artifact is stored.
pathstringoptional
The path of the artifact.
registry_urlstringrequired
The base URL of the artifact registry.
repositorystringoptional
The repository name within the registry.
statusstringoptional
The status of the artifact (e.g., active, inactive).
Allowed:activeeoldeletedDefault:active
github_repositorystringoptional
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_recordsbooleanoptional
If true, the endpoint will return the created record in the response body.
Default:true

3 status codes
200Artifact metadata storage record stored successfully.
total_countintegerrequired
storage_recordsarray<object>optional
403Forbidden
messagestringoptional
documentation_urlstringoptional
urlstringoptional
statusstringoptional
404Resource not found
messagestringoptional
documentation_urlstringoptional
urlstringoptional
statusstringoptional

Error handling

A 403 is returned: Forbidden. A 404 is returned: Resource not found.