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

Create IP range by range_id for given address pool_name

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

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

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.

string
required

Identifier for each IP range in the pool. This is just a string identifier in form of 2 digit number that must be unique within each pool

Body Params

JSON representation of ip_range config

string
required

Identifier for each IP range in the pool. This is just a string identifier in form of 2 digit number that must be unique within each pool

string
required

Starting IPv4 Address of the range.

string
required

Last IPv4 Address of the range.

boolean
Defaults to false

This is a Read-only field that indicates whether this range is overlapping with any other range in the config. Adding of overlapping ranges is not allowed. However, we can have such ranges when legacy config is migrated

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