Note

You are viewing the documentation for an older release of Interworx (8.0). To see documentation for the current generally available release of Interworx, click here: 8.2.

Controller: /siteworx/dns

Required Permissions

DNS

Required Options

Edit DNS Records

Action: add

Added in Version

4.7.0-339

Description

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

Warning

This action has been deprecated as of version 4.8.0-393. 2011-04-05 Use individual add[ type ] functions instead.

Input Parameters

Name

Type

Required?

Example Values

Default Values

Notes

domain

string

Yes

example.com, pointer.com, secondary.com

Action: addA

Added in Version

4.7.0-339

Description

Add an A record.

Input Parameters

Name

Type

Required?

Example Values

Default Values

Notes

zone_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

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.

Input Parameters

Name

Type

Required?

Example Values

Default Values

Notes

zone_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

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.

Input Parameters

Name

Type

Required?

Example Values

Default Values

Notes

zone_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.<br/><br/><b>issue:</b>This tag is used to allow/disallow the Certificate Authority to issue certificates for the domain, including wildcard certificates.<br/><br/><b>issuewild: </b>This tag is used to allow/disallow wildcard certificates issuance for the domain.<br/><br/><b>iodef: </b>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.<br/><br/>

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 <a href=”https://tools.ietf.org/html/rfc6546”>[RFC6546]</a> 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.

Input Parameters

Name

Type

Required?

Example Values

Default Values

Notes

zone_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

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.

Input Parameters

Name

Type

Required?

Example Values

Default Values

Notes

zone_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

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: addSPF

Added in Version

4.8.0-393

Description

Add an SPF record.

Input Parameters

Name

Type

Required?

Example Values

Default Values

Notes

zone_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

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

5.0.15-700

Description

Add an SRV record.

Input Parameters

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*

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

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.

Input Parameters

Name

Type

Required?

Example Values

Default Values

Notes

zone_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

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

Name

Type

Required?

Example Values

Default Values

Notes

record_id

struct (integer)

Yes

confirm_action

struct (integer)

No*

1

* indicates that it’s actually required, but probably already has a valid default value.

Action: editA

Added in Version

4.8.0-393

Description

Edit an A record.

Input Parameters

Name

Type

Required?

Example Values

Default Values

Notes

record_id

integer

Yes

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

* 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

Name

Type

Required?

Example Values

Default Values

Notes

record_id

integer

Yes

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

* 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

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.<br/><br/><b>issue:</b>This tag is used to allow/disallow the Certificate Authority to issue certificates for the domain, including wildcard certificates.<br/><br/><b>issuewild: </b>This tag is used to allow/disallow wildcard certificates issuance for the domain.<br/><br/><b>iodef: </b>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.<br/><br/>

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 <a href=”https://tools.ietf.org/html/rfc6546”>[RFC6546]</a> 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

Name

Type

Required?

Example Values

Default Values

Notes

record_id

integer

Yes

host

string

No*

www.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

alias

string

No*

example.com

* 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 an MX record.

Input Parameters

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

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.example.com

* 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

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

5.0.15-700

Description

Edit an SRV record.

Input Parameters

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

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: listZones

Added in Version

4.9.3-435

Description

List Dns Zones.

Sample Output

array (
  'status' => 0,
  'payload' =>
  array (
    0 =>
    array (
      'zone_id' => 2,
      'domain' => 'example.com',
      'nodeworx_id' => 1,
      'is_suspended' => 0,
      'domain_type' => 'master',
      'master_domain' => 'example.com',
    ),
    1 =>
    array (
      'zone_id' => 5,
      'domain' => 'secondary.com',
      'nodeworx_id' => 1,
      'is_suspended' => 0,
      'domain_type' => 'slave',
      'master_domain' => 'example.com',
    ),
    2 =>
    array (
      'zone_id' => 4,
      'domain' => 'pointer.com',
      'nodeworx_id' => 1,
      'is_suspended' => 0,
      'domain_type' => 'redirect',
      'master_domain' => 'example.com',
    ),
  ),
  'reply_code' => 205,
)

Action: queryDnsRecords

Added in Version

4.8.0-393

Description

List DNS Records that are part of the zone.

Input Parameters

Name

Type

Required?

Example Values

Default Values

Notes

zone_id

integer

No*

uni

integer

No*

1, 0

0

* indicates that it’s actually required, but probably already has a valid default value.

Action: queryEditA

Added in Version

5.1.0-838

Description

Displays the information available to the action “editA”.

Input Parameters

Name

Type

Required?

Example Values

Default Values

Notes

record_id

integer

Yes

Sample Output

array (
  'status' => 0,
  'payload' =>
  array (
    'host' => 'example.com',
    'ttl' => '43200',
    'ipaddress' => '192.168.0.3',
    'record_id' => '14',
  ),
  'reply_code' => 205,
)

Action: queryEditAAAA

Added in Version

5.1.0-838

Description

Displays the information available to the action “editAAAA”.

Sample Output

array (
  'status' => 0,
  'payload' =>
  array (
    'host' => 'example.com',
    'ttl' => '43200',
    'ipaddress' => 'bead::1',
    'record_id' => '34',
  ),
  'reply_code' => 205,
)

Action: queryEditCAA

Added in Version

6.0.8-1363

Description

Displays the information available to the action “editCAA”.

Sample Output

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

array (
  'status' => 0,
  'payload' =>
  array (
    'host' => 'www.example.com',
    'ttl' => '43200',
    'alias' => 'example.com',
    'record_id' => '17',
  ),
  'reply_code' => 205,
)

Action: queryEditMX

Added in Version

5.1.0-838

Description

Displays the information available to the action “editMX”.

Sample Output

array (
  'status' => 0,
  'payload' =>
  array (
    'host' => 'example.com',
    'ttl' => '43200',
    'preference' => '10',
    'mail_server' => 'mail.example.com',
    'record_id' => '21',
  ),
  'reply_code' => 205,
)

Action: queryEditSPF

Added in Version

5.1.0-838

Description

Displays the information available to the action “editSPF”.

Sample Output

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

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

array (
  'status' => 0,
  'payload' =>
  array (
    'host' => 'example.com',
    'ttl' => '43200',
    'text' => 'example text record',
    'record_id' => '40',
  ),
  'reply_code' => 205,
)

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.