Handle Post 1

Create or update an onboarding deployment and associated resources in the current organization

Request

URI

POST

https://vra-interop-222-139.lvn.broadcom.net/relocation/onboarding/task/create-deployment

COPY

Request Body

CreateDeploymentRequest of type(s) application/json

Required

Show optional properties

{
    "planLink": "string",
    "deploymentLink": "string"
}

{
    "planLink": "string",
    "deploymentLink": "string",
    "name": "string",
    "description": "string",
    "resources": [
        {
            "link": "string",
            "name": "string",
            "tagLinks": [
                "string"
            ],
            "ruleLinks": [
                "string"
            ]
        }
    ],
    "createBlueprint": false,
    "template": {
        "name": "string",
        "link": "string",
        "components": {
            "vm-administrator-mcm234-2347342": "Cloud_vSphere_Machine_1",
            "vm-administrator-mcm678-3429551": "Cloud_vSphere_Machine_2"
        }
    },
    "tag": "string",
    "owner": "string",
    "ownerType": "string"
}

string

planLink

Required

Link to a plan. Clients need not set this field, as it is automatically taken care of by the DeploymentBulkCreatorService

string

deploymentLink

Required

Link to an existing deployment. Only set this field when adding resources to an existing deployment.

string

name

Optional

Desired deployment name. If omitted, a name will be automatically generated

string

description

Optional

Deployment description

array of object

resources

Optional

List of resources to be created

boolean

createBlueprint

Optional

Indicates whether onboarding should generate a Template for this deployment.

object

template

Optional

Details of the template to be created

string

tag

Optional

tag

string

owner

Optional

owner

string

ownerType

Optional

ownerType

Possible values are : USER, AD_GROUP,

Authentication

This operation uses the following authentication methods.

Bearer

Responses

200

Success

Operation doesn't return any data structure

401

Unauthorized

Operation doesn't return any data structure

Code Samples

COPY

                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"deploymentLink:"string","planLink:"string"}' https://{api_host}/relocation/onboarding/task/create-deployment

On This Page

Description

Request

Request Body

Authentication

Response

200 Response Body

Errors

Onboarding Deployments Operations

POST

Handle Post

POST