Get Resources
Returns a paginated list of resources.
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. 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 tags
A comma-separated list. Results must be associated with one of these cloud Types
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 resource origins.
Given string should be part of a searchable field in one of the resources.
The expanded details of the requested comma separated objects. Ex. project, deployment, currentRequest
A comma-separated list. Results must be associated with one of the syncStatuses (MISSING, STALE).
Number of records you want
1
Number of records you want to skip
1
Sorting 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": [
{
"billable": false,
"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"
},
"deployment": {
"description": "string",
"iconId": "string",
"id": "string",
"leaseExpireAt": "string",
"name": "string",
"ownedBy": "string",
"owner": {
"email": "string",
"firstname": "string",
"id": "string",
"lastname": "string",
"type": "string"
},
"ownerType": "string"
},
"deploymentId": "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",
"orgId": "string",
"origin": "string",
"project": {
"description": "string",
"id": "string",
"name": "string",
"version": "string"
},
"projectId": "string",
"properties": {
"properties": {}
},
"syncStatus": "string",
"type": "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 resource
empty
first
last
number
numberOfElements
pageable
size
sort
totalElements
totalPages
Unauthorized
"PageResource Object"
A resource
empty
first
last
number
numberOfElements
pageable
size
sort
totalElements
totalPages
Forbidden
"PageResource Object"
A resource
empty
first
last
number
numberOfElements
pageable
size
sort
totalElements
totalPages
curl -H 'Authorization: <value>' https://{api_host}/deployment/api/resources