NSX-T Data Center REST API

Networking (Ip Management)

Associated URIs:

API Description API Path

List IpAddressBlocks


Paginated list of IpAddressBlocks.
GET /policy/api/v1/infra/ip-blocks
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/ip-blocks

Delete an IpAddressBlock


Delete the IpAddressBlock with the given id.
DELETE /policy/api/v1/infra/ip-blocks/{ip-block-id}
DELETE /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/ip-blocks/{ip-block-id}

Read a IpAddressBlock


Read IpAddressBlock with given Id.
GET /policy/api/v1/infra/ip-blocks/{ip-block-id}
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/ip-blocks/{ip-block-id}

Create a new IPBlock


Creates a new IpAddressBlock with specified ID if not already present.
If IpAddressBlock of given ID is already present, then the instance is
updated with specified attributes.
PATCH /policy/api/v1/infra/ip-blocks/{ip-block-id}
PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/ip-blocks/{ip-block-id}

Create or Replace IpAddressBlock


Create a new IpAddressBlock with given ID if it does not exist.
If IpAddressBlock with given ID already exists, it will update existing instance.
This is a full replace.
PUT /policy/api/v1/infra/ip-blocks/{ip-block-id}
PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/ip-blocks/{ip-block-id}

IpAddressBlock allocation state


Returns the allocation state of all CIDRs allocated from the IpAddressBlock
GET /policy/api/v1/infra/ip-blocks/{ip-block-id}/allocation-state
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/ip-blocks/{ip-block-id}/allocation-state

IpAddressBlock Free Subnets


Returns the number of subnets that can be carved for a given subnet mask, from the IpAddressBlock
GET /policy/api/v1/infra/ip-blocks/{ip-block-id}/available-subnets

Get an IpAddressBlock usage


Get IpAddressBlock usage with given Id.
GET /policy/api/v1/infra/ip-blocks/{ip-block-id}/usage
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/ip-blocks/{ip-block-id}/usage

IpAddressBlocks allocation states


Returns a paged list of allocation states for all IpAddressBlocks
GET /policy/api/v1/infra/ip-blocks/allocation-state
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/ip-blocks/allocation-state

Get state of the given IpAddressBlock


Get state of a given IPAddressBlock. It lists all the allocated IPs and subnets created using that block per Project and VPCs.
GET /policy/api/v1/infra/ip-blocks/state
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/ip-blocks/state

Usage Details for all IpAddressBlocks


Lists the usage details for all IpAddressBlocks
GET /policy/api/v1/infra/ip-blocks/usage
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/ip-blocks/usage

VPC IpAddressBloock Allocation State


Get allocation state of given IpAddressBlock for VPC.
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/ip-blocks/allocation-state

IpAddressBlock usage for VPC


Get usage of given IpAddressBlock for VPC.
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/ip-blocks/usage