Patch Deployment Using PATCH 1

Patch Deployment Using PATCH 1

Updates the deployment with the supplied ID.

Request
URI
PATCH
https://{api_host}//sc2-10-185-6-200.eng.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

OK

Returns Deployment of type(s) application/json 
{
    "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"
}
string
blueprintId
Optional

Deployment blueprint id

string
blueprintVersion
Optional

Deployment blueprint version

string
catalogItemId
Optional

Deployment catalog item id

string
catalogItemVersion
Optional

Deployment catalog version

string As date-time As date-time
createdAt
Optional

Creation time

string
createdBy
Optional

Created by

string
description
Optional

Description of the deployment

Expense
expense
Optional

expense

string
iconId
Optional

Deployment icon id

string As uuid As uuid
id
Optional

Id of the deployment

object
inputs
Optional

The inputs that were used to request this deployment

DeploymentRequest
lastRequest
Optional

lastRequest

string As date-time As date-time
lastUpdatedAt
Optional

Update time

string
lastUpdatedBy
Optional

Updated by

string As date-time As date-time
leaseExpireAt
Optional

Lease expiration time

string
name
Required

Name of the deployment

string
orgId
Optional

orgId

ResourceReference
project
Optional

project

string
projectId
Optional

Deployment project id

array of Resource
resources
Optional

Expanded resources for the deployment. Content of this property will not be maintained backward compatible

string
status
Optional

Deployment status.

Possible values are : CREATE_SUCCESSFUL, CREATE_INPROGRESS, CREATE_FAILED, UPDATE_SUCCESSFUL, UPDATE_INPROGRESS, UPDATE_FAILED,

401

Unauthorized

Operation doesn't return any data structure

403

Forbidden

Operation doesn't return any data structure

404

Not Found

Operation doesn't return any data structure

On This Page
Deployments Operations
GET
Check Deployment Name Using GET 1
DELETE
Delete Deployment Using DELETE 1
DELETE
Delete Resource Using DELETE 1
GET
Get Deployment By Id Using GET 1
GET
Get Deployment Expense History By Id Using GET 1
GET
Get Deployment Filter By Id Using GET 1
GET
Get Deployment Filters Using GET 1
GET
Get Deployment Resources Using GET 1
GET
Get Deployments For Project Using GET 1
GET
Get Deployments Using GET 1
GET
Get Resource By Id Using GET 1
PATCH
Patch Deployment Using PATCH 1