Skip to main content
GET
List Deployments
To list multiple Deployments, string together the deploymentIds parameter. For example, deployments?deploymentIds=deploymentId1&deploymentIds=deploymentId2.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

organizationId
string
required

The ID of the Organization to list Deployments for.

Query Parameters

deploymentIds
string[]

A list of IDs for Deployments to show. The API returns details only for the specified Deployments.

names
string[]

A list of names for Deployments to filter by. The API returns details only for the specified Deployments.

workspaceIds
string[]

A list of IDs for Workspaces to filter on. The API returns details for all Deployments belonging only to the specified Workspaces.

offset
integer
default:0

The number of results to skip before returning values.

Required range: x >= 0
limit
integer
default:20

The maximum number of results to return.

Required range: x >= 0
sorts
enum<string>[]

A list of field names to sort by, and whether to show results as ascending or descending. Formatted as <fieldName>:asc or <fieldName>:desc.

Available options:
name:asc,
name:desc,
createdAt:asc,
createdAt:desc,
updatedAt:asc,
updatedAt:desc

Response

OK

deployments
object[]
required

A list of Deployments in the current page.

limit
integer
required

The maximum number of Deployments in one page.

Example:

10

offset
integer
required

The offset of the current page of Deployments.

Example:

0

totalCount
integer
required

The total number of Deployments.

Example:

100