Create a cluster deployment records job

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.

API method documentation

Parameters

Path Parameters

org

required

string

The organization name. The name is not case sensitive.

cluster

required

string

>= 1 characters <= 128 characters /^[a-zA-Z0-9._-]+$/

The cluster name.

Request Body^required

Media typeapplication/json

object

logical_environment

required

The stage of the deployment.

string

>= 1 characters <= 128 characters

physical_environment

The physical region of the deployment.

string

<= 128 characters

deployments

required

The list of deployments to record.

Array<object>

<= 5000 items

object

name

required

The name of the artifact.

string

>= 1 characters <= 256 characters

digest

required

The hex encoded digest of the artifact.

string

>= 71 characters <= 71 characters /^sha256:[a-f0-9]{64}$/

version

The artifact version.

string

<= 100 characters

status

The deployment status of the artifact.

string

default: deployed

Allowed values: deployed decommissioned

deployment_name

required

The unique identifier for the deployment represented by the new record.

string

>= 1 characters <= 256 characters

github_repository

The name of the GitHub repository associated with the artifact.

string

<= 100 characters /^[A-Za-z0-9.\-_]+$/

tags

Key-value pairs to tag the deployment record.

object

key

additional properties

string

runtime_risks

A list of runtime risks associated with the deployment.

Array<string>

<= 4 items unique items

Allowed values: critical-resource internet-exposed lateral-movement sensitive-data

Examples

Exampledefault

{
  "logical_environment": "prod",
  "physical_environment": "pacific-east",
  "deployments": [
    {
      "name": "awesome-image",
      "digest": "sha256:1bb1e949e55dcefc6353e7b36c8897d2a107d8e8dca49d4e3c0ea8493fc0bc72",
      "version": "2.1.0",
      "status": "deployed",
      "deployment_name": "deployment-pod",
      "tags": {
        "owning-team": "platform"
      },
      "runtime_risks": [
        "sensitive-data"
      ]
    }
  ]
}

Responses

202

Job created successfully. Authorized deployments will be processed in the background.

Media typeapplication/json

object

job_id

required

The ID of the created job.

integer

errors

Deployments that were rejected during authorization.

Array<object>

object

Examples

Exampledefault

{
  "job_id": 123
}

400

Bad Request

Media typeapplication/json

Basic Error

Basic Error

object

message

string

documentation_url

string

url

string

status

string

Example^generated

{
  "message": "example",
  "documentation_url": "example",
  "url": "example",
  "status": "example"
}

403

Forbidden

Media typeapplication/json

Basic Error

Basic Error

object

message

string

documentation_url

string

url

string

status

string

Example^generated

{
  "message": "example",
  "documentation_url": "example",
  "url": "example",
  "status": "example"
}

404

Resource not found

Media typeapplication/json

Basic Error

Basic Error

object

message

string

documentation_url

string

url

string

status

string

Example^generated

{
  "message": "example",
  "documentation_url": "example",
  "url": "example",
  "status": "example"
}

409

A job is already in progress for this cluster.

Media typeapplication/json

Basic Error

Basic Error

object

message

string

documentation_url

string

url

string

status

string

Example^generated

{
  "message": "example",
  "documentation_url": "example",
  "url": "example",
  "status": "example"
}