NOTE: The Load Balance Service is deprecated. Legacy users of the service should contact Concierge for any questions on adding a Load Balance service to your zone. All other users should use the GSLB service instead.

REST Syntax

/REST/LoadBalance/ POST — Creates an instance of the Load Balance service on the zone and node indicated.

HTTP Action — POST

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

Arguments — Click for More Info

string auto_recover — Indicates whether the service should recover automatically after failover.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 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 serve_count — How many records will be returned in each DNS response

string failover_mode — How the service should failover.
Valid values:ip – Failover to a particular IPcname – Failover to a particular CNAMEglobal – Failover to the global IP address pool

string failover_data — Dependent upon failover_mode:ip – If failover_mode is ‘ip’, this should be an IPv4 addresscname – If failover_mode is ‘cname’, this should be a CNAMEglobal – If failover_mode is ‘global’, this should be empty or omitted

array pool — Required. The IP Pool list for this service.

string address — Required. The IP address or FQDN of the Node IP

string label — A descriptive string describing this IP.

string weight — A number from 1-15 describing how often this record should be served. Higher means more.

string serve_mode — Sets the behavior of this particular record.
Valid values:always – Always serve this IP addressobey – Serve this address based upon its monitoring statusremove – Serve this address based upon its monitoring status. However, if it goes down, don’t automatically bring it back up when monitoring reports it up.no – Never serve this IP address

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 — Required. Name of contact to receive notifications.

Response — Click for More Info

string auto_recover — Indicates whether the service should recover automatically after failover.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 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 serve_count — How many records will be returned in each DNS response

string failover_mode — How the service should failover.
Valid values:ip – Failover to a particular IPcname – Failover to a particular CNAMEglobal – Failover to the global IP address pool

string failover_data — Dependent upon failover_mode:ip – If failover_mode is ‘ip’, this should be an IPv4 addresscname – If failover_mode is ‘cname’, this should be a CNAMEglobal – If failover_mode is ‘global’, this should be empty or omitted

array pool — The IP Pool list for this service.

string address — The IP address or FQDN of the Node IP

string label — A descriptive string describing this IP.

string weight — A number from 1-15 describing how often this record should be served. Higher means more.

string serve_mode — Sets the behavior of this particular record.
Valid values:always – Always serve this IP addressobey – Serve this address based upon its monitoring statusremove – Serve this address based upon its monitoring status. However, if it goes down, don’t automatically bring it back up when monitoring reports it up.no – Never serve this IP address

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 zone — Name of the zone

SOAP Syntax

string auto_recover — Indicates whether the service should recover automatically after failover.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 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 serve_count — How many records will be returned in each DNS response

string failover_mode — How the service should failover.
Valid values:ip – Failover to a particular IPcname – Failover to a particular CNAMEglobal – Failover to the global IP address pool

string failover_data — Dependent upon failover_mode:ip – If failover_mode is ‘ip’, this should be an IPv4 addresscname – If failover_mode is ‘cname’, this should be a CNAMEglobal – If failover_mode is ‘global’, this should be empty or omitted

array pool — Required. The IP Pool list for this service.

string address — Required. The IP address or FQDN of the Node IP

string label — A descriptive string describing this IP.

string weight — A number from 1-15 describing how often this record should be served. Higher means more.

string serve_mode — Sets the behavior of this particular record.
Valid values:always – Always serve this IP addressobey – Serve this address based upon its monitoring statusremove – Serve this address based upon its monitoring status. However, if it goes down, don’t automatically bring it back up when monitoring reports it up.no – Never serve this IP address

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 — Required. Name of contact to receive notifications.

string fqdn — Required. Name of node where the service is created.

string token — Required. The session identifier.

string zone — Required. Name of zone where the service is created.

Response — Click for More Info

hash data

string auto_recover — Indicates whether the service should recover automatically after failover.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 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 serve_count — How many records will be returned in each DNS response

string failover_mode — How the service should failover.
Valid values:ip – Failover to a particular IPcname – Failover to a particular CNAMEglobal – Failover to the global IP address pool

string failover_data — Dependent upon failover_mode:ip – If failover_mode is ‘ip’, this should be an IPv4 addresscname – If failover_mode is ‘cname’, this should be a CNAMEglobal – If failover_mode is ‘global’, this should be empty or omitted

array pool — The IP Pool list for this service.

string address — The IP address or FQDN of the Node IP

string label — A descriptive string describing this IP.

string weight — A number from 1-15 describing how often this record should be served. Higher means more.

string serve_mode — Sets the behavior of this particular record.
Valid values:always – Always serve this IP addressobey – Serve this address based upon its monitoring statusremove – Serve this address based upon its monitoring status. However, if it goes down, don’t automatically bring it back up when monitoring reports it up.no – Never serve this IP address

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 — Required. Name of contact to receive notifications.