Overview
Error Handling

Methods

API Documentation (API Version v1)

Network/DNS/Record/

DESCRIPTION

Each DNS zone contains multiple Resource Records, which are the guts of DNS. Each record can point an domain name to an IP, a subdomain to another domain, etc.

This section of the API allows interaction with all the various Resource Records in your zones.

create

URL:

https://api.stormondemand.com/v1/Network/DNS/Record/create

Description:

This method is used to add new resource records (RRs) to a zone.

The returned data will be an associative array of the fields of the record, and will include any parsed rdata fields in that associateve array, such as the priority and exchange fields of an MX record.

In the v1 api, the prio field is considered seperate from rdata, and should be specified seperately, but in the bleed version and future numbered versions of the api, the prio field is considered part of the record data, and should be included there if appropriate for the record.

Fields: zone_id: The id of the zone that you are creating the record in. zone: The name of the zone that you are creating the record in. name: The name field of the record itself. type: The type of the record, which must a valid DNS record type. ttl: The Time To Live for the record. prio: The priority field for the record. This field applies to MX and SRV records. rdata: The Record Data associated with this DNS record. The exact contents are dependent on record type.

Parameters:

ParameterTypeNotes
nameA string permitting tabs, carriage returns and newlines* Required
prioA non-negative integer value (i.e. 0 and up).
rdataA string permitting tabs, carriage returns and newlines* Required
ttlA positive integer value (i.e. 1 and up).
typeA valid DNS resource record type* Required
zoneEither: a valid forward DNS Zone name.; or a valid reverse DNS zone.* Required if:
  • zone_id is not given
zone_idA positive integer value (i.e. 1 and up).* Required if:
  • zone is not given

Returns:

FieldTypeNotes
adminEmailEither: a valid email address.; or a valid admin email for an SOA record.* Optional
exchangeA valid hostname (Fully qualified domain name, consisting only of letters, digits and '-')* Optional
expiryA non-negative integer value (i.e. 0 and up).* Optional
fullDataA string.* Optional
idA positive integer value (i.e. 1 and up).
minimumA non-negative integer value (i.e. 0 and up).* Optional
nameEither: a valid domain name (max 127 labels, each between 1 and 63 characters, totaling no more than 253 characters); or a valid reverse ipv4 DNS record.; or a valid reverse ipv6 DNS record.; or a valid hostname (Fully qualified domain name, consisting only of letters, digits and '-'); or a wildcard, represented by '*.domain'.
nameserverEither: a valid hostname (Fully qualified domain name, consisting only of letters, digits and '-'); or a valid nameserver in an SOA record.* Optional
portA positive integer value (i.e. 1 and up).* Optional
prioA non-negative integer value (i.e. 0 and up).* Optional
rdataA string.
refreshIntervalA non-negative integer value (i.e. 0 and up).* Optional
regionOverridesAn array of associative arrays containing
 
rdataA string permitting tabs, carriage returns and newlines
regionA string permitting tabs, carriage returns and newlines
region_idA positive integer value (i.e. 1 and up).
retryA non-negative integer value (i.e. 0 and up).* Optional
serialA positive integer value (i.e. 1 and up).* Optional
targetA valid hostname (Fully qualified domain name, consisting only of letters, digits and '-')* Optional
ttlA positive integer value (i.e. 1 and up).* Optional
typeOne of: 'A', 'AAAA', 'CNAME', 'MX', 'NS', 'PTR', 'SOA', 'SRV', 'TXT'
weightA non-negative integer value (i.e. 0 and up).* Optional
zone_idA positive integer value (i.e. 1 and up).

Possible Errors:

Refer to the Error Handling documentation for the list of exception types

delete

URL:

https://api.stormondemand.com/v1/Network/DNS/Record/delete

Description:

This method is used to delete resource records (RRs) from a zone file It returns the 'deleted' field, whose value is the records id field.

Parameters:

ParameterTypeNotes
idA positive integer value (i.e. 1 and up).* Required

Returns:

FieldType
deletedA positive integer value (i.e. 1 and up).

Possible Errors:

Refer to the Error Handling documentation for the list of exception types

details

URL:

https://api.stormondemand.com/v1/Network/DNS/Record/details

Description:

Retrieve details about a particular resource record.

The returned structure is an associative array of the details of the record, with additional fields added to represent the derived meaning of the rdata field.

For example, an MX record will have a field present for the exchange that it points to, and an SRV record will have fields for weight, port and target.

Parameters:

ParameterTypeNotes
idA positive integer value (i.e. 1 and up).* Required

Returns:

