Get Deployment By Id Using GET

Returns the deployment with the supplied ID.

Request

URI

GET

https://{api_host}//api.mgmt.cloud.vmware.com/deployment/api/deployments/{depId}

COPY

Path Parameters

string

depId

Required

Deployment ID

Query Parameters

boolean

expandLastRequest

Optional

Expands deployment last request.

boolean

expandMetadata

Optional

Retrieves the 'metadata' field of the resource.

boolean

expandProject

Optional

The 'project' field of the deployment will be retrieved.

boolean

expandResources

Optional

The 'resources' field of the deployment will be retrieved.

boolean

forceCachedResources

Optional

The 'resources' field of the deployment will be guaranteed up-to-date.

boolean

forceRefreshResources

Optional

The 'resources' field of the deployment will be read from a cache for a faster query.

Responses

200

Returns Deployment of type(s) */*

{
    "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",
        "blueprintId": "string",
        "catalogItemId": "string",
        "completedTasks": 0,
        "createdAt": "string",
        "deploymentId": "string",
        "details": "string",
        "id": "string",
        "name": "string",
        "parentId": "string",
        "requestedBy": "string",
        "requester": "string",
        "resourceName": "string",
        "resourceType": "string",
        "status": "string",
        "statusDetails": "string",
        "totalTasks": 0,
        "updatedAt": "string"
    },
    "lastUpdatedAt": "string",
    "lastUpdatedBy": "string",
    "leaseExpireAt": "string",
    "name": "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"
        }
    ],
    "simulated": false,
    "status": "string"
}

string

blueprintId

Optional

Deployment blueprint id

string

blueprintVersion

Optional

Deployment blueprint version

string

catalogItemId

Optional

Deployment catalog item id