Create Load Balance (API) | Dyn Help Center

Understanding How The API Works »

Creating an instance of the Load Balance service in the API requires specific syntax depending on whether you are using REST or SOAP. Use this table to find the syntax for your command.

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

Click to view all REST Resources

/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 notify_events — A comma separated list of what events to send notifications on.
Valid values:
ip – Send notifications when individual IPs change status
svc – Send notifications when the service state changes
nosrv – Send notifications when an IP labeled ‘Do Not serve’ changes status
string recovery_delay — The number of consecutive monitoring intervals to delay before placing an IP address back in service. Defaults to 0.
string syslog_server — The Hostname or IP address of a server to receive syslog notifications on monitoring events.
string syslog_port — The port that the remote syslog server is listening on. Defaults to 514.
string syslog_ident — The ident to use when sending syslog notifications. Defaults to dynect.
string syslog_facility — The syslog facility to use when sending syslog notifications. Defaults to daemon.
Valid values:
kern, user, mail, daemon, auth, syslog, lpr, news, uucp, cron, authpriv, ftp, ntp, security, console, local0, local1, local2, local3, local4, local5, local6, local7
string syslog_delivery – Identifies when ‘health probe’ messages are logged through syslog.
Valid Values:
change – When the service’s status changes. (default)
all – At every monitoring interval.
string syslog_probe_fmt — The customizable string for probe notifications’ syslog message format. The messages will replace the %xxx variables with the data required. Default: %hos probe %tim: %sit %sta %rti “%msg” %adr.
Valid values:
%hos – hostname
%tim – current timestamp or monitored interval
%reg – region code
%sta – status
%ser – record serial
%rda – rdata
%sit – monitoring site
%rti – response time
%msg – message from monitoring
%adr – address of monitored node
%med – median value
string syslog_status_fmt — The customizable string for status notifications’ syslog message format. The messages will replace the %xxx variables with the data required. Default: %hos status %tim: %reg %sta %ser %rda.
Valid values:
%hos – hostname
%tim – current timestamp or monitored interval
%reg – region code
%sta – status
%ser – record serial
%rda – rdata
%sit – monitoring site
%rti – response time
%msg – message from monitoring
%adr – address of monitored node
%med – median value
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 IP
cname – Failover to a particular CNAME
global – 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 address
cname – If failover_mode is ‘cname’, this should be a CNAME
global – 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 address
obey – Serve this address based upon its monitoring status
remove – 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

hash monitor — Required. The health monitor for the service.

string protocol — Required. The protocol to monitor.
Valid values:
HTTP
HTTPS
PING
SMTP
TCP
string interval — Required. How often to run the monitor.
Valid values:
1 – Every minute
5 – Every 5 minutes
10 – Every 10 minutes
15 – Every 15 minutes
string retries — How many retries the monitor should attempt on failure before giving up
string timeout — How much time (in seconds) before the connection attempt times out
string port — For HTTP(S)/SMTP/TCP probes, an alternate connection port
string path — For HTTP(S) probes, a specific path to request
string host — For HTTP(S) probes, a value to pass in to the Host: header
string header — For HTTP(S) probes, additional header fields/values to pass in, separated by the newline character (\n)
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 notify_events — A comma separated list of what events to send notifications on.
Valid values:
ip – Send notifications when individual IPs change status
svc – Send notifications when the service state changes
nosrv – Send notifications when an IP labeled ‘Do Not serve’ changes status
string recovery_delay — The number of consecutive monitoring intervals to delay before placing an IP address back in service. Defaults to 0.
string syslog_server — The Hostname or IP address of a server to receive syslog notifications on monitoring events.
string syslog_port — The port that the remote syslog server is listening on. Defaults to 514.
string syslog_ident — The ident to use when sending syslog notifications. Defaults to dynect.
string syslog_facility — The syslog facility to use when sending syslog notifications. Defaults to daemon.
Valid values:
kern, user, mail, daemon, auth, syslog, lpr, news, uucp, cron, authpriv, ftp, ntp, security, console, local0, local1, local2, local3, local4, local5, local6, local7
string syslog_delivery – Identifies when ‘health probe’ messages are logged through syslog.
Valid Values:
change – When the service’s status changes. (default)
all – At every monitoring interval.
string syslog_probe_fmt — The customizable string for probe notifications’ syslog message format. The messages will replace the %xxx variables with the data required. Default: %hos probe %tim: %sit %sta %rti “%msg” %adr.
Valid values:
%hos – hostname
%tim – current timestamp or monitored interval
%reg – region code
%sta – status
%ser – record serial
%rda – rdata
%sit – monitoring site
%rti – response time
%msg – message from monitoring
%adr – address of monitored node
%med – median value
string syslog_status_fmt — The customizable string for status notifications’ syslog message format. The messages will replace the %xxx variables with the data required. Default: %hos status %tim: %reg %sta %ser %rda.
Valid values:
%hos – hostname
%tim – current timestamp or monitored interval
%reg – region code
%sta – status
%ser – record serial
%rda – rdata
%sit – monitoring site
%rti – response time
%msg – message from monitoring
%adr – address of monitored node
%med – median value
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 IP
cname – Failover to a particular CNAME
global – 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 address
cname – If failover_mode is ‘cname’, this should be a CNAME
global – 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 address
obey – Serve this address based upon its monitoring status
remove – 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

