Setting a service into Failover mode 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.
See the help topic Recover CDN Manager for more information on the CDN Manager Recover resource/command.
Understanding How The API Works »
| NOTE: CDN Manager Service is deprecated. Legacy users of the service should contact Concierge for any questions on adding a CDN Manager service to your zone. All other users should use the GSLB service instead. |
REST Syntax
| Click to view all REST Resources |
|
/REST/CDNManager/ PUT — Sets a specific region of an existing CDN Manager into failover.
HTTP Action — PUT
URIs — https://api.dynect.net/REST/CDNManager/<zone>/<fqdn>/
|
Arguments — Click for More Info
- 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
- array
region — Required. A list of regions:
- 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 CNAME Pool list for this region.
- string
cname — The CNAME record for this pool entry.
- string
label — A descriptive string describing this CNAME
- string
weight — Required. A number from 1-100 describing how often this record should be served. The higher the number, the more often it will be served.
- string
failover — A boolean to set whether or not this CNAME is intended to be the failover CNAME for region. Only one failover cname may exist for a particular region.
Valid values:
Y — CNAME is intended to be the failover CNAME for the region.
N — CNAME is NOT intended as the failover.
|
Response — Click for More Info
- string
status — The current state of the service.
Valid states:
ok – There are no problems with the service
failover – The service is in 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
- array
region — A list of regions:
- string
status — The current state of the region.
Valid values:
ok – There are no problems with the region
failover – The region is 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 CNAME Pool list for this region
- string
cname — The CNAME record for this pool entry
- string
label — A descriptive string describing this CNAME
- string
weight — A number from 1-100 describing how often this record should be served. The higher the number, the more often it will be served.
- string
failover — A boolean to set whether or not this CNAME is intended to be the failover CNAME for region. Only one failover cname may exist for a particular region.
Valid values:
Y — CNAME is intended to be the failover CNAME for the region.
N — CNAME is NOT intended as the failover.
- 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 |
|
FailoverCDNManager — Sets a specific region of an existing CDN Manager into failover.
|
Arguments — Click for More Info
- 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
fqdn — Required. Name of node where you will recover the service.
- string
token — Required. The session identifier.
- string
zone — Required. Name of zone where you will recover the service.
|
Response — Click for More Info
- hash
data
- string
status — The current state of the service.
Valid states:
ok – There are no problems with the service
failover – The service is in 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
- array
region — A list of regions:
- string
status — The current state of the region.
Valid values:
ok – There are no problems with the region
failover – The region is 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 CNAME Pool list for this region
- string
cname — The CNAME record for this pool entry
- string
label — A descriptive string describing this CNAME
- string
weight — A number from 1-100 describing how often this record should be served. The higher the number, the more often it will be served.
- string
failover — A boolean to set whether or not this CNAME is intended to be the failover CNAME for region. Only one failover cname may exist for a particular region.
Valid values:
Y — CNAME is intended to be the failover CNAME for the region.
N — CNAME is NOT intended as the failover.
- string
fqdn — Fully qualified domain name of a node in the zone
- string
zone — Name of the zone
|
Example Request — Click for More Info
{
'region_code' => 'US East',
'fqdn' => 'reverse.example.com',
'token' => 'asdlkfjasl23j4879afa',
'zone' => 'example.com',
}
|
DNS API Knowledge Base
