Create Blueprint Request Using POST

• Blueprint Requests

Creates a blueprint request

Request

URI

POST

https://{api_host}//api.mgmt.cloud.vmware.com/blueprint/api/blueprint-requests

COPY

Query Parameters

string

apiVersion

Optional

The version of the API in yyyy-MM-dd format (UTC). For versioning information please refer to /blueprint/api/about

---

Request Body

request

BlueprintRequest of type(s) application/json

Required

{
    "blueprintId": "string",
    "blueprintVersion": "string",
    "cancelRequestedAt": "string",
    "cancelRequestedBy": "string",
    "content": "string",
    "createdAt": "string",
    "createdBy": "string",
    "deploymentId": "string",
    "deploymentName": "string",
    "description": "string",
    "destroy": false,
    "failureMessage": "string",
    "flowExecutionId": "string",
    "flowId": "string",
    "id": "string",
    "ignoreDeleteFailures": false,
    "orgId": "string",
    "plan": false,
    "projectId": "string",
    "projectName": "string",
    "reason": "string",
    "requestTrackerId": "string",
    "simulate": false,
    "status": "string",
    "updatedAt": "string",
    "updatedBy": "string",
    "validationMessages": [
        {
            "message": "string",
            "path": "string",
            "resourceName": "string",
            "type": "string"
        }
    ]
}

string As uuid As uuid

blueprintId

Optional

Blueprint Id

string

blueprintVersion

Optional

Blueprint version

string As date-time As date-time

cancelRequestedAt

Optional

Cancel request time

string

cancelRequestedBy

Optional

Cancel requested by

string

content

Optional

Blueprint YAML content

string As date-time As date-time

createdAt

Optional

Created time

string

createdBy

Optional

Created by

string

deploymentId

Optional

Existing deployment Id

string

deploymentName

Optional

Name for the new deployment

string

description

Optional

Description for the new request

boolean

destroy

Optional

Destroy existing deployment

string

failureMessage

Optional

Failure message

string

flowExecutionId

Optional

Flow execution Id

string

flowId

Optional

Flow Id

string

id

Optional

Object ID

boolean

ignoreDeleteFailures

Optional

Ignore delete failures in blueprint request

object

inputs

Optional

Blueprint request inputs

string

orgId

Optional

Org ID

boolean

plan

Optional

Plan only without affecting existing deployment

string

projectId

Optional

Project ID

string

projectName

Optional

Project Name

string

reason

Optional

Reason for requesting a blueprint

string

requestTrackerId

Optional

Request tracker Id

boolean

simulate

Optional

Simulate blueprint request with providers

string

status

Optional

Status

Possible values are : CREATED, STARTED, FINISHED, FAILED, CANCELLED,

string As date-time As date-time

updatedAt

Optional

Updated time

string

updatedBy

Optional

Updated by

array of BlueprintValidationMessage

validationMessages

Optional

Validation messages

Responses

200

Hide Details

OK

Returns BlueprintRequest of type(s) application/json

{
    "blueprintId": "string",
    "blueprintVersion": "string",
    "cancelRequestedAt": "string",
    "cancelRequestedBy": "string",
    "content": "string",
    "createdAt": "string",
    "createdBy": "string",
    "deploymentId": "string",
    "deploymentName": "string",
    "description": "string",
    "destroy": false,
    "failureMessage": "string",
    "flowExecutionId": "string",
    "flowId": "string",
    "id": "string",
    "ignoreDeleteFailures": false,
    "orgId": "string",
    "plan": false,
    "projectId": "string",
    "projectName": "string",
    "reason": "string",
    "requestTrackerId": "string",
    "simulate": false,
    "status": "string",
    "updatedAt": "string",
    "updatedBy": "string",
    "validationMessages": [
        {
            "message": "string",
            "path": "string",
            "resourceName": "string",
            "type": "string"
        }
    ]
}

string As uuid As uuid

blueprintId

Optional

Blueprint Id

string

blueprintVersion

Optional

Blueprint version

string As date-time As date-time

cancelRequestedAt

Optional

Cancel request time

string

cancelRequestedBy

Optional

Cancel requested by

string

content

Optional

Blueprint YAML content

string As date-time As date-time

createdAt

Optional

Created time

string

createdBy

Optional

Created by

string

deploymentId

Optional

