Record a deployment

Creates or updates a deployment record linking an artifact to an environment. If a record for the same environment and deployment name already exists, it will be updated.

POST /v1/deployments

Record a deployment

cURL

curl --request POST \
  --url https://api.app.chainloop.dev/v1/deployments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "environment_name": "<string>",
  "artifact_digest": "<string>",
  "kind": "ARTIFACT_KIND_UNSPECIFIED",
  "artifact_name": "<string>",
  "artifact_version": "<string>",
  "status": "DEPLOYMENT_STATUS_UNSPECIFIED",
  "deployment_name": "<string>",
  "logical_environment_name": "<string>"
}
'

200

{
  "deployment_record": {
    "artifact": {
      "kind": "kind",
      "name": "name",
      "digest": "digest",
      "version": "version"
    },
    "logical_environment_id": "logical_environment_id",
    "environment_id": "environment_id",
    "updated_at": "2000-01-23T04:56:07.000Z",
    "deployment_name": "deployment_name",
    "created_at": "2000-01-23T04:56:07.000Z",
    "id": "id",
    "logical_environment_name": "logical_environment_name",
    "last_seen_at": "2000-01-23T04:56:07.000Z",
    "artifact_id": "artifact_id",
    "status": "DEPLOYMENT_STATUS_UNSPECIFIED",
    "environment_name": "environment_name"
  }
}

Authorizations

Authorization · string · header · required

Bearer token for authentication

Body

application/json

environment_name · string

artifact_digest · string

kind · enum<string> · default: ARTIFACT_KIND_UNSPECIFIED

Available options: ARTIFACT_KIND_UNSPECIFIED, CONTAINER_IMAGE, HELM_CHART

artifact_name · string

artifact_version · string

status · enum<string> · default: DEPLOYMENT_STATUS_UNSPECIFIED

• DEPLOYED: DEPLOYED indicates the artifact is currently running in the environment slot.
• DECOMMISSIONED: DECOMMISSIONED indicates the artifact has been intentionally removed from the environment slot.
• SUPERSEDED: SUPERSEDED indicates the artifact was replaced by a different artifact in the same environment slot.

Available options: DEPLOYMENT_STATUS_UNSPECIFIED, DEPLOYED, DECOMMISSIONED, SUPERSEDED

deployment_name · string

logical_environment_name · string

Response

200

application/json

A successful response.

deployment_record · DeploymentStatus defines the status of a deployment DeploymentRecord represents a deployment record entity · object

Show child attributes

Example:

{
  "artifact": {
    "kind": "kind",
    "name": "name",
    "digest": "digest",
    "version": "version"
  },
  "logical_environment_id": "logical_environment_id",
  "environment_id": "environment_id",
  "updated_at": "2000-01-23T04:56:07.000Z",
  "deployment_name": "deployment_name",
  "created_at": "2000-01-23T04:56:07.000Z",
  "id": "id",
  "logical_environment_name": "logical_environment_name",
  "last_seen_at": "2000-01-23T04:56:07.000Z",
  "artifact_id": "artifact_id",
  "status": "DEPLOYMENT_STATUS_UNSPECIFIED",
  "environment_name": "environment_name"
}