Controller: /nodeworx/dns/record ================================ :Required Permissions: DNS Action: ``add`` --------------- :Added in Version: 4.7.0-339 :Description: Add a DNS record. .. warning:: This action has been deprecated as of version 4.8.0-393. 2011-02-23 Use the individual add(record-type) functions instead. Input Parameters ^^^^^^^^^^^^^^^^^ .. list-table:: :widths: auto :header-rows: 1 * - Name - Type - Required? - Example Values - Default Values - Notes * - ``zone_id`` - integer - Yes - - - * - ``host`` - string - Yes - - - * - ``type`` - string - Yes - A, CNAME, NS, MX, PTR, TXT, SOA, SPF, SRV, AAAA, NAPTR, CAA - - * - ``target`` - string - Yes - - - * - ``ttl`` - integer - Yes - - - TTL, or Time To Live, is the number of seconds that a record will be considered valid by a server caching the information. Action: ``addA`` ---------------- :Added in Version: 4.7.0-339 :Description: Add an A record to a zone. Input Parameters ^^^^^^^^^^^^^^^^^ .. list-table:: :widths: auto :header-rows: 1 * - Name - Type - Required? - Example Values - Default Values - Notes * - ``zone_id`` - integer - Yes - - - * - ``host`` - string - No* - - {domain} - * - ``ttl`` - integer - No* - - 43200 - TTL, or Time To Live, is the number of seconds that a record will be considered valid by a server caching the information. - *In Seconds* * - ``ipaddress`` - string - Yes - - - The IPv4 address for use with this record. '{ipv4}' can be used as a special place-holder for the current IP address of the domain as assigned in InterWorx. \* indicates that it's actually required, but probably already has a valid default value. Action: ``addAAAA`` ------------------- :Added in Version: 4.8.0-393 :Description: Add an AAAA record to a zone. Input Parameters ^^^^^^^^^^^^^^^^^ .. list-table:: :widths: auto :header-rows: 1 * - Name - Type - Required? - Example Values - Default Values - Notes * - ``zone_id`` - integer - Yes - - - * - ``host`` - string - No* - - {domain} - * - ``ttl`` - integer - No* - - 43200 - TTL, or Time To Live, is the number of seconds that a record will be considered valid by a server caching the information. - *In Seconds* * - ``ipaddress`` - string - Yes - - - The IPv6 address for use with this record. '{ipv6}' can be used as a special place-holder for the current IPv6 address of the domain as assigned in InterWorx. \* indicates that it's actually required, but probably already has a valid default value. Action: ``addCAA`` ------------------ :Added in Version: 6.0.8-1363 :Description: Add a CAA record to a zone. Input Parameters ^^^^^^^^^^^^^^^^^ .. list-table:: :widths: auto :header-rows: 1 * - Name - Type - Required? - Example Values - Default Values - Notes * - ``zone_id`` - integer - Yes - - - * - ``domain`` - string - No* - - {domain} - * - ``ttl`` - integer - No* - - 43200 - TTL, or Time To Live, is the number of seconds that a record will be considered valid by a server caching the information. - *In Seconds* * - ``flags`` - integer - No* - 0, 128 - 0 - Issuer Critical Flag: If the "flags" value is set to '1', the critical flag is asserted and the property MUST be understood if the CAA record is to be correctly processed by a certificate issuer. A Certification Authority MUST NOT issue certificates for any Domain that contains a CAA critical property for an unknown or unsupported property tag that for which the issuer critical flag is set. See: RFC6844 * - ``tag`` - string - No* - issue, issuewild, iodef - issue - Property tags define the meaning of the CAA record. Three are currently supported, but more may be added in the future.

issue:This tag is used to allow/disallow the Certificate Authority to issue certificates for the domain, including wildcard certificates.

issuewild: This tag is used to allow/disallow wildcard certificates issuance for the domain.

iodef: This tag specifies a method for CAs to report to the domain holder when a certificate is issued. Not all CAs support this tag, so there is no guarantee that all certificate issuances will be reported.