hash monitor — The health monitor for the service.

string protocol — The protocol to monitor.
Valid values:
HTTP
HTTPS
PING
SMTP
TCP
string interval — How often to run the monitor.
Valid values:
1 – Every minute
5 – Every 5 minutes
10 – Every 10 minutes
15 – Every 15 minutes
string retries — How many retries the monitor should attempt on failure before giving up
string timeout — How much time (in seconds) before the connection attempt times out
string port — For HTTP(S)/SMTP/TCP probes, an alternate connection port
string path — For HTTP(S) probes, a specific path to request
string host — For HTTP(S) probes, a value to pass in to the Host: header
string header — For HTTP(S) probes, additional header fields/values to pass in, separated by the newline character (\n)
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

Click to view all SOAP Commands

CreateLoadBalance — Creates a new Load Balancing service.

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 notify_events — A comma separated list of what events to send notifications on.
Valid values:
ip – Send notifications when individual IPs change status
svc – Send notifications when the service state changes
nosrv – Send notifications when an IP labeled ‘Do Not serve’ changes status
string recovery_delay — The number of consecutive monitoring intervals to delay before placing an IP address back in service. Defaults to 0.
string syslog_server — The Hostname or IP address of a server to receive syslog notifications on monitoring events.
string syslog_port — The port that the remote syslog server is listening on. Defaults to 514.
string syslog_ident — The ident to use when sending syslog notifications. Defaults to dynect.
string syslog_facility — The syslog facility to use when sending syslog notifications. Defaults to daemon.
Valid values:
kern, user, mail, daemon, auth, syslog, lpr, news, uucp, cron, authpriv, ftp, ntp, security, console, local0, local1, local2, local3, local4, local5, local6, local7
string syslog_delivery – Identifies when ‘health probe’ messages are logged through syslog.
Valid Values:
change – When the service’s status changes. (default)
all – At every monitoring interval.
string syslog_probe_fmt — The customizable string for probe notifications’ syslog message format. The messages will replace the %xxx variables with the data required. Default: %hos probe %tim: %sit %sta %rti “%msg” %adr.
Valid values:
%hos – hostname
%tim – current timestamp or monitored interval
%reg – region code
%sta – status
%ser – record serial
%rda – rdata
%sit – monitoring site
%rti – response time
%msg – message from monitoring
%adr – address of monitored node
%med – median value
string syslog_status_fmt — The customizable string for status notifications’ syslog message format. The messages will replace the %xxx variables with the data required. Default: %hos status %tim: %reg %sta %ser %rda.
Valid values:
%hos – hostname
%tim – current timestamp or monitored interval
%reg – region code
%sta – status
%ser – record serial
%rda – rdata
%sit – monitoring site
%rti – response time
%msg – message from monitoring
%adr – address of monitored node
%med – median value
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 IP
cname – Failover to a particular CNAME
global – 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 address
cname – If failover_mode is ‘cname’, this should be a CNAME
global – 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 address
obey – Serve this address based upon its monitoring status
remove – 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

hash monitor — Required. The health monitor for the service.

