REST Syntax

/REST/Failover/ PUT — Activates or Deactivates an existing Active Failover service at the zone/node indicated.

HTTP Action — PUT

URIs — https://api.dynect.net/REST/Failover/<zone>/<fqdn>/

Arguments:

To Activate a Service:

boolean activate — Required.

To Deactivate a Service:

boolean deactivate — Required.

Response — Click for More Info

integer task_id – The number assigned to the task to activate or deactivate an active failover instance.

string active — Indicates if the service is active.
Valid values:Y — The service is active.N — The service is inactive

string status — The current state of the service.
Valid values:unk – The service state is not yet known.ok – There are no problems with the service.trouble – One or more node_ips are reporting down.failover – The number of okay node_ips has fallen below failover_count. The service has failed over.

string failover_data — The IPv4 Address or CNAME data for the failover target.

string auto_recover — Indicates whether the service should restore its original state when the source IPs resume online status. Valid values:Y – The service should come out of failover automatically when IPs come back up.N – The service should stay in failover until a user explicitly takes the service out of failover.

string expected — For HTTP(S) probes, a string to search for in the response. For SMTP probes, a string to compare the banner against. Failure to find this string means the monitor will report a down status.

string contact_nickname — Name of contact to receive notifications.

string fqdn — Fully qualified domain name of a node in the zone.

string ttl — Time To Live in seconds of records in the service. Must be less than 1/2 of the Health Probe’s monitoring interval. Valid values: 30, 60, 150, 300, 450

string zone — Name of the zone.

array log — Recent monitoring logs for the address

string status — The state of the address at the time of the log entry.
Valid values:unk – The state of the IP address is not yet knownup – The IP address is up
down – The IP address is down

string message — If status is down, an error message explaining the failure.

string time — The time or probe interval when this log entry was generated.

string site_code — The airport code of the monitoring site that generated this log entry.

SOAP Syntax

ActivateFailover — Activates an existing Active Failover service at the zone/node indicated.

DeactivateFailover — Deactivates an existing Active Failover service at the zone/node indicated.

Arguments:

Both the Activate and Deactivate commands use these arguments:

string fqdn — Required. Name of the node where the service exists.

string token — Required. The session identifier.

string zone — Required. Name of the zone where the service exists.

Response — Click for More Info

integer task_id – The number assigned to the task to activate or deactivate an active failover instance.

hash data

string active — Indicates if the service is active.
Valid values:Y — The service is active.N — The service is inactive

string status — The current state of the service.
Valid values:unk – The service state is not yet known.ok – There are no problems with the service.trouble – One or more node_ips are reporting down.failover – The number of okay node_ips has fallen below failover_count. The service has failed over.

string failover_data — The IPv4 Address or CNAME data for the failover target.

string auto_recover — Indicates whether the service should restore its original state when the source IPs resume online status. Valid values:Y – The service should come out of failover automatically when IPs come back up.N – The service should stay in failover until a user explicitly takes the service out of failover.

string expected — For HTTP(S) probes, a string to search for in the response. For SMTP probes, a string to compare the banner against. Failure to find this string means the monitor will report a down status.

string contact_nickname — Name of contact to receive notifications.

string fqdn — Fully qualified domain name of a node in the zone.

string ttl — Time To Live in seconds of records in the service. Must be less than 1/2 of the Health Probe’s monitoring interval. Valid values: 30, 60, 150, 300, 450

string zone — Name of the zone.

array log — Recent monitoring logs for the address

string status — The state of the address at the time of the log entry.
Valid values:unk – The state of the IP address is not yet knownup – The IP address is up
down – The IP address is down

string message — If status is down, an error message explaining the failure.

string time — The time or probe interval when this log entry was generated.

string site_code — The airport code of the monitoring site that generated this log entry.