Get list of failover records - API Documentation

HTTP method

GET

URL

https://api.zilore.com/dns/v1/domains/{domain_name}/failovers

Request parameters

Parameter	Description
domain_name	Domain name. Must conform to the standard. Names of national domains must be passed in Punycode format.

Additional parameters

Parameter	Description
offset	Omission of the stated number of records in the response
limit	Limit on the number of records returned
order_by	Sort parameter, accepts values: record_id — Record identifier idn_record_name — Name of record in Unicode format record_type — Record type record_value — Record value in Unicode format failover_check_type — Verification type failover_check_interval — Verification interval failover_return_to_main_value — Return flag for main value
order_param	Sort parameter, accepts values: asc — alphabetical order (A-Z) desc — reverse alphabetical order (Z-A)

Response fields

Parameter	Description
record_id	Identifier of parent record
record_name	Name of record in Unicode format
record_type	Record type: A — Establishes correspondence between a domain name/subdomain and its IPv4 address
record_value	Initial record value (by default) in Unicode format
record_ttl	Maximum permitted time for record to be cached
geo_region	GEO-identifier of the record
geo_full_region	Full name of GEO region
record_active_value	Current active record value in Unicode format
record_value_status	Value check status by default (0\|1)
failover_check_type	Verification type
failover_check_interval	Verification interval
failover_return_to_main_value	Return to the main record when access to it is restored (0: off, 1: on)
failover_notification_email	Email addresses for notifications about malfunctions, separated by commas
failover_notification_sms	Phone numbers for SMS notification of malfunctions, separated by commas
failover_use_fws	Whether or not to use FWS as a failover for this record
failover_fws_active	Whether or not FWS is currently active for this record
failover_additional_port	Port for request (TCP verification)
failover_additional_request	Request to pass to the server (TCP verification)
failover_additional_response	Expected answer (TCP verification)
failover_record_backups	Array of record reserve values from objects with status and value fields
failover_record_backups.status	Reserve value check status (0\|1)
failover_record_backups.value	Reserve value in Unicode format

Request example

GET https://api.zilore.com/dns/v1/domains/example.com/failovers
X-Auth-Key: 6fac94db-691b-ec08-d22c-00000b7c06c0

Response example

{
"status": "ok",
"response": [{
"record_id": "65483",
"record_name": "test.example.com",
"record_type": "A",
"record_ttl": "60",
"geo_region": null,
"geo_full_region": "",
"record_value": "176.58.124.228",
"record_active_value": "176.58.124.228",
"record_value_status": "0",
"failover_check_type": "HTTP",
"failover_check_interval": "60",
"failover_return_to_main_value": "1",
"failover_record_backups": [],
"failover_notification_email": "",
"failover_notification_sms": "",
"failover_use_fws": "1",
"failover_fws_active": true,
"failover_additional_port": 0,
"failover_additional_request": 0,
"failover_additional_response": 0
}]
}