Skip to main content
GET
List Deployments

Query Parameters

limit
integer
default:20

Maximum number of resources to return.

Required range: 1 <= x <= 100
offset
integer
default:0

Pagination offset. Pass this value to subsequent requests to fetch the next page of resources.

Required range: x >= 0
name_contains
string | null

Name of the deployment to filter by.

status
string | null

status of the deployment to filter by.

remote_reconciled
boolean | null

Flag to filter by remote reconciled deployments.

tag_value_ids
string | null

Comma separated list of tag value IDs of the deployment to filter by.

image_version
string | null

Image version to filter by.

deployment_type
enum<string> | null

Deployment type to filter by.

Available options:
dev_free,
dev,
prod,
dev_zero,
dev_free_zero
deployment_ids
string | null

Comma separated list of deployment IDs to filter by.

Response

Successful Response

resources
Deployment · object[]
required
offset
integer
required

Pagination offset. Pass this value to subsequent requests to fetch the next page.