Update GSLB Service (API) | Dyn Help Center

Updating an existing instance of the Global Server Load Balancing service using the API requires specific syntax depending on whether you are using REST or SOAP. Use this table to find the syntax for your command.

In order for monitoring to occur on your account, please make sure the IP addresses included here (https://manage.dynect.net/help/agents.html) can reach all your network endpoints. The web page requires you to log-on to Dyn’s Managed DNS.

Understanding How The API Works »

REST Syntax

Click to view all REST Resources

/REST/GSLB/ PUT — Update an existing instance of the Global Server Load Balancing service (GSLB) on the zone/node indicated.

HTTP Action — PUT

URI — https://api.dynect.net/REST/GSLB/<zone>/<fqdn>/

Arguments — Click for More Info

string auto_recover — Indicates whether or not the service should automatically come out of failover when the IP addresses resume active status or if the service should remain in failover until manually reset.
Valid values: Y=yes, N=no.
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.
string notify_events — A comma separated list of the events which trigger notifications.
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.

NOTE: SYSLOG Notifications will come from one or both of these IP Addresses: 216.146.40.70 — or — 216.146.41.70

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 where the remote syslog server listens for notifications. Default = 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. Default = 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, or 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
array region — Required. A list of regions.
- string serve_count — Number of records to be returned in each DNS response.
- string min_healthy — Minimum number of addresses required to have “active” status. Failover occurs when the number of “active” addresses drop below this number. Default = 1.
- string failover_mode — Defines action when failover is triggered.
  Valid values:
  ip – Failover to a particular IP.
  cname – Failover to a particular CNAME.
  region – Failover to a particular region.
  global – Failover to the global IP address pool. Default.
- string failover_data — Dependent upon failover_mode setting:
  ip – If failover_mode is ‘ip’, this should be an IP address.
  cname – If failover_mode is ‘cname’, this should be a CNAME.
  region – If failover_mode is ‘region’, this should be a region_code of the failover target region.
  global – If failover_mode is ‘global’, this should be empty or omitted.
- string region_code — Required. Name of the failover target region.
  Valid values: US West, US Central, US East, EU West, EU Central, EU East, Asia, global
- array pool — Required. The IP Pool list for this region.
  - string address — Required. The IP address or FQDN of this Node IP.
  - string label — Identifying descriptive information for this IP.
  - string weight — A number from 1-15 describing how often this record should be served. Higher values indicate more frequent service for this record.
  - 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.

NOTE: If all fields are left at default for the HTTP, HTTPS, SMTP, or TCP protocols, the measured system will display as ‘healthy’ or ‘online’ if it returns any return code. Adding contents to the Path field will require a 200 level return code for the measured system to display as ‘healthy’ or ‘online’.

string protocol — Required. The protocol to monitor.
Valid values: NONE, HTTP, HTTPS, PING, STMP, TCP.
string interval — Required. How often to run the monitor. Must be twice the TTL setting.
Valid values:
1 – Every minute
5 – Every 5 minutes
10 – Every 10 minutes
15 – Every 15 minutes
string retries — Number of retries the monitor will attempt after a failure notice before no more attempts will be made.
string port — For HTTP(S)/SMTP/TCP probes, an alternate connection port. Leaving the field blank means it will monitor the default port (80 for HTTP and TCP, 443 for HTTPS, and 25 for SMTP).
string path — For HTTP(S) probes, a specific path to request. Designate a path other than the root to be monitored. Paths should be supplied as a relative path to the root ‘/’ directory of the website.
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 case sensitive sub-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

integer task_id – The number assigned to the task to update GSLB.
string active — Indicates whether 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 states:
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 auto_recover — Indicates whether or not the service should automatically come out of failover when the IP addresses resume active status or if the service should remain in failover until manually reset.
Valid values: Y=yes, N=no.
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.
string notify_events — A comma separated list of what events trigger notifications.
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.

NOTE: SYSLOG Notifications will come from one or both of these IP Addresses: 216.146.40.70 — or — 216.146.41.70

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
array region — A list of regions.
- string serve_count — How many records will be returned in each DNS response.
- string min_healthy — If this many addresses aren’t ‘ok’, the service will go into failover; Defaults to 1.
- string failover_mode — How the region should failover.
  Valid values:
  ip – Failover to a particular IP.
  cname – Failover to a particular CNAME.
  region – Failover to a particular region.
  global – Failover to the global IP address pool. Default.
- string failover_data Dependent upon failover_mode.
  ip – If failover_mode is ‘ip’, this should be an IP address.
  cname – If failover_mode is ‘cname’, this should be a CNAME.
  region – If failover_mode is ‘region’, this should be a region_code of the failover target region.
  global – If failover_mode is ‘global’, this should be empty or omitted.
- string region_code — Name of the region.
  Valid values: US West, US Central, US East, EU West, EU Central, EU East, Asia, global
- array pool — The IP Pool list for this region.
  - string address — The IP address or FQDN of this 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
  - string status — The current state of the Node IP.
    Valid values:
    unk – The state of the IP address is not yet known.
    up – The IP address is up.
    down – The IP address is down.
  - array log — Recent monitoring logs for this IP.
    - string status — The state of the Node IP at the time of the log entry.
      Valid Values:
      unk – The state of the IP address is not yet known.
      up – 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.
- string status — The current state of the region.
  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.
hash monitor — The health monitor for the service.
- string protocol — The protocol to monitor.
  Valid values: NONE, HTTP, HTTPS, PING, STMP, 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

UpdateGSLB — Update an existing instance of the Global Server Load Balancing service.

Arguments — Click for More Info

string auto_recover — Indicates whether or not the service should automatically come out of failover when the IP addresses resume active status or if the service should remain in failover until manually reset.
Valid values: Y=yes, N=no.
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.
string notify_events — A comma separated list of which events trigger notifications.
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.

NOTE: SYSLOG Notifications will come from one or both of these IP Addresses: 216.146.40.70 — or — 216.146.41.70

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
array region — Required. A list of regions.
Valid Values: US West, US Central, US East, EU West, EU Central, EU East, Asia, global
- string serve_count — How many records will be returned in each DNS response.
- string min_healthy — If this many addresses aren’t ‘ok’, the service will go into failover; Defaults to 1.
- string failover_mode — How the region should failover.
  Valid values:
  ip – Failover to a particular IP.
  cname – Failover to a particular CNAME.
  region – Failover to a particular region.
  global – Failover to the global IP address pool Default.
- string failover_data — Dependent upon failover_mode.
  Valid values:
  ip – If failover_mode is ‘ip’, this should be an IP address.
  cname – If failover_mode is ‘cname’, this should be a CNAME.
  region – If failover_mode is ‘region’, this should be a region_code of the target region for failover.
  global – If failover_mode is ‘global’, this should be empty or omitted.
- string region_code — Required. Name of the region.
  Valid values: US West, US Central, US East, EU West, EU Central, EU East, Asia, global
- array pool — Required. The IP Pool list for this region.
  - string address — Required. The IP address or FQDN of this Node IP.
  - string label — A descriptive string describing this IP.
  - string weightA 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.

NOTE: If all fields are left at default for the HTTP, HTTPS, SMTP, or TCP protocols, the measured system will display as ‘healthy’ or ‘online’ if it returns any return code. Adding contents to the Path field will require a 200 level return code for the measured system to display as ‘healthy’ or ‘online’.

string protocol — Required. The protocol to monitor.
Valid values: HTTP, HTTPS, PING, STMP, TCP
string interval — Required. How often to run the monitor. Must be twice the TTL setting.
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 port — For HTTP(S)/SMTP/TCP probes, an alternate connection port. Leaving the field blank means it will monitor the default port (80 for HTTP and TCP, 443 for HTTPS, and 25 for SMTP).
string path — For HTTP(S) probes, a specific path to request. Designate a path other than the root to be monitored. Paths should be supplied as a relative path to the root ‘/’ directory of the website.
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 case sensitive sub-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 will exist.
string token — Required. The session identifier.
string zone — Required. Name of zone where the service will exist.

Response — Click for More Info

integer task_id – The number assigned to the task to update GSLB.
hash data
- string active — Indicates the status of the service.
  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 know.
  nok – 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 auto_recover — Indicates whether or not the service should automatically come out of failover when the IP addresses resume active status or if the service should remain in failover until manually reset.
  Valid values: Y=yes, N=no.
- 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.
- 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.

NOTE: SYSLOG Notifications will come from one or both of these IP Addresses: 216.146.40.70 — or — 216.146.41.70

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
array region — A list of regions.
- string serve_count — How many records will be returned in each DNS response.
- string min_healthy — If this many addresses aren’t ‘ok’, the service will go into failover; Defaults to 1.
- string failover_mode — How the region should failover.
  Valid values:
  ip – Failover to a particular IP.
  cname – Failover to a particular CNAME.
  region – Failover to a particular region.
  global – Failover to the global IP address pool Default.
- string failover_data — Dependent upon failover_mode.
  ip – If failover_mode is ‘ip’, this should be an IP address.
  cname – If failover_mode is ‘cname’, this should be a CNAME.
  region – If failover_mode is ‘region’, this should be a region_code of the failover target region.
  global – If failover_mode is ‘global’, this should be empty or omitted.
- string region_code — Name of the region.
  Valid values: US West, US Central, US East, EU West, EU Central, EU East, Asia, global
- array pool — The IP Pool list for this region.
  - string address — The IP address or FQDN of this 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/
  - string status — The current state of the Node IP.
    Valid values:
    unk – The state of the IP address is not yet known.
    up – The IP address is up.
    down – The IP address is down.
  - array log — Recent monitoring logs for this IP.
    - string status — The state of the Node IP at the time of the log entry.
      Valid values:
      unk – The state of the IP address is not yet known.
      up – 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.
- string status — The current state of the region.
  Valid states:
  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.
hash monitor — The health monitor for the service.
- string protocol — The protocol to monitor.
  Valid values: NONE, HTTP, HTTPSm PING, STMP, 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.

Example Request — Click for More Info

{
	'zone' => 'example.com',
	'fqdn' => 'somehost.example.com',
	'token' => 'asdlj34ot879834cdzjklfK',
	'contact_nickname' => 'owner',
	'auto_recover' => 'Y',
	'ttl' => 60,
	'notify_events' => 'ip,svc',
	'region' => [
		{
			'region_code' => 'global',
			'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',
				},
			],
		},
		{
			'region_code' => 'Asia',
			'pool' => [
				{
					'address' => '5.5.5.5',
				},
			],
		},
	],
	'monitor' => {
		'protocol' => 'HTTP',
		'interval' => 1,
	},
}

<< DNS API Knowledge Base

REST Syntax	Associated API Topics
SOAP Syntax	Create GSLB Service (API)
	Get GSLB Service(s) (API)
	Activate/DeActivate GSLB Service (API)
	Recover GSLB Service (API)
	Delete GSLB Service (API)