Create Cloud Account | vRealize Automation Cloud 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

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

string

name

Required

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

string

description

Optional

A human-friendly description.

string

cloudAccountType

Required

Cloud account type

string

privateKeyId

Required

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

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

object

cloudAccountProperties

Required

Cloud Account specific properties supplied in as name value pairs

object

customProperties

Optional

Additional custom properties that may be used toextend the Cloud Account.

array of string

regionIds

Required

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

boolean

createDefaultZones

Optional

Create default cloud zones for the enabled regions.

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

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

string

Required

The id of this resource instance

string

createdAt

Optional

Date when the entity was created. The date is in ISO 6801 and UTC.

string

updatedAt

Optional

Date when the entity was last updated. The date is ISO 8601 and UTC.

string

owner

Optional

Email of the user that owns the entity.

string

organizationId

Optional

This field is deprecated. Use orgId instead. The id of the organization this entity belongs to.

string

orgId

Optional

The id of the organization this entity belongs to.

object

_links

Required

HATEOAS of the entity

string

name

Optional

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

string

description

Optional

A human-friendly description.

string

cloudAccountType

Required

Cloud account type

object

cloudAccountProperties

Required

Cloud account specific properties

array of string

enabledRegionIds

Optional

A set of region names to enable provisioning on.

object

customProperties

Optional

Additional properties that may be used to extend the base type.

array of Tag