* - ``issue`` - string - No - comodoca.com, digicert.com, entrust.net, globalsign.com, izenpe.com, letsencrypt.org, symantec.com, trustwave.com, wosign.com, ; - - Enter the domain of the Certificate authority (ex. letsencrypt.org). To prevent Certificate Authorities from issuing certificates for this tag enter a semicolon (;). * - ``issuewild`` - string - No - comodoca.com, digicert.com, entrust.net, globalsign.com, izenpe.com, letsencrypt.org, symantec.com, trustwave.com, wosign.com, ; - - Enter the domain of the Certificate authority (ex. letsencrypt.org). To prevent Certificate Authorities from issuing certificates for this tag enter a semicolon (;). * - ``iodef`` - string - No - - - Enter an email address or url to receive IODEF incident reports. See [RFC6546] for more information regarding url reporting. \* indicates that it's actually required, but probably already has a valid default value. Action: ``addCNAME`` -------------------- :Added in Version: 4.8.0-393 :Description: Add a CNAME record to a zone. Input Parameters ^^^^^^^^^^^^^^^^^ .. list-table:: :widths: auto :header-rows: 1 * - Name - Type - Required? - Example Values - Default Values - Notes * - ``zone_id`` - integer - Yes - - - * - ``host`` - string - No* - - {domain} - * - ``ttl`` - integer - No* - - 43200 - TTL, or Time To Live, is the number of seconds that a record will be considered valid by a server caching the information. - *In Seconds* * - ``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 :Description: Add an MX record to a zone. Input Parameters ^^^^^^^^^^^^^^^^^ .. list-table:: :widths: auto :header-rows: 1 * - Name - Type - Required? - Example Values - Default Values - Notes * - ``zone_id`` - integer - Yes - - - * - ``host`` - string - No* - - {domain} - * - ``ttl`` - integer - No* - - 43200 - TTL, or Time To Live, is the number of seconds that a record will be considered valid by a server caching the information. - *In Seconds* * - ``preference`` - integer - Yes - - - An integer, ranging from 0-65535, indicating the order in which records should be attempted. Lower numbers will be processed before higher ones. * - ``mail_server`` - string - Yes - - - \* indicates that it's actually required, but probably already has a valid default value. Action: ``addNAPTR`` -------------------- :Added in Version: 4.8.0-393 :Description: Add an NAPTR record to a zone. Input Parameters ^^^^^^^^^^^^^^^^^ .. list-table:: :widths: auto :header-rows: 1 * - Name - Type - Required? - Example Values - Default Values - Notes * - ``zone_id`` - integer - Yes - - - * - ``domain`` - string - No* - - {domain} - * - ``ttl`` - integer - No* - - 43200 - TTL, or Time To Live, is the number of seconds that a record will be considered valid by a server caching the information. - *In Seconds* * - ``order`` - integer - No* - - 10 - An integer, ranging from 0-65535, indicating the order in which records MUST be processed by a client. Lower numbers will be processed before higher ones. Once a client has matched a record, that client will stop looking for records with a higher order. * - ``preference`` - integer - No* - - 100 - An integer, ranging from 0-65535, indicating the order in which records SHOULD be processed by a client. Lower numbers will be processed before higher ones. Once a client has matched a record, that client may consider records with a higher Preference. This is similar to the preference of an MX record. * - ``flag`` - string - Yes - S, A, U, P - - * - ``service`` - string - No - - - * - ``regex`` - string - No - - - * - ``replacement`` - string - No - - - The next name to query for additional records. This must be a Fully Qualified Domain Name (FQDN). \* indicates that it's actually required, but probably already has a valid default value. Action: ``addNS`` ----------------- :Added in Version: 4.8.0-393 :Description: Add an NS record to a zone. Input Parameters ^^^^^^^^^^^^^^^^^ .. list-table:: :widths: auto :header-rows: 1 * - Name - Type - Required? - Example Values - Default Values - Notes * - ``zone_id`` - integer - Yes - - - * - ``host`` - string - No* - - {domain} - * - ``ttl`` - integer - No* - - 43200 - TTL, or Time To Live, is the number of seconds that a record will be considered valid by a server caching the information. - *In Seconds* * - ``nameserver`` - string - Yes - - - \* indicates that it's actually required, but probably already has a valid default value. Action: ``addPTR`` ------------------ :Added in Version: 4.8.0-393 :Description: Add a PTR record to a zone. Input Parameters ^^^^^^^^^^^^^^^^^ .. list-table:: :widths: auto :header-rows: 1 * - Name - Type - Required? - Example Values - Default Values - Notes * - ``zone_id`` - integer - Yes - - - * - ``ip_data`` - string - No* - - - The IP Data for a PTR record can be entered in several formats. * - ``ttl`` - integer - No* - - 43200 - TTL, or Time To Live, is the number of seconds that a record will be considered valid by a server caching the information. - *In Seconds* * - ``domain`` - string - No* - - {domain} - \* indicates that it's actually required, but probably already has a valid default value. Action: ``addSOA`` ------------------ :Added in Version: 4.8.0-393 :Description: Add an SOA record to a zone. Input Parameters ^^^^^^^^^^^^^^^^^ .. list-table:: :widths: auto :header-rows: 1 * - Name - Type - Required? - Example Values - Default Values - Notes * - ``zone_id`` - integer - Yes - - - * - ``host`` - string - No* - - {domain} - * - ``nameserver`` - string - Yes - - - Enter the primary nameserver of your domain. This will almost always be handled automatically for you when creating SiteWorx accounts, and you are urged to only alter this value if you know what you are doing. This nameserver is listed on your SOA record for this domain, and setting it to an incorrect value could cause your site or any of your DNS records not to function properly. * - ``email`` - string - Yes - - - This is the email address listed on your SOA record. Enter it as a normal email address (user@domain.com) and not in the typical SOA style of (user.domain.com). * - ``refresh`` - integer - Yes - - - Sets the number of seconds that a slave will cache the record before re-checking the primary server. Recommended values are between 1200 (twenty minutes) and 43200 (twelve hours). - *In Seconds* * - ``retry`` - integer - Yes - - - Set the number of seconds to retry a refresh after the previous refresh attempt fails. Recommended values are between 180 (three minutes) and 900 (fifteen minutes). - *In Seconds* * - ``expiration`` - integer - Yes - - - Set the number of seconds for refresh and retry attempts before the server will stop serving the zone. Per RFC 1912, recommended values are between 1209600 (two weeks) and 2419200 (four weeks). This value is only used by slave servers. - *In Seconds* * - ``negative_ttl`` - integer - Yes - - - Time in seconds for negative answers (NXDOMAIN) from this zone. This field was redefined in 1998 by RFC2308. Suggested values are between 3600 (one hour) and 10800 (three hours). Values higher than 86400 (twenty-four hours) should be avoided. - *In Seconds* \* indicates that it's actually required, but probably already has a valid default value. Action: ``addSPF`` ------------------ :Added in Version: 4.8.0-393 :Description: Add an SPF record to a zone. Input Parameters ^^^^^^^^^^^^^^^^^ .. list-table:: :widths: auto :header-rows: 1 * - Name - Type - Required? - Example Values - Default Values - Notes * - ``zone_id`` - integer - Yes - - - * - ``host`` - string - No* - - {domain} - * - ``ttl`` - integer - No* - - 43200 - TTL, or Time To Live, is the number of seconds that a record will be considered valid by a server caching the information. - *In Seconds* * - ``spf_record_value`` - string - No - - - * - ``spf_version`` - string - No* - v=spf1, v=spf3 - v=spf1 - * - ``use_a`` - integer - No* - 1, 0 - 0 - Should the IP(s) referenced in DNS A Records for this domain be permitted to send mail? * - ``use_mx`` - integer - No* - 1, 0 - 0 - Should the hostnames referenced in DNS MX Records for this domain be permitted to send mail? * - ``use_ptr`` - integer - No* - 1, 0 - 0 - Should the PTR Records for the sender's IP be used to validate the sender's domain? NOT RECOMMENDED. * - ``other_servers`` - integer - No* - 1, 0 - 0 - Do any other hostnames or IPs need to be authorized to send mail for this domain? * - ``mechanism_a`` - struct (string) - No - - - If the domain name has an address record (A or AAAA) that can be resolved to the sender's address, it will match. * - ``mechanism_mx`` - struct (string) - No - - - 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). * - ``mechanism_ip4`` - struct (string) - No - - - If the sender is in a given IPv4 range, match. * - ``mechanism_ip6`` - struct (string) - No - - - If the sender is in a given IPv6 range, match. * - ``mechanism_ptr`` - struct (string) - No - - - 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. * - ``mechanism_exists`` - struct (string) - No - - - If there is a valid A Record for the given domain, match. Input may use macro-expansion. * - ``mechanism_include`` - struct (string) - No - - - Used to include the policies of another domain's SPF record. Similar to the 'Redirect' parameter. * - ``all`` - string - No - -all, ~all, ?all, +all - - Defines how to respond if the record has produced no match. * - ``redirect`` - string - No - - - 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. * - ``explanation`` - string - No - - - Defines a DNS name whose TXT Record may be returned along with failure messages. Rarely used, may not be universally supported. \* indicates that it's actually required, but probably already has a valid default value. Action: ``addSRV`` ------------------ :Added in Version: 4.8.0-393 :Description: Add an SRV record to a zone. Input Parameters ^^^^^^^^^^^^^^^^^ .. list-table:: :widths: auto :header-rows: 1 * - Name - Type - Required? - Example Values - Default Values - Notes * - ``zone_id`` - integer - Yes - - - * - ``service`` - string - Yes - - - The symbolic name of the desired service. For example, _sip, _ldap, etc. * - ``protocol`` - string - Yes - - - The name of the protocol with an underscore prepended to avoid collisions with other DNS records. "_TCP" and "_UDP" are the two most common values. * - ``domain`` - string - No* - - {domain} - * - ``ttl`` - integer - No* - - 43200 - TTL, or Time To Live, is the number of seconds that a record will be considered valid by a server caching the information. - *In Seconds* * - ``priority`` - integer - Yes - - - * - ``weight`` - integer - Yes - - - * - ``port`` - integer - Yes - - - * - ``target`` - string - Yes - - - \* indicates that it's actually required, but probably already has a valid default value. Action: ``addTXT`` ------------------ :Added in Version: 4.8.0-393 :Description: Add a TXT record to a zone. Input Parameters ^^^^^^^^^^^^^^^^^ .. list-table:: :widths: auto :header-rows: 1 * - Name - Type - Required? - Example Values - Default Values - Notes * - ``zone_id`` - integer - Yes - - - * - ``host`` - string - No* - - {domain} - * - ``ttl`` - integer - No* - - 43200 - TTL, or Time To Live, is the number of seconds that a record will be considered valid by a server caching the information. - *In Seconds* * - ``text`` - string - Yes - - - \* indicates that it's actually required, but probably already has a valid default value. Action: ``delete`` ------------------ :Added in Version: 4.7.0-339 :Description: Delete a DNS record. Input Parameters ^^^^^^^^^^^^^^^^^ .. list-table:: :widths: auto :header-rows: 1 * - Name - Type - Required? - Example Values - Default Values - Notes * - ``record_id`` - struct (integer) - Yes - - - Action: ``edit`` ---------------- :Added in Version: 4.7.0-339 :Description: Edit a DNS record. .. warning:: This action has been deprecated as of version 4.8.0-393. 2011-02-23 Use the individual edit(record-type) functions instead. Input Parameters ^^^^^^^^^^^^^^^^^ .. list-table:: :widths: auto :header-rows: 1 * - Name - Type - Required? - Example Values - Default Values - Notes * - ``record_id`` - integer - Yes - - - * - ``host`` - string - No* - - {domain} - * - ``type`` - string - No* - A, CNAME, NS, MX, PTR, TXT, SOA, SPF, SRV, AAAA, NAPTR, CAA - SOA - * - ``target`` - string - No* - - {domain} hostmaster@{domain} 7200 300 1209600 10800 - * - ``ttl`` - integer - No* - - 43200 - TTL, or Time To Live, is the number of seconds that a record will be considered valid by a server caching the information. \* indicates that it's actually required, but probably already has a valid default value. Action: ``editA`` ----------------- :Added in Version: 4.7.0-339 :Description: Edit an A record. Input Parameters ^^^^^^^^^^^^^^^^^ .. list-table:: :widths: auto :header-rows: 1 * - Name - Type - Required? - Example Values - Default Values - Notes * - ``record_id`` - integer - Yes - - - * - ``host`` - string - No* - - {domain} - * - ``ttl`` - integer - No* - - 43200 - TTL, or Time To Live, is the number of seconds that a record will be considered valid by a server caching the information. - *In Seconds* * - ``ipaddress`` - string - No* - - {ipv4} - The IPv4 address for use with this record. '{ipv4}' can be used as a special place-holder for the current IP address of the domain as assigned in InterWorx. \* indicates that it's actually required, but probably already has a valid default value. Action: ``editAAAA`` -------------------- :Added in Version: 4.8.0-393 :Description: Edit an AAAA record. Input Parameters ^^^^^^^^^^^^^^^^^ .. list-table:: :widths: auto :header-rows: 1 * - Name - Type - Required? - Example Values - Default Values - Notes * - ``record_id`` - integer - Yes - - - * - ``host`` - string - No* - - {domain} - * - ``ttl`` - integer - No* - - 43200 - TTL, or Time To Live, is the number of seconds that a record will be considered valid by a server caching the information. - *In Seconds* * - ``ipaddress`` - string - No* - - {ipv6} - The IPv6 address for use with this record. '{ipv6}' can be used as a special place-holder for the current IPv6 address of the domain as assigned in InterWorx. \* indicates that it's actually required, but probably already has a valid default value. Action: ``editCAA`` ------------------- :Added in Version: 6.0.8-1363 :Description: Edit a CAA record. Input Parameters ^^^^^^^^^^^^^^^^^ .. list-table:: :widths: auto :header-rows: 1 * - Name - Type - Required? - Example Values - Default Values - Notes * - ``record_id`` - integer - Yes - - - * - ``domain`` - string - No* - - example.com - * - ``ttl`` - integer - No* - - 43200 - TTL, or Time To Live, is the number of seconds that a record will be considered valid by a server caching the information. - *In Seconds* * - ``flags`` - integer - No* - 0, 128 - 0 - Issuer Critical Flag: If the "flags" value is set to '1', the critical flag is asserted and the property MUST be understood if the CAA record is to be correctly processed by a certificate issuer. A Certification Authority MUST NOT issue certificates for any Domain that contains a CAA critical property for an unknown or unsupported property tag that for which the issuer critical flag is set. See: RFC6844 * - ``tag`` - string - No* - issue, issuewild, iodef - issue - Property tags define the meaning of the CAA record. Three are currently supported, but more may be added in the future.

