Add failover record - API Documentation

HTTP method

POST

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.
record_id	Identifier of the record for which a failover is being created (a failover can only be created for records in the list obtainable from failover_records)
failover_check_type	Verification type (available values are returned by failover_records)
failover_check_interval	Verification interval (available values are returned by failover_records)
failover_return_to_main_value	Whether or not to return to the main value when access to it is restored (0\|1)
failover_additional_port	Port required for TCP verification
failover_record_backup_value[0]-[2]	Array of record reserve values (maximum 3), not compulsory of failover_use_fws=1 is passed, otherwise at least 1
failover_use_fws	Whether or not to use FWS as a failover for this record (0\|1), subject to the condition that FWS must be available for the domain (shown in failover_records) This parameter can only be used for HTTP and HTTPS checks

Additional parameters

Parameter	Description
failover_additional_response	Expected answer (TCP verification)
failover_additional_request	Request to pass to the server (TCP verification)
failover_notification_email	Email address for notifications about malfunctions; several values can be provided separated by commas
failover_notification_sms	Phone number to send SMS message, in international format; several values can be passed separated by commas

The failover_additional_port, failover_additional_request, and failover_additional_response parameters are only required if the verification type is TCP

Phone number for SMS notification of malfunctions must be entered in international format with no plus sign (for example 18001234567)

Warning! SMS notifications will only work if you purchase the sms notifications package

Request example

POST https://api.zilore.com/dns/v1/domains/example.com/failovers
X-Auth-Key: 6fac94db-691b-ec08-d22c-00000b7c06c0
Content-Type: application/x-www-form-urlencoded

record_id=65490&failover_check_type=PING&failover_check_interval=300&failover_return_to_main_value=0&failover_record_backup_value[0]=1.1.1.102&failover_notification_email=email@example.com

Response example

{
"status": "ok",
"response": {
"failover_status": "added"
}
}