List Deployments
List Deployments in an Organization.
Path parameters
organizationId
The ID of the Organization to list Deployments for.
Headers
Authorization
Bearer authentication of the form Bearer <token>, where token is your auth token.
Query parameters
deploymentIds
A list of IDs for Deployments to show. The API returns details only for the specified Deployments.
To list multiple Deployments, you must string together the parameter with the
deploymentIds
. For example, deployments?deploymentIds=deploymentId1&deploymentIds=deploymentId2
names
A list of names for Deployments to filter by. The API returns details only for the specified Deployments.
workspaceIds
A list of IDs for Workspaces to filter on. The API returns details for all Deployments belonging only to the specified Workspaces.
offset
The number of results to skip before returning values.
limit
The maximum number of results to return.
sorts
A list of field names to sort by, and whether to show results as ascending or descending. Formatted as <fieldName>:asc
or <fieldName>:desc
.
Response
OK
deployments
A list of Deployments in the current page.
limit
The maximum number of Deployments in one page.
offset
The offset of the current page of Deployments.
totalCount
The total number of Deployments.