Existing deployment Id

string

deploymentName

Optional

Name for the new deployment

string

description

Optional

Description for the new request

boolean

destroy

Optional

Destroy existing deployment

string

failureMessage

Optional

Failure message

string

flowExecutionId

Optional

Flow execution Id

string

flowId

Optional

Flow Id

string

id

Optional

Object ID

boolean

ignoreDeleteFailures

Optional

Ignore delete failures in blueprint request

object

inputs

Optional

Blueprint request inputs

string

orgId

Optional

Org ID

boolean

plan

Optional

Plan only without affecting existing deployment

string

projectId

Optional

Project ID

string

projectName

Optional

Project Name

string

reason

Optional

Reason for requesting a blueprint

string

requestTrackerId

Optional

Request tracker Id

boolean

simulate

Optional

Simulate blueprint request with providers

string

status

Optional

Status

Possible values are : CREATED, STARTED, FINISHED, FAILED, CANCELLED,

string As date-time As date-time

updatedAt

Optional

Updated time

string

updatedBy

Optional

Updated by

array of BlueprintValidationMessage

validationMessages

Optional

Validation messages

201

Hide Details

Created

Returns BlueprintRequest of type(s) application/json

{
    "blueprintId": "string",
    "blueprintVersion": "string",
    "cancelRequestedAt": "string",
    "cancelRequestedBy": "string",
    "content": "string",
    "createdAt": "string",
    "createdBy": "string",
    "deploymentId": "string",
    "deploymentName": "string",
    "description": "string",
    "destroy": false,
    "failureMessage": "string",
    "flowExecutionId": "string",
    "flowId": "string",
    "id": "string",
    "ignoreDeleteFailures": false,
    "orgId": "string",
    "plan": false,
    "projectId": "string",
    "projectName": "string",
    "reason": "string",
    "requestTrackerId": "string",
    "simulate": false,
    "status": "string",
    "updatedAt": "string",
    "updatedBy": "string",
    "validationMessages": [
        {
            "message": "string",
            "path": "string",
            "resourceName": "string",
            "type": "string"
        }
    ]
}

string As uuid As uuid

blueprintId

Optional

Blueprint Id

string

blueprintVersion

Optional

Blueprint version

string As date-time As date-time

cancelRequestedAt

Optional

Cancel request time

string

cancelRequestedBy

Optional

Cancel requested by

string

content

Optional

Blueprint YAML content

string As date-time As date-time

createdAt

Optional

Created time

string

createdBy

Optional

Created by

string

deploymentId

Optional

Existing deployment Id

string

deploymentName

Optional

Name for the new deployment

string

description

Optional

Description for the new request

boolean

destroy

Optional

Destroy existing deployment

string

failureMessage

Optional

Failure message

string

flowExecutionId

Optional

Flow execution Id

string

flowId

Optional

Flow Id

string

id

Optional

Object ID

boolean

ignoreDeleteFailures

Optional

Ignore delete failures in blueprint request

object

inputs

Optional

Blueprint request inputs

string

orgId

Optional

Org ID

boolean

plan

Optional

Plan only without affecting existing deployment

string

projectId

Optional

Project ID

string

projectName

Optional

Project Name

string

reason

Optional

Reason for requesting a blueprint

string

requestTrackerId

Optional

Request tracker Id

boolean

simulate

Optional

Simulate blueprint request with providers

string

status

Optional

Status

Possible values are : CREATED, STARTED, FINISHED, FAILED, CANCELLED,

string As date-time As date-time

updatedAt

Optional

Updated time

string

updatedBy

Optional

Updated by

array of BlueprintValidationMessage

validationMessages

Optional

Validation messages

401

Hide Details

Unauthorized

Operation doesn't return any data structure

403

Hide Details

Forbidden

Operation doesn't return any data structure

404

Hide Details

Not Found

Operation doesn't return any data structure

On This Page

Description

Request

Query Parameters

Request Body

Response

200 Response Body

201 Response Body

Errors

Blueprint Requests Operations

POST

Action Blueprint Request Using POST

POST

Create Blueprint Request Using POST

DELETE

Delete Blueprint Request Using DELETE

GET

Get Blueprint Plan Using GET

GET

Get Blueprint Request Using GET

GET

Get Blueprint Resources Plan Using GET

GET

List Blueprint Requests Using GET