Skip to main content
GET
List deployment records

Authorizations

Authorization
string
header
required

Bearer token for authentication

Query Parameters

pagination.page
integer<int32>

The (zero-based) offset of the first item returned in the collection.

pagination.page_size
integer<int32>

The maximum number of entries to return. If the value exceeds the maximum, then the maximum value will be used.

environment_name
string

Optional filter by environment name

project_name
string

Optional filter by project name

project_version_name
string

Optional filter by project version name (requires project_name)

status
enum<string>
default:DEPLOYMENT_STATUS_UNSPECIFIED

Optional filter by deployment status

  • 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
artifact_kind
enum<string>
default:ARTIFACT_KIND_UNSPECIFIED

Optional filter by artifact kind

Available options:
ARTIFACT_KIND_UNSPECIFIED,
CONTAINER_IMAGE,
HELM_CHART
deployment_name
string

Optional filter by deployment name (returns records for a specific slot)

full_history
boolean

When true, returns all records instead of only the latest per (environment_id, deployment_name) slot. By default, only the most recent record per slot is returned.

logical_environment_name
string

Optional filter by logical environment name

artifact_digest
string

Optional filter by artifact digest (e.g. sha256:abc...)

Response

A successful response.

deployment_records
DeploymentStatus defines the status of a deployment DeploymentRecord represents a deployment record entity · object[]
pagination
OffsetPaginationResponse is used to return the pagination information · object
Example: