Create Zone

Create Zone

Create zone

Request
URI
POST
https://vra-interop-222-139.lvn.broadcom.net/iaas/api/zones
COPY
Query Parameters
string
apiVersion
Optional

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


Request Body

Zone specification

ZoneSpecification of type(s) application/json
Required

Show optional properties

{
    "name": "string",
    "regionId": "9.0E49"
}
{
    "name": "string",
    "description": "string",
    "regionId": "9.0E49",
    "placementPolicy": "DEFAULT",
    "tags": [
        {
            "key": "production",
            "value": " "
        }
    ],
    "tagsToMatch": [
        {
            "key": "compliance",
            "value": "pci"
        }
    ],
    "customProperties": {
        "__isDefaultPlacementZone": "true"
    },
    "folder": "test-folder",
    "computeIds": [
        "[ab12c]"
    ]
}
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
regionId
Required

The id of the region for which this profile is created

string
placementPolicy
Optional

Placement policy for the zone. One of DEFAULT, SPREAD, BINPACK or SPREAD_MEMORY.

array of object
tags
Optional

A set of tag keys and optional values that are effectively applied to all compute resources in this zone, but only in the context of this zone.

array of object
tagsToMatch
Optional

A set of tag keys and optional values that will be used

object
customProperties
Optional

A list of key value pair of properties that will be used

string
folder
Optional

The folder relative path to the datacenter where resources are deployed to. (only applicable for vSphere cloud zones)

array of string
computeIds
Optional

The ids of the compute resources that will be explicitly assigned to this zone

Authentication
This operation uses the following authentication methods.
Responses
201

Created

Returns Zone of type(s) application/json
"Zone Object"
string
id
Required

The id of this resource instance

string
createdAt
Optional

Date when the entity was created. The date is in ISO 8601 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 or display name of the group that owns the entity.

string
ownerType
Optional

Type of a owner(user/ad_group) that owns the entity.

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.

array of object
tags
Optional

A set of tag keys and optional values that were set on this placement.

array of object
tagsToMatch
Optional

A set of tag keys and optional values for compute resource filtering.

string
placementPolicy
Optional

The placement policy for the zone.

object
customProperties
Optional

A list of key value pair of properties that will be used

string
folder
Optional

The folder relative path to the datacenter where resources are deployed to. If a non-existent folder name is passed, a new folder will be created in the respective datacenter when a machine is provisioned via the cloud zone. (only applicable for vSphere cloud zones)

string
externalRegionId
Optional

The id of the region for which this zone is defined

string
cloudAccountId
Optional

Cloud account this zone belongs to.


400

Not found

Returns ServiceErrorResponse of type(s) application/json
"ServiceErrorResponse Object"
string
message
Optional

message

string
messageId
Optional

messageId

array of string
stackTrace
Optional

stackTrace

integer As int32 As int32
statusCode
Optional

statusCode

integer As int32 As int32
errorCode
Optional

errorCode

array of string
details
Optional

details

string
serverErrorId
Optional

serverErrorId

string
documentKind
Optional

documentKind

integer As int32 As int32
internalErrorCode
Optional

internalErrorCode


403

Forbidden

Returns ServiceErrorResponse of type(s) application/json
"ServiceErrorResponse Object"
string
message
Optional

message

string
messageId
Optional

messageId

array of string
stackTrace
Optional

stackTrace

integer As int32 As int32
statusCode
Optional

statusCode

integer As int32 As int32
errorCode
Optional

errorCode

array of string
details
Optional

details

string
serverErrorId
Optional

serverErrorId

string
documentKind
Optional

documentKind

integer As int32 As int32
internalErrorCode
Optional

internalErrorCode


Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"name:"string","regionId:"string"}' https://{api_host}/iaas/api/zones