Create Zone

Create Zone

Create zone

Request
URI
POST
https://{api_host}/iaas/api/zones
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
ZoneSpecification of type(s) application/json
Optional
{
    "name": "string",
    "description": "string",
    "regionId": "9e49",
    "placementPolicy": "DEFAULT",
    "tags": [
        {
            "key": "string",
            "value": "string"
        }
    ],
    "tagsToMatch": [
        {
            "key": "string",
            "value": "string"
        }
    ],
    "folder": "test-folder"
}
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 or BINPACK.

array of Tag
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 Tag
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)

Responses
201

successful operation

Returns Zone 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",
    "tags": [
        {
            "key": "string",
            "value": "string"
        }
    ],
    "tagsToMatch": [
        {
            "key": "string",
            "value": "string"
        }
    ],
    "placementPolicy": "DEFAULT, SPREAD, BINPACK",
    "folder": "test-folder"
}
string
id
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.

array of Tag
tags
Optional

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

array of Tag
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. (only applicable for vSphere cloud zones)


400

Invalid Request - bad data

Operation doesn't return any data structure

403

Forbidden

Operation doesn't return any data structure