Handle Create

Create an onboarding resource in the current organization

Request

URI

POST

https://vra-interop-222-139.lvn.broadcom.net/relocation/onboarding/resource

COPY

Request Body

OnboardingResourceState of type(s) application/json

Required

Show optional properties

{
    "planLink": "string",
    "resourceLink": "string"
}

{
    "deploymentLink": "string",
    "tagLinks": [
        "string"
    ],
    "ruleLinks": [
        "string"
    ],
    "diskLinks": [
        "string"
    ],
    "createdTimeMicros": 0,
    "planLink": "string",
    "resourceLink": "string",
    "resourceName": "string",
    "consumerResourceLink": "string",
    "customProperties": {
        "customProperties": "string"
    },
    "options": [
        "string"
    ]
}

string

deploymentLink

Optional

Link to the parent deployment.

array of string

tagLinks

Optional

Tag links in the Provisioning service inventory associated with the machine.

array of string

ruleLinks

Optional

ruleLinks

array of string

diskLinks

Optional

diskLinks

integer As int64 As int64

createdTimeMicros

Optional

createdTimeMicros

string

planLink

Required

Link to the parent plan.

string

resourceLink

Required

Link to the compute resource (machine) in the Provisioning service inventory.

string

resourceName

Optional

Resource name, usually the machine name. Will be propagated to Assembler.

string

consumerResourceLink

Optional

consumerResourceLink

object

customProperties

Optional

customProperties

array of string

options

Optional

options

Authentication

This operation uses the following authentication methods.

Bearer

Responses

200

Success

Returns OnboardingResourceResponse of type(s) application/json

"OnboardingResourceResponse Object"

string

deploymentLink

Optional

Link to the parent deployment.

array of string

tagLinks

Optional

Tag links in the Provisioning service inventory associated with the machine.

array of string

ruleLinks

Optional

ruleLinks

array of string

diskLinks

Optional

diskLinks

integer As int64 As int64

createdTimeMicros

Optional

createdTimeMicros

string

planLink

Required

Link to the parent plan.

string

resourceLink

Required

Link to the compute resource (machine) in the Provisioning service inventory.

string

resourceName

Optional

Resource name, usually the machine name. Will be propagated to Assembler.

string

consumerResourceLink

Optional

consumerResourceLink

object

customProperties

Optional

customProperties

array of string

options

Optional

options

string

tenantLink

Optional

Link to the resource's tenant.

string

documentSelfLink

Optional

Link to this resource.

401

Unauthorized

Operation doesn't return any data structure

Code Samples

COPY

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

On This Page

Description

Request

Request Body

Authentication

Response

200 Response Body

Errors

Onboarding Resources Operations