Traffic Management API Resources

API Summary

Operation Method Endpoint
Domains
List Domains GET /config-gtm/v1/domains/
Get a Domain GET /config-gtm/v1/domains/{domain}
Create or Update a Domain PUT /config-gtm/v1/domains/{domain}
Data Centers
List Data Centers GET /config-gtm/v1/domains/{domain}/datacenters
Create a Data Center POST /config-gtm/v1/domains/{domain}/datacenters
Get a Data Center GET /config-gtm/v1/domains/{domain}/datacenters/{datacenterId}
Update a Data Center PUT /config-gtm/v1/domains/{domain}/datacenters/{datacenterId}
Remove a Data Center DELETE /config-gtm/v1/domains/{domain}/datacenters/{datacenterId}
Properties
List Properties GET /config-gtm/v1/domains/{domain}/properties
Get a Property GET /config-gtm/v1/domains/{domain}/properties/{propertyName}
Create or Update a Property PUT /config-gtm/v1/domains/{domain}/properties/{propertyName}
Remove a Property DELETE /config-gtm/v1/domains/{domain}/properties/{propertyName}
Resources
List Resources GET /config-gtm/v1/domains/{domain}/resources
Get a Resource GET /config-gtm/v1/domains/{domain}/resources/{resourceName}
Create or Update a Resource PUT /config-gtm/v1/domains/{domain}/resources/{resourceName}
Remove a Resource DELETE /config-gtm/v1/domains/{domain}/resources/{resourceName}
Geographic Maps
List Geographic Maps GET /config-gtm/v1/domains/{domain}/geographic-maps
Get a Geographic Map GET /config-gtm/v1/domains/{domain}/geographic-maps/{mapName}
Create or Update a Geographic Map PUT /config-gtm/v1/domains/{domain}/geographic-maps/{mapName}
Remove a Geographic Map DELETE /config-gtm/v1/domains/{domain}/geographic-maps/{mapName}
CIDR Maps
List CIDR Maps GET /config-gtm/v1/domains/{domain}/cidr-maps
Get a CIDR Map GET /config-gtm/v1/domains/{domain}/cidr-maps/{mapName}
Create or Update a CIDR Map PUT /config-gtm/v1/domains/{domain}/cidr-maps/{mapName}
Remove a CIDR Map DELETE /config-gtm/v1/domains/{domain}/cidr-maps/{mapName}
Autonomous System Maps
Get an AS Map GET /config-gtm/v1/domains/{domain}/as-maps/{mapName}
Create or Update an AS Map PUT /config-gtm/v1/domains/{domain}/as-maps/{mapName}
Remove an AS Map DELETE /config-gtm/v1/domains/{domain}/as-maps/{mapName}
Status
Get Current Status GET /config-gtm/v1/domains/{domain}/status/current

List Domains

GET /config-gtm/v1/domains/

Status 200 application/json

Response:

{
    "items": [
        {
            "acgId": "1-2345",
            "lastModified": "2014-03-03T16:02:45.000+0000",
            "links": [
                {
                    "href": "/config-gtm/v1/domains/example.akadns.net",
                    "rel": "self"
                }
            ],
            "name": "example.akadns.net",
            "status": "2014-02-20 22:56 GMT: Current configuration has been propagated to all toplevels"
        },
        {
            "acgId": "1-2345",
            "lastModified": "2013-11-09T12:04:45.000+0000",
            "links": [
                {
                    "href": "/config-gtm/v1/domains/demo.akadns.net",
                    "rel": "self"
                }
            ],
            "name": "demo.akadns.net",
            "status": "2014-02-20 22:56 GMT: Current configuration has been propagated to all toplevels"
        }
    ]
}

Get a Domain

GET /config-gtm/v1/domains/{domain}

Example: /config-gtm/v1/domains/example.akadns.net

Parameter Type Sample Description
Required
domain String example.akadns.net Name of Traffic Management domain.

Status 200 application/json

Response:

