API ReferenceNew CentralGuidesMRT APIConfiguration API
GithubAirheads Developer Community
API Reference

Modify DHCP pool profile

DHCP pool profile defining address ranges, lease times, DNS servers,
gateway addresses, domain names, and vendor options for DHCPv4 or
DHCPv6. Each entity is identified by profile name. Use these APIs
to create, modify, or delete a DHCP pool profile instance.

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

DHCPv4/DHCPv6 Pool profile name.

Query Params
string

LOCAL - To update local objects. SHARED - To update shared objects. Default - Defaults to SHARED if not provided

string

Scope at which local object needs to be updated. Mandatory if object-type = LOCAL. Should not be provided for object-type = SHARED.

string

Device function for which the local object needs to be updated. Mandatory if object_type = LOCAL. Should not be provided for object_type = SHARED.

Body Params

profilebody object

ipv4-pool
object

Grouping for IPMS related fields of dhcp pool.

ipv6-pool
object

Grouping for DHCPv6 Static Binding Configurations

string
length between 1 and 256

DHCPv4/DHCPv6 Pool profile description.

string
enum

IPv4 or IPv6 version

Show Details
IPV4The IPv4 protocol as defined in RFC 791.
IPV6The IPv6 protocol as defined in RFC 2460.
UNKNOWNAn unknown or unspecified version of the Internet protocol.
Allowed:
string
length between 1 and 256

DHCPv4/DHCPv6 Pool profile name.

Responses

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