Get Deployments Using GET 1

Returns a paginated list of deployments.

Request

URI

GET

https://{api_host}//sc2-10-185-6-200.eng.vmware.com/deployment/api/deployments

COPY

Query Parameters

string of array

$orderby

Optional

Sorting criteria in the format: property (asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

integer

$skip

Optional

Number of records you want to skip

$skip example

integer

$top

Optional

Number of records you want

$top example

string of array

cloudAccounts

Optional

A comma-separated list. Results must be associated with one of these cloud accounts.

string of array

cloudTypes

Optional

A comma-separated list. Results must be associated with one of these endpoint Types

string

createdAt

Optional

Comma-separated start and end dates for the interval

boolean

expandLastRequest

Optional

Expands deployment last request.

boolean

expandProject

Optional

The 'project' field of each resulting deployment will be retrieved.

boolean

expandResources

Optional

The 'resources' field of each resulting deployment will be retrieved.

string

expiresAt

Optional

Comma-separated start and end dates for the interval

string of array

ids

Optional

A comma-separated list. Only deployments with these IDs will be included in the results.

string

name

Optional

Results must have exactly this name.

string of array

projects

Optional

A comma-separated list. Results must be associated with one of these project IDs.

string of array

requestedBy

Optional

A comma-separated list. Results must be associated with one of these requesters

string of array

resourceTypes

Optional

A comma-separated list. Results must be associated with one of these resourceType Names.

string

Optional

Results must either have names with this string as a prefix or contain this string in their description.

string of array

status

Optional

A comma-separated list. Results must be associated with one of these statuses.

string of array

tags

Optional

A comma-separated list. Results must be associated with one of these tags

string of array

templates

Optional

A comma-separated list. Results must be associated with one of these templates.

Responses

200

Returns PageOfDeployment of type(s) application/json

{
    "content": [
        {
            "blueprintId": "string",
            "blueprintVersion": "string",
            "catalogItemId": "string",
            "catalogItemVersion": "string",
            "createdAt": "string",
            "createdBy": "string",
            "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",
            "lastRequest": {
                "actionId": "string",
                "approvedAt": "string",
                "blueprintId": "string",
                "cancelable": false,
                "catalogItemId": "string",
                "completedAt": "string",
                "completedTasks": 0,
                "createdAt": "string",
                "deploymentId": "string",
                "details": "string",
                "dismissed": false,
                "id": "string",
                "initializedAt": "string",
                "name": "string",
                "parentId": "string",
                "requestedBy": "string",
                "resourceName": "string",
                "resourceType": "string",
                "status": "string",
                "totalTasks": 0,
                "updatedAt": "string"
            },
            "lastUpdatedAt": "string",
            "lastUpdatedBy": "string",
            "leaseExpireAt": "string",
            "name": "string",
            "orgId": "string",
            "project": {
                "id": "string",
                "link": "string",
                "name": "string"
            },
            "projectId": "string",
            "resources": [
                {
                    "createdAt": "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",
                    "name": "string",
                    "state": "string",
                    "syncStatus": "string",
                    "type": "string"
                }
            ],
            "status": "string"
        }
    ],
    "empty": false,
    "first": false,
    "last": false,
    "number": 0,
    "numberOfElements": 0,
    "size": 0,
    "sort": {
        "empty": false,
        "sorted": false,
        "unsorted": false
    },
    "totalElements": 0,
    "totalPages": 0
}

array of Deployment

content

Optional

content

boolean

empty

Optional

empty

boolean

first

Optional

first