{
    "links": [
        {
            "href": "/config-gtm/v1/domains/example.akadns.net",
            "rel": "self"
        },
        {
            "href": "/config-gtm/v1/domains/example.akadns.net/datacenters",
            "rel": "datacenters"
        },
        {
            "href": "/config-gtm/v1/domains/example.akadns.net/properties",
            "rel": "properties"
        },
        {
            "href": "/config-gtm/v1/domains/example.akadns.net/geographic-maps",
            "rel": "geographic-maps"
        },
        {
            "href": "/config-gtm/v1/domains/example.akadns.net/cidr-maps",
            "rel": "cidr-maps"
        },
        {
            "href": "/config-gtm/v1/domains/example.akadns.net/resources",
            "rel": "resources"
        }
    ],
    "cidrMaps": [
        {
            "assignments": [
                {
                    "blocks": [
                        "1.3.5.9",
                        "1.2.3.0/24"
                    ],
                    "datacenterId": 3134,
                    "nickname": "Frostfangs and the Fist of First Men"
                },
                {
                    "blocks": [ "1.2.4.0/24" ],
                    "datacenterId": 3133,
                    "nickname": "Winterfell"
                }
            ],
            "defaultDatacenter": {
                "datacenterId": 5400,
                "nickname": "All Other CIDR Blocks"
            },
            "links": [
                {
                    "href": "/config-gtm/v1/domains/example.akadns.net/cidr-maps/The%20North",
                    "rel": "self"
                }
            ],
            "name": "The North"
        }
    ],
    "datacenters": [
        {
            "city": "Downpatrick",
            "cloneOf": 0,
            "continent": "EU",
            "country": "GB",
            "datacenterId": 3133,
            "defaultLoadObject": {
                "loadObject": null,
                "loadObjectPort": 0,
                "loadServers": null
            },
            "latitude": 54.367,
            "links": [
                {
                    "href": "/config-gtm/v1/domains/example.akadns.net/datacenters/3133",
                    "rel": "self"
                }
            ],
            "longitude": -5.582,
            "nickname": "Winterfell",
            "stateOrProvince": null,
            "virtual": true
        },
        {
            "city": "Doune",
            "cloneOf": 0,
            "continent": "EU",
            "country": "GB",
            "datacenterId": 3134,
            "defaultLoadObject": {
                "loadObject": null,
                "loadObjectPort": 0,
                "loadServers": null
            },
            "latitude": 56.185097,
            "links": [
                {
                    "href": "/config-gtm/v1/domains/example.akadns.net/datacenters/3134",
                    "rel": "self"
                }
            ],
            "longitude": -4.050264,
            "nickname": "Winterfell",
            "stateOrProvince": "Perthshire",
            "virtual": true
        },
        {
            "city": null,
            "cloneOf": 0,
            "continent": null,
            "country": null,
            "datacenterId": 5400,
            "defaultLoadObject": {
                "loadObject": null,
                "loadObjectPort": 0,
                "loadServers": null
            },
            "latitude": 0.0,
            "links": [
                {
                    "href": "/config-gtm/v1/domains/example.akadns.net/datacenters/5400",
                    "rel": "self"
                }
            ],
            "longitude": 0.0,
            "nickname": "Default Datacenter",
            "stateOrProvince": null,
            "virtual": true
        }
    ],
    "defaultSslClientCertificate": null,
    "defaultSslClientPrivateKey": null,
    "defaultUnreachableThreshold": null,
    "emailNotificationList": [],
    "geographicMaps": [
        {
            "assignments": [
                {
                    "countries": [ "GB", "IE" ],
                    "datacenterId": 3133,
                    "nickname": "UK and Ireland users"
                }
            ],
            "defaultDatacenter": {
                "datacenterId": 5400,
                "nickname": "Default Mapping"
            },
            "links": [
                {
                    "href": "/config-gtm/v1/domains/example.akadns.net/geographic-maps/UK%20Delivery",
                    "rel": "self"
                }
            ],
            "name": "UK Delivery"
        }
    ],
    "lastModified": "2014-04-08T18:25:51.000+0000",
    "lastModifiedBy": "admin@example.com",
    "loadFeedback": true,
    "loadImbalancePercentage": 10.0,
    "minPingableRegionFraction": null,
    "modificationComments": "CIDRMap example",
    "name": "example.akadns.net",
    "pingInterval": null,
    "properties": [
        {
            "backupCName": null,
            "backupIp": null,
            "balanceByDownloadScore": false,
            "cname": null,
            "comments": null,
            "dynamicTTL": 300,
            "failbackDelay": 0,
            "failoverDelay": 0,
            "handoutMode": "normal",
            "healthMax": null,
            "healthMultiplier": null,
            "healthThreshold": null,
            "ipv6": false,
            "lastModified": "2014-04-08T18:25:52.000+0000",
            "links": [
                {
                    "href": "/config-gtm/v1/domains/example.akadns.net/properties/www",
                    "rel": "self"
                }
            ],
            "livenessTests": [
                {
                    "disableNonstandardPortWarning": false,
                    "hostHeader": "foo.example.com",
                    "httpError3xx": true,
                    "httpError4xx": true,
                    "httpError5xx": true,
                    "links": [],
                    "name": "health-check",
                    "requestString": null,
                    "responseString": null,
                    "sslClientCertificate": null,
                    "sslClientPrivateKey": null,
                    "testInterval": 60,
                    "testObject": "/status",
                    "testObjectPassword": null,
                    "testObjectPort": 80,
                    "testObjectProtocol": "HTTP",
                    "testObjectUsername": null,
                    "testTimeout": 25.0
                }
            ],
            "mapName": null,
            "maxUnreachablePenalty": null,
            "mxRecords": [],
            "name": "www",
            "scoreAggregationType": "mean",
            "staticTTL": 600,
            "stickinessBonusConstant": 0,
            "stickinessBonusPercentage": 0,
            "trafficTargets": [
                {
                    "datacenterId": 5400,
                    "enabled": false,
                    "handoutCName": null,
                    "name": null,
                    "servers": [],
                    "weight": 0.0
                },
                {
                    "datacenterId": 3134,
                    "enabled": true,
                    "handoutCName": null,
                    "name": null,
                    "servers": [ "1.2.3.5" ],
                    "weight": 0.0
                },
                {
                    "datacenterId": 3133,
                    "enabled": true,
                    "handoutCName": null,
                    "name": null,
                    "servers": [ "1.2.3.4" ],
                    "weight": 1.0
                }
            ],
            "type": "failover",
            "unreachableThreshold": null,
            "useComputedTargets": false
        },
        {
            "backupCName": null,
            "backupIp": null,
            "balanceByDownloadScore": false,
            "cname": null,
            "comments": null,
            "dynamicTTL": 300,
            "failbackDelay": 0,
            "failoverDelay": 0,
            "handoutMode": "normal",
            "healthMax": null,
            "healthMultiplier": null,
            "healthThreshold": null,
            "ipv6": true,
            "lastModified": "2014-04-08T18:25:52.000+0000",
            "links": [
                {
                    "href": "/config-gtm/v1/domains/example.akadns.net/properties/mail",
                    "rel": "self"
                }
            ],
            "livenessTests": [],
            "loadImbalancePercentage": null,
            "mapName": null,
            "maxUnreachablePenalty": null,
            "mxRecords": [],
            "name": "mail",
            "scoreAggregationType": "mean",
            "staticTTL": 600,
            "stickinessBonusConstant": 0,
            "stickinessBonusPercentage": 0,
            "trafficTargets": [
                {
                    "datacenterId": 5400,
                    "enabled": false,
                    "handoutCName": null,
                    "name": null,
                    "servers": [],
                    "weight": 0.0
                },
                {
                    "datacenterId": 3134,
                    "enabled": true,
                    "handoutCName": null,
                    "name": null,
                    "servers": [ "2001:4878::5043:4078" ],
                    "weight": 1.0
                },
                {
                    "datacenterId": 3133,
                    "enabled": true,
                    "handoutCName": null,
                    "name": null,
                    "servers": [
                        "2001:4878::5043:4072",
                        "2001:4878::5043:4071"
                    ],
                    "weight": 1.0
                }
            ],
            "type": "weighted-round-robin",
            "unreachableThreshold": null,
            "useComputedTargets": false
        },
        {
            "backupCName": null,
            "backupIp": null,
            "balanceByDownloadScore": false,
            "cname": null,
            "comments": null,
            "dynamicTTL": 300,
            "failbackDelay": 0,
            "failoverDelay": 0,
            "handoutMode": "normal",
            "healthMax": null,
            "healthMultiplier": null,
            "healthThreshold": null,
            "ipv6": false,
            "lastModified": "2014-04-08T18:25:52.000+0000",
            "links": [
                {
                    "href": "/config-gtm/v1/domains/example.akadns.net/properties/supplies",
                    "rel": "self"
                }
            ],
            "livenessTests": [],
            "loadImbalancePercentage": null,
            "mapName": null,
            "maxUnreachablePenalty": null,
            "mxRecords": [],
            "name": "supplies",
            "scoreAggregationType": "mean",
            "staticTTL": 600,
            "stickinessBonusConstant": 0,
            "stickinessBonusPercentage": 0,
            "trafficTargets": [
                {
                    "datacenterId": 5400,
                    "enabled": false,
                    "handoutCName": "supplies.example.com",
                    "name": null,
                    "servers": [],
                    "weight": 0.0
                },
                {
                    "datacenterId": 3134,
                    "enabled": true,
                    "handoutCName": "winter.supplies.example.com",
                    "name": null,
                    "servers": [],
                    "weight": 0.0
                },
                {
                    "datacenterId": 3133,
                    "enabled": true,
                    "handoutCName": "redcross.org",
                    "name": null,
                    "servers": [],
                    "weight": 0.0
                }
            ],
            "type": "failover",
            "unreachableThreshold": null,
            "useComputedTargets": false
        },
        {
            "backupCName": null,
            "backupIp": null,
            "balanceByDownloadScore": false,
            "cname": null,
            "comments": null,
            "dynamicTTL": 300,
            "failbackDelay": 0,
            "failoverDelay": 0,
            "handoutMode": "normal",
            "healthMax": null,
            "healthMultiplier": null,
            "healthThreshold": null,
            "ipv6": false,
            "lastModified": "2014-04-08T18:25:52.000+0000",
            "links": [
                {
                    "href": "/config-gtm/v1/domains/example.akadns.net/properties/shop",
                    "rel": "self"
                }
            ],
            "livenessTests": [],
            "loadImbalancePercentage": null,
            "mapName": "UK Delivery",
            "maxUnreachablePenalty": null,
            "mxRecords": [],
            "name": "shop",
            "scoreAggregationType": "mean",
            "staticTTL": 600,
            "stickinessBonusConstant": 0,
            "stickinessBonusPercentage": 0,
            "trafficTargets": [
                {
                    "datacenterId": 5400,
                    "enabled": true,
                    "handoutCName": "shop.example.com",
                    "name": null,
                    "servers": [],
                    "weight": 1.0
                },
                {
                    "datacenterId": 3134,
                    "enabled": false,
                    "handoutCName": null,
                    "name": null,
                    "servers": [],
                    "weight": 1.0
                },
                {
                    "datacenterId": 3133,
                    "enabled": true,
                    "handoutCName": "uk.shop.example.com",
                    "name": null,
                    "servers": [],
                    "weight": 1.0
                }
            ],
            "type": "geographic",
            "unreachableThreshold": null,
            "useComputedTargets": false
        }
    ],
    "resources": [
        {
            "aggregationType": "latest",
            "constrainedProperty": "mail",
            "decayRate": null,
            "description": "CPU utilization",
            "hostHeader": null,
            "leaderString": null,
            "leastSquaresDecay": null,
            "links": [
                {
                    "href": "/config-gtm/v1/domains/example.akadns.net/resources/cpu",
                    "rel": "self"
                }
            ],
            "loadImbalancePercentage": null,
            "maxUMultiplicativeIncrement": null,
            "name": "cpu",
            "resourceInstances": [
                {
                    "datacenterId": 3134,
                    "loadObject": "/cpu",
                    "loadObjectPort": 80,
                    "loadServers": [ "1.2.3.8" ],
                    "useDefaultLoadObject": false
                },
                {
                    "datacenterId": 3133,
                    "loadObject": "/cpu",
                    "loadObjectPort": 80,
                    "loadServers": [ "1.2.3.7" ],
                    "useDefaultLoadObject": false
                },
                {
                    "datacenterId": 5400,
                    "loadObject": null,
                    "loadObjectPort": 0,
                    "loadServers": [],
                    "useDefaultLoadObject": false
                }
            ],
            "type": "XML load object via HTTP",
            "upperBound": 0
        },
        {
            "aggregationType": "latest",
            "constrainedProperty": "**",
            "decayRate": null,
            "description": "Supply levels of Arbor Gold",
            "hostHeader": null,
            "leaderString": null,
            "leastSquaresDecay": null,
            "links": [
                {
                    "href": "/config-gtm/v1/domains/example.akadns.net/resources/arbor-gold",
                    "rel": "self"
                }
            ],
            "loadImbalancePercentage": null,
            "maxUMultiplicativeIncrement": null,
            "name": "arbor-gold",
            "resourceInstances": [
                {
                    "datacenterId": 3134,
                    "loadObject": "/cups",
                    "loadObjectPort": 80,
                    "loadServers": [ "1.2.3.8" ],
                    "useDefaultLoadObject": false
                },
                {
                    "datacenterId": 3133,
                    "loadObject": "/cups",
                    "loadObjectPort": 80,
                    "loadServers": [ "1.2.3.7" ],
                    "useDefaultLoadObject": false
                },
                {
                    "datacenterId": 5400,
                    "loadObject": null,
                    "loadObjectPort": 0,
                    "loadServers": [],
                    "useDefaultLoadObject": false
                }
            ],
            "type": "Non-XML load object via HTTP",
            "upperBound": 0
        }
    ],
    "roundRobinPrefix": null,
    "servermonitorLivenessCount": null,
    "servermonitorLoadCount": null,
    "status": {
        "changeId": "5beb11ae-8908-4bfe-8459-e88efc4d2fdc",
        "links": [
            {
                "href": "/config-gtm/v1/domains/example.akadns.net/status/current".
                "rel": "self"
            }
        ],
        "message": "Change Pending",
        "passingValidation": true,
        "propagationStatus": "PENDING",
        "propagationStatusDate": "2014-04-08T18:25:51.000+0000"
    },
    "type": "full"
}

Create or Update a Domain

PUT /config-gtm/v1/domains/{domain}

Example: /config-gtm/v1/domains/example.akadns.net

Content-Type: application/json

Request:

{
    "cidrMaps": [
        {
            "assignments": [
                {
                    "blocks": [
                        "1.3.5.9",
                        "1.2.3.0/24"
                    ],
                    "datacenterId": 3134,
                    "nickname": "Frostfangs and the Fist of First Men"
                },
                {
                    "blocks": [ "1.2.4.0/24" ],
                    "datacenterId": 3133,
                    "nickname": "Winterfell"
                }
            ],
            "defaultDatacenter": {
                "datacenterId": 5400,
                "nickname": "All Other CIDR Blocks"
            },
            "name": "The North"
        }
    ],
    "datacenters": [
        {
            "city": "Doune",
            "cloneOf": 0,
            "continent": "EU",
            "country": "GB",
            "datacenterId": 3133,
            "defaultLoadObject": {
                "loadObject": null,
                "loadObjectPort": 0,
                "loadServers": null
            },
            "latitude": 56.185097,
            "longitude": -4.050264,
            "nickname": "Winterfell",
            "stateOrProvince": "Perthshire",
            "virtual": true
        },
        {
            "city": "Snæfellsjökull",
            "cloneOf": 0,
            "continent": "EU",
            "country": "IS",
            "datacenterId": 3134,
            "defaultLoadObject": {
                "loadObject": null,
                "loadObjectPort": 0,
                "loadServers": null
            },
            "latitude": 64.808,
            "longitude": -23.776,
            "nickname": "Frostfangs",
            "stateOrProvince": null,
            "virtual": true
        },
        {
            "city": null,
            "cloneOf": 0,
            "continent": null,
            "country": null,
            "datacenterId": 5400,
            "defaultLoadObject": {
                "loadObject": null,
                "loadObjectPort": 0,
                "loadServers": null
            },
            "latitude": 0.0,
            "longitude": 0.0,
            "nickname": "Default Datacenter",
            "stateOrProvince": null,
            "virtual": true
        }
    ],
    "defaultSslClientCertificate": null,
    "defaultSslClientPrivateKey": null,
    "defaultUnreachableThreshold": null,
    "emailNotificationList": [],
    "geographicMaps": [
        {
            "assignments": [
                {
                    "countries": [ "GB", "IE" ],
                    "datacenterId": 3133,
                    "nickname": "UK and Ireland users"
                }
            ],
            "defaultDatacenter": {
                "datacenterId": 5400,
                "nickname": "Default Mapping"
            },
            "name": "UK Delivery"
        }
    ],
    "lastModified": "2014-04-08T18:25:51.000+0000",
    "lastModifiedBy": "admin@example.com",
    "loadFeedback": true,
    "loadImbalancePercentage": 10.0,
    "minPingableRegionFraction": null,
    "modificationComments": "CIDRMap example",
    "name": "example.akadns.net",
    "pingInterval": null,
    "properties": [
        {
            "backupCName": null,
            "backupIp": null,
            "balanceByDownloadScore": false,
            "cname": null,
            "comments": null,
            "dynamicTTL": 300,
            "failbackDelay": 0,
            "failoverDelay": 0,
            "handoutMode": "normal",
            "healthMax": null,
            "healthMultiplier": null,
            "healthThreshold": null,
            "ipv6": false,
            "lastModified": "2014-04-08T18:25:52.000+0000",
            "livenessTests": [
                {
                    "disableNonstandardPortWarning": false,
                    "hostHeader": "foo.example.com",
                    "httpError3xx": true,
                    "httpError4xx": true,
                    "httpError5xx": true,
                    "name": "health-check",
                    "requestString": null,
                    "responseString": null,
                    "sslClientCertificate": null,
                    "sslClientPrivateKey": null,
                    "testInterval": 60,
                    "testObject": "/status",
                    "testObjectPassword": null,
                    "testObjectPort": 80,
                    "testObjectProtocol": "HTTP",
                    "testObjectUsername": null,
                    "testTimeout": 25.0
                }
            ],
            "mapName": null,
            "maxUnreachablePenalty": null,
            "mxRecords": [],
            "name": "www",
            "scoreAggregationType": "mean",
            "staticTTL": 600,
            "stickinessBonusConstant": 0,
            "stickinessBonusPercentage": 0,
            "trafficTargets": [
                {
                    "datacenterId": 5400,
                    "enabled": false,
                    "handoutCName": null,
                    "name": null,
                    "servers": [],
                    "weight": 0.0
                },
                {
                    "datacenterId": 3134,
                    "enabled": true,
                    "handoutCName": null,
                    "name": null,
                    "servers": [ "1.2.3.5" ],
                    "weight": 0.0
                },
                {
                    "datacenterId": 3133,
                    "enabled": true,
                    "handoutCName": null,
                    "name": null,
                    "servers": [ "1.2.3.4" ],
                    "weight": 1.0
                }
            ],
            "type": "failover",
            "unreachableThreshold": null,
            "useComputedTargets": false
        },
        {
            "backupCName": null,
            "backupIp": null,
            "balanceByDownloadScore": false,
            "cname": null,
            "comments": null,
            "dynamicTTL": 300,
            "failbackDelay": 0,
            "failoverDelay": 0,
            "handoutMode": "normal",
            "healthMax": null,
            "healthMultiplier": null,
            "healthThreshold": null,
            "ipv6": true,
            "lastModified": "2014-04-08T18:25:52.000+0000",
            "livenessTests": [],
            "mapName": null,
            "maxUnreachablePenalty": null,
            "mxRecords": [],
            "name": "mail",
            "scoreAggregationType": "mean",
            "staticTTL": 600,
            "stickinessBonusConstant": 0,
            "stickinessBonusPercentage": 0,
            "trafficTargets": [
                {
                    "datacenterId": 5400,
                    "enabled": false,
                    "handoutCName": null,
                    "name": null,
                    "servers": [],
                    "weight": 1.0
                },
                {
                    "datacenterId": 3134,
                    "enabled": true,
                    "handoutCName": null,
                    "name": null,
                    "servers": [ "2001:4878::5043:4078" ],
                    "weight": 1.0
                },
                {
                    "datacenterId": 3133,
                    "enabled": true,
                    "handoutCName": null,
                    "name": null,
                    "servers": [
                        "2001:4878::5043:4072",
                        "2001:4878::5043:4071"
                    ],
                    "weight": 1.0
                }
            ],
            "type": "weighted-round-robin",
            "unreachableThreshold": null,
            "useComputedTargets": false
        },
        {
            "backupCName": null,
            "backupIp": null,
            "balanceByDownloadScore": false,
            "cname": null,
            "comments": null,
            "dynamicTTL": 300,
            "failbackDelay": 0,
            "failoverDelay": 0,
            "handoutMode": "normal",
            "healthMax": null,
            "healthMultiplier": null,
            "healthThreshold": null,
            "ipv6": false,
            "lastModified": "2014-04-08T18:25:52.000+0000",
            "livenessTests": [],
            "loadImbalancePercentage": null,
            "mapName": null,
            "maxUnreachablePenalty": null,
            "mxRecords": [],
            "name": "supplies",
            "scoreAggregationType": "mean",
            "staticTTL": 600,
            "stickinessBonusConstant": 0,
            "stickinessBonusPercentage": 0,
            "trafficTargets": [
                {
                    "datacenterId": 5400,
                    "enabled": true,
                    "handoutCName": "supplies.example.com",
                    "name": null,
                    "servers": [],
                    "weight": 1.0
                },
                {
                    "datacenterId": 3134,
                    "enabled": true,
                    "handoutCName": "winter.supplies.example.com",
                    "name": null,
                    "servers": [],
                    "weight": 0.0
                },
                {
                    "datacenterId": 3133,
                    "enabled": true,
                    "handoutCName": "redcross.org",
                    "name": null,
                    "servers": [],
                    "weight": 0.0
                }
            ],
            "type": "failover",
            "unreachableThreshold": null,
            "useComputedTargets": false
        },
        {
            "backupCName": null,
            "backupIp": null,
            "balanceByDownloadScore": false,
            "cname": null,
            "comments": null,
            "dynamicTTL": 300,
            "failbackDelay": 0,
            "failoverDelay": 0,
            "handoutMode": "normal",
            "healthMax": null,
            "healthMultiplier": null,
            "healthThreshold": null,
            "ipv6": false,
            "lastModified": "2014-04-08T18:25:52.000+0000",
            "livenessTests": [],
            "loadImbalancePercentage": null,
            "mapName": "UK Delivery",
            "maxUnreachablePenalty": null,
            "mxRecords": [],
            "name": "shop",
            "scoreAggregationType": "mean",
            "staticTTL": 600,
            "stickinessBonusConstant": 0,
            "stickinessBonusPercentage": 0,
            "trafficTargets": [
                {
                    "datacenterId": 5400,
                    "enabled": true,
                    "handoutCName": "shop.example.com",
                    "name": null,
                    "servers": [],
                    "weight": 1.0
                },
                {
                    "datacenterId": 3134,
                    "enabled": false,
                    "handoutCName": null,
                    "name": null,
                    "servers": [],
                    "weight": 1.0
                },
                {
                    "datacenterId": 3133,
                    "enabled": true,
                    "handoutCName": "uk.shop.example.com",
                    "name": null,
                    "servers": [],
                    "weight": 1.0
                }
            ],
            "type": "geographic",
            "unreachableThreshold": null,
            "useComputedTargets": false
        }
    ],
    "resources": [
        {
            "aggregationType": "latest",
            "constrainedProperty": "mail",
            "decayRate": null,
            "description": "CPU utilization",
            "hostHeader": null,
            "leaderString": null,
            "leastSquaresDecay": null,
            "loadImbalancePercentage": null,
            "maxUMultiplicativeIncrement": null,
            "name": "cpu",
            "resourceInstances": [
                {
                    "datacenterId": 3134,
                    "loadObject": "/cpu",
                    "loadObjectPort": 80,
                    "loadServers": [ "1.2.3.8" ],
                    "useDefaultLoadObject": false
                },
                {
                    "datacenterId": 3133,
                    "loadObject": "/cpu",
                    "loadObjectPort": 80,
                    "loadServers": [ "1.2.3.7" ],
                    "useDefaultLoadObject": false
                },
                {
                    "datacenterId": 5400,
                    "loadObject": null,
                    "loadObjectPort": 0,
                    "loadServers": [],
                    "useDefaultLoadObject": false
                }
            ],
            "type": "XML load object via HTTP",
            "upperBound": 0
        },
        {
            "aggregationType": "latest",
            "constrainedProperty": "**",
            "decayRate": null,
            "description": "Supply levels of Arbor Gold",
            "hostHeader": null,
            "leaderString": null,
            "leastSquaresDecay": null,
            "loadImbalancePercentage": null,
            "maxUMultiplicativeIncrement": null,
            "name": "arbor-gold",
            "resourceInstances": [
                {
                    "datacenterId": 3134,
                    "loadObject": "/cups",
                    "loadObjectPort": 80,
                    "loadServers": [ "1.2.3.8" ],
                    "useDefaultLoadObject": false
                },
                {
                    "datacenterId": 3133,
                    "loadObject": "/cups",
                    "loadObjectPort": 80,
                    "loadServers": [ "1.2.3.7" ],
                    "useDefaultLoadObject": false
                },
                {
                    "datacenterId": 5400,
                    "loadObject": null,
                    "loadObjectPort": 0,
                    "loadServers": [],
                    "useDefaultLoadObject": false
                }
            ],
            "type": "Non-XML load object via HTTP",
            "upperBound": 0
        }
    ],
    "roundRobinPrefix": null,
    "servermonitorLivenessCount": null,
    "servermonitorLoadCount": null,
    "type": "full"
}

Parameter Type Sample Description
Required
domain String example.akadns.net Name of Traffic Management domain.

Status 200 application/json

Response:

