Update RTTM Region (API) | Dyn Help Center

Creating an RTTM Region 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.

Understanding How The API Works »

REST Syntax

Click to view all REST Resources

/REST/RTTMRegion/ PUT — Updates the RTTM Region settings for the specified region.

HTTP Action — PUT

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

Arguments — Click for More Info

Response — Click for More Info

integer task_id – The number assigned to the task to update the RTTM Region.
string autopopulate — If set to Y, this region will automatically be filled in from the global pool, and any other options passed in for this region will be ignored. Valid values: Y, N
string ep — Eligibility Pool – How many records will make it into the eligibility pool. The addresses that get chosen will be those that respond the fastest.
string serve_count — How many records will be returned in each DNS response.
string failover_mode — How the region should failover. Defaults to global.
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.
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.
region – If failover_mode is region, this is the region_code of the failover target region.
global – If failover_mode is global, this is empty or omitted.
string apmc — The minimum amount of IPs that must be in the up state, otherwise the region will be in failover.
string epmc — The minimum amount of IPs that must be populated in the Eligibility Pool (EP), otherwise the region will be in failover.
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 IPv4 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 the acmp. The service has failed over.

SOAP Syntax

Click to view all SOAP Commands

UpdateRTTMRegion — Updates an existing region entry in the Real Time Traffic Management(RTTM) service.

Arguments — Click for More Info

string zone — Required. Name of the zone where the RTTM service exists.
string fqdn — Required. Name of the node where the RTTM service exists.
string region_code — Required. Name of the region.
Valid values: US West, US Central, US East, EU West, EU Central, EU East, Asia, global
string autopopulate — If set to Y, this region will automatically be filled in from the global pool, and any other options passed in for this region will be ignored. Valid values: Y, N
string ep — Eligibility Pool – How many records will make it into the eligibility pool. The addresses that get chosen will be those that respond the fastest.
string serve_count — How many records will be returned in each DNS response.
string failover_mode — How the region should failover. Defaults to global.
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.
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.
region – If failover_mode is region, this is the region_code for the failover target region.
global – If failover_mode is global, this is empty or omitted.
string apmc — The minimum amount of IPs that must be in the up state, otherwise the region will be in failover.
string epmc — The minimum amount of IPs that must be populated in the Eligibility Pool (EP), otherwise the region will be in failover.
array pool — Required. The IP Pool list for this region.

string address — Required. The IPv4 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 token — Required. The session identifier.

Response — Click for More Info

integer task_id – The number assigned to the task to update the RTTM Region.
hash data

string autopopulate — If set to Y, this region will automatically be filled in from the global pool, and any other options passed in for this region will be ignored. Valid values: Y, N
string ep — Eligibility Pool – How many records will make it into the eligibility pool. The addresses that get chosen will be those that respond the fastest.
string serve_count — How many records will be returned in each DNS response.
string failover_mode — How the region should failover. Defaults to global.
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.
string failover_data — Dependent upon failover_mode.
ip – If failover_mode is ip, this is an IPv4 address.
cname – If failover_mode is cname, this is a CNAME.
region – If failover_mode is region, this is the region_code for the failover target region.
global – If failover_mode is global, this is empty or omitted.
string apmc — The minimum amount of IPs that must be in the up state, otherwise the region will be in failover.
string epmc — The minimum amount of IPs that must be populated in the Eligibility Pool (EP), otherwise the region will be in failover.
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 IPv4 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 the acmp. The service has failed over.

Example Request — Click for More Info

{
	'zone' => 'example.com',
	'fqdn' => 'example.com',
	'region_code' => 'US East'
	'serve_mode' => 'obey',
		'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',
			},
		],
	'token' => 'asdlj34ot879834cdzjklfK',
}

<< DNS API Knowledge Base

REST Syntax	Associated API Topics
SOAP Syntax	Create RTTM Region (API)
	Get RTTM Region(s) (API)
	Delete RTTM Region (API)