HomeGuidesAPI Reference
GuidesAPI ReferenceGitHubAirheads Developer CommunityLog In
API Reference
GuidesAPI ReferenceGitHubAirheads Developer Community

Create IP address pool for given pool_name

post
https://{api-base-url}/ipms-config/v1/node_list///config/address_pool//

IP Address Pool that acts as a container for one or more IP address ranges.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
enum
required

Defines the type of configuration node to which the config is being applied.

Allowed:
string
required

The identifer of the configuration node(aka group). For node-type GLOBAL, node-id should be 'GLOBAL'. For node-type 'GROUP', node-id should be set to the group-name

string
required

Name to identify an IP pool. Maximum characters allowed is 60.

Query Params
string

Specify old value of 'pool_name' if it needs to be replaced

Body Params

JSON representation of address_pool config

string
required

Name to identify an IP pool. Maximum characters allowed is 60.

string
enum
required

Pool Type identifying whether IP address is used as Inner-IP or is used as part of DHCP pool

Allowed:
ip_range
array of objects
length ≤ 8

IP Address Range. The ranges must not overlap within or across pools

ip_range
int32
Defaults to 100

Maximum number of clients that can be allocated when subnets are carved out from this pool. This applies only to pool that are of type 'DHCP_POOL_TYPE'

Responses

401

Unauthorized

403

Forbidden

413

Request-size limit exceeded

417

Request-size limit exceeded

429

API Rate limit exceeded

Updated about 2 years ago

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 2 years ago