POST /orgs/{org}/artifacts/metadata/deployment-record/cluster/{cluster}/jobs
Create a background job to set deployment records for a given cluster. Performs validation and permission checks synchronously, returning rejected deployments immediately, then enqueues a background job for the actual deployment updates. Use the companion GET endpoint to poll for job status.
Servers
- https://api.github.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
cluster |
String | Yes |
The cluster name. |
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 |
|---|---|---|---|
physical_environment |
String | No |
The physical region of the deployment. |
logical_environment |
String | Yes |
The stage of the deployment. |
deployments[] |
Array | Yes |
The list of deployments to record. |
deployments[].github_repository |
String | No |
The name of the GitHub repository associated with the artifact. |
deployments[].runtime_risks[] |
Array | No |
A list of runtime risks associated with the deployment. |
deployments[].name |
String | Yes |
The name of the artifact. |
deployments[].digest |
String | Yes |
The hex encoded digest of the artifact. |
deployments[].version |
String | No |
The artifact version. |
deployments[].deployment_name |
String | Yes |
The unique identifier for the deployment represented by the new record. |
deployments[].tags |
Object | No |
Key-value pairs to tag the deployment record. |
deployments[].status |
String | No |
The deployment status of the artifact. Valid values:
Default value: "deployed" |
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.