NSX-T Data Center REST API

IpAddressBlock allocation state

Returns the allocation state of all CIDRs allocated from the IpAddressBlock

Request:

Method:

GET

URI Path(s):

/policy/api/v1/infra/ip-blocks/{ip-block-id}/allocation-state
/policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/ip-blocks/{ip-block-id}/allocation-state

Request Headers:

n/a

Query Parameters:

AllocationStateQueryParams+

AllocationStateQueryParams (schema)

Name	Description	Type	Notes
cidr	CIDR allocated from the IpAddressBlock	string
include_workload_details	Filter details by Workload VM If set to true, and if the allocated CIDR is being used by a VM, the API will return details about the VM.	boolean	Default: "False"

Request Body:

n/a

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

IpAddressBlockAllocationState+

IpAddressBlockAllocationState (schema)

Name	Description	Type	Notes
allocation_states	State of each CIDR allocated from the IpAddressBlock	array of IpAddressBlockAllocationStateForCidr
display_name	Display Name of IpAddressBlock	string
ip_address_type	Type of IP Address Represents the type of IP addresses present inside the IpAddressBlock.	string	Enum: IPV4, IPV6
ip_block_path	Policy path of IpAddressBlock	string
visibility	Visibility of IpAddressBlock Represents visibility or scope of IpAddressBlock and expected consumption of IpAddressBlock with same scope. It is empty by default.	string	Enum: PRIVATE, EXTERNAL

Required Permissions:

read

Feature:

policy_ipam

Additional Errors:

• 301 Moved Permanently
• 307 Temporary Redirect
• 400 Bad Request
• 403 Forbidden
• 409 Conflict
• 412 Precondition Failed
• 500 Internal Server Error
• 503 Service Unavailable