Overview
Error Handling

Methods

API Documentation (API Version bleed)

Network/DNS/Zone/History/

DESCRIPTION

API interface for accessing DNS Zone History, which is a JSON structured snapshot of a zone and it's associated records that is captured prior to any change being made to a resource record (MX, CNAME, TXT, etc) on a zone.

compare

URL:

https://api.liquidweb.com/bleed/Network/DNS/Zone/History/compare

Description:

Compare a history entry to the current state of a zone.

Returns a hashref of arrayrefs of records. Each record is complete with the addition of an extra key

	action => [qw/change delete add/]

Indicating what action needs to be take to the current zone to reset it back to that point in time

Parameters:

ParameterTypeNotes
idA valid id number (a positive integer).* Required
zone_idA valid id number (a positive integer).* Required

Returns:

FieldType
recordsAn array of associative arrays containing
 
actionOne of: 'add', 'change', 'delete'* Optional
adminEmailEither: a valid email address.; or a valid admin email for an SOA record.* Optional
createdA valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object.* 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).
last_updatedA valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object.* Optional
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 * Optional
 
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', 'ALIAS', '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.liquidweb.com/bleed/Network/DNS/Zone/History/list

Description:

Retrieve a list of zone history records, for a given zone_id.

Parameters:

ParameterTypeNotes
order_byAn associative array containing the fields:
 
fieldThe value: 'created'* Required
sortOne of: 'asc', 'desc'* Optional
  • Defaults to: desc
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
zone_idA valid id number (a positive integer).* Required

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 associative arrays containing
 
createdA valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object.
idA valid id number (a positive integer).
zone_idA valid id number (a positive integer).
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