Skip to main content
POST
Record a deployment

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

A successful response.

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