API Description | API Path |
---|---|
Returns list of configured IP address blocks.Returns information about configured IP address blocks. Information includes the id, display name, description & CIDR of IP address blocks |
GET /api/v1/pools/ip-blocks
(Deprecated)
|
Create a new IP address block.Creates a new IPv4 address block using the specified cidr. cidr is a required parameter. display_name & description are optional parameters |
POST /api/v1/pools/ip-blocks
(Deprecated)
|
Delete an IP Address BlockDeletes the IP address block with specified id if it exists. IP block cannot be deleted if there are allocated subnets from the block. |
DELETE /api/v1/pools/ip-blocks/{block-id}
(Deprecated)
|
Get IP address block information.Returns information about the IP address block with specified id. Information includes id, display_name, description & cidr. |
GET /api/v1/pools/ip-blocks/{block-id}
(Deprecated)
|
Update an IP Address BlockModifies the IP address block with specifed id. display_name, description and cidr are parameters that can be modified. If a new cidr is specified, it should contain all existing subnets in the IP block. Returns a conflict error if the IP address block cidr can not be modified due to the presence of subnets that it contains. Eg: If the IP block contains a subnet 192.168.0.1/24 and we try to change the IP block cidr to 10.1.0.1/16, it results in a conflict. |
PUT /api/v1/pools/ip-blocks/{block-id}
(Deprecated)
|
List subnets within an IP blockReturns information about all subnets present within an IP address block. Information includes subnet's id, display_name, description, cidr and allocation ranges. |
GET /api/v1/pools/ip-subnets
|
Create subnet of specified size within an IP blockCarves out a subnet of requested size from the specified IP block. The "size" parameter and the "block_id " are the requireds field while invoking this API. If the IP block has sufficient resources/space to allocate a subnet of specified size, the response will contain all the details of the newly created subnet including the display_name, description, cidr & allocation_ranges. Returns a conflict error if the IP block does not have enough resources/space to allocate a subnet of the requested size. |
POST /api/v1/pools/ip-subnets
(Deprecated)
|
Delete subnet within an IP blockDeletes a subnet with specified id within a given IP address block. Deletion is allowed only when there are no allocated IP addresses from that subnet. |
DELETE /api/v1/pools/ip-subnets/{subnet-id}
(Deprecated)
|
Get the subnet within an IP blockReturns information about the subnet with specified id within a given IP address block. Information includes display_name, description, cidr and allocation_ranges. |
GET /api/v1/pools/ip-subnets/{subnet-id}
(Deprecated)
|
Allocate or Release an IP Address from a Ip SubnetAllocates or releases an IP address from the specified IP subnet. To allocate an address, include ?action=ALLOCATE in the request and a "{}" in the request body. When the request is successful, the response is "allocation_id": "<ip-address>", where <ip-address> is an IP address from the specified pool. To release an IP address (return it back to the pool), include ?action=RELEASE in the request and "allocation_id":<ip-address> in the request body, where <ip-address> is the address to be released. When the request is successful, the response is NULL. |
POST /api/v1/pools/ip-subnets/{subnet-id}
(Deprecated)
|