Controller: Dns

API Controller	/siteworx/dns
Required Permissions	["DNS"]
Required Options	Edit DNS Records

Action	Description
~~add~~	Add a DNS Record (A, CNAME, or TXT). DEPRECATED in version 4.8.0-393
addA	Add an A record.
addAAAA	Add an AAAA record.
addCNAME	Add a CNAME record.
addMX	Add an MX record.
addSPF	Add an SPF record.
addTXT	Add a TXT record.
delete	Delete a DNS Record.
editA	Edit an A record.
editAAAA	Edit an AAAA record.
editCNAME	Edit a CNAME record.
editMX	Edit an MX record.
editSPF	Edit an SPF record.
editTXT	Edit a TXT record.
queryDnsRecords	List DNS Records that are part of the zone.

Action: add (Added in version 4.2.0-260)

This action has been deprecated as of version 4.8.0-393.

MESSAGE: 2011-04-05 Use individual add[ type ] functions instead.

Add a DNS Record (A, CNAME, or TXT).

Input Parameters

Name	Type	Notes	Required?
domain	string	Example Values example.com, pointer.com, secondary.com	Yes

Action: addA (Added in version 4.8.0-393)

Add an A record.

Input Parameters

Name	Type	Notes	Required?
zone_id	integer		Yes
host	string	Example Default Value example.com	No*
ttl	integer	Description In Seconds Help Entry TTL, or Time To Live, is the number of seconds that a record will be considered valid by a server caching the information. Example Default Value 43200	No*
ipaddress	string	Help Entry ####	Yes
* indicates that it's actually required, but probably already has a valid default value

Action: addAAAA (Added in version 4.8.0-393)

Add an AAAA record.

Input Parameters

Name	Type	Notes	Required?
zone_id	integer		Yes
host	string	Example Default Value example.com	No*
ttl	integer	Description In Seconds Help Entry TTL, or Time To Live, is the number of seconds that a record will be considered valid by a server caching the information. Example Default Value 43200	No*
ipaddress	string	Help Entry ####	Yes
* indicates that it's actually required, but probably already has a valid default value

Action: addCNAME (Added in version 4.8.0-393)

Add a CNAME record.

Input Parameters

Name	Type	Notes	Required?
zone_id	integer		Yes
host	string	Example Default Value example.com	No*
ttl	integer	Description In Seconds Help Entry TTL, or Time To Live, is the number of seconds that a record will be considered valid by a server caching the information. Example Default Value 43200	No*
alias	string		Yes
* indicates that it's actually required, but probably already has a valid default value

Action: addMX (Added in version 4.8.0-393)

Add an MX record.

Input Parameters

Name	Type	Notes	Required?
zone_id	integer		Yes
host	string	Example Default Value example.com	No*
ttl	integer	Description In Seconds Help Entry TTL, or Time To Live, is the number of seconds that a record will be considered valid by a server caching the information. Example Default Value 43200	No*
preference	integer	Help Entry An integer, ranging from 0-65535, indicating the order in which records should be attempted. Lower numbers will be processed before higher ones.	Yes
mail_server	string		Yes
* indicates that it's actually required, but probably already has a valid default value

Action: addSPF (Added in version 4.8.0-393)

Add an SPF record.

Input Parameters

Name	Type	Notes	Required?
zone_id	integer		Yes
host	string	Example Default Value example.com	No*
ttl	integer	Description In Seconds Help Entry TTL, or Time To Live, is the number of seconds that a record will be considered valid by a server caching the information. Example Default Value 43200	No*
spf_record_value	string	Example Default Value v=spf1	No*
use_a	integer	Description Should the IP(s) referenced in DNS A Records for this domain be permitted to send mail? Example Values 1, 0 Example Default Value 0	No*
use_mx	integer	Description Should the hostnames referenced in DNS MX Records for this domain be permitted to send mail? Example Values 1, 0 Example Default Value 0	No*
use_ptr	integer	Description Should the PTR Records for the sender's IP be used to validate the sender's domain? NOT RECOMMENDED. Example Values 1, 0 Example Default Value 0	No*
other_servers	integer	Description Do any other hostnames or IPs need to be authorized to send mail for this domain? Example Values 1, 0 Example Default Value 0	No*
mechanism_a	struct (string)	Description If the domain name has an address record (A or AAAA) that can be resolved to the sender's address, it will match.	No
mechanism_mx	struct (string)	Description If the domain name has an MX record resolving to the sender's address, it will match (i.e. the mail comes from one of the domain's mail servers).	No
mechanism_ip4	struct (string)	Description If the sender is in a given IPv4 range, match.	No
mechanism_ip6	struct (string)	Description If the sender is in a given IPv6 range, match.	No
mechanism_ptr	struct (string)	Description If the domain name for the client's address is in the given domain and that domain name resolves to the client's address, match. Input may use macro-expansion. NOT RECOMMENDED.	No
mechanism_exists	struct (string)	Description If there is a valid A Record for the given domain, match. Input may use macro-expansion.	No
mechanism_include	struct (string)	Description Used to include the policies of another domain's SPF record. Similar to the 'Redirect' parameter.	No
all	string	Description Defines how to respond if the record has produced no match. Example Values , -all, ~all, ?all, +all	No
redirect	string	Description Redirects verification to use the SPF record of the specified domain. This is useful, for example, if you send mail through your ISP's servers and they have defined an SPF record.	No
explanation	string	Description Defines a DNS name whose TXT Record may be returned along with failure messages. Rarely used, may not be universally supported.	No
* indicates that it's actually required, but probably already has a valid default value

Action: addTXT (Added in version 4.8.0-393)

Add a TXT record.

Input Parameters

