API ReferenceNew CentralGuidesMRT APIConfiguration API
GithubAirheads Developer Community
API Reference

Create a new DDNS profile supporting IETF protocol

DDNS profile defining IETF RFC 2136 update configuration including
server addresses, TSIG authentication keys, update intervals, and
PTR record settings. Each entity is identified by profile name. Use
these APIs to create, modify, or delete a DDNS profile instance.

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

DDNS profile name.

Query Params
string

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

string

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

string

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

Body Params

profilebody object

boolean
Defaults to true

Enable DDNS updates (AP).

boolean
Defaults to false

Enables Dynamic DNS updates with PTR records.

int64
900 to 86400
Defaults to 900

Periodic refresh interval for DDNS updates (900–86400 seconds, default 900).

server
array of objects
length ≤ 2147483647

Gateway DDNS servers used to publish uplink and DHCP client IP changes.
Servers use IPv4 and authenticate with a TSIG key.

server
string
length between 1 and 256

DDNS profile description.

string
length between 1 and 256

DDNS 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