FieldTypeNotes
adminEmailEither: a valid email address.; or a valid admin email for an SOA record.* Optional
exchangeA valid hostname (Fully qualified domain name, consisting only of letters, digits and '-')* Optional
expiryA non-negative integer value (i.e. 0 and up).* Optional
fullDataA string.* Optional
idA positive integer value (i.e. 1 and up).
minimumA non-negative integer value (i.e. 0 and up).* Optional
nameEither: a valid domain name (max 127 labels, each between 1 and 63 characters, totaling no more than 253 characters); or a valid reverse ipv4 DNS record.; or a valid reverse ipv6 DNS record.; or a valid hostname (Fully qualified domain name, consisting only of letters, digits and '-'); or a wildcard, represented by '*.domain'.
nameserverEither: a valid hostname (Fully qualified domain name, consisting only of letters, digits and '-'); or a valid nameserver in an SOA record.* Optional
portA positive integer value (i.e. 1 and up).* Optional
prioA non-negative integer value (i.e. 0 and up).* Optional
rdataA string.
refreshIntervalA non-negative integer value (i.e. 0 and up).* Optional
regionOverridesAn array of associative arrays containing
 
rdataA string permitting tabs, carriage returns and newlines
regionA string permitting tabs, carriage returns and newlines
region_idA positive integer value (i.e. 1 and up).
retryA non-negative integer value (i.e. 0 and up).* Optional
serialA positive integer value (i.e. 1 and up).* Optional
targetA valid hostname (Fully qualified domain name, consisting only of letters, digits and '-')* Optional
ttlA positive integer value (i.e. 1 and up).* Optional
typeOne of: 'A', 'AAAA', 'CNAME', 'MX', 'NS', 'PTR', 'SOA', 'SRV', 'TXT'
weightA non-negative integer value (i.e. 0 and up).* Optional
zone_idA positive integer value (i.e. 1 and up).

Possible Errors:

Refer to the Error Handling documentation for the list of exception types

list

URL:

https://api.stormondemand.com/v1/Network/DNS/Record/list

Description:

This method is used to get resource records (RRs) from a zone file. Each entry in the 'items' array referrs to one of the records in the zone. The details of these entries are further described in the 'details' method.

Parameters:

ParameterTypeNotes
page_numA positive integer value (i.e. 1 and up).* Optional
  • Defaults to: 1
page_sizeA positive integer value (i.e. 1 and up).* Optional
  • Defaults to: 25
zoneEither: a valid forward DNS Zone name.; or a valid reverse DNS zone.* Required if:
  • zone_id is not given
zone_idA positive integer value (i.e. 1 and up).* Required if:
  • zone is not given

Returns:

FieldType
item_countA non-negative integer value (i.e. 0 and up).
item_totalA non-negative integer value (i.e. 0 and up).
itemsAn array of an associative array containing a DNS Resource Records details
page_numA positive integer value (i.e. 1 and up).
page_sizeA positive integer value (i.e. 1 and up).
page_totalA positive integer value (i.e. 1 and up).

Possible Errors:

Refer to the Error Handling documentation for the list of exception types

update

URL:

https://api.stormondemand.com/v1/Network/DNS/Record/update

Description:

This method is used to update resource records (RRs) in a zone.

For details on the return structure, input field explanation, and interversion compatibility caveats, please referr to the documentation of the 'create' method.

Parameters:

ParameterTypeNotes
idA positive integer value (i.e. 1 and up).* Required
nameA string permitting tabs, carriage returns and newlines
prioA non-negative integer value (i.e. 0 and up).
rdataA string permitting tabs, carriage returns and newlines
ttlA positive integer value (i.e. 1 and up).

Returns:

FieldTypeNotes
adminEmailEither: a valid email address.; or a valid admin email for an SOA record.* Optional
exchangeA valid hostname (Fully qualified domain name, consisting only of letters, digits and '-')* Optional
expiryA non-negative integer value (i.e. 0 and up).* Optional
fullDataA string.* Optional
idA positive integer value (i.e. 1 and up).
minimumA non-negative integer value (i.e. 0 and up).* Optional
nameEither: a valid domain name (max 127 labels, each between 1 and 63 characters, totaling no more than 253 characters); or a valid reverse ipv4 DNS record.; or a valid reverse ipv6 DNS record.; or a valid hostname (Fully qualified domain name, consisting only of letters, digits and '-'); or a wildcard, represented by '*.domain'.
nameserverEither: a valid hostname (Fully qualified domain name, consisting only of letters, digits and '-'); or a valid nameserver in an SOA record.* Optional
portA positive integer value (i.e. 1 and up).* Optional
prioA non-negative integer value (i.e. 0 and up).* Optional
rdataA string.
refreshIntervalA non-negative integer value (i.e. 0 and up).* Optional
regionOverridesAn array of associative arrays containing
 
rdataA string permitting tabs, carriage returns and newlines
regionA string permitting tabs, carriage returns and newlines
region_idA positive integer value (i.e. 1 and up).
retryA non-negative integer value (i.e. 0 and up).* Optional
serialA positive integer value (i.e. 1 and up).* Optional
targetA valid hostname (Fully qualified domain name, consisting only of letters, digits and '-')* Optional
ttlA positive integer value (i.e. 1 and up).* Optional
typeOne of: 'A', 'AAAA', 'CNAME', 'MX', 'NS', 'PTR', 'SOA', 'SRV', 'TXT'
weightA non-negative integer value (i.e. 0 and up).* Optional
zone_idA positive integer value (i.e. 1 and up).

Possible Errors:

Refer to the Error Handling documentation for the list of exception types