Create Cloud Account | vRealize Automation Infrastructure as a Service (IaaS) API

Create Cloud Account

Create a cloud account in the current organization

Request

URI

POST

https://{api_host}/iaas/api/cloud-accounts

COPY

Query Parameters

string

apiVersion

Optional

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

Request Body

CloudAccountSpecification of type(s) application/json

Optional

{
    "privateKey": "gfsScK345sGGaVdds222dasdfDDSSasdfdsa34fS",
    "associatedCloudAccountIds": [
        "string"
    ],
    "createDefaultZones": true,
    "cloudAccountType": "vsphere, aws, azure, nsxv, nsxt",
    "name": "string",
    "description": "string",
    "regionIds": [
        "string"
    ],
    "privateKeyId": "ACDC55DB4MFH6ADG75KK",
    "tags": [
        {
            "value": "string",
            "key": "string"
        }
    ]
}

object

cloudAccountProperties

Required

Cloud Account specific properties supplied in as name value pairs

string

privateKey

Required

Secret access key or password to be used to authenticate with the cloud account

array of string

associatedCloudAccountIds

Optional

Cloud account to link with this cloud account

boolean

createDefaultZones

Optional

Create default cloud zones for the enabled regions.

object

customProperties

Optional

Additional custom properties that may be used to extend the Cloud Account.

string

cloudAccountType

Required

Cloud account type

string

name

Required

A human-friendly name used as an identifier in APIs that support this option.

string

description

Optional

A human-friendly description.

array of string

regionIds

Required

A set of Region names to enable provisioning on.Refer to /iaas/cloud-accounts/region-enumeration.

string

privateKeyId

Required

Access key id or username to be used to authenticate with the cloud account

array of Tag

tags

Optional

A set of tag keys and optional values to set on the Cloud Account

Responses

201

successful operation

Returns CloudAccount of type(s) application/json

{
    "owner": "csp@vmware.com",
    "enabledRegionIds": [
        "string"
    ],
    "cloudAccountType": "vsphere, aws, azure, nsxv, nsxt",
    "description": "my-description",
    "orgId": "9e49",
    "tags": [
        {
            "value": "string",
            "key": "string"
        }
    ],
    "organizationId": "deprecated",
    "createdAt": "2012-09-27",
    "name": "my-name",
    "id": "9e49",
    "updatedAt": "2012-09-27"
}

string

owner

Optional

Email of the user that owns the entity.

object

cloudAccountProperties

Required

Cloud account specific properties

array of string

enabledRegionIds

Optional

A set of region names to enable provisioning on.

object

_links

Required

HATEOAS of the entity

string

cloudAccountType

Required

Cloud account type

string

description

Optional

A human-friendly description.

string

orgId

Optional

The id of the organization this entity belongs to.

array of Tag