{
    "resource": {
        "links": [
            {
                "href": "/config-gtm/v1/domains/example.akadns.net",
                "rel": "self"
            },
            {
                "href": "/config-gtm/v1/domains/example.akadns.net/datacenters",
                "rel": "datacenters"
            },
            {
                "href": "/config-gtm/v1/domains/example.akadns.net/properties",
                "rel": "properties"
            },
            {
                "href": "/config-gtm/v1/domains/example.akadns.net/geographic-maps",
                "rel": "geographic-maps"
            },
            {
                "href": "/config-gtm/v1/domains/example.akadns.net/cidr-maps",
                "rel": "cidr-maps"
            },
            {
                "href": "/config-gtm/v1/domains/example.akadns.net/resources",
                "rel": "resources"
            }
        ],
        "cidrMaps": [
            {
                "assignments": [
                    {
                        "blocks": [
                            "1.3.5.9",
                            "1.2.3.0/24"
                        ],
                        "datacenterId": 3134,
                        "nickname": "Frostfangs and the Fist of First Men"
                    },
                    {
                        "blocks": [ "1.2.4.0/24" ],
                        "datacenterId": 3133,
                        "nickname": "Winterfell"
                    }
                ],
                "defaultDatacenter": {
                    "datacenterId": 5400,
                    "nickname": "All Other CIDR Blocks"
                },
                "links": [
                    {
                        "href": "/config-gtm/v1/domains/example.akadns.net/cidr-maps/The%20North",
                        "rel": "self"
                    }
                ],
                "name": "The North"
            }
        ],
        "datacenters": [
            {
                "city": "Doune",
                "cloneOf": 0,
                "continent": "EU",
                "country": "GB",
                "datacenterId": 3133,
                "defaultLoadObject": {
                    "loadObject": null,
                    "loadObjectPort": 0,
                    "loadServers": null
                },
                "latitude": 56.185097,
                "links": [
                    {
                        "href": "/config-gtm/v1/domains/example.akadns.net/datacenters/3133",
                        "rel": "self"
                    }
                ],
                "longitude": -4.050264,
                "nickname": "Winterfell",
                "stateOrProvince": "Perthshire",
                "virtual": true
            },
            {
                "city": "Snæfellsjökull",
                "cloneOf": 0,
                "continent": "EU",
                "country": "IS",
                "datacenterId": 3134,
                "defaultLoadObject": {
                    "loadObject": null,
                    "loadObjectPort": 0,
                    "loadServers": null
                },
                "latitude": 64.808,
                "links": [
                    {
                        "href": "/config-gtm/v1/domains/example.akadns.net/datacenters/3134",
                        "rel": "self"
                    }
                ],
                "longitude": -23.776,
                "nickname": "Frostfangs",
                "stateOrProvince": null,
                "virtual": true
            },
            {
                "city": null,
                "cloneOf": 0,
                "continent": null,
                "country": null,
                "datacenterId": 5400,
                "defaultLoadObject": {
                    "loadObject": null,
                    "loadObjectPort": 0,
                    "loadServers": null
                },
                "latitude": 0.0,
                "links": [
                    {
                        "href": "/config-gtm/v1/domains/example.akadns.net/datacenters/5400",
                        "rel": "self"
                    }
                ],
                "longitude": 0.0,
                "nickname": "Default Datacenter",
                "stateOrProvince": null,
                "virtual": true
            }
        ],
        "defaultSslClientCertificate": null,
        "defaultSslClientPrivateKey": null,
        "defaultUnreachableThreshold": null,
        "emailNotificationList": [],
        "geographicMaps": [
            {
                "assignments": [
                    {
                        "countries": [ "GB", "IE" ],
                        "datacenterId": 3133,
                        "nickname": "UK and Ireland users"
                    }
                ],
                "defaultDatacenter": {
                    "datacenterId": 5400,
                    "nickname": "Default Mapping"
                },
                "links": [
                    {
                        "href": "/config-gtm/v1/domains/example.akadns.net/geographic-maps/UK%20Delivery",
                        "rel": "self"
                    }
                ],
                "name": "UK Delivery"
            }
        ],
        "lastModified": "2014-04-08T18:25:51.000+0000",
        "lastModifiedBy": "admin@example.com",
        "loadFeedback": true,
        "loadImbalancePercentage": 10.0,
        "minPingableRegionFraction": null,
        "modificationComments": "CIDRMap example",
        "name": "example.akadns.net",
        "pingInterval": null,
        "properties": [
            {
                "backupCName": null,
                "backupIp": null,
                "balanceByDownloadScore": false,
                "cname": null,
                "comments": null,
                "dynamicTTL": 300,
                "failbackDelay": 0,
                "failoverDelay": 0,
                "handoutMode": "normal",
                "healthMax": null,
                "healthMultiplier": null,
                "healthThreshold": null,
                "ipv6": false,
                "lastModified": "2014-04-08T18:25:52.000+0000",
                "links": [
                    {
                        "href": "/config-gtm/v1/domains/example.akadns.net/properties/www",
                        "rel": "self"
                    }
                ],
                "livenessTests": [
                    {
                        "disableNonstandardPortWarning": false,
                        "hostHeader": "foo.example.com",
                        "httpError3xx": true,
                        "httpError4xx": true,
                        "httpError5xx": true,
                        "links": [],
                        "name": "health-check",
                        "requestString": null,
                        "responseString": null,
                        "sslClientCertificate": null,
                        "sslClientPrivateKey": null,
                        "testInterval": 60,
                        "testObject": "/status",
                        "testObjectPassword": null,
                        "testObjectPort": 80,
                        "testObjectProtocol": "HTTP",
                        "testObjectUsername": null,
                        "testTimeout": 25.0
                    }
                ],
                "mapName": null,
                "maxUnreachablePenalty": null,
                "mxRecords": [],
                "name": "www",
                "scoreAggregationType": "mean",
                "staticTTL": 600,
                "stickinessBonusConstant": 0,
                "stickinessBonusPercentage": 0,
                "trafficTargets": [
                    {
                        "datacenterId": 5400,
                        "enabled": false,
                        "handoutCName": null,
                        "name": null,
                        "servers": [],
                        "weight": 0.0
                    },
                    {
                        "datacenterId": 3134,
                        "enabled": true,
                        "handoutCName": null,
                        "name": null,
                        "servers": [ "1.2.3.5" ],
                        "weight": 0.0
                    },
                    {
                        "datacenterId": 3133,
                        "enabled": true,
                        "handoutCName": null,
                        "name": null,
                        "servers": [ "1.2.3.4" ],
                        "weight": 1.0
                    }
                ],
                "type": "failover",
                "unreachableThreshold": null,
                "useComputedTargets": false
            },
            {
                "backupCName": null,
                "backupIp": null,
                "balanceByDownloadScore": false,
                "cname": null,
                "comments": null,
                "dynamicTTL": 300,
                "failbackDelay": 0,
                "failoverDelay": 0,
                "handoutMode": "normal",
                "healthMax": null,
                "healthMultiplier": null,
                "healthThreshold": null,
                "ipv6": true,
                "lastModified": "2014-04-08T18:25:52.000+0000",
                "links": [
                    {
                        "href": "/config-gtm/v1/domains/example.akadns.net/properties/mail",
                        "rel": "self"
                    }
                ],
                "livenessTests": [],
                "mapName": null,
                "maxUnreachablePenalty": null,
                "mxRecords": [],
                "name": "mail",
                "scoreAggregationType": "mean",
                "staticTTL": 600,
                "stickinessBonusConstant": 0,
                "stickinessBonusPercentage": 0,
                "trafficTargets": [
                    {
                        "datacenterId": 5400,
                        "enabled": false,
                        "handoutCName": null,
                        "name": null,
                        "servers": [],
                        "weight": 1.0
                    },
                    {
                        "datacenterId": 3134,
                        "enabled": true,
                        "handoutCName": null,
                        "name": null,
                        "servers": [ "2001:4878::5043:4078" ],
                        "weight": 1.0
                    },
                    {
                        "datacenterId": 3133,
                        "enabled": true,
                        "handoutCName": null,
                        "name": null,
                        "servers": [
                            "2001:4878::5043:4072",
                            "2001:4878::5043:4071"
                        ],
                        "weight": 1.0
                    }
                ],
                "type": "weighted-round-robin",
                "unreachableThreshold": null,
                "useComputedTargets": false
            },
            {
                "backupCName": null,
                "backupIp": null,
                "balanceByDownloadScore": false,
                "cname": null,
                "comments": null,
                "dynamicTTL": 300,
                "failbackDelay": 0,
                "failoverDelay": 0,
                "handoutMode": "normal",
                "healthMax": null,
                "healthMultiplier": null,
                "healthThreshold": null,
                "ipv6": false,
                "lastModified": "2014-04-08T18:25:52.000+0000",
                "links": [
                    {
                        "href": "/config-gtm/v1/domains/example.akadns.net/properties/supplies",
                        "rel": "self"
                    }
                ],
                "livenessTests": [],
                "loadImbalancePercentage": null,
                "mapName": null,
                "maxUnreachablePenalty": null,
                "mxRecords": [],
                "name": "supplies",
                "scoreAggregationType": "mean",
                "staticTTL": 600,
                "stickinessBonusConstant": 0,
                "stickinessBonusPercentage": 0,
                "trafficTargets": [
                    {
                        "datacenterId": 5400,
                        "enabled": true,
                        "handoutCName": "supplies.example.com",
                        "name": null,
                        "servers": [],
                        "weight": 1.0
                    },
                    {
                        "datacenterId": 3134,
                        "enabled": true,
                        "handoutCName": "winter.supplies.example.com",
                        "name": null,
                        "servers": [],
                        "weight": 0.0
                    },
                    {
                        "datacenterId": 3133,
                        "enabled": true,
                        "handoutCName": "redcross.org",
                        "name": null,
                        "servers": [],
                        "weight": 0.0
                    }
                ],
                "type": "failover",
                "unreachableThreshold": null,
                "useComputedTargets": false
            },
            {
                "backupCName": null,
                "backupIp": null,
                "balanceByDownloadScore": false,
                "cname": null,
                "comments": null,
                "dynamicTTL": 300,
                "failbackDelay": 0,
                "failoverDelay": 0,
                "handoutMode": "normal",
                "healthMax": null,
                "healthMultiplier": null,
                "healthThreshold": null,
                "ipv6": false,
                "lastModified": "2014-04-08T18:25:52.000+0000",
                "links": [
                    {
                        "href": "/config-gtm/v1/domains/example.akadns.net/properties/shop",
                        "rel": "self"
                    }
                ],
                "livenessTests": [],
                "loadImbalancePercentage": null,
                "mapName": "UK Delivery",
                "maxUnreachablePenalty": null,
                "mxRecords": [],
                "name": "shop",
                "scoreAggregationType": "mean",
                "staticTTL": 600,
                "stickinessBonusConstant": 0,
                "stickinessBonusPercentage": 0,
                "trafficTargets": [
                    {
                        "datacenterId": 5400,
                        "enabled": true,
                        "handoutCName": "shop.example.com",
                        "name": null,
                        "servers": [],
                        "weight": 1.0
                    },
                    {
                        "datacenterId": 3134,
                        "enabled": false,
                        "handoutCName": null,
                        "name": null,
                        "servers": [],
                        "weight": 1.0
                    },
                    {
                        "datacenterId": 3133,
                        "enabled": true,
                        "handoutCName": "uk.shop.example.com",
                        "name": null,
                        "servers": [],
                        "weight": 1.0
                    }
                ],
                "type": "geographic",
                "unreachableThreshold": null,
                "useComputedTargets": false
            }
        ],
        "resources": [
            {
                "aggregationType": "latest",
                "constrainedProperty": "mail",
                "decayRate": null,
                "description": "CPU utilization",
                "hostHeader": null,
                "leaderString": null,
                "leastSquaresDecay": null,
                "links": [
                    {
                        "href": "/config-gtm/v1/domains/example.akadns.net/resources/cpu",
                        "rel": "self"
                    }
                ],
                "loadImbalancePercentage": null,
                "maxUMultiplicativeIncrement": null,
                "name": "cpu",
                "resourceInstances": [
                    {
                        "datacenterId": 3134,
                        "loadObject": "/cpu",
                        "loadObjectPort": 80,
                        "loadServers": [ "1.2.3.8" ],
                        "useDefaultLoadObject": false
                    },
                    {
                        "datacenterId": 3133,
                        "loadObject": "/cpu",
                        "loadObjectPort": 80,
                        "loadServers": [ "1.2.3.7" ],
                        "useDefaultLoadObject": false
                    },
                    {
                        "datacenterId": 5400,
                        "loadObject": null,
                        "loadObjectPort": 0,
                        "loadServers": [],
                        "useDefaultLoadObject": false
                    }
                ],
                "type": "XML load object via HTTP",
                "upperBound": 0
            },
            {
                "aggregationType": "latest",
                "constrainedProperty": "**",
                "decayRate": null,
                "description": "Supply levels of Arbor Gold",
                "hostHeader": null,
                "leaderString": null,
                "leastSquaresDecay": null,
                "links": [
                    {
                        "href": "/config-gtm/v1/domains/example.akadns.net/resources/arbor-gold",
                        "rel": "self"
                    }
                ],
                "loadImbalancePercentage": null,
                "maxUMultiplicativeIncrement": null,
                "name": "arbor-gold",
                "resourceInstances": [
                    {
                        "datacenterId": 3134,
                        "loadObject": "/cups",
                        "loadObjectPort": 80,
                        "loadServers": [ "1.2.3.8" ],
                        "useDefaultLoadObject": false
                    },
                    {
                        "datacenterId": 3133,
                        "loadObject": "/cups",
                        "loadObjectPort": 80,
                        "loadServers": [ "1.2.3.7" ],
                        "useDefaultLoadObject": false
                    },
                    {
                        "datacenterId": 5400,
                        "loadObject": null,
                        "loadObjectPort": 0,
                        "loadServers": [],
                        "useDefaultLoadObject": false
                    }
                ],
                "type": "Non-XML load object via HTTP",
                "upperBound": 0
            }
        ],
        "roundRobinPrefix": null,
        "servermonitorLivenessCount": null,
        "servermonitorLoadCount": null,
        "status": {
            "changeId": "5beb11ae-8908-4bfe-8459-e88efc4d2fdc",
            "links": [
                {
                    "href": "/config-gtm/v1/domains/example.akadns.net/status/current".
                    "rel": "self"
                }
            ],
            "message": "Change Pending",
            "passingValidation": true,
            "propagationStatus": "PENDING",
            "propagationStatusDate": "2014-04-08T18:25:51.000+0000"
        },
        "type": "full"
    },
    "status": {
        "changeId": "5beb11ae-8908-4bfe-8459-e88efc4d2fdc",
        "links": [
            {
                "href": "/config-gtm/v1/domains/example.akadns.net/status/current".
                "rel": "self"
            }
        ],
        "message": "Change Pending",
        "passingValidation": true,
        "propagationStatus": "PENDING",
        "propagationStatusDate": "2014-04-08T18:25:51.000+0000"
    }
 }