issue:This tag is used to allow/disallow the Certificate Authority to issue certificates for the domain, including wildcard certificates.

issuewild: This tag is used to allow/disallow wildcard certificates issuance for the domain.

iodef: This tag specifies a method for CAs to report to the domain holder when a certificate is issued. Not all CAs support this tag, so there is no guarantee that all certificate issuances will be reported.

* - ``issue`` - string - No - comodoca.com, digicert.com, entrust.net, globalsign.com, izenpe.com, letsencrypt.org, symantec.com, trustwave.com, wosign.com, ; - ca.example.net - Enter the domain of the Certificate authority (ex. letsencrypt.org). To prevent Certificate Authorities from issuing certificates for this tag enter a semicolon (;). * - ``issuewild`` - string - No - comodoca.com, digicert.com, entrust.net, globalsign.com, izenpe.com, letsencrypt.org, symantec.com, trustwave.com, wosign.com, ; - - Enter the domain of the Certificate authority (ex. letsencrypt.org). To prevent Certificate Authorities from issuing certificates for this tag enter a semicolon (;). * - ``iodef`` - string - No - - - Enter an email address or url to receive IODEF incident reports. See [RFC6546] for more information regarding url reporting. \* indicates that it's actually required, but probably already has a valid default value. Action: ``editCNAME`` --------------------- :Added in Version: 4.8.0-393 :Description: Edit a CNAME record. Input Parameters ^^^^^^^^^^^^^^^^^ .. list-table:: :widths: auto :header-rows: 1 * - Name - Type - Required? - Example Values - Default Values - Notes * - ``record_id`` - integer - Yes - - - * - ``host`` - string - No* - - www.{domain} - * - ``ttl`` - integer - No* - - 43200 - TTL, or Time To Live, is the number of seconds that a record will be considered valid by a server caching the information. - *In Seconds* * - ``alias`` - string - No* - - {domain} - \* indicates that it's actually required, but probably already has a valid default value. Action: ``editMX`` ------------------ :Added in Version: 4.8.0-393 :Description: Edit a MX record. Input Parameters ^^^^^^^^^^^^^^^^^ .. list-table:: :widths: auto :header-rows: 1 * - Name - Type - Required? - Example Values - Default Values - Notes * - ``record_id`` - integer - Yes - - - * - ``host`` - string - No* - - {domain} - * - ``ttl`` - integer - No* - - 43200 - TTL, or Time To Live, is the number of seconds that a record will be considered valid by a server caching the information. - *In Seconds* * - ``preference`` - integer - No* - - 10 - An integer, ranging from 0-65535, indicating the order in which records should be attempted. Lower numbers will be processed before higher ones. * - ``mail_server`` - string - No* - - mail.{domain} - \* indicates that it's actually required, but probably already has a valid default value. Action: ``editNAPTR`` --------------------- :Added in Version: 4.8.0-393 :Description: Edit a NAPTR record. Input Parameters ^^^^^^^^^^^^^^^^^ .. list-table:: :widths: auto :header-rows: 1 * - Name - Type - Required? - Example Values - Default Values - Notes * - ``record_id`` - integer - Yes - - - * - ``domain`` - string - No* - - example.com - * - ``ttl`` - integer - No* - - 43200 - TTL, or Time To Live, is the number of seconds that a record will be considered valid by a server caching the information. - *In Seconds* * - ``order`` - integer - No* - - 10 - An integer, ranging from 0-65535, indicating the order in which records MUST be processed by a client. Lower numbers will be processed before higher ones. Once a client has matched a record, that client will stop looking for records with a higher order. * - ``preference`` - integer - No* - - 100 - An integer, ranging from 0-65535, indicating the order in which records SHOULD be processed by a client. Lower numbers will be processed before higher ones. Once a client has matched a record, that client may consider records with a higher Preference. This is similar to the preference of an MX record. * - ``flag`` - string - No* - S, A, U, P - S - * - ``service`` - string - No - - - * - ``regex`` - string - No - - !^.\*$!sip:info@example.com! - * - ``replacement`` - string - No - - _sip._udp.example.com - The next name to query for additional records. This must be a Fully Qualified Domain Name (FQDN). \* indicates that it's actually required, but probably already has a valid default value. Action: ``editNS`` ------------------ :Added in Version: 4.8.0-393 :Description: Edit a NS record. Input Parameters ^^^^^^^^^^^^^^^^^ .. list-table:: :widths: auto :header-rows: 1 * - Name - Type - Required? - Example Values - Default Values - Notes * - ``record_id`` - integer - Yes - - - * - ``host`` - string - No* - - {domain} - * - ``ttl`` - integer - No* - - 43200 - TTL, or Time To Live, is the number of seconds that a record will be considered valid by a server caching the information. - *In Seconds* * - ``nameserver`` - string - No* - - ns7.interworx.com - \* indicates that it's actually required, but probably already has a valid default value. Action: ``editPTR`` ------------------- :Added in Version: 4.8.0-393 :Description: Edit a PTR record. Input Parameters ^^^^^^^^^^^^^^^^^ .. list-table:: :widths: auto :header-rows: 1 * - Name - Type - Required? - Example Values - Default Values - Notes * - ``record_id`` - integer - Yes - - - * - ``ip_data`` - string - No* - - 4.3.2.1.in-addr.arpa - The IP Data for a PTR record can be entered in several formats. * - ``ttl`` - integer - No* - - 43200 - TTL, or Time To Live, is the number of seconds that a record will be considered valid by a server caching the information. - *In Seconds* * - ``domain`` - string - No* - - example.com - \* indicates that it's actually required, but probably already has a valid default value. Action: ``editSOA`` ------------------- :Added in Version: 4.8.0-393 :Description: Edit an SOA record. Input Parameters ^^^^^^^^^^^^^^^^^ .. list-table:: :widths: auto :header-rows: 1 * - Name - Type - Required? - Example Values - Default Values - Notes * - ``record_id`` - integer - Yes - - - * - ``nameserver`` - string - No* - - {domain} - Enter the primary nameserver of your domain. This will almost always be handled automatically for you when creating SiteWorx accounts, and you are urged to only alter this value if you know what you are doing. This nameserver is listed on your SOA record for this domain, and setting it to an incorrect value could cause your site or any of your DNS records not to function properly. * - ``email`` - string - No* - - hostmaster@{domain} - This is the email address listed on your SOA record. Enter it as a normal email address (user@domain.com) and not in the typical SOA style of (user.domain.com). * - ``refresh`` - integer - No* - - 7200 - Sets the number of seconds that a slave will cache the record before re-checking the primary server. Recommended values are between 1200 (twenty minutes) and 43200 (twelve hours). - *In Seconds* * - ``retry`` - integer - No* - - 300 - Set the number of seconds to retry a refresh after the previous refresh attempt fails. Recommended values are between 180 (three minutes) and 900 (fifteen minutes). - *In Seconds* * - ``expiration`` - integer - No* - - 1209600 - Set the number of seconds for refresh and retry attempts before the server will stop serving the zone. Per RFC 1912, recommended values are between 1209600 (two weeks) and 2419200 (four weeks). This value is only used by slave servers. - *In Seconds* * - ``negative_ttl`` - integer - No* - - 10800 - Time in seconds for negative answers (NXDOMAIN) from this zone. This field was redefined in 1998 by RFC2308. Suggested values are between 3600 (one hour) and 10800 (three hours). Values higher than 86400 (twenty-four hours) should be avoided. - *In Seconds* \* indicates that it's actually required, but probably already has a valid default value. Action: ``editSPF`` ------------------- :Added in Version: 4.8.0-393 :Description: Edit an SPF record. Input Parameters ^^^^^^^^^^^^^^^^^ .. list-table:: :widths: auto :header-rows: 1 * - Name - Type - Required? - Example Values - Default Values - Notes * - ``record_id`` - integer - Yes - - - * - ``host`` - string - No* - - example.com - * - ``ttl`` - integer - No* - - 43200 - TTL, or Time To Live, is the number of seconds that a record will be considered valid by a server caching the information. - *In Seconds* * - ``spf_record_value`` - string - No - - v=spf1 - * - ``spf_version`` - string - No* - v=spf1, v=spf3 - v=spf1 - * - ``use_a`` - integer - No* - 1, 0 - 0 - Should the IP(s) referenced in DNS A Records for this domain be permitted to send mail? * - ``use_mx`` - integer - No* - 1, 0 - 0 - Should the hostnames referenced in DNS MX Records for this domain be permitted to send mail? * - ``use_ptr`` - integer - No* - 1, 0 - 0 - Should the PTR Records for the sender's IP be used to validate the sender's domain? NOT RECOMMENDED. * - ``other_servers`` - integer - No* - 1, 0 - 0 - Do any other hostnames or IPs need to be authorized to send mail for this domain? * - ``mechanism_a`` - struct (string) - No - - - If the domain name has an address record (A or AAAA) that can be resolved to the sender's address, it will match. * - ``mechanism_mx`` - struct (string) - No - - - 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). * - ``mechanism_ip4`` - struct (string) - No - - - If the sender is in a given IPv4 range, match. * - ``mechanism_ip6`` - struct (string) - No - - - If the sender is in a given IPv6 range, match. * - ``mechanism_ptr`` - struct (string) - No - - - 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. * - ``mechanism_exists`` - struct (string) - No - - - If there is a valid A Record for the given domain, match. Input may use macro-expansion. * - ``mechanism_include`` - struct (string) - No - - - Used to include the policies of another domain's SPF record. Similar to the 'Redirect' parameter. * - ``all`` - string - No - -all, ~all, ?all, +all - - Defines how to respond if the record has produced no match. * - ``redirect`` - string - No - - - 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. * - ``explanation`` - string - No - - - Defines a DNS name whose TXT Record may be returned along with failure messages. Rarely used, may not be universally supported. \* indicates that it's actually required, but probably already has a valid default value. Action: ``editSRV`` ------------------- :Added in Version: 4.8.0-393 :Description: Edit an SRV record. Input Parameters ^^^^^^^^^^^^^^^^^ .. list-table:: :widths: auto :header-rows: 1 * - Name - Type - Required? - Example Values - Default Values - Notes * - ``record_id`` - integer - Yes - - - * - ``service`` - string - No* - - _sip - The symbolic name of the desired service. For example, _sip, _ldap, etc. * - ``protocol`` - string - No* - - _tcp - The name of the protocol with an underscore prepended to avoid collisions with other DNS records. "_TCP" and "_UDP" are the two most common values. * - ``domain`` - string - No* - - example.com - * - ``ttl`` - integer - No* - - 43200 - TTL, or Time To Live, is the number of seconds that a record will be considered valid by a server caching the information. - *In Seconds* * - ``priority`` - integer - No* - - 10 - * - ``weight`` - integer - No* - - 100 - * - ``port`` - integer - No* - - 5060 - * - ``target`` - string - No* - - www.google.com - \* indicates that it's actually required, but probably already has a valid default value. Action: ``editTXT`` ------------------- :Added in Version: 4.8.0-393 :Description: Edit a TXT record. Input Parameters ^^^^^^^^^^^^^^^^^ .. list-table:: :widths: auto :header-rows: 1 * - Name - Type - Required? - Example Values - Default Values - Notes * - ``record_id`` - integer - Yes - - - * - ``host`` - string - No* - - example.com - * - ``ttl`` - integer - No* - - 43200 - TTL, or Time To Live, is the number of seconds that a record will be considered valid by a server caching the information. - *In Seconds* * - ``text`` - string - No* - - example text record - \* indicates that it's actually required, but probably already has a valid default value. Action: ``fail`` ---------------- :Added in Version: n/a :Description: Magic function - test for failure mechanism. Action: ``listRecordIds`` ------------------------- :Added in Version: 4.7.0-339 :Description: List dns records by id. .. warning:: This action has been deprecated as of version 4.1.0-247. 2009-12-07 use listRecords Sample Output ^^^^^^^^^^^^^ .. code-block:: array ( 'status' => 0, 'payload' => array ( 0 => array ( 0 => '1', 1 => '{domain} | SOA | {domain} hostmaster@{domain} 7200 300 1209600 10800', ), 1 => array ( 0 => '2', 1 => '{domain} | A | {ipv4}', ), 2 => array ( 0 => '3', 1 => 'ipv4.{domain} | A | {ipv4}', ), ), 'reply_code' => 205, ) Action: ``listRecords`` ----------------------- :Added in Version: 4.7.0-339 :Description: List dns records by id. Sample Output ^^^^^^^^^^^^^ .. code-block:: array ( 'status' => 0, 'payload' => array ( 0 => array ( 'record_id' => '2', 'zone_id' => '1', 'domain' => '1.dns-template.com', 'type' => 'A', 'host' => '{domain}', 'target' => '{ipv4}', 'ttl' => '43200', 'last_update' => '1578808273', 'is_template' => '1', ), 1 => array ( 'record_id' => '3', 'zone_id' => '1', 'domain' => '1.dns-template.com', 'type' => 'A', 'host' => 'ipv4.{domain}', 'target' => '{ipv4}', 'ttl' => '43200', 'last_update' => '1578808273', 'is_template' => '1', ), 2 => array ( 'record_id' => '9', 'zone_id' => '1', 'domain' => '1.dns-template.com', 'type' => 'A', 'host' => 'mail.{domain}', 'target' => '{ipv4}', 'ttl' => '43200', 'last_update' => '1578808273', 'is_template' => '1', ), ), 'reply_code' => 205, ) Action: ``queryEditA`` ---------------------- :Added in Version: 5.1.0-838 :Description: Displays the information available to the action "editA". Input Parameters ^^^^^^^^^^^^^^^^^ .. list-table:: :widths: auto :header-rows: 1 * - Name - Type - Required? - Example Values - Default Values - Notes * - ``record_id`` - integer - Yes - - - Sample Output ^^^^^^^^^^^^^ .. code-block:: array ( 'status' => 0, 'payload' => array ( 'host' => '1.dns-template.com', 'ttl' => '43200', 'ipaddress' => '1.1.1.1', 'record_id' => '2', ), 'reply_code' => 205, ) Action: ``queryEditAAAA`` ------------------------- :Added in Version: 5.1.0-838 :Description: Displays the information available to the action "editAAAA". Sample Output ^^^^^^^^^^^^^ .. code-block:: array ( 'status' => 0, 'payload' => array ( 'host' => '1.dns-template.com', 'ttl' => '43200', 'ipaddress' => '1::1', 'record_id' => '4', ), 'reply_code' => 205, ) Action: ``queryEditCAA`` ------------------------ :Added in Version: 6.0.8-1363 :Description: Displays the information available to the action "editCAA". Sample Output ^^^^^^^^^^^^^ .. code-block:: array ( 'status' => 0, 'payload' => array ( 'domain' => 'example.com', 'ttl' => '43200', 'flags' => '0', 'tag' => 'issue', 'issue' => 'ca.example.net', 'issuewild' => '', 'iodef' => '', 'record_id' => '36', ), 'reply_code' => 205, ) Action: ``queryEditCNAME`` -------------------------- :Added in Version: 5.1.0-838 :Description: Displays the information available to the action "editCNAME". Sample Output ^^^^^^^^^^^^^ .. code-block:: array ( 'status' => 0, 'payload' => array ( 'host' => 'www.1.dns-template.com', 'ttl' => '43200', 'alias' => '1.dns-template.com', 'record_id' => '6', ), 'reply_code' => 205, ) Action: ``queryEditMX`` ----------------------- :Added in Version: 5.1.0-838 :Description: Displays the information available to the action "editMX". Sample Output ^^^^^^^^^^^^^ .. code-block:: array ( 'status' => 0, 'payload' => array ( 'host' => '1.dns-template.com', 'ttl' => '43200', 'preference' => '10', 'mail_server' => 'mail.1.dns-template.com', 'record_id' => '8', ), 'reply_code' => 205, ) Action: ``queryEditNAPTR`` -------------------------- :Added in Version: 5.1.0-838 :Description: Displays the information available to the action "editNAPTR". Sample Output ^^^^^^^^^^^^^ .. code-block:: array ( 'status' => 0, 'payload' => array ( 'domain' => 'example.com', 'ttl' => '43200', 'order' => '10', 'preference' => '100', 'flag' => 'S', 'service' => '', 'regex' => '!^.*$!sip:info@example.com!', 'replacement' => '_sip._udp.example.com', 'record_id' => '35', ), 'reply_code' => 205, ) Action: ``queryEditNS`` ----------------------- :Added in Version: 5.1.0-838 :Description: Displays the information available to the action "editNS". Sample Output ^^^^^^^^^^^^^ .. code-block:: array ( 'status' => 0, 'payload' => array ( 'host' => '1.dns-template.com', 'ttl' => '43200', 'nameserver' => 'ns7.interworx.com', 'record_id' => '13', ), 'reply_code' => 205, ) Action: ``queryEditPTR`` ------------------------ :Added in Version: 5.1.0-838 :Description: Displays the information available to the action "editPTR". Sample Output ^^^^^^^^^^^^^ .. code-block:: array ( 'status' => 0, 'payload' => array ( 'ip_data' => '4.3.2.1.in-addr.arpa', 'ttl' => '43200', 'domain' => 'example.com', 'record_id' => '37', ), 'reply_code' => 205, ) Action: ``queryEditSOA`` ------------------------ :Added in Version: 5.1.0-838 :Description: Displays the information available to the action "editSOA". Sample Output ^^^^^^^^^^^^^ .. code-block:: array ( 'status' => 0, 'payload' => array ( 'host' => '1.dns-template.com', 'nameserver' => '1.dns-template.com', 'email' => 'hostmaster@1.dns-template.com', 'refresh' => '7200', 'retry' => '300', 'expiration' => '1209600', 'negative_ttl' => '10800', 'record_id' => '1', ), 'reply_code' => 205, ) Action: ``queryEditSPF`` ------------------------ :Added in Version: 5.1.0-838 :Description: Displays the information available to the action "editSPF". Sample Output ^^^^^^^^^^^^^ .. code-block:: array ( 'status' => 0, 'payload' => array ( 'host' => 'example.com', 'ttl' => '43200', 'spf_record_value' => 'v=spf1', 'spf_version' => 'v=spf1', 'use_a' => '0', 'use_mx' => '0', 'use_ptr' => '0', 'other_servers' => '0', 'mechanism_a' => array ( ), 'mechanism_mx' => array ( ), 'mechanism_ip4' => array ( ), 'mechanism_ip6' => array ( ), 'mechanism_ptr' => array ( ), 'mechanism_exists' => array ( ), 'mechanism_include' => array ( ), 'all' => NULL, 'redirect' => '', 'explanation' => NULL, 'record_id' => '38', ), 'reply_code' => 205, ) Action: ``queryEditSRV`` ------------------------ :Added in Version: 5.1.0-838 :Description: Displays the information available to the action "editSRV". Sample Output ^^^^^^^^^^^^^ .. code-block:: array ( 'status' => 0, 'payload' => array ( 'service' => '_sip', 'protocol' => '_tcp', 'domain' => 'example.com', 'ttl' => '43200', 'priority' => '10', 'weight' => '100', 'port' => '5060', 'target' => 'www.google.com', 'record_id' => '39', ), 'reply_code' => 205, ) Action: ``queryEditTXT`` ------------------------ :Added in Version: 5.1.0-838 :Description: Displays the information available to the action "editTXT". Sample Output ^^^^^^^^^^^^^ .. code-block:: array ( 'status' => 0, 'payload' => array ( 'host' => 'example.com', 'ttl' => '43200', 'text' => 'example text record', 'record_id' => '40', ), 'reply_code' => 205, ) Action: ``queryRecords`` ------------------------ :Added in Version: 4.7.0-339 :Description: Query DNS Records. Input Parameters ^^^^^^^^^^^^^^^^^ .. list-table:: :widths: auto :header-rows: 1 * - Name - Type - Required? - Example Values - Default Values - Notes * - ``zone_id`` - integer - No - - - * - ``domain`` - struct (string) - No - example.com, pointer.com, secondary.com - - * - ``type`` - struct (string) - No - A, CNAME, NS, MX, PTR, TXT, SOA, SPF, SRV, AAAA, NAPTR, CAA - - * - ``last_update`` - string - No - - - * - ``uni`` - integer - No* - 1, 0 - 0 - * - ``show_domain`` - integer - No* - 1, 0 - 1 - \* indicates that it's actually required, but probably already has a valid default value. Action: ``reroute`` ------------------- :Added in Version: n/a :Description: Action to re-route from the current controller to a different one. Action: ``win`` --------------- :Added in Version: n/a :Description: Magic function - test for testing success mechanism.