Understanding How The API Works
Creating a new Dynamic DNS service instance and its dedicated user in the API requires specific syntax depending on whether you are using REST or SOAP. Use this table to find the syntax for your command.
REST Syntax
Click to view all REST Resources |
/REST/DDNS/ POST — Creates a new Dynamic DNS service and its dedicated user on the zone/node indicated.
HTTP Action — POST
URIs — https://api.dynect.net/REST/DDNS/<zone>/<fqdn>/<record type>/
NOTE: <record_type> should be either A, for IPv4, or AAAA, for IPv6.
|
Arguments:
boolean full_setup — Required. Flag to indicate a user is specified.
string address — Required. IPv4 or IPv6 address for the service.
string user — Required. Name of the user to create, or the name of an existing update user to allow access to this service.
|
Response — Click for More Info
- hash
ddns — The new Dynamic DNS service created.
- string
abuse_count — Total number of abusive updates since last good update.
- string
active — A boolean indicating whether or not the service is active.
Y – The service is active.
N – The service is inactive.
- string
last_updated — Timestamp of the last good update by an update client.
- string
address — IPv4 or IPv6 Address.
- string
fqdn — Fully qualified domain name of a node in the zone
- string
record_type — The RRType of the service.
Valid values: A or AAAA
- string
zone — Name of the zone.
- hash
new_user — The new user created (if any)
- string
password — Password of the new update user.
- array
group_name — A list of permission groups where this user belongs.
- string
status — Current status of the user.
- string
user_name — The user’s system username; used for logging into the system.
|
SOAP Syntax
Click to view all SOAP Commands |
CreateDDNSHost — Creates a new Dynamic DNS service and (optionally) a new update user. Also creates the necessary permission entries for the update user to interact with the service.
|
Arguments — Click for More Info
- string
address — Required. IPv4 or IPv6 address for the service.
- string
fqdn — Required. Name of node where the service will exist.
- string
record_type — Required. The RRType of the service.
Valid values: A or AAAA
- string
token — Required. The session identifier.
- string
user — Required. Name of the user to create, or the name of an existing update user to allow access to this service.
- string
zone — Required. Name of zone where the service will exist.
|
Response — Click for More Info
- hash
data
- hash
ddns — The new Dynamic DNS service created.
- string
abuse_count — Total number of abusive updates since last good update.
- string
active — A boolean indicating whether or not the service is active.
Y – The service is active.
N – The service is inactive.
- string
last_updated — Timestamp of the last good update by an update client.
- string
address — IPv4 or IPv6 Address.
- string
fqdn — Fully qualified domain name of a node in the zone
- string
record_type — The RRType of the service.
Valid values: A or AAAA
- string
zone — Name of the zone.
- hash
new_user — The new user created (if any)
- string
password — Password of the new update user.
- array
group_name — A list of permission groups where this user belongs.
- string
status — Current status of the user.
- string
user_name — The user’s system username; used for logging into the system.
|
Example Request — Click for More Info
{
'address' => '1.2.3.4',
'fqdn' => 'www.example.com',
'record_type' => 'A',
'token' => 'asdlkfjasl23j4879afa',
'user' => 'updater',
'zone' => 'example.com',
}
|
<< DNS API Knowledge Base