API ReferenceNew CentralGuidesMRT APIConfiguration API
GithubAirheads Developer Community
API Reference

Update profile for DHCPv4/DHCPv6 Relay configurations

DHCP relay profile defining DHCPv4 and DHCPv6 relay agent parameters
including server addresses, Option 82 handling, hop count settings,
and source interface selection. Each entity is identified by profile
name. Use these APIs to create, modify, or delete a DHCP relay
profile instance.

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

DHCP Relay 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
object

Grouping for Option 82 Configurations

ipv6
object

Grouping for DHCPv6 Relay Configurations

string
length between 1 and 256

DHCP Relay profile description.

string
length between 1 and 256

DHCP Relay 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