Patch Deployment Using PATCH | vRealize Automation Cloud Deployment API

Patch Deployment Using PATCH

Updates the deployment with the supplied ID.

Request

URI

PATCH

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

COPY

Path Parameters

string

depId

Required

Deployment ID

Request Body

A set of fields to overwrite the corresponding fields in the deployment

DeploymentUpdate of type(s) application/json

Optional

{
    "description": "string",
    "name": "string"
}

string

description

Optional

New description of the deployment

string

name

Optional

New name of the deployment

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