Methods
create(attributes, callbackopt)
Create a domain object.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
attributes |
object | The attributes with which to create the domain. See the official docs for valid attributes. | |
callback |
requestCallback |
<optional> |
callback that handles the response |
- Source:
createRecord(domainName, attributes, callbackopt)
Create a record object in a domain.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
domainName |
string | The name of the domain for which to create a record | |
attributes |
object | The attributes with which to create the domain record. See the official docs for valid attributes. | |
callback |
requestCallback |
<optional> |
callback that handles the response |
- Source:
delete(name, callbackopt)
Delete the identified domain object.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
name |
string | The name of the domain to delete | |
callback |
requestCallback |
<optional> |
callback that handles the response |
- Source:
deleteRecord(domainName, id, callbackopt)
Delete the identified domain record object.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
domainName |
string | The name of the domain for which to delete a record | |
id |
number | The id of the domain record to retrieve | |
callback |
requestCallback |
<optional> |
callback that handles the response |
- Source:
get(name, callbackopt)
Get the identified domain object.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
name |
string | The name of the domain to retrieve | |
callback |
requestCallback |
<optional> |
callback that handles the response |
- Source:
getRecord(domainName, id, callbackopt)
Get the identified domain record object.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
domainName |
string | The name of the domain for which to retrieve a record | |
id |
number | The id of the domain record to retrieve | |
callback |
requestCallback |
<optional> |
callback that handles the response |
- Source:
list(page or queryObjectopt, perPageopt, callbackopt)
List domain objects.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
page or queryObject |
number | object |
<optional> |
page number to retrieve or key value pairs of query parameters |
perPage |
number |
<optional> |
number of result per page to retrieve |
callback |
listRequestCallback |
<optional> |
callback that handles the response |
- Source:
listRecords(domainName, page or queryObjectopt, perPageopt, callbackopt)
List domain record objects.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
domainName |
string | name of domain for which to retrieve records | |
page or queryObject |
number | object |
<optional> |
page number to retrieve or key value pairs of query parameters |
perPage |
number |
<optional> |
number of result per page to retrieve |
callback |
listRequestCallback |
<optional> |
callback that handles the response |
- Source:
updateRecord(domainName, id, attributes, callbackopt)
Update the identified record object in a domain.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
domainName |
string | The name of the domain for which to update the record | |
id |
number | The id of the domain record to retrieve | |
attributes |
object | The attributes with which to update the domain record. See the official docs for valid attributes. | |
callback |
requestCallback |
<optional> |
callback that handles the response |
- Source: