Get Deployments 1
Returns a paginated list of deployments.
Zero-based page index (0..N)
The size of the page to be returned
Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
A comma-separated list. Only deployments with these IDs will be included in the results.
Given string should either be part of a searchable field in a deployment or one of deployment's resources.
Results must have exactly this name.
A comma-separated list. Results must be associated with one of these statuses.
A comma-separated list. Results must be associated with one of these project IDs.
A comma-separated list. Results must be associated with one of these resourceType Names.
A comma-separated list. Results must be associated with one of these cloud accounts.
A comma-separated list. Results must be associated with one of these endpoint Types
A comma-separated list. Results must be associated with one of these requesters
A comma-separated list. Results must be associated with one of these owners
A comma-separated list. Results must be associated with one of these tags
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])
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])
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])
The 'resources' field of each resulting deployment will be retrieved.
Expands deployment last request.
The 'project' field of each resulting deployment will be retrieved.
The expanded details of the requested comma separated objects. 'resources' option returns resources with all properties. Ex. blueprint, project
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.
Retrieves only soft-deleted deployments that have not yet been completely deleted.
Number of records you want
1Number of records you want to skip
1Sorting criteria in the format: property (asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
A subset of records that satisfy the given predicate expression
startswith(name, 'Act'), toupper(name) eq 'ACTIVATE', substringof('renameVM', name), name eq 'ABCD'OK
{
"content": [
{
"blueprint": {
"description": "string",
"id": "string",
"name": "string",
"version": "string"
},
"blueprintId": "string",
"blueprintVersion": "string",
"catalog": {
"description": "string",
"id": "string",
"name": "string",
"version": "string"
},
"catalogItemId": "string",
"catalogItemVersion": "string",
"createdAt": "string",
"createdBy": "string",
"creator": {
"email": "string",
"firstname": "string",
"id": "string",
"lastname": "string",
"type": "string"
},
"deleted": false,
"description": "string",
"expense": {
"additionalExpense": "number",
"code": "string",
"computeExpense": "number",
"lastUpdatedTime": "string",
"message": "string",
"networkExpense": "number",
"storageExpense": "number",
"totalExpense": "number",
"unit": "string"
},
"iconId": "string",
"id": "string",
"inprogressRequests": {},
"inputs": {},
"lastRequest": {
"actionId": "string",
"approvedAt": "string",
"blueprintId": "string",
"cancelable": false,
"catalogItemId": "string",
"completedAt": "string",
"completedTasks": 0,
"createdAt": "string",
"deploymentId": "string",
"details": "string",
"dismissed": false,
"estimatedCompletionTime": "string",
"id": "string",
"initializedAt": "string",
"inputs": {
"inputs": {}
},
"name": "string",
"outputs": {
"outputs": {}
},
"requestedBy": "string",
"resourceIds": [
"string"
],
"resources": [
{
"description": "string",
"id": "string",
"name": "string",
"version": "string"
}
],
"status": "string",
"totalTasks": 0,
"updatedAt": "string"
},
"lastUpdatedAt": "string",
"lastUpdatedBy": "string",
"lastUpdater": {
"email": "string",
"firstname": "string",
"id": "string",
"lastname": "string",
"type": "string"
},
"leaseExpireAt": "string",
"leaseGracePeriodDays": 0,
"name": "string",
"orgId": "string",
"outputs": {},
"ownedBy": "string",
"owner": {
"email": "string",
"firstname": "string",
"id": "string",
"lastname": "string",
"type": "string"
},
"ownerType": "string",
"project": {
"description": "string",
"id": "string",
"name": "string",
"version": "string"
},
"projectId": "string",
"resources": [
{
"createdAt": "string",
"currentRequest": {
"actionId": "string",
"approvedAt": "string",
"blueprintId": "string",
"cancelable": false,
"catalogItemId": "string",
"completedAt": "string",
"completedTasks": 0,
"createdAt": "string",
"deploymentId": "string",
"details": "string",
"dismissed": false,
"estimatedCompletionTime": "string",
"id": "string",
"initializedAt": "string",
"inputs": {
"inputs": {}
},
"name": "string",
"outputs": {
"outputs": {}
},
"requestedBy": "string",
"resourceIds": [
"string"
],
"resources": [
{
"description": "string",
"id": "string",
"name": "string",
"version": "string"
}
],
"status": "string",
"totalTasks": 0,
"updatedAt": "string"
},
"dependsOn": [
"string"
],
"description": "string",
"expense": {
"additionalExpense": "number",
"code": "string",
"computeExpense": "number",
"lastUpdatedTime": "string",
"message": "string",
"networkExpense": "number",
"storageExpense": "number",
"totalExpense": "number",
"unit": "string"
},
"id": "string",
"inprogressRequests": {},
"name": "string",
"origin": "string",
"properties": {
"properties": {}
},
"state": "string",
"syncStatus": "string",
"type": "string"
}
],
"status": "string"
}
],
"empty": false,
"first": false,
"last": false,
"number": 0,
"numberOfElements": 0,
"pageable": {
"offset": 0,
"pageNumber": 0,
"pageSize": 0,
"paged": false,
"sort": [
{
"ascending": false,
"direction": "string",
"ignoreCase": false,
"nullHandling": "string",
"property": "string"
}
],
"unpaged": false
},
"size": 0,
"sort": [
{
"ascending": false,
"direction": "string",
"ignoreCase": false,
"nullHandling": "string",
"property": "string"
}
],
"totalElements": 0,
"totalPages": 0
}A group of resources such as machines, network, software, etc... typically provisioned together to deliver a complete/workable application.
empty
first
last
number
numberOfElements
pageable
size
sort
totalElements
totalPages
Unauthorized
"PageDeployment Object"A group of resources such as machines, network, software, etc... typically provisioned together to deliver a complete/workable application.
empty
first
last
number
numberOfElements
pageable
size
sort
totalElements
totalPages
curl -H 'Authorization: <value>' https://{api_host}/deployment/api/deployments