Pitchfork

Domains

Clone Domain

/v1.0/{ddi}/domains/{domain_id}/clone?cloneName={clone_name}}

Clone an existing domain giving it a new name

View Documentation

Warning! This action can be destructive or can result in additional charges to the account.

	Parameter		Type	Required	Description
	domain_id		integer	Yes	Domain ID Number
	clone_name		text	Yes	Name to give the cloned domain

* Required for API Call

Create Domain

/v1.0/{ddi}/domains

Create a new domain with the supplied information

View Documentation

Warning! This action can be destructive or can result in additional charges to the account.

Parameter	Type	Required	Description
domain_name	text	Yes	Name of the domain being added
domain_email	text	Yes	Domain admin's email address
domain_ttl	integer	No	Domain TTL in seconds. Default is 3600 and must be greater than 300
domain_comment	text	No	Comment about domain and must be less than 160 characters
sub_domain	text	No	Name of sub-domain to add under domain
sub_domain_email	text	No	Sub-domain admin's email address
sub_domain_comment	text	No	Comment about sub-domain. Must be less than 160 characters
record_name	text	No	Record Name to place under domain
record_type	text	No	Type of record to add
record_data	text	No	Record data. For PTR, A, and AAAA records this must be a valid IP
record TTL	text	No	TTL for the record

* Required for API Call

Export Domain

/v1.0/{ddi}/domains/{domain_id}/export

Export the specified domain into BIND 9 format

View Documentation

	Parameter		Type	Required	Description
	domain_id		integer	Yes	Domain ID Number

* Required for API Call

Import Domain

/v1.0/{ddi}/domains/import

Import a new domain into Cloud DNS

View Documentation

Warning! This action can be destructive or can result in additional charges to the account.

	Parameter		Type	Required	Description
	content_type		text	Yes	Content type of contents. This is the only option
	contents		text	Yes	Contents of domain to be imported

* Required for API Call

List Domain Changes Since

/v1.0/{ddi}/domains/{domain_id}/changes?since={date_time}

List domain changes since the specified supplied date.

View Documentation

	Parameter		Type	Required	Description
	domain_id		integer	Yes	Domain ID Number
	date_time		text	Yes	Date/Time to search for changes. Format of yyyy-mm-ddThh:mm:ss-0000. For example: 2015-09-20T00:00:00-0000

* Required for API Call

List Domains

/v1.0/{ddi}/domains

List all domains that are managed by the account.

View Documentation

	Parameter		Type	Required	Description
Filter		text	No	Filter parameters i.e. limit=100. For multiple parameters separate using an & i.e. limit=100&marker=100

* Required for API Call

Modify Multiple Domains

/v1.0/{ddi}/domains

Modify multiple domains at once

View Documentation

Warning! This action can be destructive or can result in additional charges to the account.

Parameter	Type	Required	Description
domain_id	integer	Yes	Domain ID Number
domain_email	text	No	Admin email address for domain
domain_ttl	integer	No	TTL in seconds. Must be greater than 300
domain_comment	text	No	Comments about the domain. Must be less than 300 characters

* Required for API Call

Remove Domain

/v1.0/{ddi}/domains/{domain_id}

None

View Documentation

Warning! This action can be destructive or can result in additional charges to the account.

	Parameter		Type	Required	Description
	domain_id		integer	Yes	Domain ID Number

* Required for API Call

Remove Domain And All Subdomains

/v1.0/{ddi}/domains/{domain_id}?deleteSubdomains=true

Remove domain and all associated subdomains

View Documentation

Warning! This action can be destructive or can result in additional charges to the account.

	Parameter		Type	Required	Description
	domain_id		text	Yes	Domain ID Number

* Required for API Call

Search Domains

/v1.0/{ddi}/domains/search/?name={search_string}

Search domain names using the search string provided

View Documentation

	Parameter		Type	Required	Description
	search_string		text	Yes	Search String. [A-Za-z], [0-9], and '-' are allowed

* Required for API Call

Show Domain Changes

/v1.0/{ddi}/domains/{domain_id}/changes

List all changes on the domain from a specified time. Default is midnight of current day.

