POST /orgs/{org}/artifacts/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.
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. |
name |
String | Yes |
The name of the artifact. |
artifact_url |
String | No |
The URL where the artifact is stored. |
digest |
String | Yes |
The digest of the artifact (algorithm:hex-encoded-digest). |
version |
String | No |
The artifact version. |
repository |
String | No |
The repository name within the registry. |
status |
String | No |
The status of the artifact (e.g., active, inactive). Valid values:
Default value: "active" |
path |
String | No |
The path of the artifact. |
registry_url |
String | Yes |
The base URL of the artifact registry. |
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.