List Data Centers

GET /config-gtm/v1/domains/{domain}/datacenters

Example: /config-gtm/v1/domains/example.akadns.net/datacenters

Parameter Type Sample Description
Required
domain String example.akadns.net Name of Traffic Management domain.

Status 200 application/json

Response:

{
    "items": [
        {
            "city": "Doune",
            "cloneOf": 0,
            "continent": "EU",
            "country": "GB",
            "datacenterId": 3133,
            "defaultLoadObject": {
                "loadObject": null,
                "loadObjectPort": 0,
                "loadServers": null
            },
            "latitude": 56.185097,
            "links": [
                {
                    "href": "/config-gtm/v1/domains/example.akadns.net/datacenters/3133",
                    "rel": "self"
                }
            ],
            "longitude": -4.050264,
            "nickname": "Winterfell",
            "stateOrProvince": "Perthshire",
            "virtual": true
        },
        {
            "city": "Snæfellsjökull",
            "cloneOf": 0,
            "continent": "EU",
            "country": "IS",
            "datacenterId": 3134,
            "defaultLoadObject": {
                "loadObject": null,
                "loadObjectPort": 0,
                "loadServers": null
            },
            "latitude": 64.808,
            "links": [
                {
                    "href": "/config-gtm/v1/domains/example.akadns.net/datacenters/3134",
                    "rel": "self"
                }
            ],
            "longitude": -23.776,
            "nickname": "Frostfangs",
            "stateOrProvince": null,
            "virtual": true
        }
    ]
}

Create a Data Center

POST /config-gtm/v1/domains/{domain}/datacenters

Example: /config-gtm/v1/domains/example.akadns.net/datacenters

Content-Type: application/json

Request:

 {
    "city": "Doune",
    "stateOrProvince": "Perthshire",
    "cloneOf": 0,
    "continent": "EU",
    "country": "GB",
    "defaultLoadObject": {
        "loadObject": null,
        "loadObjectPort": 0,
        "loadServers": null
    },
    "latitude": 56.185096,
    "longitude": -4.050264,
    "nickname": "Winterfell"
}

Parameter Type Sample Description
Required
domain String example.akadns.net Name of Traffic Management domain.

Status 201 application/json

Headers:

  • Location: /config-gtm/v1/domains/example.akadns.net/datacenters/3133

Response:

{
    "resource": {
        "city": "Doune",
        "cloneOf": 0,
        "continent": "EU",
        "country": "GB",
        "datacenterId": 3133,
        "defaultLoadObject": {
            "loadObject": null,
            "loadObjectPort": 0,
            "loadServers": null
        },
        "latitude": 56.185097,
        "links": [
            {
                "href": "/config-gtm/v1/domains/example.akadns.net/datacenters/3133",
                "rel": "self"
            }
        ],
        "longitude": -4.050264,
        "nickname": "Winterfell",
        "stateOrProvince": "Perthshire",
        "virtual": true
    },
    "status": {
        "changeId": "f0c51967-d119-4665-9403-364a57ea5530",
        "links": [
            {
                "href": "/config-gtm/v1/domains/example.akadns.net/status/current",
                "rel": "self"
            }
        ],
        "message": "Change Pending",
        "passingValidation": true,
        "propagationStatus": "PENDING",
        "propagationStatusDate": "2014-04-15T11:30:27.000+0000"
    }
}

Get a Data Center

GET /config-gtm/v1/domains/{domain}/datacenters/{datacenterId}

Example: /config-gtm/v1/domains/example.akadns.net/datacenters/1

Parameter Type Sample Description
Required
datacenterId Number 1 Numeric id of the data center.
domain String example.akadns.net Name of Traffic Management domain.

Status 200 application/json

Response:

{
    "city": "Downpatrick",
    "cloneOf": 0,
    "continent": "EU",
    "country": "GB",
    "datacenterId": 3133,
    "defaultLoadObject": {
        "loadObject": null,
        "loadObjectPort": 0,
        "loadServers": null
    },
    "latitude": 54.367,
    "links": [
        {
            "href": "/config-gtm/v1/domains/example.akadns.net/datacenters/3133",
            "rel": "self"
        }
    ],
    "longitude": -5.582,
    "nickname": "Winterfell",
    "stateOrProvince": null,
    "virtual": true
}

Update a Data Center

PUT /config-gtm/v1/domains/{domain}/datacenters/{datacenterId}

Example: /config-gtm/v1/domains/example.akadns.net/datacenters/1

Content-Type: application/json

Request:

{
    "city": "Downpatrick",
    "cloneOf": 0,
    "continent": "EU",
    "country": "GB",
    "datacenterId": 3133,
    "defaultLoadObject": {
        "loadObject": null,
        "loadObjectPort": 0,
        "loadServers": null
    },
    "latitude": 54.367,
    "longitude": -5.582,
    "nickname": "Winterfell"
}

Parameter Type Sample Description
Required
datacenterId Number 1 Numeric id of the data center.
domain String example.akadns.net Name of Traffic Management domain.

Status 200 application/json

Response:

{
    "resource": {
        "city": "Downpatrick",
        "cloneOf": 0,
        "continent": "EU",
        "country": "GB",
        "datacenterId": 3133,
        "defaultLoadObject": {
            "loadObject": null,
            "loadObjectPort": 0,
            "loadServers": null
        },
        "latitude": 54.367,
        "links": [
            {
                "href": "/config-gtm/v1/domains/example.akadns.net/datacenters/3133",
                "rel": "self"
            }
        ],
        "longitude": -5.582,
        "nickname": "Winterfell",
        "stateOrProvince": null,
        "virtual": true
    },
    "status": {
        "changeId": "bd69be9b-ff44-433d-bff8-ae00d270ea33",
        "links": [
            {
                "href": "/config-gtm/v1/domains/example.akadns.net/status/current",
                "rel": "self"
            }
        ],
        "message": "Change Pending",
        "passingValidation": true,
        "propagationStatus": "PENDING",
        "propagationStatusDate": "2014-04-15T11:30:27.000+0000"
    }
}

Remove a Data Center

DELETE /config-gtm/v1/domains/{domain}/datacenters/{datacenterId}

Example: /config-gtm/v1/domains/example.akadns.net/datacenters/1

Parameter Type Sample Description
Required
datacenterId Number 1 Numeric id of the data center.
domain String example.akadns.net Name of Traffic Management domain.

Status 200 application/json

Response:

{
    "resource": null,
    "status": {
        "changeId": "66c7ff0b-4b9e-41cc-9fd0-34d4f75c2484",
        "links": [
            {
                "href": "/config-gtm/v1/domains/example.akadns.net/status/current",
                "rel": "self"
            }
        ],
        "message": "Change Pending",
        "passingValidation": true,
        "propagationStatus": "PENDING",
        "propagationStatusDate": "2014-04-03T21:18:01.000+0000"
    }
}