string protocol — Required. The protocol to monitor.
Valid values:
HTTP
HTTPS
PING
SMTP
TCP
string interval — Required. How often to run the monitor.
Valid values:
1 – Every minute
5 – Every 5 minutes
10 – Every 10 minutes
15 – Every 15 minutes
string retries — How many retries the monitor should attempt on failure before giving up
string timeout — How much time (in seconds) before the connection attempt times out
string port — For HTTP(S)/SMTP/TCP probes, an alternate connection port
string path — For HTTP(S) probes, a specific path to request
string host — For HTTP(S) probes, a value to pass in to the Host: header
string header — For HTTP(S) probes, additional header fields/values to pass in, separated by the newline character (\n)
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 notify_events — A comma separated list of what events to send notifications on.
Valid values:
ip – Send notifications when individual IPs change status
svc – Send notifications when the service state changes
nosrv – Send notifications when an IP labeled ‘Do Not serve’ changes status
string recovery_delay — The number of consecutive monitoring intervals to delay before placing an IP address back in service. Defaults to 0.
string syslog_server — The Hostname or IP address of a server to receive syslog notifications on monitoring events.
string syslog_port — The port that the remote syslog server is listening on. Defaults to 514.
string syslog_ident — The ident to use when sending syslog notifications. Defaults to dynect.
string syslog_facility — The syslog facility to use when sending syslog notifications. Defaults to daemon.
Valid values:
kern, user, mail, daemon, auth, syslog, lpr, news, uucp, cron, authpriv, ftp, ntp, security, console, local0, local1, local2, local3, local4, local5, local6, local7
string syslog_delivery – Identifies when ‘health probe’ messages are logged through syslog.
Valid Values:
change – When the service’s status changes. (default)
all – At every monitoring interval.
string syslog_probe_fmt — The customizable string for probe notifications’ syslog message format. The messages will replace the %xxx variables with the data required. Default: %hos probe %tim: %sit %sta %rti “%msg” %adr.
Valid values:
%hos – hostname
%tim – current timestamp or monitored interval
%reg – region code
%sta – status
%ser – record serial
%rda – rdata
%sit – monitoring site
%rti – response time
%msg – message from monitoring
%adr – address of monitored node
%med – median value
string syslog_status_fmt — The customizable string for status notifications’ syslog message format. The messages will replace the %xxx variables with the data required. Default: %hos status %tim: %reg %sta %ser %rda.
Valid values:
%hos – hostname
%tim – current timestamp or monitored interval
%reg – region code
%sta – status
%ser – record serial
%rda – rdata
%sit – monitoring site
%rti – response time
%msg – message from monitoring
%adr – address of monitored node
%med – median value
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 IP
cname – Failover to a particular CNAME
global – 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 address
cname – If failover_mode is ‘cname’, this should be a CNAME
global – 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 address
obey – Serve this address based upon its monitoring status
remove – 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

hash monitor — The health monitor for the service.

string protocol — The protocol to monitor.
Valid values:
HTTP
HTTPS
PING
SMTP
TCP
string interval — How often to run the monitor.
Valid values:
1 – Every minute
5 – Every 5 minutes
10 – Every 10 minutes
15 – Every 15 minutes
string retries — How many retries the monitor should attempt on failure before giving up
string timeout — How much time (in seconds) before the connection attempt times out
string port — For HTTP(S)/SMTP/TCP probes, an alternate connection port
string path — For HTTP(S) probes, a specific path to request
string host — For HTTP(S) probes, a value to pass in to the Host: header
string header — For HTTP(S) probes, additional header fields/values to pass in, separated by the newline character (\n)
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 — Fully qualified domain name of a node in the zone
string zone — Name of the zone

Example Request — Click for More Info

{
	'zone' => 'example.com',
	'fqdn' => 'example.com',
	'token' => 'asdlj34ot879834cdzjklfK',
	'contact_nickname' => 'owner',
	'auto_recover' => 'Y',
	'ttl' => 60,
	'notify_events' => 'ip,svc',
	'failover_mode' => 'ip',
	'failover_data' => '127.0.0.1',
	'serve_count' => 1,
	'pool' => [
		{
			'address' => '1.2.3.4',
			'serve_mode' => 'obey',
		},
		{
			'address' => '5.6.7.8',
			'serve_mode' => 'obey',
		},
	],
	'monitor' => {
		'protocol' => 'HTTP',
		'interval' => 1,
	},
}

<< DNS API Knowledge Base

REST Syntax	Associated API Topics
SOAP Syntax	Update Load Balance (API)
	Get Load Balance (API)
	De-Activate Load Balance (API)
	Recover Load Balance (API)
	Delete Load Balance (API)