NetworkDomain

NetworkDomain
NetworkDomain

The network domain object is the parent of related subnets that are configured together. Subnets within a domain must have non-overlapping address spaces.
HATEOAS links:
cloud-accounts - array[CloudAccount] - List of cloud accounts where this network domain exists.
self - NetworkDomain - Self link to this network domain

JSON Example
{
    "id": "9e49",
    "createdAt": "2012-09-27",
    "updatedAt": "2012-09-27",
    "owner": "[email protected]",
    "organizationId": "deprecated",
    "orgId": "9e49",
    "name": "my-name",
    "description": "my-description",
    "externalId": "i-cfe4-e241-e53b-756a9a2e25d2",
    "cidr": "10.0.0.0/8",
    "externalRegionId": "ap-northeast-2",
    "tags": [
        {
            "key": "string",
            "value": "string"
        }
    ],
    "cloudAccountIds": [
        "string"
    ]
}
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.

string
externalId
Optional

External entity Id on the provider side.

string
cidr
Required

IPv4 address range of the network domain in CIDR format

string
externalRegionId
Required

The external regionId of the network domain.

array of Tag
tags
Optional

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

object
customProperties
Optional

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

array of string
cloudAccountIds
Optional

Set of ids of the cloud accounts this entity belongs to.