API ReferenceNew CentralGuidesMRT APIConfiguration API
GithubAirheads Developer Community
API Reference
GithubAirheads Developer Community

Read DHCPv4/DHCPv6 Relay configurations

get
https://de1.api.central.arubanetworks.com/network-config/v1alpha1/dhcp-relay

DHCP Relay forwards DHCP requests from clients on one network
segment to DHCP servers located on different network
segments, enabling centralized IP address management across
multiple subnets. DHCP Relay supports DHCPv4 (RFC 2131) and
DHCPv6 (RFC 3315) with configurable helper addresses, Option
82 insertion for client identification, hop count control,
and smart relay functionality. Configure IPv4 and IPv6 relay
parameters including server addresses, source interfaces, and
DHCP option handling policies. Use this API to retrieve the
list of DHCP relay profiles.

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

LIBRARY - Returns shared objects in library. For LIBRARY, all other parameters listed below, except 'detailed' , will be ignored. LOCAL - Returns configurations for a scope and one or more device function based on parameters below.

string

Retrieves LOCAL or SHARED or both(default) configuration objects.

string

Configuration at a given scope. Mandatory for view-type = LOCAL.

string

Filters configuration specific to given device-function type. If not provided and view_type = LOCAL, then defaults to all device-function's.

boolean

True - Returns effective configuration (i.e hierarchically merged configuration). False - Returns committed configuration at a given scope.

boolean

True - Includes annotations in the returned json to indicate the type of object, scope, and device function. False - Returns only config objects without annotations.

integer

Limit for pagination.

integer

Offset for pagination.

Responses

Updated 11 days ago

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

Updated 11 days ago