List Properties

GET /config-gtm/v1/domains/{domain}/properties

Example: /config-gtm/v1/domains/example.akadns.net/properties

Parameter Type Sample Description
Required
domain String example.akadns.net Name of Traffic Management domain.

Status 200 application/json

Response:

{
    "items": [
        {
            "balanceByDownloadScore": false,
            "dynamicTTL": 300,
            "failbackDelay": 0,
            "failoverDelay": 0,
            "handoutMode": "normal",
            "ipv6": false,
            "lastModified": "2014-04-07T16:21:27.000+0000",
            "links": [
                {
                    "href": "/config-gtm/v1/domains/example.akadns.net/properties/www",
                    "rel": "self"
                }
            ],
            "livenessTests": [
                {
                    "disableNonstandardPortWarning": false,
                    "hostHeader": "foo.example.com",
                    "httpError3xx": true,
                    "httpError4xx": true,
                    "httpError5xx": true,
                    "name": "health-check",
                    "testInterval": 60,
                    "testObject": "/status",
                    "testObjectPort": 80,
                    "testObjectProtocol": "HTTP",
                    "testTimeout": 25.0
                }
            ],
            "mxRecords": [],
            "name": "www",
            "scoreAggregationType": "mean",
            "staticTTL": 600,
            "stickinessBonusConstant": 0,
            "stickinessBonusPercentage": 0,
            "trafficTargets": [
                {
                    "datacenterId": 3134,
                    "enabled": true,
                    "servers": [ "1.2.3.5" ],
                    "weight": 0.0
                },
                {
                    "datacenterId": 3133,
                    "enabled": true,
                    "servers": [ "1.2.3.4" ],
                    "weight": 1.0
                }
            ],
            "type": "failover",
            "useComputedTargets": false
        },
        {
            "balanceByDownloadScore": false,
            "dynamicTTL": 300,
            "failbackDelay": 0,
            "failoverDelay": 0,
            "handoutMode": "normal",
            "ipv6": true,
            "lastModified": "2014-04-07T16:21:27.000+0000",
            "links": [
                {
                    "href": "/config-gtm/v1/domains/example.akadns.net/properties/mail",
                    "rel": "self"
                }
            ],
            "livenessTests": [],
            "mxRecords": [],
            "name": "mail",
            "scoreAggregationType": "mean",
            "staticTTL": 600,
            "stickinessBonusConstant": 0,
            "stickinessBonusPercentage": 0,
            "trafficTargets": [
                {
                    "datacenterId": 3134,
                    "enabled": true,
                    "servers": [ "2001:4878::5043:4078" ],
                    "weight": 1.0
                },
                {
                    "datacenterId": 3133,
                    "enabled": true,
                    "servers": [
                        "2001:4878::5043:4072",
                        "2001:4878::5043:4071"
                    ],
                    "weight": 1.0
                }
            ],
            "type": "weighted-round-robin",
            "useComputedTargets": false
        }
    ]
}

Get a Property

GET /config-gtm/v1/domains/{domain}/properties/{propertyName}

Example: /config-gtm/v1/domains/example.akadns.net/properties/www

Parameter Type Sample Description
Required
domain String example.akadns.net Name of Traffic Management domain.
propertyName String www Name of property to create or update.

Status 200 application/json

Response:

{
    "backupCName": null,
    "backupIp": null,
    "balanceByDownloadScore": false,
    "cname": null,
    "comments": null,
    "dynamicTTL": 300,
    "failbackDelay": 0,
    "failoverDelay": 0,
    "handoutMode": "normal",
    "healthMax": null,
    "healthMultiplier": null,
    "healthThreshold": null,
    "ipv6": false,
    "lastModified": "2014-04-08T15:11:10.000+0000",
    "links": [
        {
            "href": "/config-gtm/v1/domains/example.akadns.net/properties/www",
            "rel": "self"
        }
    ],
    "livenessTests": [
        {
            "disableNonstandardPortWarning": false,
            "hostHeader": "foo.example.com",
            "httpError3xx": true,
            "httpError4xx": true,
            "httpError5xx": true,
            "name": "health-check",
            "requestString": null,
            "responseString": null,
            "sslClientCertificate": null,
            "sslClientPrivateKey": null,
            "testInterval": 60,
            "testObject": "/status",
            "testObjectPassword": null,
            "testObjectPort": 80,
            "testObjectProtocol": "HTTP",
            "testObjectUsername": null,
            "testTimeout": 25.0
        }
    ],
    "loadImbalancePercentage": null,
    "mapName": null,
    "maxUnreachablePenalty": null,
    "mxRecords": [],
    "name": "www",
    "scoreAggregationType": "mean",
    "staticTTL": 600,
    "stickinessBonusConstant": 0,
    "stickinessBonusPercentage": 0,
    "trafficTargets": [
        {
            "datacenterId": 3134,
            "enabled": true,
            "handoutCName": null,
            "name": null,
            "servers": [ "1.2.3.5" ],
            "weight": 0.0
        },
        {
            "datacenterId": 3133,
            "enabled": true,
            "handoutCName": null,
            "name": null,
            "servers": [ "1.2.3.4" ],
            "weight": 1.0
        }
    ],
    "type": "failover",
    "unreachableThreshold": null,
    "useComputedTargets": false
}

Create or Update a Property

PUT /config-gtm/v1/domains/{domain}/properties/{propertyName}

Example: /config-gtm/v1/domains/example.akadns.net/properties/www

Content-Type: application/json

Request:

{
    "balanceByDownloadScore": false,
    "failbackDelay": 0,
    "failoverDelay": 0,
    "handoutMode": "normal",
    "healthMax": null,
    "healthMultiplier": null,
    "healthThreshold": null,
    "ipv6": false,
    "livenessTests": [
        {
            "disableNonstandardPortWarning": false,
            "hostHeader": "foo.example.com",
            "httpError3xx": true,
            "httpError4xx": true,
            "httpError5xx": true,
            "name": "health-check",
            "requestString": null,
            "responseString": null,
            "sslClientCertificate": null,
            "sslClientPrivateKey": null,
            "testInterval": 60,
            "testObject": "/status",
            "testObjectPassword": null,
            "testObjectPort": 80,
            "testObjectProtocol": "HTTP",
            "testObjectUsername": null,
            "testTimeout": 25.0
        }
    ],
    "mxRecords": [],
    "name": "origin",
    "scoreAggregationType": "mean",
    "staticTTL": 600,
    "stickinessBonusConstant": 0,
    "stickinessBonusPercentage": 0,
    "trafficTargets": [
        {
            "datacenterId": 3134,
            "enabled": true,
            "servers": [ "1.2.3.5" ],
            "weight": 50.0
        },
        {
            "datacenterId": 3133,
            "enabled": true,
            "servers": [ "1.2.3.4" ],
            "weight": 50.0
        }
    ],
    "type": "weighted-round-robin",
    "useComputedTargets": false
}

Parameter Type Sample Description
Required
domain String example.akadns.net Name of Traffic Management domain.
propertyName String www Name of property to create or update.

Status 201 application/json

Response:

{
    "resource": {
        "backupCName": null,
        "backupIp": null,
        "balanceByDownloadScore": false,
        "cname": null,
        "comments": null,
        "dynamicTTL": 300,
        "failbackDelay": 0,
        "failoverDelay": 0,
        "handoutMode": "normal",
        "healthMax": null,
        "healthMultiplier": null,
        "healthThreshold": null,
        "ipv6": false,
        "lastModified": null,
        "links": [
            {
                "href": "/config-gtm/v1/domains/example.akadns.net/properties/origin",
                "rel": "self"
            }
        ],
        "livenessTests": [
            {
                "disableNonstandardPortWarning": false,
                "hostHeader": "foo.example.com",
                "httpError3xx": true,
                "httpError4xx": true,
                "httpError5xx": true,
                "name": "health-check",
                "requestString": null,
                "responseString": null,
                "sslClientCertificate": null,
                "sslClientPrivateKey": null,
                "testInterval": 60,
                "testObject": "/status",
                "testObjectPassword": null,
                "testObjectPort": 80,
                "testObjectProtocol": "HTTP",
                "testObjectUsername": null,
                "testTimeout": 25.0
            }
        ],
        "loadImbalancePercentage": null,
        "mapName": null,
        "maxUnreachablePenalty": null,
        "mxRecords": [],
        "name": "origin",
        "scoreAggregationType": "mean",
        "staticTTL": 600,
        "stickinessBonusConstant": 0,
        "stickinessBonusPercentage": 0,
        "trafficTargets": [
            {
                "datacenterId": 3134,
                "enabled": true,
                "handoutCName": null,
                "name": null,
                "servers": [ "1.2.3.5" ],
                "weight": 50.0
            },
            {
                "datacenterId": 3133,
                "enabled": true,
                "handoutCName": null,
                "name": null,
                "servers": [ "1.2.3.4" ],
                "weight": 50.0
            }
        ],
        "type": "weighted-round-robin",
        "unreachableThreshold": null,
        "useComputedTargets": false
    },
    "status": {
        "changeId": "eee0c3b4-0e45-4f4b-822c-7dbc60764d18",
        "links": [
            {
                "href": "/config-gtm/v1/domains/example.akadns.net/status/current",
                "rel": "self"
            }
        ],
        "message": "Change Pending",
        "passingValidation": true,
        "propagationStatus": "PENDING",
        "propagationStatusDate": "2014-04-15T11:30:27.000+0000"
    }
}

Remove a Property

DELETE /config-gtm/v1/domains/{domain}/properties/{propertyName}

Example: /config-gtm/v1/domains/example.akadns.net/properties/www

Parameter Type Sample Description
Required
domain String example.akadns.net Name of Traffic Management domain.
propertyName String www Name of property to create or update.

Status 200 application/json

Response:

{
    "resource": null,
    "status": {
        "changeId": "426e9ea3-c968-47df-a41b-43a993c6f873",
        "links": [
            {
                "href": "/config-gtm/v1/domains/example.akadns.net/status/current",
                "rel": "self"
            }
        ],
        "message": "Change Pending",
        "passingValidation": true,
        "propagationStatus": "PENDING",
        "propagationStatusDate": "2014-04-08T12:52:46.000+0000"
    }
}

List Resources

GET /config-gtm/v1/domains/{domain}/resources

Example: /config-gtm/v1/domains/example.akadns.net/resources

