deployment_get_deployments
Read-onlyIdempotent
Fetch a paginated list of deployments with filtering by status, tags, projects, and other criteria to find specific deployments.
Instructions
Fetch all deployments. Returns a paginated list of deployments. GET /deployment/api/deployments
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ids | No | A comma-separated list. Only deployments with these IDs will be included in the results. | |
| top | No | Number of records you want | |
| name | No | Results must have exactly this name. | |
| page | No | Zero-based page index (0..N) | |
| size | No | The size of the page to be returned | |
| skip | No | Number of records you want to skip | |
| sort | No | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | |
| tags | No | A comma-separated list. Results must be associated with one of these tags | |
| expand | No | The expanded details of the requested comma separated objects. 'resources' option returns resources with all properties. Ex. blueprint, project | |
| filter | No | A subset of records that satisfy the given predicate expression | |
| search | No | Given string should either be part of a searchable field in a deployment or one of deployment's resources. | |
| status | No | A comma-separated list. Results must be associated with one of these statuses. | |
| deleted | No | Retrieves only soft-deleted deployments that have not yet been completely deleted. | |
| orderby | No | Sorting criteria in the format: property (asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | |
| ownedBy | No | A comma-separated list. Results must be associated with one of these owners | |
| projects | No | A comma-separated list. Results must be associated with one of these project IDs. | |
| createdAt | No | Comma-separated start and end dates where start date or end date is optional (e.g. [2020-12-01T08:00:00.000Z,2020-12-11T23:59:00.000Z], [2020-11-03T08:00:00.000Z,], [,2020-11-08T08:00:00.000Z]) | |
| expiresAt | No | Comma-separated start and end dates where start date or end date is optional (e.g. [2020-12-01T08:00:00.000Z,2020-12-11T23:59:00.000Z], [2020-11-03T08:00:00.000Z,], [,2020-11-08T08:00:00.000Z]) | |
| cloudTypes | No | A comma-separated list. Results must be associated with one of these endpoint Types | |
| requestedBy | No | A comma-separated list. Results must be associated with one of these requesters | |
| cloudAccounts | No | A comma-separated list. Results must be associated with one of these cloud accounts. | |
| expandProject | No | The 'project' field of each resulting deployment will be retrieved. | |
| lastUpdatedAt | No | Comma-separated start and end dates where start date or end date is optional (e.g. [2020-12-01T08:00:00.000Z,2020-12-11T23:59:00.000Z], [2020-11-03T08:00:00.000Z,], [,2020-11-08T08:00:00.000Z]) | |
| resourceTypes | No | A comma-separated list. Results must be associated with one of these resourceType Names. | |
| expandResources | No | The 'resources' field of each resulting deployment will be retrieved. | |
| expandLastRequest | No | Expands deployment last request. | |
| lastRequestStatus | No | A comma-separated list of last request statuses. Allowed values are: ABORTED, APPROVAL_PENDING, APPROVAL_REJECTED, FAILED, INPROGRESS, PENDING and SUCCESSFUL. Results must be associated with one of these last request statuses. |