View Documentation

	Parameter		Type	Required	Description
	domain_id		integer	No	Domain ID Number

* Required for API Call

Show Domain Details

/v1.0/{ddi}/domains/{domain_id}

List details about the specified domain

View Documentation

	Parameter		Type	Required	Description
	domain_id		integer	Yes	Domain ID Number

* Required for API Call

Update Single Domain

/v1.0/{ddi}/domains/{domain_id}

Modify one domain under the specified account

View Documentation

Warning! This action can be destructive or can result in additional charges to the account.

Parameter	Type	Required	Description
domain_id	text	Yes	Domain ID Number
domain_email	text	No	Admin email address for domain
domain_ttl	integer	No	Domain TTL in seconds. Must be greater or equal to 300
domain_comment	text	No	Comment for domain. Must be less than 160 characters

* Required for API Call

Subdomains

List Subdomains

/v1.0/{ddi}/domains/{domain_id}/subdomains

List domains that are subdomains of the specified domain

View Documentation

	Parameter		Type	Required	Description
	domain_id		text	Yes	Domain ID Number

* Required for API Call

Records

Add Record To Domain

/v1.0/{ddi}/domains/{domain_id}/records

Add new record to the specified domain

View Documentation

Warning! This action can be destructive or can result in additional charges to the account.

Parameter	Type	Required	Description
domain_id	integer	Yes	Domain ID Number
record_name	text	Yes	Name of the Record to be added
record_type	text	Yes	Type of Record to be added
record_data	text	Yes	Record data i.e. IP, or domain name.
record_priority	integer	No	Record priority. Only required for MX and SRV records
record_ttl	integer	No	Record TTL. Defaults to 3600 and must be greter than 300
record_comment	text	No	Comment for new record

* Required for API Call

List Records For Domain

/v1.0/{ddi}/domains/{domain_id}/records

List all records configured for specified domain

View Documentation

	Parameter		Type	Required	Description
	domain_id		integer	Yes	Domain ID Number

* Required for API Call

Remove Record From Domain

/v1.0/{ddi}/domains/{domain_id}/records/{record_id}

Remove record from specified domain

View Documentation

Warning! This action can be destructive or can result in additional charges to the account.

	Parameter		Type	Required	Description
	domain_id		integer	Yes	Domain ID Number
	record_id		text	Yes	Record ID Number

* Required for API Call

Search Records For Domain

/v1.0/{ddi}/domains/{domain_id}/records?type={record_type}

List all records for the specified domain that match the specified name

View Documentation

	Parameter		Type	Required	Description
	domain_id		integer	Yes	Domain ID Number
	record_type		text	Yes	Type of record to search for

* Required for API Call

Show Record Details

/v1.0/{ddi}/domains/{domain_id}/records/{record_id}

List all details about specified record for the domain

View Documentation

	Parameter		Type	Required	Description
	domain_id		integer	Yes	Domain ID Number
	record_id		text	Yes	Record ID Number

* Required for API Call

Update Record On Domain

/v1.0/{ddi}/domains/{domain_id}/records/{record_id}

Modify the configuration of records on the domain

View Documentation

Warning! This action can be destructive or can result in additional charges to the account.

Parameter	Type	Required	Description
domain_id	integer	Yes	Domain ID Number
record_id	text	Yes	Record ID Number
record_name	text	Yes	Name for the record
record_data	text	No	Record data i.e. IP, or domain name.
record_ttl	integer	No	Record TTL in seconds. Must be greater than 300 seconds
record_priority	integer	No	Record priority. Only required for MX and SRV records
record_comment	text	No	Record Comment

* Required for API Call

Reverse DNS

Add Pointer Record

/v1.0/{ddi}/rdns

Add new PTR record for the specified Cloud Product

View Documentation

Warning! This action can be destructive or can result in additional charges to the account.