Parameter Type Sample Description
Required
domain String example.akadns.net Name of Traffic Management domain.

Status 200 application/json

Response:

{
    "items": [
        {
            "aggregationType": "latest",
            "constrainedProperty": "**",
            "decayRate": null,
            "description": "Supply levels of Arbor Gold",
            "hostHeader": null,
            "leaderString": null,
            "leastSquaresDecay": null,
            "links": [
                {
                    "href": "/config-gtm/v1/domains/example.akadns.net/resources/arbor-gold",
                    "rel": "self"
                }
            ],
            "loadImbalancePercentage": null,
            "maxUMultiplicativeIncrement": null,
            "name": "arbor-gold",
            "resourceInstances": [
                {
                    "datacenterId": 3134,
                    "loadObject": "/cups",
                    "loadObjectPort": 80,
                    "loadServers": [ "1.2.3.8" ],
                    "useDefaultLoadObject": false
                },
                {
                    "datacenterId": 3133,
                    "loadObject": "/cups",
                    "loadObjectPort": 80,
                    "loadServers": [ "1.2.3.7" ],
                    "useDefaultLoadObject": false
                }
            ],
            "type": "Non-XML load object via HTTP",
            "upperBound": 0
        },
        {
            "aggregationType": "latest",
            "constrainedProperty": "mail",
            "decayRate": null,
            "description": "CPU utilization",
            "hostHeader": null,
            "leaderString": null,
            "leastSquaresDecay": null,
            "links": [
                {
                    "href": "/config-gtm/v1/domains/example.akadns.net/resources/cpu",
                    "rel": "self"
                }
            ],
            "loadImbalancePercentage": null,
            "maxUMultiplicativeIncrement": null,
            "name": "cpu",
            "resourceInstances": [
                {
                    "datacenterId": 3134,
                    "loadObject": "/cpu",
                    "loadObjectPort": 80,
                    "loadServers": [ "1.2.3.8" ],
                    "useDefaultLoadObject": false
                },
                {
                    "datacenterId": 3133,
                    "loadObject": "/cpu",
                    "loadObjectPort": 80,
                    "loadServers": [ "1.2.3.7" ],
                    "useDefaultLoadObject": false
                }
            ],
            "type": "XML load object via HTTP",
            "upperBound": 0
        }
    ]
}

Get a Resource

GET /config-gtm/v1/domains/{domain}/resources/{resourceName}

Example: /config-gtm/v1/domains/example.akadns.net/resources/cpu

Parameter Type Sample Description
Required
domain String example.akadns.net Name of Traffic Management domain.
resourceName String cpu Name of Resource to create or update.

Status 200 application/json

Response:

{
    "aggregationType": "latest",
    "constrainedProperty": "**",
    "decayRate": null,
    "description": "Supply levels of Arbor Gold",
    "hostHeader": null,
    "leaderString": null,
    "leastSquaresDecay": null,
    "links": [
        {
            "href": "/config-gtm/v1/domains/example.akadns.net/resources/arbor-gold",
            "rel": "self"
        }
    ],
    "loadImbalancePercentage": null,
    "maxUMultiplicativeIncrement": null,
    "name": "arbor-gold",
    "resourceInstances": [
        {
            "datacenterId": 3134,
            "loadObject": "/cups",
            "loadObjectPort": 80,
            "loadServers": [ "1.2.3.8" ],
            "useDefaultLoadObject": false
        },
        {
            "datacenterId": 3133,
            "loadObject": "/cups",
            "loadObjectPort": 80,
            "loadServers": [ "1.2.3.7" ],
            "useDefaultLoadObject": false
        }
    ],
    "type": "Non-XML load object via HTTP",
    "upperBound": 0
}

Create or Update a Resource

PUT /config-gtm/v1/domains/{domain}/resources/{resourceName}

Example: /config-gtm/v1/domains/example.akadns.net/resources/cpu

Content-Type: application/json

Request:

{
    "aggregationType": "latest",
    "constrainedProperty": "mail",
    "decayRate": null,
    "description": "Disk utilization",
    "hostHeader": null,
    "leaderString": null,
    "leastSquaresDecay": null,
    "loadImbalancePercentage": null,
    "maxUMultiplicativeIncrement": null,
    "name": "disk",
    "resourceInstances": [
        {
            "datacenterId": 3134,
            "loadObject": "/disk",
            "loadObjectPort": 80,
            "loadServers": [ "1.2.3.9" ],
            "useDefaultLoadObject": false
        },
        {
            "datacenterId": 3133,
            "loadObject": "/disk",
            "loadObjectPort": 80,
            "loadServers": [ "1.2.3.10" ],
            "useDefaultLoadObject": false
        }
    ],
    "type": "XML load object via HTTP",
    "upperBound": 0
}

Parameter Type Sample Description
Required
domain String example.akadns.net Name of Traffic Management domain.
resourceName String cpu Name of Resource to create or update.

Status 200 application/json

Response:

{
    "resource": {
        "aggregationType": "latest",
        "constrainedProperty": "mail",
        "decayRate": null,
        "description": "Disk utilization",
        "hostHeader": null,
        "leaderString": null,
        "leastSquaresDecay": null,
        "links": [
            {
                "href": "/config-gtm/v1/domains/example.akadns.net/resources/disk",
                "rel": "self"
            }
        ],
        "loadImbalancePercentage": null,
        "maxUMultiplicativeIncrement": null,
        "name": "disk",
        "resourceInstances": [
            {
                "datacenterId": 3134,
                "loadObject": "/disk",
                "loadObjectPort": 80,
                "loadServers": [ "1.2.3.9" ],
                "useDefaultLoadObject": false
            },
            {
                "datacenterId": 3133,
                "loadObject": "/disk",
                "loadObjectPort": 80,
                "loadServers": [ "1.2.3.10" ],
                "useDefaultLoadObject": false
            }
        ],
        "type": "XML load object via HTTP",
        "upperBound": 0
    },
    "status": {
        "changeId": "79255c00-f6b6-48ea-9d67-c6d02a8742c9",
        "links": [
            {
                "href": "/config-gtm/v1/domains/example.akadns.net/status/current",
                "rel": "self"
            }
        ],
        "message": "Change Pending",
        "passingValidation": true,
        "propagationStatus": "PENDING",
        "propagationStatusDate": "2014-04-15T11:30:27.000+0000"
    }
}

Remove a Resource

DELETE /config-gtm/v1/domains/{domain}/resources/{resourceName}

Example: /config-gtm/v1/domains/example.akadns.net/resources/cpu

Parameter Type Sample Description
Required
domain String example.akadns.net Name of Traffic Management domain.
resourceName String cpu Name of Resource to create or update.

Status 200 application/json

Response:

{
    "resource": null,
    "status": {
        "changeId": "a97bedfe-c997-4634-84a4-cdb31529fb4c",
        "links": [
            {
                "href": "/config-gtm/v1/domains/example.akadns.net/status/current",
                "rel": "self"
            }
        ],
        "message": "Change Pending",
        "passingValidation": true,
        "propagationStatus": "PENDING",
        "propagationStatusDate": "2014-04-08T13:44:53.000+0000"
    }
}

List Geographic Maps

GET /config-gtm/v1/domains/{domain}/geographic-maps

Example: /config-gtm/v1/domains/example.akadns.net/geographic-maps

Parameter Type Sample Description
Required
domain String example.akadns.net Name of Traffic Management domain.

Status 200 application/json

Response:

{
    "items": [
        {
            "assignments": [
                {
                    "countries": [ "GB", "IE" ],
                    "datacenterId": 3133,
                    "nickname": "UK and Ireland users"
                }
            ],
            "defaultDatacenter": {
                "datacenterId": 5400,
                "nickname": "Default Mapping"
            },
            "links": [
                {
                    "href": "/config-gtm/v1/domains/example.akadns.net/geographic-maps/UK%20Delivery",
                    "rel": "self"
                }
            ],
            "name": "UK Delivery"
        }
    ]
}

Get a Geographic Map

GET /config-gtm/v1/domains/{domain}/geographic-maps/{mapName}

Example: /config-gtm/v1/domains/example.akadns.net/geographic-maps/Software-rollout

Parameter Type Sample Description
Required
domain String example.akadns.net Name of Traffic Management domain.
mapName String Software-rollout Name of Geographic Map to create or update.

Status 200 application/json

Response:

{
    "assignments": [
        {
            "countries": [ "GB", "IE" ],
            "datacenterId": 3133,
            "nickname": "UK and Ireland users"
        }
    ],
    "defaultDatacenter": {
        "datacenterId": 5400,
        "nickname": "Default Mapping"
    },
    "links": [
        {
            "href": "/config-gtm/v1/domains/example.akadns.net/geographic-maps/UK%20Delivery",
            "rel": "self"
        }
    ],
    "name": "UK Delivery"
}

Create or Update a Geographic Map

PUT /config-gtm/v1/domains/{domain}/geographic-maps/{mapName}

Example: /config-gtm/v1/domains/example.akadns.net/geographic-maps/Software-rollout

Content-Type: application/json

Request:

{
    "assignments": [
        {
            "countries": [ "GB", "IE" ],
            "datacenterId": 3133,
            "nickname": "UK and Ireland users"
        }
    ],
    "defaultDatacenter": {
        "datacenterId": 5400,
        "nickname": "Default Mapping"
    }
    "name": "UK Delivery"
}

Parameter Type Sample Description
Required
domain String example.akadns.net Name of Traffic Management domain.
mapName String Software-rollout Name of Geographic Map to create or update.

Status 200 application/json

Response:

{
    "resource": {
        "assignments": [
            {
                "countries": [ "GB", "IE" ],
                "datacenterId": 3133,
                "nickname": "UK and Ireland users"
            }
        ],
        "defaultDatacenter": {
            "datacenterId": 5400,
            "nickname": "Default Mapping"
        },
        "links": [
            {
                "href": "/config-gtm/v1/domains/example.akadns.net/geographic-maps/UK%20Delivery",
                "rel": "self"
            }
        ],
        "name": "UK Delivery"
    },
    "status": {
        "changeId": "f2977f97-565b-46af-abfb-1da7e3e8c54b",
        "links": [
            {
                "href": "/config-gtm/v1/domains/example.akadns.net/status/current",
                "rel": "self"
            }
        ],
        "message": "Change Pending",
        "passingValidation": true,
        "propagationStatus": "PENDING",
        "propagationStatusDate": "2014-04-15T11:30:27.000+0000"
    }
}

