Update Zone

Update Zone

Update zone

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

The ID of the zone.

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 
{
    "folder": "test-folder",
    "regionId": "9e49",
    "tagsToMatch": [
        {
            "value": "string",
            "key": "string"
        }
    ],
    "name": "string",
    "description": "string",
    "placementPolicy": "DEFAULT",
    "tags": [
        {
            "value": "string",
            "key": "string"
        }
    ]
}
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)

string
regionId
Required

The id of the region for which this profile is created

array of Tag
tagsToMatch
Optional

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

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
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.

Responses
200

successful operation

Returns Zone of type(s) application/json 
{
    "owner": "[email protected]",
    "description": "my-description",
    "orgId": "9e49",
    "tags": [
        {
            "value": "string",
            "key": "string"
        }
    ],
    "organizationId": "deprecated",
    "createdAt": "2012-09-27",
    "folder": "test-folder",
    "tagsToMatch": [
        {
            "value": "string",
            "key": "string"
        }
    ],
    "name": "my-name",
    "placementPolicy": "DEFAULT, SPREAD, BINPACK",
    "id": "9e49",
    "updatedAt": "2012-09-27"
}
string
owner
Optional

Email of the user that owns the entity.

object
_links
Required

HATEOAS of the entity

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 this placement.

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

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 Tag
tagsToMatch
Optional

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

string
name
Optional

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

string
placementPolicy
Optional

The placement policy for the zone.

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.


400

Invalid Request - bad data

Operation doesn't return any data structure

403

Forbidden

Operation doesn't return any data structure

On This Page
Location Operations
POST
Create Zone
DELETE
Delete Zone
GET
Get Region
GET
Get Regions
GET
Get Zone
GET
Get Zones
PATCH
Update Zone