Domain object

This table aggregates membership for all versions of the Domain object.

Versioned schema members

Any object member specific to a range of versions is indicated in its description, at what version the member was either introduced or removed. Any listed data member with no version number is common to all versions of the object.

MemberTypeDescription
Domain: Contains information about the basic building block of a traffic management configuration. Each domain object is a representation of a complete GTM domain such as example.akadns.net.
asMapsAsMap[]v1.1. required: Contains information about the set of AS maps assigned to this domain.
cidrMapsCidrMap[]required: Contains information about the set of CIDR maps assigned to this domain.
cnameCoalescingEnabledBooleanv1.1. required: If enabled, GTM collapses CNAME redirections in DNS answers when it knows the target of the CNAME. The default value is false.
datacentersDatacenter[]required: Contains information about the set of data centers assigned to this domain.
defaultErrorPenaltyIntegerrequired: Specifies the download penalty score. If the download encounters an error, the web agent computes a score that is either the download time in seconds or a penalty score. The default penalty is 75.
defaultSslClientCertificateString, Nullrequired: Specifies an optional Base64-encoded certificate that corresponds with the private key for TLS-based liveness tests using HTTPS, SMTPS, POPS, and TCPS. When the liveness test does not contain sslClientCertificate and sslClientPrivateKey values, use this and the defaultSslClientPrivateKey object members to generate a certificate. In this case, use a separate, throwaway private key when generating a certificate or certificate signing request (CSR). You shouldn't use this key for any other purpose. See also defaultSslClientPrivateKey within this object.
defaultSslClientPrivateKeyString, Nullrequired: Specifies an optional Base64-encoded private key that corresponds with the TLS certificate for TLS-based liveness tests using HTTPS, SMTPS, POPS, and TCPS. See also defaultSslClientCertificate within this object.
defaultTimeoutPenaltyIntegerrequired: Specifies the timeout penalty score. The web agent then computes a score that is either the download time in seconds or a penalty score if the download request times out. The default penalty for a time out is 25.
emailNotificationListArrayrequired: A list of email addresses to notify when a change is made to the domain.
geographicMapsGeographicMap[]required: Contains information about the set of geographic maps assigned to this domain.
lastModifiedStringrequired: An ISO 8601 timestamp that indicates the time of the last domain change.
lastModifiedByString, Nullrequired: The email address of the administrator who made the last change to the domain.
linksHypermedia[]v1.1. Provides a URL path that allows direct navigation to the domain.
loadFeedbackBooleanrequired: Indicates whether you're using resources to control load balancing. Resources represent a constraint on how much load a data center can absorb. The value is true if you're using load feedback.
loadImbalancePercentageNumber, Nullrequired: Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is 0, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as 10.0 percent. The value ranges from 0 to 1000000 percent.
modificationCommentsString, Nullrequired: A descriptive note about changes to the domain. The maximum is 4000 characters.
nameStringrequired: The full GTM domain name that needs to end in .akadns.net, up to 100 characters.
propertiesProperty[]required: Contains information about the properties in the GTM domain.
resourcesResource[]required: Contains information about the resources in the GTM domain.
statusStatusSpecifies the condition of the change in the domain's activation.
typeEnumerationrequired: Indicates the type of domain available based on your contract. Either failover-only, static, weighted, basic, or full.

Sample v1 object

This version contains information about the basic building block of a traffic management configuration. It uses this MIME type:

domain-vnd-config-gtm.v1.0+json
{
  "defaultSslClientCertificate": null,
  "defaultSslClientPrivateKey": null,
  "defaultUnreachableThreshold": null,
  "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,
  "roundRobinPrefix": null,
  "servermonitorLivenessCount": null,
  "servermonitorLoadCount": null,
  "type": "full",
  "emailNotificationList": [],
  "status": {
    "changeId": "5beb11ae-8908-4bfe-8459-e88efc4d2fdc",
    "message": "Change Pending",
    "passingValidation": true,
    "propagationStatus": "PENDING",
    "propagationStatusDate": "2014-04-08T18:25:51.000+0000",
    "links": [
      {
        "href": "/config-gtm/v1/domains/example.akadns.net/status/current",
        "rel": "self"
      }
    ]
  },
  "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": [
    {
      "name": "The North",
      "defaultDatacenter": {
        "datacenterId": 5400,
        "nickname": "All Other CIDR Blocks"
      },
      "assignments": [
        {
          "datacenterId": 3134,
          "nickname": "Frostfangs and the Fist of First Men",
          "blocks": [
            "1.3.5.9",
            "1.2.3.0/24"
          ]
        },
        {
          "datacenterId": 3133,
          "nickname": "Winterfell",
          "blocks": [
            "1.2.4.0/24"
          ]
        }
      ],
      "links": [
        {
          "href": "/config-gtm/v1/domains/example.akadns.net/cidr-maps/The%20North",
          "rel": "self"
        }
      ]
    }
  ],
  "datacenters": [
    {
      "city": "Downpatrick",
      "cloneOf": 0,
      "continent": "EU",
      "country": "GB",
      "datacenterId": 3133,
      "latitude": 54.367,
      "longitude": -5.582,
      "nickname": "Winterfell",
      "stateOrProvince": null,
      "virtual": true,
      "defaultLoadObject": {
        "loadObject": null,
        "loadObjectPort": 0,
        "loadServers": null
      },
      "links": [
        {
          "href": "/config-gtm/v1/domains/example.akadns.net/datacenters/3133",
          "rel": "self"
        }
      ]
    },
    {
      "city": "Doune",
      "cloneOf": 0,
      "continent": "EU",
      "country": "GB",
      "datacenterId": 3134,
      "latitude": 56.185097,
      "longitude": -4.050264,
      "nickname": "Winterfell",
      "stateOrProvince": "Perthshire",
      "virtual": true,
      "defaultLoadObject": {
        "loadObject": null,
        "loadObjectPort": 0,
        "loadServers": null
      },
      "links": [
        {
          "href": "/config-gtm/v1/domains/example.akadns.net/datacenters/3134",
          "rel": "self"
        }
      ]
    },
    {
      "city": null,
      "cloneOf": 0,
      "continent": null,
      "country": null,
      "datacenterId": 5400,
      "latitude": 0.0,
      "longitude": 0.0,
      "nickname": "Default Datacenter",
      "stateOrProvince": null,
      "virtual": true,
      "defaultLoadObject": {
        "loadObject": null,
        "loadObjectPort": 0,
        "loadServers": null
      },
      "links": [
        {
          "href": "/config-gtm/v1/domains/example.akadns.net/datacenters/5400",
          "rel": "self"
        }
      ]
    }
  ],
  "geographicMaps": [
    {
      "name": "UK Delivery",
      "defaultDatacenter": {
        "datacenterId": 5400,
        "nickname": "Default Mapping"
      },
      "assignments": [
        {
          "datacenterId": 3133,
          "nickname": "UK users",
          "countries": [
            "GB"
          ]
        }
      ],
      "links": [
        {
          "href": "/config-gtm/v1/domains/example.akadns.net/geographic-maps/UK%20Delivery",
          "rel": "self"
        }
      ]
    }
  ],
  "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",
      "mapName": null,
      "maxUnreachablePenalty": null,
      "name": "www",
      "scoreAggregationType": "mean",
      "staticTTL": 600,
      "stickinessBonusConstant": 0,
      "stickinessBonusPercentage": 0,
      "type": "failover",
      "unreachableThreshold": null,
      "useComputedTargets": false,
      "mxRecords": [],
      "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": 10.0,
          "links": []
        }
      ],
      "trafficTargets": [
        {
          "datacenterId": 5400,
          "enabled": false,
          "handoutCName": null,
          "name": null,
          "weight": 0.0,
          "servers": []
        },
        {
          "datacenterId": 3134,
          "enabled": true,
          "handoutCName": null,
          "name": null,
          "weight": 0.0,
          "servers": [
            "1.2.3.5"
          ]
        },
        {
          "datacenterId": 3133,
          "enabled": true,
          "handoutCName": null,
          "name": null,
          "weight": 1.0,
          "servers": [
            "1.2.3.4"
          ]
        }
      ]
    },
    {
      "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",
      "loadImbalancePercentage": null,
      "mapName": null,
      "maxUnreachablePenalty": null,
      "name": "mail",
      "scoreAggregationType": "mean",
      "staticTTL": 600,
      "stickinessBonusConstant": 0,
      "stickinessBonusPercentage": 0,
      "type": "weighted-round-robin",
      "unreachableThreshold": null,
      "useComputedTargets": false,
      "livenessTests": [],
      "mxRecords": [],
      "links": [
        {
          "href": "/config-gtm/v1/domains/example.akadns.net/properties/mail",
          "rel": "self"
        }
      ],
      "trafficTargets": [
        {
          "datacenterId": 5400,
          "enabled": false,
          "handoutCName": null,
          "name": null,
          "weight": 0.0,
          "servers": []
        },
        {
          "datacenterId": 3134,
          "enabled": true,
          "handoutCName": null,
          "name": null,
          "weight": 1.0,
          "servers": [
            "2001:4878::5043:4078"
          ]
        },
        {
          "datacenterId": 3133,
          "enabled": true,
          "handoutCName": null,
          "name": null,
          "weight": 1.0,
          "servers": [
            "2001:4878::5043:4072",
            "2001:4878::5043:4071"
          ]
        }
      ]
    },
    {
      "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",
      "loadImbalancePercentage": null,
      "mapName": null,
      "maxUnreachablePenalty": null,
      "name": "supplies",
      "scoreAggregationType": "mean",
      "staticTTL": 600,
      "stickinessBonusConstant": 0,
      "stickinessBonusPercentage": 0,
      "type": "failover",
      "unreachableThreshold": null,
      "useComputedTargets": false,
      "livenessTests": [],
      "mxRecords": [],
      "links": [
        {
          "href": "/config-gtm/v1/domains/example.akadns.net/properties/supplies",
          "rel": "self"
        }
      ],
      "trafficTargets": [
        {
          "datacenterId": 5400,
          "enabled": false,
          "handoutCName": "supplies.example.com",
          "name": null,
          "weight": 0.0,
          "servers": []
        },
        {
          "datacenterId": 3134,
          "enabled": true,
          "handoutCName": "winter.supplies.example.com",
          "name": null,
          "weight": 0.0,
          "servers": []
        },
        {
          "datacenterId": 3133,
          "enabled": true,
          "handoutCName": "redcross.org",
          "name": null,
          "weight": 0.0,
          "servers": []
        }
      ]
    },
    {
      "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",
      "loadImbalancePercentage": null,
      "mapName": "UK Delivery",
      "maxUnreachablePenalty": null,
      "name": "shop",
      "scoreAggregationType": "mean",
      "staticTTL": 600,
      "stickinessBonusConstant": 0,
      "stickinessBonusPercentage": 0,
      "type": "geographic",
      "unreachableThreshold": null,
      "useComputedTargets": false,
      "livenessTests": [],
      "mxRecords": [],
      "links": [
        {
          "href": "/config-gtm/v1/domains/example.akadns.net/properties/shop",
          "rel": "self"
        }
      ],
      "trafficTargets": [
        {
          "datacenterId": 5400,
          "enabled": true,
          "handoutCName": "shop.example.com",
          "name": null,
          "weight": 1.0,
          "servers": []
        },
        {
          "datacenterId": 3134,
          "enabled": false,
          "handoutCName": null,
          "name": null,
          "weight": 1.0,
          "servers": []
        },
        {
          "datacenterId": 3133,
          "enabled": true,
          "handoutCName": "uk.shop.example.com",
          "name": null,
          "weight": 1.0,
          "servers": []
        }
      ]
    }
  ],
  "resources": [
    {
      "aggregationType": "latest",
      "constrainedProperty": "mail",
      "decayRate": null,
      "description": "CPU utilization",
      "hostHeader": null,
      "leaderString": null,
      "leastSquaresDecay": null,
      "loadImbalancePercentage": null,
      "maxUMultiplicativeIncrement": null,
      "name": "cpu",
      "type": "XML load object via HTTP",
      "upperBound": 0,
      "links": [
        {
          "href": "/config-gtm/v1/domains/example.akadns.net/resources/cpu",
          "rel": "self"
        }
      ],
      "resourceInstances": [
        {
          "datacenterId": 3134,
          "loadObject": "/cpu",
          "loadObjectPort": 80,
          "useDefaultLoadObject": false,
          "loadServers": [
            "1.2.3.8"
          ]
        },
        {
          "datacenterId": 3133,
          "loadObject": "/cpu",
          "loadObjectPort": 80,
          "useDefaultLoadObject": false,
          "loadServers": [
            "1.2.3.7"
          ]
        },
        {
          "datacenterId": 5400,
          "loadObject": null,
          "loadObjectPort": 0,
          "useDefaultLoadObject": false,
          "loadServers": []
        }
      ]
    },
    {
      "aggregationType": "latest",
      "constrainedProperty": "**",
      "decayRate": null,
      "description": "Supply levels of Arbor Gold",
      "hostHeader": null,
      "leaderString": null,
      "leastSquaresDecay": null,
      "loadImbalancePercentage": null,
      "maxUMultiplicativeIncrement": null,
      "name": "arbor-gold",
      "type": "Non-XML load object via HTTP",
      "upperBound": 0,
      "links": [
        {
          "href": "/config-gtm/v1/domains/example.akadns.net/resources/arbor-gold",
          "rel": "self"
        }
      ],
      "resourceInstances": [
        {
          "datacenterId": 3134,
          "loadObject": "/cups",
          "loadObjectPort": 80,
          "useDefaultLoadObject": false,
          "loadServers": [
            "1.2.3.8"
          ]
        },
        {
          "datacenterId": 3133,
          "loadObject": "/cups",
          "loadObjectPort": 80,
          "useDefaultLoadObject": false,
          "loadServers": [
            "1.2.3.7"
          ]
        },
        {
          "datacenterId": 5400,
          "loadObject": null,
          "loadObjectPort": 0,
          "useDefaultLoadObject": false,
          "loadServers": []
        }
      ]
    }
  ]
}