Update Cloud Account

Update Cloud Account

Update a single CloudAccount

Request
URI
PATCH
https://{api_host}/iaas/api/cloud-accounts/{id}
COPY
Path Parameters
string
id
Required

The ID of the cloudAccount

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

Cloud account details to be updated

UpdateCloudAccountSpecification of type(s) application/json
Required
{
    "createDefaultZones": true,
    "associatedCloudAccountIds": [
        "string"
    ],
    "description": "string",
    "regionIds": [
        "string"
    ],
    "tags": [
        {
            "value": "string",
            "key": "string"
        }
    ]
}
boolean
createDefaultZones
Optional

Create default cloud zones for the enabled regions.

array of string
associatedCloudAccountIds
Optional

Cloud accounts to link with this cloud account

object
customProperties
Optional

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

string
description
Optional

A human-friendly description.

array of string
regionIds
Optional

A set of Region names to enable provisioning on.

array of Tag
tags
Optional

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

Responses
200

successful operation

Returns CloudAccount of type(s) application/json
{
    "owner": "[email protected]",
    "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
tags
Optional

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

string
organizationId
Optional

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

string
createdAt
Optional

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

object
customProperties
Optional

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

string
name
Optional

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

string
id
Required

The id of this resource instance

string
updatedAt
Optional

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


403

Forbidden

Operation doesn't return any data structure

404

Not Found

Operation doesn't return any data structure