Allocate | VMware Cloud Director OpenAPI

Allocate

Allocate floating IP addresses or IP Prefix blocks from an IP Space. This results in reserving the IP address or IP Prefix block for the specified organization. The organization can then use the IP address for network services such as NAT or use the IP Prefix as the network CIDR definition during Org VDC network creation.

Request

URI

POST

https://{api_host}/cloudapi/1.0.0/ipSpaces/{ipSpaceId}/allocate

COPY

Path Parameters

string

ipSpaceId

Required

ipSpaceId

string

ipSpaceId

Required

ipSpaceId

Request Body

IpSpaceIpAllocationRequest of type(s) application/json

Required

{
    "type": "string",
    "quantity": 0,
    "prefixLength": 0
}

string

type

Required

The type of the IP allocation requested. Possible values are:

FLOATING_IP - For allocation of floating IP addresses from defined IP Space ranges.
IP_PREFIX - For allocation of IP prefix sequences from defined IP Space prefixes.

integer

quantity

Required

Number of IP addresses or IP Prefix blocks to allocate.

integer

prefixLength

Optional

The prefix length of an IP Prefix to allocate. This is required if type is IP_PREFIX.

Authentication

This operation uses the following authentication methods.

ApiKeyAuth

Responses