@itentialopensource/adapter-akamai_gtm
Version:
This adapter integrates with Akamai Global Traffic Management
8,400 lines • 316 kB
JSON
{
"openapi": "3.1.0",
"info": {
"title": "",
"version": "1.0.0"
},
"paths": {
"/domains/{domainName}/as-maps": {
"get": {
"tags": [
"AutonomousSystemMaps"
],
"operationId": "getDomainNameAsMaps",
"description": "The parameters and request body are for method: getDomainNameAsMaps. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"title": "result",
"type": "object"
}
}
}
}
},
"parameters": [
{
"name": "domainName",
"in": "path",
"required": true,
"schema": {
"title": "domainName",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/domains/{domainName}/as-maps/{mapName}": {
"get": {
"tags": [
"AutonomousSystemMaps"
],
"operationId": "getDomainNameAsMapsMapName",
"description": "The parameters and request body are for method: getDomainNameAsMapsMapName. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"description": "Contains information about the AS map configured for the property.",
"type": "object",
"additionalProperties": false,
"properties": {
"assignments": {
"type": "array",
"items": {
"description": "Contains information about the AS zone groupings of AS IDs.",
"type": "object",
"additionalProperties": false,
"properties": {
"asNumbers": {
"type": "array",
"items": {
"minimum": 1,
"maximum": 4294967295,
"description": "Specifies an array of AS numbers.",
"type": "integer"
}
},
"datacenterId": {
"description": "A unique identifier for an existing data center in the domain.",
"type": "integer"
},
"nickname": {
"minLength": 1,
"maxLength": 128,
"description": "A descriptive label for the group.",
"type": "string"
}
},
"required": [
"asNumbers",
"datacenterId",
"nickname"
]
}
},
"defaultDatacenter": {
"description": "A placeholder for all other AS zones, AS IDs not found in these AS zones. Note that an AS map can't have the same AS ID in multiple AS zones.",
"type": "object",
"additionalProperties": false,
"properties": {
"datacenterId": {
"description": "For each property, an identifier for all other AS zones' CNAME. For example, 5400.",
"type": "integer"
},
"nickname": {
"minLength": 1,
"maxLength": 128,
"description": "A descriptive label for all other AS zones, up to 128 characters. If the value is empty or `null`, the default is `Default Mapping`.",
"type": "string"
}
},
"required": [
"datacenterId",
"nickname"
]
},
"name": {
"minLength": 1,
"maxLength": 128,
"description": "A descriptive label for the AS map. Properties set up for asmapping can use this as reference.",
"type": "string"
},
"links": {
"type": "array",
"items": {
"description": "Specifies the URL path that allows direct navigation to the As map."
}
}
},
"required": [
"assignments",
"defaultDatacenter",
"name"
]
}
}
}
}
},
"parameters": [
{
"name": "domainName",
"in": "path",
"required": true,
"schema": {
"title": "domainName",
"type": "string"
}
},
{
"name": "mapName",
"in": "path",
"required": true,
"schema": {
"title": "mapName",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
},
"put": {
"tags": [
"AutonomousSystemMaps"
],
"operationId": "putDomainNameAsMapsMapName",
"description": "The parameters and request body are for method: putDomainNameAsMapsMapName. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
}
},
"parameters": [
{
"name": "domainName",
"in": "path",
"required": true,
"schema": {
"title": "domainName",
"type": "string"
}
},
{
"name": "mapName",
"in": "path",
"required": true,
"schema": {
"title": "mapName",
"type": "string"
}
}
],
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"delete": {
"tags": [
"AutonomousSystemMaps"
],
"operationId": "deleteDomainNameAsMapsMapName",
"description": "The parameters and request body are for method: deleteDomainNameAsMapsMapName. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
}
},
"parameters": [
{
"name": "domainName",
"in": "path",
"required": true,
"schema": {
"title": "domainName",
"type": "string"
}
},
{
"name": "mapName",
"in": "path",
"required": true,
"schema": {
"title": "mapName",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/domains/{domainName}/cidr-maps": {
"get": {
"tags": [
"CIDRMaps"
],
"operationId": "getDomainNameCidrMaps",
"description": "The parameters and request body are for method: getDomainNameCidrMaps. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"defaultDatacenter": {
"type": "object",
"properties": {
"datacenterId": {
"type": "number"
},
"nickname": {
"type": "string"
}
}
},
"assignments": {
"type": "array",
"items": {
"type": "object",
"properties": {
"datacenterId": {
"type": "number"
},
"nickname": {
"type": "string"
},
"blocks": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"links": {
"type": "array",
"items": {
"type": "object",
"properties": {
"href": {
"type": "string"
},
"rel": {
"type": "string"
}
}
}
}
}
}
}
}
},
"example": {
"items": [
{
"name": "The North",
"defaultDatacenter": {
"datacenterId": 5400,
"nickname": "All Other CIDR Blocks"
},
"assignments": [
{
"datacenterId": 3134,
"nickname": "Frostfangs and the Fist of First Men",
"blocks": [
"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"
}
]
}
]
}
}
}
}
},
"parameters": [
{
"name": "domainName",
"in": "path",
"required": true,
"schema": {
"title": "domainName",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/domains/{domainName}/cidr-maps/{mapName}": {
"get": {
"tags": [
"CIDRMaps"
],
"operationId": "getDomainNameCidrMapsMapName",
"description": "The parameters and request body are for method: getDomainNameCidrMapsMapName. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"title": "result",
"type": "object"
}
}
}
}
},
"parameters": [
{
"name": "domainName",
"in": "path",
"required": true,
"schema": {
"title": "domainName",
"type": "string"
}
},
{
"name": "mapName",
"in": "path",
"required": true,
"schema": {
"title": "mapName",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
},
"put": {
"tags": [
"CIDRMaps"
],
"operationId": "putDomainNameCidrMapsMapName",
"description": "The parameters and request body are for method: putDomainNameCidrMapsMapName. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"resource": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"defaultDatacenter": {
"type": "object",
"properties": {
"datacenterId": {
"type": "number"
},
"nickname": {
"type": "string"
}
}
},
"assignments": {
"type": "array",
"items": {
"type": "object",
"properties": {
"datacenterId": {
"type": "number"
},
"nickname": {
"type": "string"
},
"blocks": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"links": {
"type": "array",
"items": {
"type": "object",
"properties": {
"href": {
"type": "string"
},
"rel": {
"type": "string"
}
}
}
}
}
},
"status": {
"type": "object",
"properties": {
"changeId": {
"type": "string"
},
"message": {
"type": "string"
},
"passingValidation": {
"type": "boolean"
},
"propagationStatus": {
"type": "string"
},
"propagationStatusDate": {
"type": "string"
},
"links": {
"type": "array",
"items": {
"type": "object",
"properties": {
"href": {
"type": "string"
},
"rel": {
"type": "string"
}
}
}
}
}
}
}
},
"example": {
"resource": {
"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%2520North",
"rel": "self"
}
]
},
"status": {
"changeId": "93a48b86-4fc3-4a5f-9ca2-036835034cc6",
"message": "Change Pending",
"passingValidation": true,
"propagationStatus": "PENDING",
"propagationStatusDate": "2014-04-15T11:30:27.000+0000",
"links": [
{
"href": "/config-gtm/v1/domains/example.akadns.net/status/current",
"rel": "self"
}
]
}
}
}
}
}
},
"parameters": [
{
"name": "domainName",
"in": "path",
"required": true,
"schema": {
"title": "domainName",
"type": "string"
}
},
{
"name": "mapName",
"in": "path",
"required": true,
"schema": {
"title": "mapName",
"type": "string"
}
}
],
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"delete": {
"tags": [
"CIDRMaps"
],
"operationId": "deleteDomainNameCidrMapsMapName",
"description": "The parameters and request body are for method: deleteDomainNameCidrMapsMapName. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"resource": {
"type": "object"
},
"status": {
"type": "object",
"properties": {
"changeId": {
"type": "string"
},
"message": {
"type": "string"
},
"passingValidation": {
"type": "boolean"
},
"propagationStatus": {
"type": "string"
},
"propagationStatusDate": {
"type": "string"
},
"links": {
"type": "array",
"items": {
"type": "object",
"properties": {
"href": {
"type": "string"
},
"rel": {
"type": "string"
}
}
}
}
}
}
}
},
"example": {
"resource": null,
"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"
}
]
}
}
}
}
}
},
"parameters": [
{
"name": "domainName",
"in": "path",
"required": true,
"schema": {
"title": "domainName",
"type": "string"
}
},
{
"name": "mapName",
"in": "path",
"required": true,
"schema": {
"title": "mapName",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/domains/{domainName}/datacenters": {
"get": {
"tags": [
"DataCenters"
],
"operationId": "getDomainNameDatacenters",
"description": "The parameters and request body are for method: getDomainNameDatacenters. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"city": {
"type": "string"
},
"cloneOf": {
"type": "number"
},
"continent": {
"type": "string"
},
"country": {
"type": "string"
},
"datacenterId": {
"type": "number"
},
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
},
"nickname": {
"type": "string"
},
"stateOrProvince": {
"type": "string"
},
"virtual": {
"type": "boolean"
},
"defaultLoadObject": {
"type": "object",
"properties": {
"loadObject": {
"type": "object"
},
"loadObjectPort": {
"type": "number"
},
"loadServers": {
"type": "object"
}
}
},
"links": {
"type": "array",
"items": {
"type": "object",
"properties": {
"href": {
"type": "string"
},
"rel": {
"type": "string"
}
}
}
}
}
}
}
}
},
"example": {
"items": [
{
"city": "Doune",
"cloneOf": 0,
"continent": "EU",
"country": "GB",
"datacenterId": 3133,
"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/3133",
"rel": "self"
}
]
},
{
"city": "Snæfellsjökull",
"cloneOf": 0,
"continent": "EU",
"country": "IS",
"datacenterId": 3134,
"latitude": 64.808,
"longitude": -23.776,
"nickname": "Frostfangs",
"stateOrProvince": null,
"virtual": true,
"defaultLoadObject": {
"loadObject": null,
"loadObjectPort": 0,
"loadServers": null
},
"links": [
{
"href": "/config-gtm/v1/domains/example.akadns.net/datacenters/3134",
"rel": "self"
}
]
}
]
}
}
}
}
},
"parameters": [
{
"name": "domainName",
"in": "path",
"required": true,
"schema": {
"title": "domainName",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
},
"post": {
"tags": [
"DataCenters"
],
"operationId": "postDomainNameDatacenters",
"description": "The parameters and request body are for method: postDomainNameDatacenters. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"resource": {
"type": "object",
"properties": {
"city": {
"type": "string"
},
"cloneOf": {
"type": "number"
},
"continent": {
"type": "string"
},
"country": {
"type": "string"
},
"datacenterId": {
"type": "number"
},
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
},
"nickname": {
"type": "string"
},
"stateOrProvince": {
"type": "string"
},
"virtual": {
"type": "boolean"
},
"defaultLoadObject": {
"type": "object",
"properties": {
"loadObject": {
"type": "object"
},
"loadObjectPort": {
"type": "number"
},
"loadServers": {
"type": "object"
}
}
},
"links": {
"type": "array",
"items": {
"type": "object",
"properties": {
"href": {
"type": "string"
},
"rel": {
"type": "string"
}
}
}
}
}
},
"status": {
"type": "object",
"properties": {
"changeId": {
"type": "string"
},
"message": {
"type": "string"
},
"passingValidation": {
"type": "boolean"
},
"propagationStatus": {
"type": "string"
},
"propagationStatusDate": {
"type": "string"
},
"links": {
"type": "array",
"items": {
"type": "object",
"properties": {
"href": {
"type": "string"
},
"rel": {
"type": "string"
}
}
}
}
}
}
}
},
"example": {
"resource": {
"city": "Doune",
"cloneOf": 0,
"continent": "EU",
"country": "GB",
"datacenterId": 3133,
"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/3133",
"rel": "self"
}
]
},
"status": {
"changeId": "f0c51967-d119-4665-9403-364a57ea5530",
"message": "Change Pending",
"passingValidation": true,
"propagationStatus": "PENDING",
"propagationStatusDate": "2014-04-15T11:30:27.000+0000",
"links": [
{
"href": "/config-gtm/v1/domains/example.akadns.net/status/current",
"rel": "self"
}
]
}
}
}
}
}
},
"parameters": [
{
"name": "domainName",
"in": "path",
"required": true,
"schema": {
"title": "domainName",
"type": "string"
}
}
],
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/domains/{domainName}/datacenters/{datacenterId}": {
"get": {
"tags": [
"DataCenters"
],
"operationId": "getDomainNameDatacentersDatacenterId",
"description": "The parameters and request body are for method: getDomainNameDatacentersDatacenterId. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"city": {
"type": "string"
},
"cloneOf": {
"type": "number"
},
"continent": {
"type": "string"
},
"country": {
"type": "string"
},
"datacenterId": {
"type": "number"
},
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
},
"nickname": {
"type": "string"
},
"stateOrProvince": {
"type": "object"
},
"virtual": {
"type": "boolean"
},
"defaultLoadObject": {
"type": "object",
"properties": {
"loadObject": {
"type": "object"
},
"loadObjectPort": {
"type": "number"
},
"loadServers": {
"type": "object"
}
}
},
"links": {
"type": "array",
"items": {
"type": "object",
"properties": {
"href": {
"type": "string"
},
"rel": {
"type": "string"
}
}
}
}
}
},
"example": {
"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"
}
]
}
}
}
}
},
"parameters": [
{
"name": "domainName",
"in": "path",
"required": true,
"schema": {
"title": "domainName",
"type": "string"
}
},
{
"name": "datacenterId",
"in": "path",
"required": true,
"schema": {
"title": "datacenterId",
"type": "number"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
},
"put": {
"tags": [
"DataCenters"
],
"operationId": "putDomainNameDatacentersDatacenterId",
"description": "The parameters and request body are for method: putDomainNameDatacentersDatacenterId. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"resource": {
"type": "object",
"properties": {
"city": {
"type": "string"
},
"cloneOf": {
"type": "number"
},
"continent": {
"type": "string"
},
"country": {
"type": "string"
},
"datacenterId": {
"type": "number"
},
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
},
"nickname": {
"type": "string"
},
"stateOrProvince": {
"type": "object"
},
"virtual": {
"type": "boolean"
},
"defaultLoadObject": {
"type": "object",
"properties": {
"loadObject": {
"type": "object"
},
"loadObjectPort": {
"type": "number"
},
"loadServers": {
"type": "object"
}
}
},
"links": {
"type": "array",
"items": {
"type": "object",
"properties": {
"href": {
"type": "string"
},
"rel": {
"type": "string"
}
}
}
}
}
},
"status": {
"type": "object",
"properties": {
"changeId": {
"type": "string"
},
"message": {
"type": "string"
},
"passingValidation": {
"type": "boolean"
},
"propagationStatus": {
"type": "string"
},
"propagationStatusDate": {
"type": "string"
},
"links": {
"type": "array",
"items": {
"type": "object",
"properties": {
"href": {
"type": "string"
},
"rel": {
"type": "string"
}
}
}
}
}
}
}
},
"example": {
"resource": {
"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"
}
]
},
"status": {
"changeId": "bd69be9b-ff44-433d-bff8-ae00d270ea33",
"message": "Change Pending",
"passingValidation": true,
"propagationStatus": "PENDING",
"propagationStatusDate": "2014-04-15T11:30:27.000+0000",
"links": [
{
"href": "/config-gtm/v1/domains/example.akadns.net/status/current",
"rel": "self"
}
]
}
}
}
}
}
},
"parameters": [
{
"name": "domainName",
"in": "path",
"required": true,
"schema": {
"title": "domainName",
"type": "string"
}
},
{
"name": "datacenterId",
"in": "path",
"required": true,
"schema": {
"title": "datacenterId",
"type": "number"
}
}
],
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"delete": {
"tags": [
"DataCenters"
],
"operationId": "deleteDomainNameDatacentersDatacenterId",
"description": "The parameters and request body are for method: deleteDomainNameDatacentersDatacenterId. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"resource": {
"type": "object"
},
"status": {
"type": "object",
"properties": {
"changeId": {
"type": "string"
},
"message": {
"type": "string"
},
"passingValidation": {
"type": "boolean"
},
"propagationStatus": {
"type": "string"
},
"propagationStatusDate": {
"type": "string"
},
"links": {
"type": "array",
"items": {
"type": "object",
"properties": {
"href": {
"type": "string"
},
"rel": {
"type": "string"
}
}
}
}
}
}
}
},
"example": {
"resource": null,
"status": {
"changeId": "66c7ff0b-4b9e-41cc-9fd0-34d4f75c2484",
"message": "Change Pending",
"passingValidation": true,
"propagationStatus": "PENDING",
"propagationStatusDate": "2014-04-03T21:18:01.000+0000",
"links": [
{
"href": "/config-gtm/v1/domains/example.akadns.net/status/current",
"rel": "self"
}
]
}
}
}
}
}
},
"parameters": [
{
"name": "domainName",
"in": "path",
"required": true,
"schema": {
"title": "domainName",
"type": "string"
}
},
{
"name": "datacenterId",
"in": "path",
"required": true,
"schema": {
"title": "datacenterId",
"type": "number"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/domains/{domainName}/datacenters/default-datacenter-for-maps": {
"post": {
"tags": [
"DataCenters"
],
"operationId": "postDomainNameDatacentersDefaultDatacenterForMaps",
"description": "The parameters and request body are for method: postDomainNameDatacentersDefaultDatacenterForMaps. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"resource": {
"type": "object",
"properties": {
"city": {
"type": "object"
},
"cloneOf": {
"type": "object"
},
"cloudServerHostHeaderOverride": {
"type": "boolean"
},
"cloudServerTargeting": {
"type": "boolean"
},
"continent": {
"type": "object"
},
"country": {
"type": "object"
},
"datacenterId": {
"type": "number"
},
"defaultLoadObject": {
"type": "object"
},
"latitude": {
"type": "number"
},
"links": {
"type": "array",
"items": {
"type": "object",
"properties": {
"href": {
"type": "string"
},
"rel": {
"type": "string"
}
}
}
},
"longitude": {
"type": "number"
},
"nickname": {
"type": "string"
},
"pingInterval": {
"type": "object"
},
"pingPacketSize": {
"type": "object"
},
"scorePenalty": {
"type": "number"
},
"servermonitorLivenessCount": {
"type": "object"
},
"servermonitorLoadCount": {
"type": "object"
},
"servermonitorPool": {
"type": "object"
},
"stateOrProvince": {
"type": "object"
},
"virtual": {
"type": "boolean"
}
}
},
"status": {
"type": "object",
"properties": {
"changeId": {
"type": "string"
},
"message": {
"type": "string"
},
"passingValidation": {
"type": "boolean"
},
"propagationStatus": {
"type": "string"
},
"propagationStatusDate": {
"type": "string"
},
"links": {
"type": "array",
"items": {
"type": "object",
"properties": {
"href": {
"type": "string"
},
"rel": {
"type": "string"
}
}
}
}
}
}
}
},
"example": {
"resource": {
"city": null,
"cloneOf": null,
"cloudServerHostHeaderOverride": false,
"cloudServerTargeting": false,
"continent": null,
"country": null,
"datacenterId": 5400,
"defaultLoadObject": null,
"latitude": 0,
"links": [
{
"href": "/config-gtm/v1/domains/example.akadns.net/datacenters/5400",
"rel": "self"
}
],
"longitude": 0,
"nickname": "Default Datacenter",
"pingInterval": null,
"pingPacketSize": null,
"scorePenalty": 0,
"servermonitorLivenessCount": null,
"servermonitorLoadCount": null,
"servermonitorPool": null,
"stateOrProvince": null,
"virtual": true
},
"status": {
"changeId": "b97e535e-cec7-417c-bb1e-90fc06bf7783",
"message": "Change Pending",
"passingValidation": true,
"propagationStatus": "PENDING",
"propagationStatusDate": "2020-02-18T22:31:00.000+0000",
"links": [
{
"href": "/config-gtm/v1/domains/example.akadns.net/status/current",
"rel": "self"
}
]
}
}
}
}
}
},
"parameters": [
{
"name": "domainName",
"in": "path",
"required": true,
"schema": {
"title": "domainName",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/domains/{domainName}/datacenters/datacenter-for-ip-version-selector-ipv4": {
"post": {
"tags": [
"DataCenters"
],
"operationId": "postDomainNameDatacentersDatacenterForIpVersionSelectorIpv4",
"description": "The parameters and request body are for method: postDomainNameDatacentersDatacenterForIpVersionSelectorIpv4. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"resource": {
"type": "object",
"properties": {
"city": {
"type": "object"
},
"cloneOf": {
"type": "object"
},
"cloudServerHostHeaderOverride": {
"type": "boolean"
},
"cloudServerTargeting": {
"type": "boolean"
},
"continent": {
"type": "object"
},
"country": {
"type": "object"
},
"datacenterId": {
"type": "number"
},
"defaultLoadObject": {
"type": "object"
},
"latitude": {
"type": "number"
},
"links": {
"type": "array",
"items": {
"type": "object",
"properties": {
"href": {
"type": "string"
},
"rel": {
"type": "string"
}
}
}
},
"longitude": {
"type": "number"
},
"nickname": {
"type": "string"
},
"pingInterval": {
"type": "object"
},
"pingPacketSize": {
"type": "object"
},
"scorePenalty": {
"type": "number"
},
"servermonitorLivenessCount": {
"type": "object"
},
"servermonitorLoadCount": {
"type": "object"
},
"servermonitorPool": {
"type": "object"
},
"stateOrProvince": {
"type": "object"
},
"virtual": {
"type": "boolean"
}
}
},
"status": {
"type": "object",
"properties": {
"changeId": {
"type": "string"
},
"message": {
"type": "string"
},
"passingValidation": {
"type": "boolean"
},
"propagationStatus": {
"type": "string"
},
"propagationStatusDate": {
"type": "string"
},
"links": {
"type": "array",
"items": {
"type": "object",
"properties": {
"href": {
"type": "string"
},
"rel": {
"type": "string"
}
}
}
}
}
}
}
},
"example": {
"resource": {
"city": null,
"cloneOf": null,
"cloudServerHostHeaderOverride": false,
"cloudServerTargeting": false,
"continent": null,
"country": null,
"datacenterId": 5401,
"defaultLoadObject": null,
"latitude": 0,
"links": [
{
"href": "/config-gtm/v1/domains/example.akadns.net/datacenters/5401",
"rel": "self"
}
],
"longitude": 0,
"nickname": "Target for AAAA records",
"pingInterval": null,
"pingPacketSize": null,
"scorePenalty": 0,
"servermonitorLivenessCount": null,
"servermonitorLoadCount": null,
"servermonitorPool": null,
"stateOrProvince": null,
"virtual": true
},
"status": {
"changeId": "b97e535e-cec7-417c-bb1e-90fc06bf7783",
"message": "Change Pending",
"passingValidation": true,
"propagationStatus": "PENDING",
"propagationStatusDate": "2020-02-18T22:31:00.000+0000",
"links": [
{
"href": "/config-gtm/v1/domains/example.akadns.net/status/current",
"rel": "self"
}
]
}
}
}
}
}
},
"parameters": [
{
"name": "domainName",
"in": "path",
"required": true,
"schema": {
"title": "domainName",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/domains/{domainName}/datacenters/datacenter-for-ip-version-selector-ipv6": {
"post": {
"tags": [
"DataCenters"
],
"operationId": "postDomainNameDatacentersDatacenterForIpVersionSelectorIpv6",
"description": "The parameters and request body are for method: postDomainNameDatacentersDatacenterForIpVersionSelectorIpv6. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"resource": {
"type": "object",
"properties": {
"city": {
"type": "object"
},
"cloneOf": {
"type": "object"
},
"cloudServerHostHeaderOverride": {
"type": "boolean"
},
"cloudServerTargeting": {
"type": "boolean"
},
"continent": {
"type": "object"
},
"country": {
"type": "object"
},
"datacenterId": {
"type": "number"
},
"defaultLoadObject": {
"type": "object"
},
"latitude": {
"type": "number"
},
"links": {
"type": "array",
"items": {
"type": "object",
"properties": {
"href": {
"type": "string"
},
"rel": {
"type": "string"
}
}
}
},
"longitude": {
"type": "number"
},
"nickname": {
"type": "string"
},
"pingInterval": {
"type": "object"
},
"pingPacketSize": {
"type": "object"
},
"scorePenalty": {
"type": "number"
},
"servermonitorLivenessCount": {
"type": "object"
},
"servermonitorLoadCount": {
"type": "object"
},
"servermonitorPool": {
"type": "object"
},
"stateOrProvince": {
"type": "object"
},
"virtual": {
"type": "boolean"
}
}
},
"status": {
"type": "object",
"properties": {
"changeId": {
"type": "string"
},
"message": {
"type": "string"
},
"passingValidation": {
"type": "boolean"
},
"propagationStatus": {
"type": "string"
},
"propagationStatusDate": {
"type": "string"
},
"links": {
"type": "array",
"items": {
"type": "object",
"properties": {
"href": {
"type": "string"
},
"rel": {
"type": "string"
}
}
}
}
}
}
}
},
"example": {
"resource": {
"city": null,
"cloneOf": null,
"cloudServerHostHeaderOverride": false,
"cloudServerTargeting": false,
"continent": null,
"country": null,
"datacenterId": 5402,
"defaultLoadObject": null,
"latitude": 0,
"links": [
{
"href": "/config-gtm/v1/domains/example.akadns.net/datacenters/5402",
"rel": "self"
}
],
"longitude": 0,
"nickname": "Target for AAAA records",
"pingInterval": null,
"pingPacketSize": null,
"scorePenalty": 0,
"servermonitorLivenessCount": null,
"servermonitorLoadCount": null,
"servermonitorPool": null,
"stateOrProvince": null,
"virtual": true
},
"status": {
"changeId": "b97e535e-cec7-417c-bb1e-90fc06bf7783",
"message": "Change Pending",
"passingValidation": true,
"propagationStatus": "PENDING",
"propagationStatusDate": "2020-02-18T22:31:00.000+0000",
"links": [
{
"href": "/config-gtm/v1/domains/example.akadns.net/status/current",
"rel": "self"
}
]
}
}
}
}
}
},
"parameters": [
{
"name": "domainName",
"in": "path",
"required": true,
"schema": {
"title": "domainName",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/domains": {
"post": {
"tags": [
"Domains"
],
"operationId": "postDomains",
"description": "The parameters and request body are for method: postDomains. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"resource": {
"type": "object",
"properties": {
"defaultSslClientCertificate": {
"type": "object"
},
"defaultSslClientPrivateKey": {
"type": "object"
},
"defaultUnreachableThreshold": {
"type": "object"
},
"lastModified": {
"type": "string"
},
"lastModifiedBy": {
"type": "string"
},
"loadFeedback": {
"type": "boolean"
},
"loadImbalancePercentage": {
"type": "number"
},
"minPingableRegionFraction": {
"type": "object"
},
"modificationComments": {
"type": "string"
},
"name": {
"type": "string"
},
"pingInterval": {
"type": "object"
},
"roundRobinPrefix": {
"type": "object"
},
"servermonitorLivenessCount": {
"type": "object"
},
"servermonitorLoadCount": {
"type": "object"
},
"type": {
"type": "string"
},
"emailNotificationList": {
"type": "object"
},
"status": {
"type": "object",
"properties": {
"changeId": {
"type": "string"
},
"message": {
"type": "string"
},
"passingValidation": {
"type": "boolean"
},
"propagationStatus": {
"type": "string"
},
"propagationStatusDate": {
"type": "string"
},
"links": {
"type": "array",
"items": {
"type": "object",
"properties": {
"href": {
"type": "string"
},
"rel": {
"type": "string"
}
}
}
}
}
},
"links": {
"type": "array",
"items": {
"type": "object",
"properties": {
"href": {
"type": "string"
},
"rel": {
"type": "string"
}
}
}
},
"cidrMaps": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"defaultDatacenter": {
"type": "object",
"properties": {
"datacenterId": {
"type": "number"
},
"nickname": {
"type": "string"
}
}
},
"assignments": {
"type": "array",
"items": {
"type": "object",
"properties": {
"datacenterId": {
"type": "number"
},
"nickname": {
"type": "string"
},
"blocks": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"links": {
"type": "array",
"items": {
"type": "object",
"properties": {
"href": {
"type": "string"
},
"rel": {
"type": "string"
}
}
}
}
}
}
},
"datacenters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"city": {
"type": "string"
},
"cloneOf": {
"type": "number"
},
"continent": {
"type": "string"
},
"country": {
"type": "string"
},
"datacenterId": {
"type": "number"
},
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
},
"nickname": {
"type": "string"
},
"stateOrProvince": {
"type": "string"
},
"virtual": {
"type": "boolean"
},
"defaultLoadObject": {
"type": "object",
"properties": {
"loadObject": {
"type": "object"
},
"loadObjectPort": {
"type": "number"
},
"loadServers": {
"type": "object"
}
}
},
"links": {
"type": "array",
"items": {
"type": "object",
"properties": {
"href": {
"type": "string"
},
"rel": {
"type": "string"
}
}
}
}
}
}
},
"geographicMaps": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"defaultDatacenter": {
"type": "object",
"properties": {
"datacenterId": {
"type": "number"
},
"nickname": {
"type": "string"
}
}
},
"assignments": {
"type": "array",
"items": {
"type": "object",
"properties": {
"datacenterId": {
"type": "number"
},
"nickname": {
"type": "string"
},
"countries": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"links": {
"type": "array",
"items": {
"type": "object",
"properties": {
"href": {
"type": "string"
},
"rel": {
"type": "string"
}
}
}
}
}
}
},
"properties": {
"type": "array",
"items": {
"type": "object",
"properties": {
"backupCName": {
"type": "object"
},
"backupIp": {
"type": "object"
},
"balanceByDownloadScore": {
"type": "boolean"
},
"cname": {
"type": "object"
},
"comments": {
"type": "object"
},
"dynamicTTL": {
"type": "number"
},
"failbackDelay": {
"type": "number"
},
"failoverDelay": {
"type": "number"
},
"handoutMode": {
"type": "string"
},
"healthMax": {
"type": "object"
},
"healthMultiplier": {
"type": "object"
},
"healthThreshold": {
"type": "object"
},
"ipv6": {
"type": "boolean"
},
"lastModified": {
"type": "string"
},
"mapName": {
"type": "object"
},
"maxUnreachablePenalty": {
"type": "object"
},
"name": {
"type": "string"
},
"scoreAggregationType": {
"type": "string"
},
"staticTTL": {
"type": "number"
},
"stickinessBonusConstant": {
"type": "number"
},
"stickinessBonusPercentage": {
"type": "number"
},
"type": {
"type": "string"
},
"unreachableThreshold": {
"type": "object"
},
"useComputedTargets": {
"type": "boolean"
},
"mxRecords": {
"type": "object"
},
"links": {
"type": "array",
"items": {
"type": "object",
"properties": {
"href": {
"type": "string"
},
"rel": {
"type": "string"
}
}
}
},
"livenessTests": {
"type": "array",
"items": {
"type": "object",
"properties": {
"disableNonstandardPortWarning": {
"type": "boolean"
},
"hostHeader": {
"type": "string"
},
"httpError3xx": {
"type": "boolean"
},
"httpError4xx": {
"type": "boolean"
},
"httpError5xx": {
"type": "boolean"
},
"name": {
"type": "string"
},
"requestString": {
"type": "object"
},
"responseString": {
"type": "object"
},
"sslClientCertificate": {
"type": "object"
},
"sslClientPrivateKey": {
"type": "object"
},
"testInterval": {
"type": "number"
},
"testObject": {
"type": "string"
},
"testObjectPassword": {
"type": "object"
},
"testObjectPort": {
"type": "number"
},
"testObjectProtocol": {
"type": "string"
},
"testObjectUsername": {
"type": "object"
},
"testTimeout": {
"type": "number"
},
"links": {
"type": "object"
}
}
}
},
"trafficTargets": {
"type": "array",
"items": {
"type": "object",
"properties": {
"datacenterId": {
"type": "number"
},
"enabled": {
"type": "boolean"
},
"handoutCName": {
"type": "object"
},
"name": {
"type": "object"
},
"weight": {
"type": "number"
},
"servers": {
"type": "object"
}
}
}
}
}
}
},
"resources": {
"type": "array",
"items": {
"type": "object",
"properties": {
"aggregationType": {
"type": "string"
},
"constrainedProperty": {
"type": "string"
},
"decayRate": {
"type": "object"
},
"description": {
"type": "string"
},
"hostHeader": {
"type": "object"
},
"leaderString": {
"type": "object"
},
"leastSquaresDecay": {
"type": "object"
},
"loadImbalancePercentage": {
"type": "object"
},
"maxUMultiplicativeIncrement": {
"type": "object"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"upperBound": {
"type": "number"
},
"links": {
"type": "array",
"items": {
"type": "object",
"properties": {
"href": {
"type": "string"
},
"rel": {
"type": "string"
}
}
}
},
"resourceInstances": {
"type": "array",
"items": {
"type": "object",
"properties": {
"datacenterId": {
"type": "number"
},
"loadObject": {
"type": "string"
},
"loadObjectPort": {
"type": "number"
},
"useDefaultLoadObject": {
"type": "boolean"
},
"loadServers": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}
}
}
}
},
"status": {
"type": "object",
"properties": {
"changeId": {
"type": "string"
},
"message": {
"type": "string"
},
"passingValidation": {
"type": "boolean"
},
"propagationStatus": {
"type": "string"
},
"propagationStatusDate": {
"type": "string"
},
"links": {
"type": "array",
"items": {
"type": "object",
"properties": {
"href": {
"type": "string"
},
"rel": {
"type": "string"
}
}
}
}
}
}
}
},
"example": {
"resource": {
"defaultSslClientCertificate": null,
"defaultSslClientPrivateKey": null,
"defaultUnreachableThreshold": null,
"lastModified": "2014-04-08T18:25:51.000+0000",
"lastModifiedBy": "admin@example.com",
"loadFeedback": true,
"loadImbalancePercentage": 10,
"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": "Doune",
"cloneOf": 0,
"continent": "EU",
"country": "GB",
"datacenterId": 3133,
"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/3133",
"rel": "self"
}
]
},
{
"city": "Snæfellsjökull",
"cloneOf": 0,
"continent": "EU",
"country": "IS",
"datacenterId": 3134,
"latitude": 64.808,
"longitude": -23.776,
"nickname": "Frostfangs",
"stateOrProvince": null,
"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,
"longitude": 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": 25,
"links": []
}
],
"trafficTargets": [
{
"datacenterId": 5400,
"enabled": false,
"handoutCName": null,
"name": null,
"weight": 0,
"servers": []
},
{
"datacenterId": 3134,
"enabled": true,
"handoutCName": null,
"name": null,
"weight": 0,
"servers": [
"1.2.3.5"
]
},
{
"datacenterId": 3133,
"enabled": true,
"handoutCName": null,
"name": null,
"weight": 1,
"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",
"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": 1,
"servers": []
},
{
"datacenterId": 3134,
"enabled": true,
"handoutCName": null,
"name": null,
"weight": 1,
"servers": [
"2001:4878::5043:4078"
]
},
{
"datacenterId": 3133,
"enabled": true,
"handoutCName": null,
"name": null,
"weight": 1,
"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": true,
"handoutCName": "supplies.example.com",
"name": null,
"weight": 1,
"servers": []
},
{
"datacenterId": 3134,
"enabled": true,
"handoutCName": "winter.supplies.example.com",
"name": null,
"weight": 0,
"servers": []
},
{
"datacenterId": 3133,
"enabled": true,
"handoutCName": "redcross.org",
"name": null,
"weight": 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,
"servers": []
},
{
"datacenterId": 3134,
"enabled": false,
"handoutCName": null,
"name": null,
"weight": 1,
"servers": []
},
{
"datacenterId": 3133,
"enabled": true,
"handoutCName": "uk.shop.example.com",
"name": null,
"weight": 1,
"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": []
}
]
}
]
},
"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"
}
]
}
}
}
}
}
},
"parameters": [
{
"name": "contractId",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "gid",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"get": {
"tags": [
"Domains"
],
"operationId": "getDomains",
"description": "The parameters and request body are for method: getDomains. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"acgId": {
"type": "string"
},
"lastModified": {
"type": "string"
},
"name": {
"type": "string"
},
"status": {
"type": "string"
},
"links": {
"type": "array",
"items": {
"type": "object",
"properties": {
"href": {
"type": "string"
},
"rel": {
"type": "string"
}
}
}
}
}
}
}
}
},
"example": {
"items": [
{
"acgId": "1-2345",
"lastModified": "2014-03-03T16:02:45.000+0000",
"name": "example.akadns.net",
"status": "2014-02-20 22:56 GMT: Current configuration has been propagated to all GTM name servers",
"links": [
{
"href": "/config-gtm/v1/domains/example.akadns.net",
"rel": "self"
}
]
},
{
"acgId": "1-2345",
"lastModified": "2013-11-09T12:04:45.000+0000",
"name": "demo.akadns.net",
"status": "2014-02-20 22:56 GMT: Current configuration has been propagated to all GTM name servers",
"links": [
{
"href": "/config-gtm/v1/domains/demo.akadns.net",
"rel": "self"
}
]
}
]
}
}
}
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/domains/{domainName}": {
"get": {
"tags": [
"Domains"
],
"operationId": "getDomainsDomainName",
"description": "The parameters and request body are for method: getDomainsDomainName. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"defaultSslClientCertificate": {
"type": "object"
},
"defaultSslClientPrivateKey": {
"type": "object"
},
"defaultUnreachableThreshold": {
"type": "object"
},
"lastModified": {
"type": "string"
},
"lastModifiedBy": {
"type": "string"
},
"loadFeedback": {
"type": "boolean"
},
"loadImbalancePercentage": {
"type": "number"
},
"minPingableRegionFraction": {
"type": "object"
},
"modificationComments": {
"type": "string"
},
"name": {
"type": "string"
},
"pingInterval": {
"type": "object"
},
"roundRobinPrefix": {
"type": "object"
},
"servermonitorLivenessCount": {
"type": "object"
},
"servermonitorLoadCount": {
"type": "object"
},
"type": {
"type": "string"
},
"emailNotificationList": {
"type": "object"
},
"status": {
"type": "object",
"properties": {
"changeId": {
"type": "string"
},
"message": {
"type": "string"
},
"passingValidation": {
"type": "boolean"
},
"propagationStatus": {
"type": "string"
},
"propagationStatusDate": {
"type": "string"
},
"links": {
"type": "array",
"items": {
"type": "object",
"properties": {
"href": {
"type": "string"
},
"rel": {
"type": "string"
}
}
}
}
}
},
"links": {
"type": "array",
"items": {
"type": "object",
"properties": {
"href": {
"type": "string"
},
"rel": {
"type": "string"
}
}
}
},
"cidrMaps": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"defaultDatacenter": {
"type": "object",
"properties": {
"datacenterId": {
"type": "number"
},
"nickname": {
"type": "string"
}
}
},
"assignments": {
"type": "array",
"items": {
"type": "object",
"properties": {
"datacenterId": {
"type": "number"
},
"nickname": {
"type": "string"
},
"blocks": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"links": {
"type": "array",
"items": {
"type": "object",
"properties": {
"href": {
"type": "string"
},
"rel": {
"type": "string"
}
}
}
}
}
}
},
"datacenters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"city": {
"type": "string"
},
"cloneOf": {
"type": "number"
},
"continent": {
"type": "string"
},
"country": {
"type": "string"
},
"datacenterId": {
"type": "number"
},
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
},
"nickname": {
"type": "string"
},
"stateOrProvince": {
"type": "object"
},
"virtual": {
"type": "boolean"
},
"defaultLoadObject": {
"type": "object",
"properties": {
"loadObject": {
"type": "object"
},
"loadObjectPort": {
"type": "number"
},
"loadServers": {
"type": "object"
}
}
},
"links": {
"type": "array",
"items": {
"type": "object",
"properties": {
"href": {
"type": "string"
},
"rel": {
"type": "string"
}
}
}
}
}
}
},
"geographicMaps": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"defaultDatacenter": {
"type": "object",
"properties": {
"datacenterId": {
"type": "number"
},
"nickname": {
"type": "string"
}
}
},
"assignments": {
"type": "array",
"items": {
"type": "object",
"properties": {
"datacenterId": {
"type": "number"
},
"nickname": {
"type": "string"
},
"countries": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"links": {
"type": "array",
"items": {
"type": "object",
"properties": {
"href": {
"type": "string"
},
"rel": {
"type": "string"
}
}
}
}
}
}
},
"properties": {
"type": "array",
"items": {
"type": "object",
"properties": {
"backupCName": {
"type": "object"
},
"backupIp": {
"type": "object"
},
"balanceByDownloadScore": {
"type": "boolean"
},
"cname": {
"type": "object"
},
"comments": {
"type": "object"
},
"dynamicTTL": {
"type": "number"
},
"failbackDelay": {
"type": "number"
},
"failoverDelay": {
"type": "number"
},
"handoutMode": {
"type": "string"
},
"healthMax": {
"type": "object"
},
"healthMultiplier": {
"type": "object"
},
"healthThreshold": {
"type": "object"
},
"ipv6": {
"type": "boolean"
},
"lastModified": {
"type": "string"
},
"mapName": {
"type": "object"
},
"maxUnreachablePenalty": {
"type": "object"
},
"name": {
"type": "string"
},
"scoreAggregationType": {
"type": "string"
},
"staticTTL": {
"type": "number"
},
"stickinessBonusConstant": {
"type": "number"
},
"stickinessBonusPercentage": {
"type": "number"
},
"type": {
"type": "string"
},
"unreachableThreshold": {
"type": "object"
},
"useComputedTargets": {
"type": "boolean"
},
"mxRecords": {
"type": "object"
},
"links": {
"type": "array",
"items": {
"type": "object",
"properties": {
"href": {
"type": "string"
},
"rel": {
"type": "string"
}
}
}
},
"livenessTests": {
"type": "array",
"items": {
"type": "object",
"properties": {
"disableNonstandardPortWarning": {
"type": "boolean"
},
"hostHeader": {
"type": "string"
},
"httpError3xx": {
"type": "boolean"
},
"httpError4xx": {
"type": "boolean"
},
"httpError5xx": {
"type": "boolean"
},
"name": {
"type": "string"
},
"requestString": {
"type": "object"
},
"responseString": {
"type": "object"
},
"sslClientCertificate": {
"type": "object"
},
"sslClientPrivateKey": {
"type": "object"
},
"testInterval": {
"type": "number"
},
"testObject": {
"type": "string"
},
"testObjectPassword": {
"type": "object"
},
"testObjectPort": {
"type": "number"
},
"testObjectProtocol": {
"type": "string"
},
"testObjectUsername": {
"type": "object"
},
"testTimeout": {
"type": "number"
},
"links": {
"type": "object"
}
}
}
},
"trafficTargets": {
"type": "array",
"items": {
"type": "object",
"properties": {
"datacenterId": {
"type": "number"
},
"enabled": {
"type": "boolean"
},
"handoutCName": {
"type": "object"
},
"name": {
"type": "object"
},
"weight": {
"type": "number"
},
"servers": {
"type": "object"
}
}
}
}
}
}
},
"resources": {
"type": "array",
"items": {
"type": "object",
"properties": {
"aggregationType": {
"type": "string"
},
"constrainedProperty": {
"type": "string"
},
"decayRate": {
"type": "object"
},
"description": {
"type": "string"
},
"hostHeader": {
"type": "object"
},
"leaderString": {
"type": "object"
},
"leastSquaresDecay": {
"type": "object"
},
"loadImbalancePercentage": {
"type": "object"
},
"maxUMultiplicativeIncrement": {
"type": "object"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"upperBound": {
"type": "number"
},
"links": {
"type": "array",
"items": {
"type": "object",
"properties": {
"href": {
"type": "string"
},
"rel": {
"type": "string"
}
}
}
},
"resourceInstances": {
"type": "array",
"items": {
"type": "object",
"properties": {
"datacenterId": {
"type": "number"
},
"loadObject": {
"type": "string"
},
"loadObjectPort": {
"type": "number"
},
"useDefaultLoadObject": {
"type": "boolean"
},
"loadServers": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}
}
}
}
},
"example": {
"defaultSslClientCertificate": null,
"defaultSslClientPrivateKey": null,
"defaultUnreachableThreshold": null,
"lastModified": "2014-04-08T18:25:51.000+0000",
"lastModifiedBy": "admin@example.com",
"loadFeedback": true,
"loadImbalancePercentage": 10,
"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,
"longitude": 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": 25,
"links": []
}
],
"trafficTargets": [
{
"datacenterId": 5400,
"enabled": false,
"handoutCName": null,
"name": null,
"weight": 0,
"servers": []
},
{
"datacenterId": 3134,
"enabled": true,
"handoutCName": null,
"name": null,
"weight": 0,
"servers": [
"1.2.3.5"
]
},
{
"datacenterId": 3133,
"enabled": true,
"handoutCName": null,
"name": null,
"weight": 1,
"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,
"servers": []
},
{
"datacenterId": 3134,
"enabled": true,
"handoutCName": null,
"name": null,
"weight": 1,
"servers": [
"2001:4878::5043:4078"
]
},
{
"datacenterId": 3133,
"enabled": true,
"handoutCName": null,
"name": null,
"weight": 1,
"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,
"servers": []
},
{
"datacenterId": 3134,
"enabled": true,
"handoutCName": "winter.supplies.example.com",
"name": null,
"weight": 0,
"servers": []
},
{
"datacenterId": 3133,
"enabled": true,
"handoutCName": "redcross.org",
"name": null,
"weight": 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,
"servers": []
},
{
"datacenterId": 3134,
"enabled": false,
"handoutCName": null,
"name": null,
"weight": 1,
"servers": []
},
{
"datacenterId": 3133,
"enabled": true,
"handoutCName": "uk.shop.example.com",
"name": null,
"weight": 1,
"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": []
}
]
}
]
}
}
}
}
},
"parameters": [
{
"name": "domainName",
"in": "path",
"required": true,
"schema": {
"title": "domainName",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
},
"put": {
"tags": [
"Domains"
],
"operationId": "putDomainsDomainName",
"description": "The parameters and request body are for method: putDomainsDomainName. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"resource": {
"type": "object",
"properties": {
"defaultSslClientCertificate": {
"type": "object"
},
"defaultSslClientPrivateKey": {
"type": "object"
},
"defaultUnreachableThreshold": {
"type": "object"
},
"lastModified": {
"type": "string"
},
"lastModifiedBy": {
"type": "string"
},
"loadFeedback": {
"type": "boolean"
},
"loadImbalancePercentage": {
"type": "number"
},
"minPingableRegionFraction": {
"type": "object"
},
"modificationComments": {
"type": "string"
},
"name": {
"type": "string"
},
"pingInterval": {
"type": "object"
},
"roundRobinPrefix": {
"type": "object"
},
"servermonitorLivenessCount": {
"type": "object"
},
"servermonitorLoadCount": {
"type": "object"
},
"type": {
"type": "string"
},
"emailNotificationList": {
"type": "object"
},
"status": {
"type": "object",
"properties": {
"changeId": {
"type": "string"
},
"message": {
"type": "string"
},
"passingValidation": {
"type": "boolean"
},
"propagationStatus": {
"type": "string"
},
"propagationStatusDate": {
"type": "string"
},
"links": {
"type": "array",
"items": {
"type": "object",
"properties": {
"href": {
"type": "string"
},
"rel": {
"type": "string"
}
}
}
}
}
},
"links": {
"type": "array",
"items": {
"type": "object",
"properties": {
"href": {
"type": "string"
},
"rel": {
"type": "string"
}
}
}
},
"cidrMaps": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"defaultDatacenter": {
"type": "object",
"properties": {
"datacenterId": {
"type": "number"
},
"nickname": {
"type": "string"
}
}
},
"assignments": {
"type": "array",
"items": {
"type": "object",
"properties": {
"datacenterId": {
"type": "number"
},
"nickname": {
"type": "string"
},
"blocks": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"links": {
"type": "array",
"items": {
"type": "object",
"properties": {
"href": {
"type": "string"
},
"rel": {
"type": "string"
}
}
}
}
}
}
},
"datacenters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"city": {
"type": "string"
},
"cloneOf": {
"type": "number"
},
"continent": {
"type": "string"
},
"country": {
"type": "string"
},
"datacenterId": {
"type": "number"
},
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
},
"nickname": {
"type": "string"
},
"stateOrProvince": {
"type": "string"
},
"virtual": {
"type": "boolean"
},
"defaultLoadObject": {
"type": "object",
"properties": {
"loadObject": {
"type": "object"
},
"loadObjectPort": {
"type": "number"
},
"loadServers": {
"type": "object"
}
}
},
"links": {
"type": "array",
"items": {
"type": "object",
"properties": {
"href": {
"type": "string"
},
"rel": {
"type": "string"
}
}
}
}
}
}
},
"geographicMaps": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"defaultDatacenter": {
"type": "object",
"properties": {
"datacenterId": {
"type": "number"
},
"nickname": {
"type": "string"
}
}
},
"assignments": {
"type": "array",
"items": {
"type": "object",
"properties": {
"datacenterId": {
"type": "number"
},
"nickname": {
"type": "string"
},
"countries": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"links": {
"type": "array",
"items": {
"type": "object",
"properties": {
"href": {
"type": "string"
},
"rel": {
"type": "string"
}
}
}
}
}
}
},
"properties": {
"type": "array",
"items": {
"type": "object",
"properties": {
"backupCName": {
"type": "object"
},
"backupIp": {
"type": "object"
},
"balanceByDownloadScore": {
"type": "boolean"
},
"cname": {
"type": "object"
},
"comments": {
"type": "object"
},
"dynamicTTL": {
"type": "number"
},
"failbackDelay": {
"type": "number"
},
"failoverDelay": {
"type": "number"
},
"handoutMode": {
"type": "string"
},
"healthMax": {
"type": "object"
},
"healthMultiplier": {
"type": "object"
},
"healthThreshold": {
"type": "object"
},
"ipv6": {
"type": "boolean"
},
"lastModified": {
"type": "string"
},
"mapName": {
"type": "object"
},
"maxUnreachablePenalty": {
"type": "object"
},
"name": {
"type": "string"
},
"scoreAggregationType": {
"type": "string"
},
"staticTTL": {
"type": "number"
},
"stickinessBonusConstant": {
"type": "number"
},
"stickinessBonusPercentage": {
"type": "number"
},
"type": {
"type": "string"
},
"unreachableThreshold": {
"type": "object"
},
"useComputedTargets": {
"type": "boolean"
},
"mxRecords": {
"type": "object"
},
"links": {
"type": "array",
"items": {
"type": "object",
"properties": {
"href": {
"type": "string"
},
"rel": {
"type": "string"
}
}
}
},
"livenessTests": {
"type": "array",
"items": {
"type": "object",
"properties": {
"disableNonstandardPortWarning": {
"type": "boolean"
},
"hostHeader": {
"type": "string"
},
"httpError3xx": {
"type": "boolean"
},
"httpError4xx": {
"type": "boolean"
},
"httpError5xx": {
"type": "boolean"
},
"name": {
"type": "string"
},
"requestString": {
"type": "object"
},
"responseString": {
"type": "object"
},
"sslClientCertificate": {
"type": "object"
},
"sslClientPrivateKey": {
"type": "object"
},
"testInterval": {
"type": "number"
},
"testObject": {
"type": "string"
},
"testObjectPassword": {
"type": "object"
},
"testObjectPort": {
"type": "number"
},
"testObjectProtocol": {
"type": "string"
},
"testObjectUsername": {
"type": "object"
},
"testTimeout": {
"type": "number"
},
"links": {
"type": "object"
}
}
}
},
"trafficTargets": {
"type": "array",
"items": {
"type": "object",
"properties": {
"datacenterId": {
"type": "number"
},
"enabled": {
"type": "boolean"
},
"handoutCName": {
"type": "object"
},
"name": {
"type": "object"
},
"weight": {
"type": "number"
},
"servers": {
"type": "object"
}
}
}
}
}
}
},
"resources": {
"type": "array",
"items": {
"type": "object",
"properties": {
"aggregationType": {
"type": "string"
},
"constrainedProperty": {
"type": "string"
},
"decayRate": {
"type": "object"
},
"description": {
"type": "string"
},
"hostHeader": {
"type": "object"
},
"leaderString": {
"type": "object"
},
"leastSquaresDecay": {
"type": "object"
},
"loadImbalancePercentage": {
"type": "object"
},
"maxUMultiplicativeIncrement": {
"type": "object"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"upperBound": {
"type": "number"
},
"links": {
"type": "array",
"items": {
"type": "object",
"properties": {
"href": {
"type": "string"
},
"rel": {
"type": "string"
}
}
}
},
"resourceInstances": {
"type": "array",
"items": {
"type": "object",
"properties": {
"datacenterId": {
"type": "number"
},
"loadObject": {
"type": "string"
},
"loadObjectPort": {
"type": "number"
},
"useDefaultLoadObject": {
"type": "boolean"
},
"loadServers": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}
}
}
}
},
"status": {
"type": "object",
"properties": {
"changeId": {
"type": "string"
},
"message": {
"type": "string"
},
"passingValidation": {
"type": "boolean"
},
"propagationStatus": {
"type": "string"
},
"propagationStatusDate": {
"type": "string"
},
"links": {
"type": "array",
"items": {
"type": "object",
"properties": {
"href": {
"type": "string"
},
"rel": {
"type": "string"
}
}
}
}
}
}
}
},
"example": {
"resource": {
"defaultSslClientCertificate": null,
"defaultSslClientPrivateKey": null,
"defaultUnreachableThreshold": null,
"lastModified": "2014-04-08T18:25:51.000+0000",
"lastModifiedBy": "admin@example.com",
"loadFeedback": true,
"loadImbalancePercentage": 10,
"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": "Doune",
"cloneOf": 0,
"continent": "EU",
"country": "GB",
"datacenterId": 3133,
"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/3133",
"rel": "self"
}
]
},
{
"city": "Snæfellsjökull",
"cloneOf": 0,
"continent": "EU",
"country": "IS",
"datacenterId": 3134,
"latitude": 64.808,
"longitude": -23.776,
"nickname": "Frostfangs",
"stateOrProvince": null,
"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,
"longitude": 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": 25,
"links": []
}
],
"trafficTargets": [
{
"datacenterId": 5400,
"enabled": false,
"handoutCName": null,
"name": null,
"weight": 0,
"servers": []
},
{
"datacenterId": 3134,
"enabled": true,
"handoutCName": null,
"name": null,
"weight": 0,
"servers": [
"1.2.3.5"
]
},
{
"datacenterId": 3133,
"enabled": true,
"handoutCName": null,
"name": null,
"weight": 1,
"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",
"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": 1,
"servers": []
},
{
"datacenterId": 3134,
"enabled": true,
"handoutCName": null,
"name": null,
"weight": 1,
"servers": [
"2001:4878::5043:4078"
]
},
{
"datacenterId": 3133,
"enabled": true,
"handoutCName": null,
"name": null,
"weight": 1,
"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": true,
"handoutCName": "supplies.example.com",
"name": null,
"weight": 1,
"servers": []
},
{
"datacenterId": 3134,
"enabled": true,
"handoutCName": "winter.supplies.example.com",
"name": null,
"weight": 0,
"servers": []
},
{
"datacenterId": 3133,
"enabled": true,
"handoutCName": "redcross.org",
"name": null,
"weight": 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,
"servers": []
},
{
"datacenterId": 3134,
"enabled": false,
"handoutCName": null,
"name": null,
"weight": 1,
"servers": []
},
{
"datacenterId": 3133,
"enabled": true,
"handoutCName": "uk.shop.example.com",
"name": null,
"weight": 1,
"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": []
}
]
}
]
},
"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"
}
]
}
}
}
}
}
},
"parameters": [
{
"name": "domainName",
"in": "path",
"required": true,
"schema": {
"title": "domainName",
"type": "string"
}
},
{
"name": "contractId",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "gid",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/domains/{domainName}/geographic-maps": {
"get": {
"tags": [
"GeographicMaps"
],
"operationId": "getDomainNameGeographicMaps",
"description": "The parameters and request body are for method: getDomainNameGeographicMaps. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"defaultDatacenter": {
"type": "object",
"properties": {
"datacenterId": {
"type": "number"
},
"nickname": {
"type": "string"
}
}
},
"assignments": {
"type": "array",
"items": {
"type": "object",
"properties": {
"datacenterId": {
"type": "number"
},
"nickname": {
"type": "string"
},
"countries": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"links": {
"type": "array",
"items": {
"type": "object",
"properties": {
"href": {
"type": "string"
},
"rel": {
"type": "string"
}
}
}
}
}
}
}
}
},
"example": {
"items": [
{
"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"
}
]
}
]
}
}
}
}
},
"parameters": [
{
"name": "domainName",
"in": "path",
"required": true,
"schema": {
"title": "domainName",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/domains/{domainName}/geographic-maps/{mapName}": {
"get": {
"tags": [
"GeographicMaps"
],
"operationId": "getDomainNameGeographicMapsMapName",
"description": "The parameters and request body are for method: getDomainNameGeographicMapsMapName. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"defaultDatacenter": {
"type": "object",
"properties": {
"datacenterId": {
"type": "number"
},
"nickname": {
"type": "string"
}
}
},
"assignments": {
"type": "array",
"items": {
"type": "object",
"properties": {
"datacenterId": {
"type": "number"
},
"nickname": {
"type": "string"
},
"countries": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"links": {
"type": "array",
"items": {
"type": "object",
"properties": {
"href": {
"type": "string"
},
"rel": {
"type": "string"
}
}
}
}
}
},
"example": {
"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"
}
]
}
}
}
}
},
"parameters": [
{
"name": "domainName",
"in": "path",
"required": true,
"schema": {
"title": "domainName",
"type": "string"
}
},
{
"name": "mapName",
"in": "path",
"required": true,
"schema": {
"title": "mapName",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
},
"put": {
"tags": [
"GeographicMaps"
],
"operationId": "putDomainNameGeographicMapsMapName",
"description": "The parameters and request body are for method: putDomainNameGeographicMapsMapName. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"resource": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"defaultDatacenter": {
"type": "object",
"properties": {
"datacenterId": {
"type": "number"
},
"nickname": {
"type": "string"
}
}
},
"assignments": {
"type": "array",
"items": {
"type": "object",
"properties": {
"datacenterId": {
"type": "number"
},
"nickname": {
"type": "string"
},
"countries": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"links": {
"type": "array",
"items": {
"type": "object",
"properties": {
"href": {
"type": "string"
},
"rel": {
"type": "string"
}
}
}
}
}
},
"status": {
"type": "object",
"properties": {
"changeId": {
"type": "string"
},
"message": {
"type": "string"
},
"passingValidation": {
"type": "boolean"
},
"propagationStatus": {
"type": "string"
},
"propagationStatusDate": {
"type": "string"
},
"links": {
"type": "array",
"items": {
"type": "object",
"properties": {
"href": {
"type": "string"
},
"rel": {
"type": "string"
}
}
}
}
}
}
}
},
"example": {
"resource": {
"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"
}
]
},
"status": {
"changeId": "f2977f97-565b-46af-abfb-1da7e3e8c54b",
"message": "Change Pending",
"passingValidation": true,
"propagationStatus": "PENDING",
"propagationStatusDate": "2014-04-15T11:30:27.000+0000",
"links": [
{
"href": "/config-gtm/v1/domains/example.akadns.net/status/current",
"rel": "self"
}
]
}
}
}
}
}
},
"parameters": [
{
"name": "domainName",
"in": "path",
"required": true,
"schema": {
"title": "domainName",
"type": "string"
}
},
{
"name": "mapName",
"in": "path",
"required": true,
"schema": {
"title": "mapName",
"type": "string"
}
}
],
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"delete": {
"tags": [
"GeographicMaps"
],
"operationId": "deleteDomainNameGeographicMapsMapName",
"description": "The parameters and request body are for method: deleteDomainNameGeographicMapsMapName. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"resource": {
"type": "object"
},
"status": {
"type": "object",
"properties": {
"changeId": {
"type": "string"
},
"message": {
"type": "string"
},
"passingValidation": {
"type": "boolean"
},
"propagationStatus": {
"type": "string"
},
"propagationStatusDate": {
"type": "string"
},
"links": {
"type": "array",
"items": {
"type": "object",
"properties": {
"href": {
"type": "string"
},
"rel": {
"type": "string"
}
}
}
}
}
}
}
},
"example": {
"resource": null,
"status": {
"changeId": "a97bedfe-c997-4634-84a4-cdb31529fb4c",
"message": "Change Pending",
"passingValidation": true,
"propagationStatus": "PENDING",
"propagationStatusDate": "2014-04-08T13:44:53.000+0000",
"links": [
{
"href": "/config-gtm/v1/domains/example.akadns.net/status/current",
"rel": "self"
}
]
}
}
}
}
}
},
"parameters": [
{
"name": "domainName",
"in": "path",
"required": true,
"schema": {
"title": "domainName",
"type": "string"
}
},
{
"name": "mapName",
"in": "path",
"required": true,
"schema": {
"title": "mapName",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/identity": {
"get": {
"tags": [
"Identity"
],
"operationId": "getIdentity",
"description": "The parameters and request body are for method: getIdentity. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"accountId": {
"type": "string"
},
"userName": {
"type": "string"
},
"userTimeZone": {
"type": "string"
},
"locale": {
"type": "string"
},
"firstName": {
"type": "string"
},
"lastName": {
"type": "string"
},
"email": {
"type": "string"
},
"active": {
"type": "boolean"
},
"contracts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"contractId": {
"type": "string"
},
"features": {
"type": "array",
"items": {
"type": "string"
}
},
"permissions": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}
},
"example": {
"accountId": "1-1TJZFB",
"userName": "ed@example.com",
"userTimeZone": "-05:00",
"locale": "en_US",
"firstName": "Eddard",
"lastName": "Stark",
"email": "ed@example.com",
"active": true,
"contracts": [
{
"contractId": "1-1TJZH5",
"features": [
"FAILOVER",
"QTR",
"ASMAPPING",
"CIDRMAPPING",
"GEOGRAPHIC",
"WEIGHTED_ROUND_ROBIN",
"WEIGHTED_ROUND_ROBIN_LOAD_FEEDBACK",
"WEIGHTED_HASHED",
"PERFORMANCE"
],
"permissions": [
"READ",
"WRITE",
"ADD"
]
},
{
"contractId": "3-ZQ0H6H",
"features": [
"FAILOVER",
"QTR",
"ASMAPPING",
"CIDRMAPPING",
"GEOGRAPHIC"
],
"permissions": [
"READ",
"WRITE"
]
}
]
}
}
}
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/identity/contracts": {
"get": {
"tags": [
"Identity"
],
"operationId": "getIdentityContracts",
"description": "The parameters and request body are for method: getIdentityContracts. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"accountId": {
"type": "string"
},
"contracts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"contractId": {
"type": "string"
},
"contractName": {
"type": "string"
},
"contractTypeName": {
"type": "string"
}
}
}
}
}
},
"example": {
"accountId": "1-1TJZFB",
"contracts": [
{
"contractId": "1-1TJZH5",
"contractName": "Wolves",
"contractTypeName": "DIRECT_CUSTOMER"
},
{
"contractId": "3-ZQ0H6H",
"contractName": "Stags",
"contractTypeName": "DIRECT_CUSTOMER"
}
]
}
}
}
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/identity/groups": {
"get": {
"tags": [
"Identity"
],
"operationId": "getIdentityGroups",
"description": "The parameters and request body are for method: getIdentityGroups. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"groups": {
"type": "array",
"items": {
"type": "object",
"properties": {
"groupId": {
"type": "number"
},
"groupName": {
"type": "string"
},
"contractIds": {
"type": "array",
"items": {
"type": "string"
}
},
"permissions": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}
},
"example": {
"groups": [
{
"groupId": 15166,
"groupName": "House Stark",
"contractIds": [
"1-1TJZH5"
],
"permissions": [
"ADD",
"READ",
"WRITE"
]
},
{
"groupId": 41443,
"groupName": "House Baratheon",
"contractIds": [
"1-1TJZH5",
"3-ZQ0H6H"
],
"permissions": [
"READ",
"WRITE"
]
}
]
}
}
}
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/domains/{domainName}/properties": {
"get": {
"tags": [
"Properties"
],
"operationId": "getDomainNameProperties",
"description": "The parameters and request body are for method: getDomainNameProperties. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"balanceByDownloadScore": {
"type": "boolean"
},
"dynamicTTL": {
"type": "number"
},
"failbackDelay": {
"type": "number"
},
"failoverDelay": {
"type": "number"
},
"handoutMode": {
"type": "string"
},
"ipv6": {
"type": "boolean"
},
"lastModified": {
"type": "string"
},
"name": {
"type": "string"
},
"scoreAggregationType": {
"type": "string"
},
"staticTTL": {
"type": "number"
},
"stickinessBonusConstant": {
"type": "number"
},
"stickinessBonusPercentage": {
"type": "number"
},
"type": {
"type": "string"
},
"useComputedTargets": {
"type": "boolean"
},
"mxRecords": {
"type": "object"
},
"links": {
"type": "array",
"items": {
"type": "object",
"properties": {
"href": {
"type": "string"
},
"rel": {
"type": "string"
}
}
}
},
"livenessTests": {
"type": "array",
"items": {
"type": "object",
"properties": {
"disableNonstandardPortWarning": {
"type": "boolean"
},
"hostHeader": {
"type": "string"
},
"httpError3xx": {
"type": "boolean"
},
"httpError4xx": {
"type": "boolean"
},
"httpError5xx": {
"type": "boolean"
},
"name": {
"type": "string"
},
"testInterval": {
"type": "number"
},
"testObject": {
"type": "string"
},
"testObjectPort": {
"type": "number"
},
"testObjectProtocol": {
"type": "string"
},
"testTimeout": {
"type": "number"
}
}
}
},
"trafficTargets": {
"type": "array",
"items": {
"type": "object",
"properties": {
"datacenterId": {
"type": "number"
},
"enabled": {
"type": "boolean"
},
"weight": {
"type": "number"
},
"servers": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}
}
}
}
},
"example": {
"items": [
{
"balanceByDownloadScore": false,
"dynamicTTL": 300,
"failbackDelay": 0,
"failoverDelay": 0,
"handoutMode": "normal",
"ipv6": false,
"lastModified": "2014-04-07T16:21:27.000+0000",
"name": "www",
"scoreAggregationType": "mean",
"staticTTL": 600,
"stickinessBonusConstant": 0,
"stickinessBonusPercentage": 0,
"type": "failover",
"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",
"testInterval": 60,
"testObject": "/status",
"testObjectPort": 80,
"testObjectProtocol": "HTTP",
"testTimeout": 25
}
],
"trafficTargets": [
{
"datacenterId": 3134,
"enabled": true,
"weight": 0,
"servers": [
"1.2.3.5"
]
},
{
"datacenterId": 3133,
"enabled": true,
"weight": 1,
"servers": [
"1.2.3.4"
]
}
]
},
{
"balanceByDownloadScore": false,
"dynamicTTL": 300,
"failbackDelay": 0,
"failoverDelay": 0,
"handoutMode": "normal",
"ipv6": true,
"lastModified": "2014-04-07T16:21:27.000+0000",
"name": "mail",
"scoreAggregationType": "mean",
"staticTTL": 600,
"stickinessBonusConstant": 0,
"stickinessBonusPercentage": 0,
"type": "weighted-round-robin",
"useComputedTargets": false,
"livenessTests": [],
"mxRecords": [],
"links": [
{
"href": "/config-gtm/v1/domains/example.akadns.net/properties/mail",
"rel": "self"
}
],
"trafficTargets": [
{
"datacenterId": 3134,
"enabled": true,
"weight": 1,
"servers": [
"2001:4878::5043:4078"
]
},
{
"datacenterId": 3133,
"enabled": true,
"weight": 1,
"servers": [
"2001:4878::5043:4072",
"2001:4878::5043:4071"
]
}
]
}
]
}
}
}
}
},
"parameters": [
{
"name": "domainName",
"in": "path",
"required": true,
"schema": {
"title": "domainName",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/domains/{domainName}/properties/{propertyName}": {
"get": {
"tags": [
"Properties"
],
"operationId": "getDomainNamePropertiesPropertyName",
"description": "The parameters and request body are for method: getDomainNamePropertiesPropertyName. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"backupCName": {
"type": "object"
},
"backupIp": {
"type": "object"
},
"balanceByDownloadScore": {
"type": "boolean"
},
"cname": {
"type": "object"
},
"comments": {
"type": "object"
},
"dynamicTTL": {
"type": "number"
},
"failbackDelay": {
"type": "number"
},
"failoverDelay": {
"type": "number"
},
"handoutMode": {
"type": "string"
},
"healthMax": {
"type": "object"
},
"healthMultiplier": {
"type": "object"
},
"healthThreshold": {
"type": "object"
},
"ipv6": {
"type": "boolean"
},
"lastModified": {
"type": "string"
},
"loadImbalancePercentage": {
"type": "object"
},
"mapName": {
"type": "object"
},
"maxUnreachablePenalty": {
"type": "object"
},
"name": {
"type": "string"
},
"scoreAggregationType": {
"type": "string"
},
"staticTTL": {
"type": "number"
},
"stickinessBonusConstant": {
"type": "number"
},
"stickinessBonusPercentage": {
"type": "number"
},
"type": {
"type": "string"
},
"unreachableThreshold": {
"type": "object"
},
"useComputedTargets": {
"type": "boolean"
},
"mxRecords": {
"type": "object"
},
"links": {
"type": "array",
"items": {
"type": "object",
"properties": {
"href": {
"type": "string"
},
"rel": {
"type": "string"
}
}
}
},
"livenessTests": {
"type": "array",
"items": {
"type": "object",
"properties": {
"disableNonstandardPortWarning": {
"type": "boolean"
},
"hostHeader": {
"type": "string"
},
"httpError3xx": {
"type": "boolean"
},
"httpError4xx": {
"type": "boolean"
},
"httpError5xx": {
"type": "boolean"
},
"name": {
"type": "string"
},
"requestString": {
"type": "object"
},
"responseString": {
"type": "object"
},
"sslClientCertificate": {
"type": "object"
},
"sslClientPrivateKey": {
"type": "object"
},
"testInterval": {
"type": "number"
},
"testObject": {
"type": "string"
},
"testObjectPassword": {
"type": "object"
},
"testObjectPort": {
"type": "number"
},
"testObjectProtocol": {
"type": "string"
},
"testObjectUsername": {
"type": "object"
},
"testTimeout": {
"type": "number"
}
}
}
},
"trafficTargets": {
"type": "array",
"items": {
"type": "object",
"properties": {
"datacenterId": {
"type": "number"
},
"enabled": {
"type": "boolean"
},
"handoutCName": {
"type": "object"
},
"name": {
"type": "object"
},
"weight": {
"type": "number"
},
"servers": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}
},
"example": {
"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",
"loadImbalancePercentage": null,
"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": 25
}
],
"trafficTargets": [
{
"datacenterId": 3134,
"enabled": true,
"handoutCName": null,
"name": null,
"weight": 0,
"servers": [
"1.2.3.5"
]
},
{
"datacenterId": 3133,
"enabled": true,
"handoutCName": null,
"name": null,
"weight": 1,
"servers": [
"1.2.3.4"
]
}
]
}
}
}
}
},
"parameters": [
{
"name": "domainName",
"in": "path",
"required": true,
"schema": {
"title": "domainName",
"type": "string"
}
},
{
"name": "propertyName",
"in": "path",
"required": true,
"schema": {
"title": "propertyName",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
},
"put": {
"tags": [
"Properties"
],
"operationId": "putDomainNamePropertiesPropertyName",
"description": "The parameters and request body are for method: putDomainNamePropertiesPropertyName. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"resource": {
"type": "object",
"properties": {
"backupCName": {
"type": "object"
},
"backupIp": {
"type": "object"
},
"balanceByDownloadScore": {
"type": "boolean"
},
"cname": {
"type": "object"
},
"comments": {
"type": "object"
},
"dynamicTTL": {
"type": "number"
},
"failbackDelay": {
"type": "number"
},
"failoverDelay": {
"type": "number"
},
"handoutMode": {
"type": "string"
},
"healthMax": {
"type": "object"
},
"healthMultiplier": {
"type": "object"
},
"healthThreshold": {
"type": "object"
},
"ipv6": {
"type": "boolean"
},
"lastModified": {
"type": "object"
},
"loadImbalancePercentage": {
"type": "object"
},
"mapName": {
"type": "object"
},
"maxUnreachablePenalty": {
"type": "object"
},
"name": {
"type": "string"
},
"scoreAggregationType": {
"type": "string"
},
"staticTTL": {
"type": "number"
},
"stickinessBonusConstant": {
"type": "number"
},
"stickinessBonusPercentage": {
"type": "number"
},
"type": {
"type": "string"
},
"unreachableThreshold": {
"type": "object"
},
"useComputedTargets": {
"type": "boolean"
},
"mxRecords": {
"type": "object"
},
"links": {
"type": "array",
"items": {
"type": "object",
"properties": {
"href": {
"type": "string"
},
"rel": {
"type": "string"
}
}
}
},
"livenessTests": {
"type": "array",
"items": {
"type": "object",
"properties": {
"disableNonstandardPortWarning": {
"type": "boolean"
},
"hostHeader": {
"type": "string"
},
"httpError3xx": {
"type": "boolean"
},
"httpError4xx": {
"type": "boolean"
},
"httpError5xx": {
"type": "boolean"
},
"name": {
"type": "string"
},
"requestString": {
"type": "object"
},
"responseString": {
"type": "object"
},
"sslClientCertificate": {
"type": "object"
},
"sslClientPrivateKey": {
"type": "object"
},
"testInterval": {
"type": "number"
},
"testObject": {
"type": "string"
},
"testObjectPassword": {
"type": "object"
},
"testObjectPort": {
"type": "number"
},
"testObjectProtocol": {
"type": "string"
},
"testObjectUsername": {
"type": "object"
},
"testTimeout": {
"type": "number"
}
}
}
},
"trafficTargets": {
"type": "array",
"items": {
"type": "object",
"properties": {
"datacenterId": {
"type": "number"
},
"enabled": {
"type": "boolean"
},
"handoutCName": {
"type": "object"
},
"name": {
"type": "object"
},
"weight": {
"type": "number"
},
"servers": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}
},
"status": {
"type": "object",
"properties": {
"changeId": {
"type": "string"
},
"message": {
"type": "string"
},
"passingValidation": {
"type": "boolean"
},
"propagationStatus": {
"type": "string"
},
"propagationStatusDate": {
"type": "string"
},
"links": {
"type": "array",
"items": {
"type": "object",
"properties": {
"href": {
"type": "string"
},
"rel": {
"type": "string"
}
}
}
}
}
}
}
},
"example": {
"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,
"loadImbalancePercentage": null,
"mapName": null,
"maxUnreachablePenalty": null,
"name": "origin",
"scoreAggregationType": "mean",
"staticTTL": 600,
"stickinessBonusConstant": 0,
"stickinessBonusPercentage": 0,
"type": "weighted-round-robin",
"unreachableThreshold": null,
"useComputedTargets": false,
"mxRecords": [],
"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
}
],
"trafficTargets": [
{
"datacenterId": 3134,
"enabled": true,
"handoutCName": null,
"name": null,
"weight": 50,
"servers": [
"1.2.3.5"
]
},
{
"datacenterId": 3133,
"enabled": true,
"handoutCName": null,
"name": null,
"weight": 50,
"servers": [
"1.2.3.4"
]
}
]
},
"status": {
"changeId": "eee0c3b4-0e45-4f4b-822c-7dbc60764d18",
"message": "Change Pending",
"passingValidation": true,
"propagationStatus": "PENDING",
"propagationStatusDate": "2014-04-15T11:30:27.000+0000",
"links": [
{
"href": "/config-gtm/v1/domains/example.akadns.net/status/current",
"rel": "self"
}
]
}
}
}
}
}
},
"parameters": [
{
"name": "domainName",
"in": "path",
"required": true,
"schema": {
"title": "domainName",
"type": "string"
}
},
{
"name": "propertyName",
"in": "path",
"required": true,
"schema": {
"title": "propertyName",
"type": "string"
}
}
],
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"delete": {
"tags": [
"Properties"
],
"operationId": "deleteDomainNamePropertiesPropertyName",
"description": "The parameters and request body are for method: deleteDomainNamePropertiesPropertyName. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"resource": {
"type": "object"
},
"status": {
"type": "object",
"properties": {
"changeId": {
"type": "string"
},
"message": {
"type": "string"
},
"passingValidation": {
"type": "boolean"
},
"propagationStatus": {
"type": "string"
},
"propagationStatusDate": {
"type": "string"
},
"links": {
"type": "array",
"items": {
"type": "object",
"properties": {
"href": {
"type": "string"
},
"rel": {
"type": "string"
}
}
}
}
}
}
}
},
"example": {
"resource": null,
"status": {
"changeId": "426e9ea3-c968-47df-a41b-43a993c6f873",
"message": "Change Pending",
"passingValidation": true,
"propagationStatus": "PENDING",
"propagationStatusDate": "2014-04-08T12:52:46.000+0000",
"links": [
{
"href": "/config-gtm/v1/domains/example.akadns.net/status/current",
"rel": "self"
}
]
}
}
}
}
}
},
"parameters": [
{
"name": "domainName",
"in": "path",
"required": true,
"schema": {
"title": "domainName",
"type": "string"
}
},
{
"name": "propertyName",
"in": "path",
"required": true,
"schema": {
"title": "propertyName",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/domains/{domainName}/resources": {
"get": {
"tags": [
"Resources"
],
"operationId": "getDomainNameResources",
"description": "The parameters and request body are for method: getDomainNameResources. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"aggregationType": {
"type": "string"
},
"constrainedProperty": {
"type": "string"
},
"decayRate": {
"type": "object"
},
"description": {
"type": "string"
},
"hostHeader": {
"type": "object"
},
"leaderString": {
"type": "object"
},
"leastSquaresDecay": {
"type": "object"
},
"loadImbalancePercentage": {
"type": "object"
},
"maxUMultiplicativeIncrement": {
"type": "object"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"upperBound": {
"type": "number"
},
"links": {
"type": "array",
"items": {
"type": "object",
"properties": {
"href": {
"type": "string"
},
"rel": {
"type": "string"
}
}
}
},
"resourceInstances": {
"type": "array",
"items": {
"type": "object",
"properties": {
"datacenterId": {
"type": "number"
},
"loadObject": {
"type": "string"
},
"loadObjectPort": {
"type": "number"
},
"useDefaultLoadObject": {
"type": "boolean"
},
"loadServers": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}
}
}
}
},
"example": {
"items": [
{
"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"
]
}
]
}
]
}
}
}
}
},
"parameters": [
{
"name": "domainName",
"in": "path",
"required": true,
"schema": {
"title": "domainName",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/domains/{domainName}/resources/{resourceName}": {
"get": {
"tags": [
"Resources"
],
"operationId": "getDomainNameResourcesResourceName",
"description": "The parameters and request body are for method: getDomainNameResourcesResourceName. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"aggregationType": {
"type": "string"
},
"constrainedProperty": {
"type": "string"
},
"decayRate": {
"type": "object"
},
"description": {
"type": "string"
},
"hostHeader": {
"type": "object"
},
"leaderString": {
"type": "object"
},
"leastSquaresDecay": {
"type": "object"
},
"loadImbalancePercentage": {
"type": "object"
},
"maxUMultiplicativeIncrement": {
"type": "object"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"upperBound": {
"type": "number"
},
"links": {
"type": "array",
"items": {
"type": "object",
"properties": {
"href": {
"type": "string"
},
"rel": {
"type": "string"
}
}
}
},
"resourceInstances": {
"type": "array",
"items": {
"type": "object",
"properties": {
"datacenterId": {
"type": "number"
},
"loadObject": {
"type": "string"
},
"loadObjectPort": {
"type": "number"
},
"useDefaultLoadObject": {
"type": "boolean"
},
"loadServers": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}
},
"example": {
"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"
]
}
]
}
}
}
}
},
"parameters": [
{
"name": "domainName",
"in": "path",
"required": true,
"schema": {
"title": "domainName",
"type": "string"
}
},
{
"name": "resourceName",
"in": "path",
"required": true,
"schema": {
"title": "resourceName",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
},
"put": {
"tags": [
"Resources"
],
"operationId": "putDomainNameResourcesResourceName",
"description": "The parameters and request body are for method: putDomainNameResourcesResourceName. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"resource": {
"type": "object",
"properties": {
"aggregationType": {
"type": "string"
},
"constrainedProperty": {
"type": "string"
},
"decayRate": {
"type": "object"
},
"description": {
"type": "string"
},
"hostHeader": {
"type": "object"
},
"leaderString": {
"type": "object"
},
"leastSquaresDecay": {
"type": "object"
},
"loadImbalancePercentage": {
"type": "object"
},
"maxUMultiplicativeIncrement": {
"type": "object"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"upperBound": {
"type": "number"
},
"links": {
"type": "array",
"items": {
"type": "object",
"properties": {
"href": {
"type": "string"
},
"rel": {
"type": "string"
}
}
}
},
"resourceInstances": {
"type": "array",
"items": {
"type": "object",
"properties": {
"datacenterId": {
"type": "number"
},
"loadObject": {
"type": "string"
},
"loadObjectPort": {
"type": "number"
},
"useDefaultLoadObject": {
"type": "boolean"
},
"loadServers": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}
},
"status": {
"type": "object",
"properties": {
"changeId": {
"type": "string"
},
"message": {
"type": "string"
},
"passingValidation": {
"type": "boolean"
},
"propagationStatus": {
"type": "string"
},
"propagationStatusDate": {
"type": "string"
},
"links": {
"type": "array",
"items": {
"type": "object",
"properties": {
"href": {
"type": "string"
},
"rel": {
"type": "string"
}
}
}
}
}
}
}
},
"example": {
"resource": {
"aggregationType": "latest",
"constrainedProperty": "mail",
"decayRate": null,
"description": "Disk utilization",
"hostHeader": null,
"leaderString": null,
"leastSquaresDecay": null,
"loadImbalancePercentage": null,
"maxUMultiplicativeIncrement": null,
"name": "disk",
"type": "XML load object via HTTP",
"upperBound": 0,
"links": [
{
"href": "/config-gtm/v1/domains/example.akadns.net/resources/disk",
"rel": "self"
}
],
"resourceInstances": [
{
"datacenterId": 3134,
"loadObject": "/disk",
"loadObjectPort": 80,
"useDefaultLoadObject": false,
"loadServers": [
"1.2.3.9"
]
},
{
"datacenterId": 3133,
"loadObject": "/disk",
"loadObjectPort": 80,
"useDefaultLoadObject": false,
"loadServers": [
"1.2.3.10"
]
}
]
},
"status": {
"changeId": "79255c00-f6b6-48ea-9d67-c6d02a8742c9",
"message": "Change Pending",
"passingValidation": true,
"propagationStatus": "PENDING",
"propagationStatusDate": "2014-04-15T11:30:27.000+0000",
"links": [
{
"href": "/config-gtm/v1/domains/example.akadns.net/status/current",
"rel": "self"
}
]
}
}
}
}
}
},
"parameters": [
{
"name": "domainName",
"in": "path",
"required": true,
"schema": {
"title": "domainName",
"type": "string"
}
},
{
"name": "resourceName",
"in": "path",
"required": true,
"schema": {
"title": "resourceName",
"type": "string"
}
}
],
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"delete": {
"tags": [
"Resources"
],
"operationId": "deleteDomainNameResourcesResourceName",
"description": "The parameters and request body are for method: deleteDomainNameResourcesResourceName. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"resource": {
"type": "object"
},
"status": {
"type": "object",
"properties": {
"changeId": {
"type": "string"
},
"message": {
"type": "string"
},
"passingValidation": {
"type": "boolean"
},
"propagationStatus": {
"type": "string"
},
"propagationStatusDate": {
"type": "string"
},
"links": {
"type": "array",
"items": {
"type": "object",
"properties": {
"href": {
"type": "string"
},
"rel": {
"type": "string"
}
}
}
}
}
}
}
},
"example": {
"resource": null,
"status": {
"changeId": "a97bedfe-c997-4634-84a4-cdb31529fb4c",
"message": "Change Pending",
"passingValidation": true,
"propagationStatus": "PENDING",
"propagationStatusDate": "2014-04-08T13:44:53.000+0000",
"links": [
{
"href": "/config-gtm/v1/domains/example.akadns.net/status/current",
"rel": "self"
}
]
}
}
}
}
}
},
"parameters": [
{
"name": "domainName",
"in": "path",
"required": true,
"schema": {
"title": "domainName",
"type": "string"
}
},
{
"name": "resourceName",
"in": "path",
"required": true,
"schema": {
"title": "resourceName",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/domains/{domainName}/status/current": {
"get": {
"tags": [
"Status"
],
"operationId": "getDomainNameStatusCurrent",
"description": "The parameters and request body are for method: getDomainNameStatusCurrent. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"changeId": {
"type": "string"
},
"message": {
"type": "string"
},
"passingValidation": {
"type": "boolean"
},
"propagationStatus": {
"type": "string"
},
"propagationStatusDate": {
"type": "string"
},
"links": {
"type": "array",
"items": {
"type": "object",
"properties": {
"href": {
"type": "string"
},
"rel": {
"type": "string"
}
}
}
}
}
},
"example": {
"changeId": "5beb11ae-8908-4bfe-8459-e88efc4d2fdc",
"message": "Current configuration has been propagated to all GTM name servers.",
"passingValidation": true,
"propagationStatus": "COMPLETE",
"propagationStatusDate": "2014-03-08T15:39:00.000+0000",
"links": [
{
"href": "/config-gtm/v1/domains/example.akadns.net/status/current",
"rel": "self"
}
]
}
}
}
}
},
"parameters": [
{
"name": "domainName",
"in": "path",
"required": true,
"schema": {
"title": "domainName",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/run-proposed-property-liveness-tests": {
"post": {
"tags": [
"Tools"
],
"operationId": "postRunProposedPropertyLivenessTests",
"description": "The parameters and request body are for method: postRunProposedPropertyLivenessTests. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"result": {
"type": "string"
}
}
},
"example": {
"result": "Datacenter \"Cambridge office (physical datacenterId 3200)\", server IP 1.2.3.5, test \"test object 1\": liveness test failed: Connection timed out\nDatacenter \"Cambridge office (physical datacenterId 3200)\", server IP 1.2.3.4, test \"test object 1\": liveness test failed: Connection timed out\nDatacenter \"Cambridge office (physical datacenterId 3200)\", server IP 1.2.3.5, test \"test object 2\": liveness test failed: Connection timed out\nDatacenter \"Cambridge office (physical datacenterId 3200)\", server IP 1.2.3.4, test \"test object 2\": liveness test failed: Connection timed out\nDatacenter \"San Mateo office (physical datacenterId 3201)\", server IP 1.2.3.7, test \"test object 1\": liveness test failed: Connection timed out\nDatacenter \"San Mateo office (physical datacenterId 3201)\", server IP 1.2.3.6, test \"test object 1\": liveness test failed: Connection timed out\nDatacenter \"San Mateo office (physical datacenterId 3201)\", server IP 1.2.3.7, test \"test object 2\": liveness test failed: Connection timed out\nDatacenter \"San Mateo office (physical datacenterId 3201)\", server IP 1.2.3.6, test \"test object 2\": liveness test failed: Connection timed out\n"
}
}
}
}
},
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
}
},
"components": {
"schemas": {}
}
}