Remove a Geographic Map

DELETE /config-gtm/v1/domains/{domain}/geographic-maps/{mapName}

Example: /config-gtm/v1/domains/example.akadns.net/geographic-maps/Software-rollout

Parameter Type Sample Description
Required
domain String example.akadns.net Name of Traffic Management domain.
mapName String Software-rollout Name of Geographic Map to create or update.

Status 200 application/json

Response:

{
    "resource": null,
    "status": {
        "changeId": "a97bedfe-c997-4634-84a4-cdb31529fb4c",
        "links": [
            {
                "href": "/config-gtm/v1/domains/example.akadns.net/status/current",
                "rel": "self"
            }
        ],
        "message": "Change Pending",
        "passingValidation": true,
        "propagationStatus": "PENDING",
        "propagationStatusDate": "2014-04-08T13:44:53.000+0000"
    }
}

List CIDR Maps

GET /config-gtm/v1/domains/{domain}/cidr-maps

Example: /config-gtm/v1/domains/example.akadns.net/cidr-maps

Parameter Type Sample Description
Required
domain String example.akadns.net Name of Traffic Management domain.

Status 200 application/json

Response:

{
    "items": [
        {
            "assignments": [
                {
                    "blocks": [ "1.2.3.0/24" ],
                    "datacenterId": 3134,
                    "nickname": "Frostfangs and the Fist of First Men"
                },
                {
                    "blocks": [ "1.2.4.0/24" ],
                    "datacenterId": 3133,
                    "nickname": "Winterfell"
                }
            ],
            "defaultDatacenter": {
                "datacenterId": 5400,
                "nickname": "All Other CIDR Blocks"
            },
            "links": [
                {
                    "href": "/config-gtm/v1/domains/example.akadns.net/cidr-maps/The%20North",
                    "rel": "self"
                }
            ],
            "name": "The North"
        }
    ]
}

Get a CIDR Map

GET /config-gtm/v1/domains/{domain}/cidr-maps/{mapName}

Example: /config-gtm/v1/domains/example.akadns.net/cidr-maps/Software-rollout

Parameter Type Sample Description
Required
domain String example.akadns.net Name of Traffic Management domain.
mapName String Software-rollout Name of CIDR Map to create or update.

Status 200 application/json

Response:

{
    "assignments": [
        {
            "blocks": [ "1.2.3.0/24" ],
            "datacenterId": 3134,
            "nickname": "Frostfangs and the Fist of First Men"
        },
        {
            "blocks": [ "1.2.4.0/24" ],
            "datacenterId": 3133,
            "nickname": "Winterfell"
        }
    ],
    "defaultDatacenter": {
        "datacenterId": 5400,
        "nickname": "All Other CIDR Blocks"
    },
    "links": [
        {
            "href": "/config-gtm/v1/domains/example.akadns.net/cidr-maps/The%20North",
            "rel": "self"
        }
    ],
    "name": "The North"
}

Create or Update a CIDR Map

PUT /config-gtm/v1/domains/{domain}/cidr-maps/{mapName}

Example: /config-gtm/v1/domains/example.akadns.net/cidr-maps/Software-rollout

Content-Type: application/json

Request:

{
    "assignments": [
        {
            "blocks": [
                "1.3.5.9",
                "1.2.3.0/24"
            ],
            "datacenterId": 3134,
            "nickname": "Frostfangs and the Fist of First Men"
        },
        {
            "blocks": [ "1.2.4.0/24" ],
            "datacenterId": 3133,
            "nickname": "Winterfell"
        }
    ],
    "defaultDatacenter": {
        "datacenterId": 5400,
        "nickname": "All Other CIDR Blocks"
    }
    "name": "The North"
}

Parameter Type Sample Description
Required
domain String example.akadns.net Name of Traffic Management domain.
mapName String Software-rollout Name of CIDR Map to create or update.

Status 200 application/json

Response:

{
    "resource": {
        "assignments": [
            {
                "blocks": [
                    "1.3.5.9",
                    "1.2.3.0/24"
                ],
                "datacenterId": 3134,
                "nickname": "Frostfangs and the Fist of First Men"
            },
            {
                "blocks": [ "1.2.4.0/24" ],
                "datacenterId": 3133,
                "nickname": "Winterfell"
            }
        ],
        "defaultDatacenter": {
            "datacenterId": 5400,
            "nickname": "All Other CIDR Blocks"
        },
        "links": [
            {
                "href": "/config-gtm/v1/domains/example.akadns.net/cidr-maps/The%2520North",
                "rel": "self"
            }
        ],
        "name": "The North"
    },
    "status": {
        "changeId": "93a48b86-4fc3-4a5f-9ca2-036835034cc6",
        "links": [
            {
                "href": "/config-gtm/v1/domains/example.akadns.net/status/current",
                "rel": "self"
            }
        ],
        "message": "Change Pending",
        "passingValidation": true,
        "propagationStatus": "PENDING",
        "propagationStatusDate": "2014-04-15T11:30:27.000+0000"
    }
}

Remove a CIDR Map

DELETE /config-gtm/v1/domains/{domain}/cidr-maps/{mapName}

Example: /config-gtm/v1/domains/example.akadns.net/cidr-maps/Software-rollout

Parameter Type Sample Description
Required
domain String example.akadns.net Name of Traffic Management domain.
mapName String Software-rollout Name of CIDR Map to create or update.

Status 200 application/json

Response:

{
    "resource": null,
    "status": {
        "changeId": "5beb11ae-8908-4bfe-8459-e88efc4d2fdc",
        "links": [
            {
                "href": "/config-gtm/v1/domains/example.akadns.net/status/current",
                "rel": "self"
            }
        ],
        "message": "Change Pending",
        "passingValidation": true,
        "propagationStatus": "PENDING",
        "propagationStatusDate": "2014-04-08T18:25:51.000+0000"
    }
}

Get an AS Map

GET /config-gtm/v1/domains/{domain}/as-maps/{mapName}

Example: /config-gtm/v1/domains/example.akadns.net/as-maps/Software-rollout

Parameter Type Sample Description
Required
domain String example.akadns.net Name of Traffic Management domain.
mapName String Software-rollout Name of AS Map to create, update or delete.

Status 200 application/vnd.config-gtm.v1.1+json

Response:

{
    "assignments": [
        {
            "asNumbers": [ 12222, 16702, 17334 ],
            "datacenterId": 3134,
            "nickname": "Frostfangs and the Fist of First Men"
        },
        {
            "asNumbers": [ 16625 ],
            "datacenterId": 3133,
            "nickname": "Winterfell"
        }
    ],
    "defaultDatacenter": {
        "datacenterId": 5400,
        "nickname": "All Other AS numbers"
    },
    "links": [
        {
            "href": "/config-gtm/v1/domains/example.akadns.net/as-maps/The%20North",
            "rel": "self"
        }
    ],
    "name": "The North"
}

Create or Update an AS Map

PUT /config-gtm/v1/domains/{domain}/as-maps/{mapName}

Example: /config-gtm/v1/domains/example.akadns.net/as-maps/Software-rollout

Content-Type: application/vnd.config-gtm.v1.1+json

Request:

{
    "assignments": [
        {
            "asNumbers": [ 16625 ],
            "datacenterId": 3134,
            "nickname": "Frostfangs and the Fist of First Men"
        },
        {
            "asNumbers": [ 12222, 16702, 17334 ],
            "datacenterId": 3133,
            "nickname": "Winterfell"
        }
    ],
    "defaultDatacenter": {
        "datacenterId": 5400,
        "nickname": "All Other AS Numbers"
    }
    "name": "The North"
}

Parameter Type Sample Description
Required
domain String example.akadns.net Name of Traffic Management domain.
mapName String Software-rollout Name of AS Map to create, update or delete.

Status 200 application/vnd.config-gtm.v1.1+json

Response:

{
    "resource": {
        "assignments": [
            {
                "asNumbers": [ 16625 ],
                "datacenterId": 3134,
                "nickname": "Frostfangs and the Fist of First Men"
            },
            {
                "asNumbers": [ 12222, 16702, 17334 ],
                "datacenterId": 3133,
                "nickname": "Winterfell"
            }
        ],
        "defaultDatacenter": {
            "datacenterId": 5400,
            "nickname": "All Other AS Numbers"
        },
        "links": [
            {
                "href": "/config-gtm/v1/domains/example.akadns.net/as-maps/The%2520North",
                "rel": "self"
            }
        ],
        "name": "The North"
    },
    "status": {
        "changeId": "93a48b86-4fc3-4a5f-9ca2-036835034cc6",
        "links": [
            {
                "href": "/config-gtm/v1/domains/example.akadns.net/status/current",
                "rel": "self"
            }
        ],
        "message": "Change Pending",
        "passingValidation": true,
        "propagationStatus": "PENDING",
        "propagationStatusDate": "2014-04-15T11:30:27.000+0000"
    }
}

Remove an AS Map

DELETE /config-gtm/v1/domains/{domain}/as-maps/{mapName}

Example: /config-gtm/v1/domains/example.akadns.net/as-maps/Software-rollout

Parameter Type Sample Description
Required
domain String example.akadns.net Name of Traffic Management domain.
mapName String Software-rollout Name of AS Map to create, update or delete.

Status 200 application/vnd.config-gtm.v1.1+json

Response:

{
    "resource": null,
    "status": {
        "changeId": "5beb11ae-8908-4bfe-8459-e88efc4d2fdc",
        "links": [
            {
                "href": "/config-gtm/v1/domains/example.akadns.net/status/current",
                "rel": "self"
            }
        ],
        "message": "Change Pending",
        "passingValidation": true,
        "propagationStatus": "PENDING",
        "propagationStatusDate": "2014-04-08T18:25:51.000+0000"
    }
}

Get Current Status

GET /config-gtm/v1/domains/{domain}/status/current

Example: /config-gtm/v1/domains/example.akadns.net/status/current

Parameter Type Sample Description
Required
domain String example.akadns.net Name of Traffic Management domain.

Status 200 application/json

Response:

{
    "changeId": "5beb11ae-8908-4bfe-8459-e88efc4d2fdc",
    "links": [
        "href": "/config-gtm/v1/domains/example.akadns.net/status/current".
        "rel": "self"
    ],
    "message": "Current configuration has been propagated to all toplevels",
    "passingValidation": true,
    "propagationStatus": "COMPLETE",
    "propagationStatusDate": "2014-03-08T15:39:00.000+0000"
}


Last modified: 4/6/2017