Sign in

v1

latestOpenAPI 3.0.3MIT2026-07-22399194.2 KB
Deployments

List

List all deployments.

get/deployments

Query parameters

offsetinteger

The offset of the items to return. An offset of 10 with a limit of 10 returns items 11-20.

limitinteger
Example:10

The maximum number of items to return. A limit of 15 with an offset of 0 returns items 1-15.

order_byDeploymentOrderBy[]

Sort order for the deployment results.

[
  "created_at:desc"
]
expandDeploymentListExpansion[]

Fields to expand on each deployment in the list.

[
  "device"
]
idstring[]

The deployment IDs to filter by.

[
  "dpl_123"
]
target_statusDeploymentTargetStatus[]

The deployment target statuses to filter by.

[
  "staged"
]
activity_statusDeploymentActivityStatus[]

The deployment activity statuses to filter by.

[
  "drifted"
]
error_statusDeploymentErrorStatus[]

The deployment error statuses to filter by.

[
  "none"
]
device_idstring[]

The deployment device IDs to filter by.

[
  "dvc_123"
]
release_idstring[]

The deployment release IDs to filter by.

[
  "rls_123"
]

Response

Successfully listed the deployments.

object'list' required

The object type, which is always list.

total_countinteger

The total number of items in the list. By default the total count is not returned. The total count must be expanded (using expand=total_count) to get the total number of items in the list.

limitinteger required

The maximum number of items to return. A limit of 15 with an offset of 0 returns items 1-15.

offsetinteger required

The offset of the items to return. An offset of 10 with a limit of 10 returns items 11-20.

has_moreboolean required

True if there are more items in the list to return. False if there are no more items to return.

Example response

{
  "object": "list",
  "data": [
    {
      "object": "deployment",
      "id": "dpl_123",
      "description": "Deployment for the motion control config instance",
      "status": "staged",
      "activity_status": "staged",
      "error_status": "none",
      "target_status": "staged",
      "device_id": "dvc_123",
      "release_id": "rls_123",
      "created_at": "2024-01-01T00:00:00Z",
      "updated_at": "2024-01-01T00:00:00Z"
    }
  ]
}