Parameter	Type	Required	Description
ptr_product_ref	text	Yes	URL reference to cloud product. API URL to Cloud Product
ptr_product_rel	text	Yes	Cloud Product for that PTR record is for
record_type	text	Yes	Record Type to Create
record_name	text	Yes	The name for the domain or subdomain
record_data	text	Yes	Valid IPv4 or IPv6 address
record_ttl	text	No	TTL for PTR record in seconds must be greater than 300 seconds
record_comment	text	No	Comment for record must be less than 160 characters
ptr_content	text	No	Comment for PTR record

* Required for API Call

List Pointer Records

/v1.0/{ddi}/rdns/{service_name}?href={device_resource_uri}

List all PTR records for the specified Cloud Device

View Documentation

	Parameter		Type	Required	Description
	service_name		text	Yes	Service Name where PTR Record is setup
	device_resource_uri		text	Yes	URI for resource. Basically the API reference to the particular device

* Required for API Call

Remove Pointer Record

/v1.0/{ddi}/rdns/{service_name}?href={device_resource_uri}

Remove the PTR record from the specified Cloud Product

View Documentation

Warning! This action can be destructive or can result in additional charges to the account.

	Parameter		Type	Required	Description
	service_name		text	Yes	Name of Cloud Service Product
	device_resource_uri		text	Yes	Resource URI for Device or API reference URL

* Required for API Call

Show Pointer Record Details

/v1.0/{ddi}/rdns/{service_name}/{record_id}?href={device_resource_uri}

None

View Documentation

Parameter	Type	Required	Description
service_name	text	Yes	Service name of product
record_id	text	Yes	Record ID of PTR record
device_resource_uri	text	Yes	URL of device resource. API endpoint to device on specific product.

* Required for API Call

Update Pointer Records

/v1.0/{ddi}/rdns

Modify the PTR record associated with Cloud Product

View Documentation

Warning! This action can be destructive or can result in additional charges to the account.

Parameter	Type	Required	Description
ptr_product_ref	text	Yes	URL reference to cloud product. API URL to Cloud Product
ptr_product_rel	text	Yes	Cloud Product for that PTR record is for
record_type	text	Yes	Record Type to Create
record_name	text	Yes	The name for the domain or subdomain
record_data	text	Yes	Valid IPv4 or IPv6 address
record_id	text	Yes	Record ID Number
record_ttl	text	No	TTL for PTR record in seconds must be greater than 300 seconds
record_comment	text	No	Comment for record must be less than 160 characters
ptr_content	text	No	Comment for PTR record

* Required for API Call

Jobs

Show Job Details

/v1.0/{ddi}/status/{job_id}?showDetails={show_details}

Show Job Request details

View Documentation

	Parameter		Type	Required	Description
	job_id		text	Yes	Job ID Number
	show_details		text	Yes	Whether or not to show details

* Required for API Call

Limits

List All Limits

/v1.0/{ddi}/limits

List Limit Types

/v1.0/{ddi}/limits/types

List Specific Limit

/v1.0/{ddi}/limits/{limit_type}

List specified limit for Cloud DNS

View Documentation

	Parameter		Type	Required	Description
	limit_type		text	Yes	Limit type

* Required for API Call

DNS - API Calls

Domains

Request URL

Request Headers

Request Data Object

Response Headers

Response Body

Request URL

Request Headers

Request Data Object

Response Headers

Response Body

Request URL

Request Headers

Request Data Object

Response Headers

Response Body

Request URL

Request Headers

Request Data Object

Response Headers

Response Body

Request URL

Request Headers

Request Data Object

Response Headers

Response Body

Request URL

Request Headers

Request Data Object

Response Headers

Response Body

Request URL

Request Headers

Request Data Object

Response Headers

Response Body

Request URL

Request Headers

Request Data Object

Response Headers

Response Body

Request URL

Request Headers

Request Data Object

Response Headers

Response Body

Request URL

Request Headers

Request Data Object

Response Headers

Response Body

Request URL

Request Headers

Request Data Object

Response Headers

Response Body

Request URL

Request Headers

Request Data Object

Response Headers

Response Body

Request URL

Request Headers

Request Data Object

Response Headers

Response Body

Subdomains

Request URL

Request Headers

Request Data Object

Response Headers

Response Body

Records

Request URL

Request Headers

Request Data Object

Response Headers

Response Body

Request URL