Name	Type	Notes	Required?
zone_id	integer		Yes
host	string	Example Default Value example.com	No*
ttl	integer	Description In Seconds Help Entry TTL, or Time To Live, is the number of seconds that a record will be considered valid by a server caching the information. Example Default Value 43200	No*
text	string		Yes
* indicates that it's actually required, but probably already has a valid default value

Action: delete (Added in version 4.2.0-260)

Delete a DNS Record.

Input Parameters

Name	Type	Notes	Required?
record_id	struct (integer)		Yes
confirm_action	struct (integer)	Example Values 1	No*
* indicates that it's actually required, but probably already has a valid default value

Action: editA (Added in version 4.8.0-393)

Edit an A record.

Input Parameters

Name	Type	Notes	Required?
record_id	integer		Yes
ttl	integer	Description In Seconds Help Entry TTL, or Time To Live, is the number of seconds that a record will be considered valid by a server caching the information. Example Default Value 43200	No*
* indicates that it's actually required, but probably already has a valid default value

Action: editAAAA (Added in version 4.8.0-393)

Edit an AAAA record.

Input Parameters

Name	Type	Notes	Required?
record_id	integer		Yes
ttl	integer	Description In Seconds Help Entry TTL, or Time To Live, is the number of seconds that a record will be considered valid by a server caching the information. Example Default Value 43200	No*
* indicates that it's actually required, but probably already has a valid default value

Action: editCNAME (Added in version 4.8.0-393)

Edit a CNAME record.

Input Parameters

Name	Type	Notes	Required?
record_id	integer		Yes
host	string	Example Default Value sub.example.com	No*
ttl	integer	Description In Seconds Help Entry TTL, or Time To Live, is the number of seconds that a record will be considered valid by a server caching the information. Example Default Value 43200	No*
alias	string	Example Default Value example.com	No*
* indicates that it's actually required, but probably already has a valid default value

Action: editMX (Added in version 4.8.0-393)

Edit an MX record.

Input Parameters

Name	Type	Notes	Required?
record_id	integer		Yes
host	string	Example Default Value example.com	No*
ttl	integer	Description In Seconds Help Entry TTL, or Time To Live, is the number of seconds that a record will be considered valid by a server caching the information. Example Default Value 43200	No*
preference	integer	Help Entry An integer, ranging from 0-65535, indicating the order in which records should be attempted. Lower numbers will be processed before higher ones. Example Default Value 10	No*
mail_server	string	Example Default Value mail.example.com	No*
* indicates that it's actually required, but probably already has a valid default value

Action: editSPF (Added in version 4.8.0-393)

Edit an SPF record.

Input Parameters

Name	Type	Notes	Required?
record_id	integer		Yes
host	string	Example Default Value example.com	No*
ttl	integer	Description In Seconds Help Entry TTL, or Time To Live, is the number of seconds that a record will be considered valid by a server caching the information. Example Default Value 43200	No*
spf_record_value	string	Example Default Value v=spf1	No*
use_a	integer	Description Should the IP(s) referenced in DNS A Records for this domain be permitted to send mail? Example Values 1, 0 Example Default Value 0	No*
use_mx	integer	Description Should the hostnames referenced in DNS MX Records for this domain be permitted to send mail? Example Values 1, 0 Example Default Value 0	No*
use_ptr	integer	Description Should the PTR Records for the sender's IP be used to validate the sender's domain? NOT RECOMMENDED. Example Values 1, 0 Example Default Value 0	No*
other_servers	integer	Description Do any other hostnames or IPs need to be authorized to send mail for this domain? Example Values 1, 0 Example Default Value 0	No*
mechanism_a	struct (string)	Description If the domain name has an address record (A or AAAA) that can be resolved to the sender's address, it will match.	No
mechanism_mx	struct (string)	Description If the domain name has an MX record resolving to the sender's address, it will match (i.e. the mail comes from one of the domain's mail servers).	No
mechanism_ip4	struct (string)	Description If the sender is in a given IPv4 range, match.	No
mechanism_ip6	struct (string)	Description If the sender is in a given IPv6 range, match.	No
mechanism_ptr	struct (string)	Description If the domain name for the client's address is in the given domain and that domain name resolves to the client's address, match. Input may use macro-expansion. NOT RECOMMENDED.	No
mechanism_exists	struct (string)	Description If there is a valid A Record for the given domain, match. Input may use macro-expansion.	No
mechanism_include	struct (string)	Description Used to include the policies of another domain's SPF record. Similar to the 'Redirect' parameter.	No
all	string	Description Defines how to respond if the record has produced no match. Example Values , -all, ~all, ?all, +all	No
redirect	string	Description Redirects verification to use the SPF record of the specified domain. This is useful, for example, if you send mail through your ISP's servers and they have defined an SPF record.	No
explanation	string	Description Defines a DNS name whose TXT Record may be returned along with failure messages. Rarely used, may not be universally supported.	No
* indicates that it's actually required, but probably already has a valid default value

Action: editTXT (Added in version 4.8.0-393)

Edit a TXT record.

Input Parameters

Name	Type	Notes	Required?
record_id	integer		Yes
host	string	Example Default Value example.com	No*
ttl	integer	Description In Seconds Help Entry TTL, or Time To Live, is the number of seconds that a record will be considered valid by a server caching the information. Example Default Value 43200	No*
text	string	Example Default Value example text record	No*
* indicates that it's actually required, but probably already has a valid default value

Action: queryDnsRecords (Added in version 4.8.0-393)

List DNS Records that are part of the zone.

Input Parameters

Name	Type	Notes	Required?
zone_id	integer		No*
uni	integer	Example Values 1, 0 Example Default Value 0	No*
* indicates that it's actually required, but probably already has a valid default value