@itentialopensource/adapter-akamai_gtm
Version:
This adapter integrates with Akamai Global Traffic Management
5,319 lines • 218 kB
YAML
openapi: 3.0.0
info:
title: Akamai GTM
contact: {}
version: '1'
servers:
- url: https://{defaultHost}
variables:
defaultHost:
default: www.example.com/config-gtm/v1/
paths:
/domains/{domainName}/as-maps:
get:
tags:
- AutonomousSystemMaps
summary: GET_domainName-as-maps
description: >
List AS maps: Returns a list of AS maps.
operationId: GET_domainName-as-maps
parameters:
- name: domainName
in: path
description: ''
required: true
style: simple
schema:
type: string
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema: {}
deprecated: false
/domains/{domainName}/as-maps/{mapName}:
get:
tags:
- AutonomousSystemMaps
summary: GET_domainName-as-maps-mapName
description: >
Get an AS map: Returns information for a specific AS map.
operationId: GET_domainName-as-maps-mapName
parameters:
- name: mapName
in: path
description: Unique name for the AS map.
required: true
style: simple
schema:
type: string
- name: domainName
in: path
description: The full GTM domain name.
required: true
style: simple
schema:
type: string
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/as-map-asm'
- description: Contains information about the AS map configured for the property.
deprecated: false
put:
tags:
- AutonomousSystemMaps
summary: PUT_domainName-as-maps-mapName
description: >
Create or update an AS map: Run this operation to create or
update an AS map.
operationId: PUT_domainName-as-maps-mapName
parameters:
- name: mapName
in: path
description: Unique name for the AS map.
required: true
style: simple
schema:
type: string
- name: domainName
in: path
description: The full GTM domain name.
required: true
style: simple
schema:
type: string
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/as-map-asm'
required: false
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
type: string
example: Can not resolve examples/create-or-update-an-as-map-asm.json
example: Can not resolve examples/create-or-update-an-as-map-asm.json
deprecated: false
delete:
tags:
- AutonomousSystemMaps
summary: DELETE_domainName-as-maps-mapName
description: >
Remove an AS map: Removes a specific AS map.
operationId: DELETE_domainName-as-maps-mapName
parameters:
- name: mapName
in: path
description: Unique name for the AS map.
required: true
style: simple
schema:
type: string
- name: domainName
in: path
description: The full GTM domain name.
required: true
style: simple
schema:
type: string
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
type: string
example: Can not resolve examples/remove-an-as-map-asm-200.json
example: Can not resolve examples/remove-an-as-map-asm-200.json
deprecated: false
/domains/{domainName}/cidr-maps:
get:
tags:
- CIDRMaps
summary: GET_domainName-cidr-maps
description: >
List CIDR maps: Returns a list of CIDR maps.
operationId: GET_domainName-cidr-maps
parameters:
- name: domainName
in: path
description: The full GTM domain name.
required: true
style: simple
schema:
type: string
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/get-all-cidrmap'
- 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
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
deprecated: false
/domains/{domainName}/cidr-maps/{mapName}:
get:
tags:
- CIDRMaps
summary: GET_domainName-cidr-maps-mapName
description: >
Get a CIDR map: Returns information for a specific CIDR map.
operationId: GET_domainName-cidr-maps-mapName
parameters:
- name: mapName
in: path
description: Unique name for the CIDR map.
required: true
style: simple
schema:
type: string
- name: domainName
in: path
description: The full GTM domain name.
required: true
style: simple
schema:
type: string
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema: {}
deprecated: false
put:
tags:
- CIDRMaps
summary: PUT_domainName-cidr-maps-mapName
description: >
Create or update a CIDR map: Run this operation to create or update a CIDR map.
operationId: PUT_domainName-cidr-maps-mapName
parameters:
- name: mapName
in: path
description: Unique name for the CIDR map.
required: true
style: simple
schema:
type: string
- name: domainName
in: path
description: The full GTM domain name.
required: true
style: simple
schema:
type: string
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/cidr-dto-cidrmap'
required: false
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/update-response-cidrmap'
- 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
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
deprecated: false
delete:
tags:
- CIDRMaps
summary: DELETE_domainName-cidr-maps-mapName
description: >
Remove a CIDR map: Removes a specific CIDR map.
operationId: DELETE_domainName-cidr-maps-mapName
parameters:
- name: mapName
in: path
description: Unique name for the CIDR map.
required: true
style: simple
schema:
type: string
- name: domainName
in: path
description: The full GTM domain name.
required: true
style: simple
schema:
type: string
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/update-response-cidrmap'
deprecated: false
/domains/{domainName}/datacenters:
get:
tags:
- DataCenters
summary: GET_domainName-datacenters
description: >
List data centers: Returns a list of data centers.
operationId: GET_domainName-datacenters
parameters:
- name: domainName
in: path
description: The full GTM domain name.
required: true
style: simple
schema:
type: string
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/get-all-cidrmap'
- 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
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
deprecated: false
post:
tags:
- DataCenters
summary: POST_domainName-datacenters
description: >
Create a data center: Creates a specific data center.
operationId: POST_domainName-datacenters
parameters:
- name: domainName
in: path
description: The full GTM domain name.
required: true
style: simple
schema:
type: string
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/dto-datacenters'
required: false
responses:
'201':
description: ''
headers:
Location:
content:
text/plain:
schema:
type: string
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/update-response-cidrmap'
- 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
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
deprecated: false
/domains/{domainName}/datacenters/{datacenterId}:
get:
tags:
- DataCenters
summary: GET_domainName-datacenters-datacenterId
description: >
Get a data center: Returns information for a specific data center.
operationId: GET_domainName-datacenters-datacenterId
parameters:
- name: datacenterId
in: path
description: Numeric `id` of the data center.
required: true
style: simple
schema:
type: number
format: double
- name: domainName
in: path
description: The full GTM domain name.
required: true
style: simple
schema:
type: string
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/dto-datacenters'
- description: Contains information about the data centers in the GTM domain.
deprecated: false
put:
tags:
- DataCenters
summary: PUT_domainName-datacenters-datacenterId
description: >
Update a data center: Updates a specific data center.
operationId: PUT_domainName-datacenters-datacenterId
parameters:
- name: datacenterId
in: path
description: Numeric `id` of the data center.
required: true
style: simple
schema:
type: number
format: double
- name: domainName
in: path
description: The full GTM domain name.
required: true
style: simple
schema:
type: string
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/dto-datacenters'
required: false
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/update-response-cidrmap'
- 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
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
deprecated: false
delete:
tags:
- DataCenters
summary: DELETE_domainName-datacenters-datacenterId
description: >
Remove a data center: Removes a data center. Removes a data
center, which is only possible when no properties or resources
are assigned to it.
operationId: DELETE_domainName-datacenters-datacenterId
parameters:
- name: datacenterId
in: path
description: Numeric `id` of the data center.
required: true
style: simple
schema:
type: number
format: double
- name: domainName
in: path
description: The full GTM domain name.
required: true
style: simple
schema:
type: string
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/update-response-datacenters'
deprecated: false
/domains/{domainName}/datacenters/default-datacenter-for-maps:
post:
tags:
- DataCenters
summary: POST_domainName-datacenters-default-datacenter-for-maps
description: >
Create a default data center: Creates a data center which can be used by map-type properties (CIDR, Geographic or
AS mapping) as the "Default Datacenter."
operationId: POST_domainName-datacenters-default-datacenter-for-maps
parameters:
- name: domainName
in: path
description: The full GTM domain name.
required: true
style: simple
schema:
type: string
responses:
'201':
description: ''
headers:
Location:
content:
text/plain:
schema:
type: string
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/update-response-cidrmap'
- 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
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
deprecated: false
/domains/{domainName}/datacenters/datacenter-for-ip-version-selector-ipv4:
post:
tags:
- DataCenters
summary: POST_domainName-datacenters-datacenter-for-ip-version-selector-ipv4
description: >
Create an IPv4 datacenter for ip-version-selector: Creates a data center which is solely reserved for use by properties
of type "qtr" (IP Version Selector). The datacenter created by this resource will be assigned the `datacenterId` 5401,
which is interpreted as the target for `A` record requests.
operationId: POST_domainName-datacenters-datacenter-for-ip-version-selector-ipv4
parameters:
- name: domainName
in: path
description: The full GTM domain name.
required: true
style: simple
schema:
type: string
responses:
'201':
description: ''
headers:
Location:
content:
text/plain:
schema:
type: string
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/update-response-cidrmap'
- 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
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
deprecated: false
/domains/{domainName}/datacenters/datacenter-for-ip-version-selector-ipv6:
post:
tags:
- DataCenters
summary: POST_domainName-datacenters-datacenter-for-ip-version-selector-ipv6
description: >
Create an IPv6 datacenter for ip-version-selector: Creates a data center which is solely reserved for use by properties
of type `qtr` (IP Version Selector). The datacenter created by this resource will be assigned the `datacenterId` 5402,
which is interpreted as the target for `AAAA` record requests.
operationId: POST_domainName-datacenters-datacenter-for-ip-version-selector-ipv6
parameters:
- name: domainName
in: path
description: The full GTM domain name.
required: true
style: simple
schema:
type: string
responses:
'201':
description: ''
headers:
Location:
content:
text/plain:
schema:
type: string
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/update-response-cidrmap'
- 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
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
deprecated: false
/domains:
post:
tags:
- Domains
summary: POST_domains
description: >
Create a domain: Creates a new GTM domain.
operationId: POST_domains
parameters:
- name: contractId
in: query
description: >-
A unique identifier for the contract. If your GTM client
credential has access to more than one contract, you need
to specify under which contract to provision the domain.
For more information, see [API concepts](#apiconcepts).
style: form
explode: true
schema:
type: string
- name: gid
in: query
description: >-
A unique identifier for the group. If your GTM client
credential has access to more than one group, you need to
specify which group to assign to the domain. For more
information, see [API concepts](#apiconcepts).
style: form
explode: true
schema:
type: integer
format: int32
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/dto-domains'
required: false
responses:
'201':
description: ''
headers:
Location:
content:
text/plain:
schema:
type: string
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/update-response-cidrmap'
- 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
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
deprecated: false
get:
tags:
- Domains
summary: GET_domains
description: >
List domains: Returns a list of GTM domains under your contract.
operationId: GET_domains
parameters: []
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/get-all-domains'
- 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
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
deprecated: false
/domains/{domainName}:
get:
tags:
- Domains
summary: GET_domains-domainName
description: >
Get a domain: Returns information for a specific GTM domain.
operationId: GET_domains-domainName
parameters:
- name: domainName
in: path
description: The full GTM domain name.
required: true
style: simple
schema:
type: string
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/dto-domains'
- description: Contains information about the basic building block of a traffic management configuration. Each domain object is a representation of a complete GTM domain such as `example.akadns.net`.
deprecated: false
put:
tags:
- Domains
summary: PUT_domains-domainName
description: >
Update a domain: Updates a specific GTM domain.
operationId: PUT_domains-domainName
parameters:
- name: contractId
in: query
description: >-
A unique identifier for the contract. If your GTM client
credential has access to more than one contract, you need
to specify under which contract to provision the domain.
For more information, see [API concepts](#apiconcepts).
style: form
explode: true
schema:
type: string
- name: gid
in: query
description: >-
A unique identifier for the group. If your GTM client
credential has access to more than one group, you need to
specify which group to assign to the domain. For more
information, see [API concepts](#apiconcepts).
style: form
explode: true
schema:
type: integer
format: int32
- name: domainName
in: path
description: The full GTM domain name.
required: true
style: simple
schema:
type: string
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/dto-domains'
required: false
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/update-response-cidrmap'
- 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
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
deprecated: false
/domains/{domainName}/geographic-maps:
get:
tags:
- GeographicMaps
summary: GET_domainName-geographic-maps
description: >
List geographic maps: Returns a list of geographic maps.
operationId: GET_domainName-geographic-maps
parameters:
- name: domainName
in: path
description: The full GTM domain name.
required: true
style: simple
schema:
type: string
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/get-all-cidrmap'
- 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
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
deprecated: false
/domains/{domainName}/geographic-maps/{mapName}:
get:
tags:
- GeographicMaps
summary: GET_domainName-geographic-maps-mapName
description: >
Get a geographic map: Returns information for a specific geographic map.
operationId: GET_domainName-geographic-maps-mapName
parameters:
- name: mapName
in: path
description: Unique name for the geographic map.
required: true
style: simple
schema:
type: string
- name: domainName
in: path
description: The full GTM domain name.
required: true
style: simple
schema:
type: string
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/DomainsGeographicMapsResponse1'
- 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
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
deprecated: false
put:
tags:
- GeographicMaps
summary: PUT_domainName-geographic-maps-mapName
description: >
Create or update a geographic map: Run this operation to
create or update a geographic map.
operationId: PUT_domainName-geographic-maps-mapName
parameters:
- name: mapName
in: path
description: Unique name for the geographic map.
required: true
style: simple
schema:
type: string
- name: domainName
in: path
description: The full GTM domain name.
required: true
style: simple
schema:
type: string
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/dto-geographicmaps'
required: false
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/update-response-cidrmap'
- 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
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
deprecated: false
delete:
tags:
- GeographicMaps
summary: DELETE_domainName-geographic-maps-mapName
description: >
Remove a geographic map: Removes a geographic map.
operationId: DELETE_domainName-geographic-maps-mapName
parameters:
- name: mapName
in: path
description: Unique name for the geographic map.
required: true
style: simple
schema:
type: string
- name: domainName
in: path
description: The full GTM domain name.
required: true
style: simple
schema:
type: string
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/update-response-geographicmaps'
deprecated: false
/identity:
get:
tags:
- Identity
summary: GET_identity
description: >
Get identity: Returns information about the API client. Run this
operation for details on the API client contract such as
available load balancing `features` and `permissions` the
client has on the domains tied to the contract.
operationId: GET_identity
parameters: []
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/IdentityResponse'
- 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
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
deprecated: false
/identity/contracts:
get:
tags:
- Identity
summary: GET_identity-contracts
description: >
List contracts: Returns a list of API client `contracts`. When
you [Create a domain](#postdomains), you may need a
`contractId` under certain circumstances. Run this operation
to view available values.
operationId: GET_identity-contracts
parameters: []
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/IdentityContractsResponse'
- example:
accountId: 1-1TJZFB
contracts:
- contractId: 1-1TJZH5
contractName: Wolves
contractTypeName: DIRECT_CUSTOMER
- contractId: 3-ZQ0H6H
contractName: Stags
contractTypeName: DIRECT_CUSTOMER
example:
accountId: 1-1TJZFB
contracts:
- contractId: 1-1TJZH5
contractName: Wolves
contractTypeName: DIRECT_CUSTOMER
- contractId: 3-ZQ0H6H
contractName: Stags
contractTypeName: DIRECT_CUSTOMER
deprecated: false
/identity/groups:
get:
tags:
- Identity
summary: GET_identity-groups
description: >
List groups: Returns a list of API client `groups` and their
parameters. When you [Create a domain](#postdomains), you may
need a `groupId` under certain circumstances. Run this
operation to view available values.
operationId: GET_identity-groups
parameters: []
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/IdentityGroupsResponse'
- 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
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
deprecated: false
/domains/{domainName}/properties:
get:
tags:
- Properties
summary: GET_domainName-properties
description: >
List properties: Returns a list of GTM properties.
operationId: GET_domainName-properties
parameters:
- name: domainName
in: path
description: The full GTM domain name.
required: true
style: simple
schema:
type: string
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/get-all-cidrmap'
- 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
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
deprecated: false
/domains/{domainName}/properties/{propertyName}:
get:
tags:
- Properties
summary: GET_domainName-properties-propertyName
description: >
Get a property: Returns information for a specific GTM property.
operationId: GET_domainName-properties-propertyName
parameters:
- name: propertyName
in: path
description: >-
A unique name for the property that when joined to the
`domainName` with a dot (`.`) separator, it forms a valid
[RFC 1123](https://tools.ietf.org/html/rfc1123) hostname.
required: true
style: simple
schema:
type: string
- name: domainName
in: path
description: The full GTM domain name.
required: true
style: simple
schema:
type: string
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/dto-properties'
- description: Contains information about the entire GTM property configuration.
deprecated: false
put:
tags:
- Properties
summary: PUT_domainName-properties-propertyName
description: >
Create or update a property: Run this operation to create or
update a GTM property.
operationId: PUT_domainName-properties-propertyName
parameters:
- name: propertyName
in: path
description: >-
A unique name for the property that when joined to the
`domainName` with a dot (`.`) separator, it forms a valid
[RFC 1123](https://tools.ietf.org/html/rfc1123) hostname.
required: true
style: simple
schema:
type: string
- name: domainName
in: path
description: The full GTM domain name.
required: true
style: simple
schema:
type: string
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/dto-properties'
required: false
responses:
'201':
description: ''
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/update-response-cidrmap'
- 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
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
deprecated: false
delete:
tags:
- Properties
summary: DELETE_domainName-properties-propertyName
description: >
Remove a property: Removes a specific GTM property.
operationId: DELETE_domainName-properties-propertyName
parameters:
- name: propertyName
in: path
description: >-
A unique name for the property that when joined to the
`domainName` with a dot (`.`) separator, it forms a valid
[RFC 1123](https://tools.ietf.org/html/rfc1123) hostname.
required: true
style: simple
schema:
type: string
- name: domainName
in: path
description: The full GTM domain name.
required: true
style: simple
schema:
type: string
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/update-response-properties'
deprecated: false
/domains/{domainName}/resources:
get:
tags:
- Resources
summary: GET_domainName-resources
description: >
List resources: Returns a list of resources created within the
domain that constrain one or more properties in a data center.
operationId: GET_domainName-resources
parameters:
- name: domainName
in: path
description: The full GTM domain name.
required: true
style: simple
schema:
type: string
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/dto-resources'
- description: Contains information about the resources in the GTM domain.
deprecated: false
/domains/{domainName}/resources/{resourceName}:
get:
tags:
- Resources
summary: GET_domainName-resources-resourceName
description: >
Get a resource: Returns information for a specific resource.
operationId: GET_domainName-resources-resourceName
parameters:
- name: resourceName
in: path
description: Name of the `resource` to create or update.
required: true
style: simple
schema:
type: string
- name: domainName
in: path
description: The full GTM domain name.
required: true
style: simple
schema:
type: string
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/dto-resources'
- description: Contains information about the resources in the GTM domain.
deprecated: false
put:
tags:
- Resources
summary: PUT_domainName-resources-resourceName
description: >
Create or update a resource: Run this operation to create or
update a resource.
operationId: PUT_domainName-resources-resourceName
parameters:
- name: resourceName
in: path
description: Name of the `resource` to create or update.
required: true
style: simple
schema:
type: string
- name: domainName
in: path
description: The full GTM domain name.
required: true
style: simple
schema:
type: string
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/dto-resources'
required: false
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/dto-resources'
- description: Contains information about the resources in the GTM domain.
deprecated: false
delete:
tags:
- Resources
summary: DELETE_domainName-resources-resourceName
description: >
Remove a resource: Removes a specific resource.
operationId: DELETE_domainName-resources-resourceName
parameters:
- name: resourceName
in: path
description: Name of the `resource` to create or update.
required: true
style: simple
schema:
type: string
- name: domainName
in: path
description: The full GTM domain name.
required: true
style: simple
schema:
type: string
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/update-response-resources'
deprecated: false
/domains/{domainName}/status/current:
get:
tags:
- Status
summary: GET_domainName-status-current
description: >
Get current status: Returns information about the current condition of the
change in the domain's activation.
operationId: GET_domainName-status-current
parameters:
- name: domainName
in: path
description: The full GTM domain name.
required: true
style: simple
schema:
type: string
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/DomainsStatusCurrentResponse'
- 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
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
deprecated: false
/run-proposed-property-liveness-tests:
post:
tags:
- Tools
summary: POST_run-proposed-property-liveness-tests
description: >
Run proposed liveness tests: Runs liveness test(s) contained by
property and returns the results.
operationId: POST_run-proposed-property-liveness-tests
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/run-liveness-tests-dto-tools'
required: false
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/RunProposedPropertyLivenessTestsResponse'
- example:
result: >
Datacenter "Cambridge office (physical datacenterId 3200)", server IP 1.2.3.5, test "test object 1": liveness test failed: Connection timed out
Datacenter "Cambridge office (physical datacenterId 3200)", server IP 1.2.3.4, test "test object 1": liveness test failed: Connection timed out
Datacenter "Cambridge office (physical datacenterId 3200)", server IP 1.2.3.5, test "test object 2": liveness test failed: Connection timed out
Datacenter "Cambridge office (physical datacenterId 3200)", server IP 1.2.3.4, test "test object 2": liveness test failed: Connection timed out
Datacenter "San Mateo office (physical datacenterId 3201)", server IP 1.2.3.7, test "test object 1": liveness test failed: Connection timed out
Datacenter "San Mateo office (physical datacenterId 3201)", server IP 1.2.3.6, test "test object 1": liveness test failed: Connection timed out
Datacenter "San Mateo office (physical datacenterId 3201)", server IP 1.2.3.7, test "test object 2": liveness test failed: Connection timed out
Datacenter "San Mateo office (physical datacenterId 3201)", server IP 1.2.3.6, test "test object 2": liveness test failed: Connection timed out
example:
result: >
Datacenter "Cambridge office (physical datacenterId 3200)", server IP 1.2.3.5, test "test object 1": liveness test failed: Connection timed out
Datacenter "Cambridge office (physical datacenterId 3200)", server IP 1.2.3.4, test "test object 1": liveness test failed: Connection timed out
Datacenter "Cambridge office (physical datacenterId 3200)", server IP 1.2.3.5, test "test object 2": liveness test failed: Connection timed out
Datacenter "Cambridge office (physical datacenterId 3200)", server IP 1.2.3.4, test "test object 2": liveness test failed: Connection timed out
Datacenter "San Mateo office (physical datacenterId 3201)", server IP 1.2.3.7, test "test object 1": liveness test failed: Connection timed out
Datacenter "San Mateo office (physical datacenterId 3201)", server IP 1.2.3.6, test "test object 1": liveness test failed: Connection timed out
Datacenter "San Mateo office (physical datacenterId 3201)", server IP 1.2.3.7, test "test object 2": liveness test failed: Connection timed out
Datacenter "San Mateo office (physical datacenterId 3201)", server IP 1.2.3.6, test "test object 2": liveness test failed: Connection timed out
deprecated: false
components:
schemas:
as-map-asm:
title: as-map-asm
required:
- assignments
- defaultDatacenter
- name
type: object
properties:
assignments:
type: array
items:
$ref: '#/components/schemas/Assignment'
description: ''
defaultDatacenter:
$ref: '#/components/schemas/DefaultDatacenter4'
name:
maxLength: 128
minLength: 1
type: string
description: A descriptive label for the AS map. Properties set up for asmapping can use this as reference.
links:
type: array
items: {}
description: ''
description: Contains information about the AS map configured for the property.
cidr-dto-cidrmap:
title: cidr-dto-cidrmap
type: object
properties:
name:
maxLength: 255
minLength: 1
type: string
description: A descriptive label for the CIDR map, up to 255 characters.
assignments:
type: array
items:
$ref: '#/components/schemas/Assignment1'
description: ''
defaultDatacenter:
$ref: '#/components/schemas/DefaultDatacenter12'
links:
type: array
items: {}
description: ''
description: Contains information about the CIDR map configured for the property.
get-all-cidrmap:
title: get-all-cidrmap
type: object
properties:
items:
type: array
items:
type: object
description: ''
update-response-cidrmap:
title: update-response-cidrmap
type: object
properties:
resource:
type: object
status:
type: object
dto-datacenters:
title: dto-datacenters
required:
- datacenterId
type: object
properties:
city:
type: string
description: The name of the city where the data center is located.
cloneOf:
type: integer
description: Identifies the data center's `datacenterId` of which this data center is a clone. A data center clone is just like any other data center except that it inherits its geographic attributes (`continent`, `country`, `stateOrProvince`, `city`, `latitude`, and `longitude`) from the data center of which it is a clone.
format: int32
cloudServerTargeting:
type: boolean
description: Balances load between two or more servers in a cloud environment. Either `true` if cloud server targeting is enabled or `false` if not.
continent:
allOf:
- $ref: '#/components/schemas/Continent'
- maxLength: 2
country:
maxLength: 2
type: string
description: A two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code that specifies the country where the data center maps to.
datacenterId:
type: integer
description: A unique identifier for an existing data center in the domain.
format: int32
defaultLoadObject:
$ref: '#/components/schemas/DefaultLoadObject2'
latitude:
type: number
description: Specifies the geographical latitude of the data center's position. See also `longitude` within this object.
links:
type: array
items: {}
description: ''
longitude:
type: number
description: Specifies the geographic longitude of the data center's position. See also `latitude` within this object.
nickname:
maxLength: 256
type: string
description: A descriptive label for the data center.
stateOrProvince:
type: string
description: Specifies a two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code for the state or province where the data center is located.
virtual:
type: boolean
description: Indicates whether or not the data center is `virtual` or physical, the latter meaning the data center has an Akamai Network Agent installed, and its physical location (latitude, longitude) is fixed. Either `true` if `virtual` or `false` if physical.
description: Contains information about the data centers in the GTM domain.
get-all-datacenters:
title: get-all-datacenters
type: object
properties:
items:
type: array
items:
type: object
description: ''
update-response-datacenters:
title: update-response-datacenters
type: object
properties:
resource:
type: object
status:
type: object
dto-domains:
title: dto-domains
required:
- cidrMaps
- datacenters
- defaultErrorPenalty
- defaultSslClientCertificate
- defaultSslClientPrivateKey
- defaultTimeoutPenalty
- emailNotificationList
- lastModified
- lastModifiedBy
- loadFeedback
- loadImbalancePercentage
- modificationComments
- name
- properties
- resources
- type
- geographicMaps
type: object
properties:
cidrMaps:
type: array
items:
type: object
description: ''
datacenters:
type: array
items: {}
description: ''
defaultErrorPenalty:
type: integer
description: Specifies the download penalty score. If the download encounters an error, the web agent computes a score that is either the download time in seconds or a penalty score. The default penalty is `75`.
format: int32
defaultSslClientCertificate:
type: string
description: Specifies an optional Base64-encoded certificate that corresponds with the private key for TLS-based liveness tests (HTTPS, SMTPS, POPS, and TCPS). When the liveness test does not contain `sslClientCertificate` and `sslClientPrivateKey` values, use this and the `defaultSslClientPrivateKey` object members to generate a certificate. Note that the private key used to generate a certificate (or the CSR used to request the certificate) for this purpose needs to be throwaway, meaning that it is not used for any other purpose. See also `defaultSslClientPrivateKey` within this object.
defaultSslClientPrivateKey:
type: string
description: Specifies an optional Base64-encoded private key that corresponds with the TLS certificate for TLS-based liveness tests (HTTPS, SMTPS, POPS, and TCPS). See also `defaultSslClientCertificate` within this object.
defaultTimeoutPenalty:
type: integer
description: Specifies the timeout penalty score. The web agent then computes a score that is either the download time in seconds or a penalty score if the download request times out. The default penalty for a time out is `25`.
format: int32
emailNotificationList:
type: array
items:
type: string
description: ''
lastModified:
type: string
description: An ISO 8601 timestamp that indicates when the domain was last changed.
format: date-time
lastModifiedBy:
maxLength: 256
type: string
description: The email address of the administrator who made the last change to the domain.
loadFeedback:
type: boolean
description: Indicates whether one or more measurements of load (`resources`) are defined by you and supplied by each data center in real time to balance load. The value is `true` if load balance is used.
loadImbalancePercentage:
maximum: 1000000
minimum: 0
type: number
description: Indicates the percent of load imbalance factor (LIF) for the domain. The LIF controls how imbalanced GTM allows the load to be. That is the factor by which the demand sent to a data center is permitted to exceed the configured value. For example, with a data center traffic allocation of 25 percent and an LIF of 1.5, the demand sent to the data center is allowed to grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. The LIF is represented as a percentage. Zero means no load imbalance is allowed at all. However, internally, GTM adds one to the LIF so that it can be used as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.
modificationComments:
maxLength: 4000
type: string
description: A descriptive note about changes to the domain. The maximum is 4000 characters.
name:
maxLength: 100
minLength: 1
type: string
description: The full GTM domain name that needs to end in `.akadns.net, up to 100 characters.`
properties:
type: array
items: {}
description: ''
resources:
type: array
items: {}
description: ''
type:
$ref: '#/components/schemas/Type'
status:
description: Specifies the condition of the change in the domain's activation.
links:
type: array
items: {}
description: ''
geographicMaps:
type: array
items: {}
description: ''
description: Contains information about the basic building block of a traffic management configuration. Each domain object is a representation of a complete GTM domain such as `example.akadns.net`.
get-all-domains:
title: get-all-domains
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/Item'
description: ''
update-response-domains:
title: update-response-domains
type: object
properties:
resource:
type: object
status:
type: object
dto-geographicmaps:
title: dto-geographicmaps
type: object
properties:
name:
maxLength: 128
minLength: 1
type: string
description: A descriptive label for the geographic map, up to `128` characters.
defaultDatacenter:
$ref: '#/components/schemas/DefaultDatacenter22'
assignments:
type: array
items:
$ref: '#/components/schemas/Assignment2'
description: ''
links:
type: array
items: {}
description: ''
description: Contains information about the geographic map configured for the property.
get-all-geographicmaps:
title: get-all-geographicmaps
type: object
properties:
items:
type: array
items:
type: object
description: ''
update-response-geographicmaps:
title: update-response-geographicmaps
type: object
properties:
resource:
type: object
status:
type: object
identity-response-identity:
title: identity-response-identity
type: object
properties:
accountId:
type: string
description: A unique API client identity for a specific account, created in [Control Center](https://control.akamai.com/apps/home-page).
active:
type: boolean
description: Enabled if the account is active.
contracts:
type: array
items:
$ref: '#/components/schemas/Contract'
description: ''
email:
type: string
description: The email address of the client on the account.
firstName:
type: string
description: The first name of the client on the account.
lastName:
type: string
description: The last name of the client on the account.
locale:
type: string
description: Indicates the client's language and country in [RFC 5646](https://tools.ietf.org/html/rfc5646) format.
userName:
type: string
description: The username of the client on the account.
userTimeZone:
type: string
description: The time zone of the client on the account, which specifies an offset from GTM.
description: Collects high-level information about the API client for a specific GTM account.
identity-contracts-response-identity:
title: identity-contracts-response-identity
type: object
properties:
accountId:
type: string
description: A unique identifier for the account where the contract exists.
contracts:
type: array
items:
$ref: '#/components/schemas/Contract1'
description: ''
description: Collects information about each contract under a specific GTM account.
identity-groups-response-identity:
title: identity-groups-response-identity
type: object
properties:
groups:
type: array
items:
$ref: '#/components/schemas/Group'
description: ''
description: Collects information about each group under a specific GTM account.
dto-properties:
title: dto-properties
required:
- backupCName
- backupIp
- balanceByDownloadScore
- cname
- dynamicTTL
- failbackDelay
- failoverDelay
- handoutMode
- healthMax
- healthMultiplier
- healthThreshold
- ipv6
- livenessTests
- loadImbalancePercentage
- mapName
- maxUnreachablePenalty
- mxRecords
- name
- scoreAggregationType
- staticTTL
- stickinessBonusPercentage
- stickinessBonusConstant
- trafficTargets
- type
- unreachableThreshold
- useComputedTargets
- lastModified
type: object
properties:
backupCName:
type: string
description: Specifies a `backupCName`. If GTM declares that all of the servers configured for your property are down, and you configured a `backupCName`, then queries for the property return the `backupCName`. If a `backupCName` is set, do not set a `backupIp`.
backupIp:
type: string
description: Specifies a backup IP. When GTM declares that all of the targets are down, the `backupIP` is handed out. The IP type coincides with the property's `iPv6` setting. If a `backupIp` is set, do not set a `backupCName`.
balanceByDownloadScore:
type: boolean
description: "Indicates whether download score based load balancing is enabled. GTM estimates the load on your data centers based on how long they take to respond to GTM liveness tests. The advantage: you do not need to implement a load object. The disadvantage: it's a very crude measure of load, and usually highly nonlinear. As load increases, download times do not increase significantly, until there is too much load. When that happens, the download times skyrocket. This can easily cause erratic load balancing or load oscillations."
cname:
type: string
description: Indicates the fully qualified name aliased to a particular property. The public name of the property.
dynamicTTL:
maximum: 3600
minimum: 30
type: integer
description: Indicates the TTL in seconds for records that might change dynamically based on liveness and load balancing such as A and AAAA records, and CNAMEs. The value ranges from `30` to `3600` and can change on request. The default is `60`.
format: int32
failbackDelay:
minimum: 0
type: integer
description: Specifies the failback delay in seconds. The minimum value is `0`. If specified, when a server has been down and comes back up, (that is, its liveness test starts succeeding again), GTM only considers it up after the failback delay has elapsed and tests continue to succeed.
format: int32
failoverDelay:
minimum: 0
type: integer
description: Specifies the failover delay in seconds. The minimum value is `0`. If specified, when a server begins failing its liveness test, GTM only considers it down after the failover delay has elapsed and the errors persist.
format: int32
handoutMode:
$ref: '#/components/schemas/HandoutMode'
healthMax:
type: number
description: Defines the absolute limit beyond which IPs are declared unhealthy. If backup CNAMEs are provided for a property, then it is reasonable for all IPs to be declared unhealthy. The `healthMax` value is multiplied by the smaller of the `timeoutPenalty` and the `errorPenalty`. Any server with a score greater than this product is declared down. The default value is `null`.
healthMultiplier:
type: number
description: 'Configures a cutoff value that is computed from the median scores. Any server with a score over the cutoff value is considered down, and load is not sent to it. The cutoff is computed from the minimum score across all data centers, for a given property and two object members: `healthMultiplier` and `healthThreshold`. The cutoff is either `healthMultiplier` (default value: 1.5) times the minimum score, or the `healthThreshold` (default value: 4), whichever is greater. See also `healthThreshold` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide]({{base.url}}/{{page.language}}/webhelp/global-traffic-management/global-traffic-management-user-guide/).'
healthThreshold:
type: number
description: Configures a cutoff value that is computed from the median scores. Any server with a score over the cutoff value is considered down, and load is not sent to it. See also `healthMultiplier` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide]({{base.url}}/{{page.language}}/webhelp/global-traffic-management/global-traffic-management-user-guide/).
ipv6:
type: boolean
description: Indicates the type of IP address handed out by a property. A `true` value indicates that all IP addresses specified are IPv6, and all hostnames need to resolve to AAAA records. A `false` value indicates IPv4 addresses, and all hostnames need to resolve to A records.
livenessTests:
type: array
items:
$ref: '#/components/schemas/LivenessTest'
description: Contains information about the liveness tests, which are run periodically to determine whether your servers respond to requests.
loadImbalancePercentage:
maximum: 1000000
minimum: 0
type: number
description: Indicates the percent of load imbalance factor (LIF) for the property. The LIF controls how imbalanced GTM allows the load to be. That is the factor by which the demand sent to a data center is permitted to exceed the configured value. For example, with a data center traffic allocation of `25` percent and an LIF of 1.5, the demand sent to the data center is allowed to grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. The LIF is represented as a percentage; zero means no load imbalance is allowed at all. However, GTM adds one to the LIF so that it can be used as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The allowable range is `0` to `1000000` percent.
mapName:
type: string
description: A descriptive label for a [GeographicMap](#geographicmap) or a [CidrMap](#cidrmap) that's required if the property is either `geographic` or `cidrmapping`, in which case `mapName` needs to reference either an existing [GeographicMap](#geographicmap) or [CidrMap](#cidrmap) in the same domain.
maxUnreachablePenalty:
minimum: 0
type: number
description: For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers show an aggregated loss fraction higher than the penalty value. The penalty value is either `maxUnreachablePenalty` (minimum value is `0` and the default is `null`) or `unreachableThreshold` (decimal between `0` and `1`. A value of 1.0 or `null` disables an unreachable penalty). See also `unreachableThreshold` within this object.
mxRecords:
type: array
items:
$ref: '#/components/schemas/MxRecord'
description: ''
name:
maxLength: 256
pattern: ^(@|[\w-]+(\.[\w-]+)*)$
type: string
description: The value, together with the full GTM `domainName`, forms the property's hostname. The value should not begin or end with a dot (`.`), and needs to be a valid [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname. Set the name to `@` if the property is to be located at the apex of the domain.
scoreAggregationType:
$ref: '#/components/schemas/ScoreAggregationType'
staticTTL:
maximum: 3600
minimum: 30
type: integer
description: Specifies the TTL in seconds for static resource records that do not change based on the requesting name server IP. This includes MX, TXT, and SPF records.
format: int32
stickinessBonusPercentage:
maximum: 100
minimum: 0
type: integer
description: Specifies a percentage used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `100`. See also `stickinessBonusConstant` within this object. To learn more about how these object members relate to each other, see [API concepts](#apiconcepts).
format: int32
stickinessBonusConstant:
maximum: 30000
minimum: 0
type: integer
description: Specifies a constant used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `30000`. See also `stickinessBonusPercentage` within this object. To learn more about how these object members relate to each other, see [API concepts](#apiconcepts).
format: int32
trafficTargets:
type: array
items:
$ref: '#/components/schemas/TrafficTarget'
description: ''
type:
$ref: '#/components/schemas/Type1'
unreachableThreshold:
maximum: 1
minimum: 0
type: number
description: For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers have an aggregated loss fraction higher than this value. The value is a decimal between `0` and `1`. A value of `1.0` or `null` disables an unreachable penalty. See also `maxUnreachablePenalty` within this object.
useComputedTargets:
type: boolean
description: For `load-feedback` domains only, this specifies that you want GTM to automatically compute target load. Report only the current load objects, either by omission, or by using non-XML load objects.
lastModified:
type: string
description: An ISO 8601 timestamp that indicates when the property was last changed.
format: date-time
links:
type: array
items: {}
description: ''
description: Contains information about the entire GTM property configuration.
get-all-properties:
title: get-all-properties
type: object
properties:
items:
type: array
items:
type: object
description: ''
update-response-properties:
title: update-response-properties
type: object
properties:
resource:
type: object
status:
type: object
dto-resources:
title: dto-resources
required:
- aggregationType
- name
- type
type: object
properties:
aggregationType:
allOf:
- $ref: '#/components/schemas/AggregationType'
- maxLength: 15
constrainedProperty:
maxLength: 256
type: string
description: Specifies the name of the property that this resource constrains, or `**` to constrain all properties.
decayRate:
maximum: 1
minimum: 0
type: number
description: For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.
description:
maxLength: 256
type: string
description: A descriptive note to help you track what the resource constrains. For example, `aggregate bandwidth for all properties`. A maximum of 256 characters.
hostHeader:
maxLength: 255
type: string
description: Optionally specifies the host header used when fetching the load object.
leaderString:
maxLength: 256
type: string
description: Specifies the text that comes before the `loadObject`. GTM assumes that the current load is the first number to appear after this text, minus any white space. The value is a maximum of 256 characters. The default is `null`. For example, suppose your `loadObject` file contains, _This is a load object. TheLoadIs:497. This is the end of the load object_. Then GTM reads the current load as _497_ if the `leaderString` is set to _TheLoadIs_.
leastSquaresDecay:
maximum: 1
minimum: 0
type: number
description: For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.
links:
type: array
items: {}
description: ''
loadImbalancePercentage:
maximum: 1000000
minimum: 0
type: number
description: Indicates the percent of load imbalance factor (LIF) for the property. The LIF controls how imbalanced GTM allows the load to be. That is the factor by which the demand sent to a data center is permitted to exceed the configured value. For example, with a data center traffic allocation of 25 percent and an LIF of 1.5, the demand sent to the data center is allowed to grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. The LIF is represented as a percentage; zero means no load imbalance is allowed at all. However, GTM adds one to the LIF so that it can be used as a multiplier. The default LIF is 1.1, and displayed as 10.0 percent. The allowable range is 0 to 1000000 percent.
maxUMultiplicativeIncrement:
minimum: 1
type: number
description: For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.
name:
maxLength: 150
pattern: ^((?!\s).)*$
type: string
description: A descriptive label for the resource. A maximum 150 non-space characters.
resourceInstances:
type: array
items:
$ref: '#/components/schemas/ResourceInstance'
description: ''
type:
$ref: '#/components/schemas/Type2'
upperBound:
type: integer
description: An optional sanity check that specifies the maximum allowed value for any component of the load object. If the `loadObject` contains a number that exceeds this value, the entire load object is rejected as invalid and GTM continues to use the load values from the most recently acquired `loadObject`. To receive an alert when a load object is rejected, log in to [Control Center](https://control.akamai.com), from the Common Services category select Alerts, then create a Load Object File Invalid or Cannot be Fetched alert. [Learn more]({{base.url}}/{{page.language}}/webhelp/alerts/alerts/index.html).
format: int32
description: Contains information about the resources in the GTM domain.
get-all-resources:
title: get-all-resources
type: object
properties:
items:
type: array
items:
type: object
description: ''
update-response-resources:
title: update-response-resources
type: object
properties:
resource:
type: object
status:
type: object
status-response-status:
title: status-response-status
type: object
properties:
changeId:
maxLength: 36
type: string
description: A unique identifier that is generated when a change occurs to the domain. The maximum length is 36 characters.
links:
type: array
items: {}
description: ''
message:
maxLength: 4000
type: string
description: A notification that is generated when a change occurs to the domain. The maximum length is 4000 characters.
propagationStatus:
allOf:
- $ref: '#/components/schemas/PropagationStatus'
- maxLength: 20
propagationStatusDate:
type: string
description: An ISO 8601 timestamp indicating when a change occurs to the domain.
format: date-time
passingValidation:
type: boolean
description: Indicates if the domain validates.
description: Contains information about the condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](#getcurrentstatus) operation, which returns information about the current condition of the change in the domain's activation.
run-liveness-tests-dto-tools:
title: run-liveness-tests-dto-tools
type: object
properties:
domainName:
type: string
description: The full GTM domain name
property:
type: object
description: Run proposed liveness test for a property request
run-liveness-tests-response-tools:
title: run-liveness-tests-response-tools
type: object
properties:
result:
type: string
description: Liveness Test results
description: Liveness test results
AggregationType:
title: AggregationType
enum:
- sum
- median
- latest
type: string
description: Specifies how GTM handles different load numbers when multiple load servers are used for a data center or property. Either `sum`, `median`, or `latest`. For test time load feedback, consider `median`. (Akamai conducts tests from multiple locations, so you can ignore outlying values.) For load feedback with manual targets or dynamic targets, consider `latest` because all load servers normally report similar numbers.
Assignment:
title: Assignment
required:
- asNumbers
- datacenterId
- nickname
type: object
properties:
asNumbers:
type: array
items:
maximum: 4294967295
minimum: 1
type: integer
format: int32
description: ''
datacenterId:
type: integer
description: A unique identifier for an existing data center in the domain.
format: int32
nickname:
maxLength: 128
minLength: 1
type: string
description: A descriptive label for the group.
description: Contains information about the AS zone groupings of AS IDs.
Assignment1:
title: Assignment1
type: object
properties:
datacenterId:
type: integer
description: A unique identifier for an existing data center in the domain.
format: int32
nickname:
maxLength: 256
minLength: 1
type: string
description: A descriptive label for the CIDR zone group, up to 256 characters.
blocks:
type: array
items:
maxLength: 256
minLength: 1
type: string
description: ''
description: Contains information about the CIDR zone groupings of CIDR blocks.
Assignment2:
title: Assignment2
type: object
properties:
datacenterId:
type: integer
description: A unique identifier for an existing data center in the domain.
format: int32
nickname:
maxLength: 128
minLength: 1
type: string
description: A descriptive label for the group.
countries:
type: array
items:
maxLength: 10
minLength: 1
type: string
description: ''
description: Contains information about the geographic zone groupings of countries.
Continent:
title: Continent
enum:
- AF
- AS
- EU
- NA
- OC
- OT
- SA
type: string
description: A two-letter code that specifies the continent where the data center maps to. If omitted, GTM populates this parameter. Either `AF`, `AS`, `EU`, `NA`, `OC`, `OT`, or `SA`.
Contract:
title: Contract
type: object
properties:
contractId:
type: string
description: A unique identifier for the contract.
features:
type: array
items:
$ref: '#/components/schemas/Feature'
description: ''
permissions:
type: array
items:
$ref: '#/components/schemas/Permission'
description: ''
description: Lists information about each contract under a specific account.
Contract1:
title: Contract1
type: object
properties:
contractId:
type: string
description: A unique identifier for the contract.
contractName:
type: string
description: A descriptive name for the contract.
contractTypeName:
type: string
description: A descriptive name for the contract type.
description: Collects information about each contract under a specific account.
DefaultDatacenter:
title: DefaultDatacenter
required:
- datacenterId
- nickname
type: object
properties:
datacenterId:
type: integer
description: For each property, an identifier for all other AS zones' CNAME. For example, 5400.
format: int32
nickname:
maxLength: 128
minLength: 1
type: string
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`.
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.
DefaultDatacenter1:
title: DefaultDatacenter1
type: object
properties:
datacenterId:
type: integer
description: For each property, an identifier for all other CIDR zones' CNAME. For example, 5400.
format: int32
nickname:
maxLength: 128
minLength: 1
type: string
description: A descriptive label for the all other CIDR blocks. If omitted, the default is `All Other CIDR Blocks`.
description: A placeholder for all other CIDR zones, CIDR blocks not found in these CIDR zones. Note that a CIDR map can't have the same CIDR block in multiple CIDR zones.
DefaultDatacenter2:
title: DefaultDatacenter2
type: object
properties:
datacenterId:
type: integer
description: For each property, an identifier for all other geographic zones' CNAME. For example, 5400.
format: int32
nickname:
maxLength: 128
minLength: 1
type: string
description: A descriptive label for all other geographic zones. The value ranges from 1 to 128 characters. If omitted, defaults to `Default Mapping`.
description: A placeholder for all other geographic zones, countries not found in these geographic zones. Note that a geographic map cannot have the same countries in multiple geographic zones.
DefaultLoadObject:
title: DefaultLoadObject
type: object
properties:
loadObject:
maxLength: 256
pattern: ^(?!:).*$
type: string
description: Specifies the load object that GTM requests. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. The value cannot begin with a `:` character, and is limited to a maximum of 256 characters.
loadObjectPort:
maximum: 65535
minimum: 0
type: integer
description: Specifies the TCP port to connect to when requesting the load object. A value of `0` means to use the default port, equivalent to either `80` or `443`.
format: int32
loadServers:
type: array
items:
maxLength: 256
type: string
description: Specifies a list of servers to request the load object from. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, do not use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.
description: Specifies the load reporting interface between you and the GTM system. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. This default load object is intended to be shared. Individual [Resources](#resource) can specify `useDefaultLoadObject` to use it instead of specifying their own.
Feature:
title: Feature
enum:
- FAILOVER
- QTR
- ASMAPPING
- CIDRMAPPING
- GEOGRAPHIC
- WEIGHTED_ROUND_ROBIN
- WEIGHTED_ROUND_ROBIN_LOAD_FEEDBACK
- WEIGHTED_HASHED
- PERFORMANCE
type: string
description: 'Indicates the available property types for a specific domain. Types include: `FAILOVER`, `QTR`, `ASMAPPING`, `CIDRMAPPING`, `GEOGRAPHIC`, `WEIGHTED_ROUND_ROBIN`, `WEIGHTED_ROUND_ROBIN_LOAD_FEEDBACK`, `WEIGHTED_HASHED`, and `PERFORMANCE`.'
Group:
title: Group
type: object
properties:
contractIds:
type: array
items:
type: string
description: ''
groupId:
type: integer
description: A unique identifier for the group.
format: int32
groupName:
type: string
description: A descriptive name for the group.
permissions:
type: array
items:
$ref: '#/components/schemas/Permission1'
description: ''
description: 'Collects information about each group under a specific GTM account. For details on how to modify group permissions, see the [Identity Management: User Administration API](https://developer.akamai.com/api/core_features/identity_management_user_admin/v2.html).'
HandoutMode:
title: HandoutMode
enum:
- normal
- persistent
- one-ip
- one-ip-hashed
- all-live-ips
type: string
description: Specifies how IPs are returned when more than one IP is alive and available. Either `normal`, `persistent`, `one-ip`, `one-ip-hashed`, or `all-live-ips`. The default is `normal`. Handout mode is relevant only when you have more than one server IP in a data center.
Item:
title: Item
type: object
properties:
acgId:
type: string
description: Contract Id
lastModified:
type: string
description: Read-only [date-time](http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.23) value, generated when a change occurs.
format: date-time
name:
maxLength: 100
minLength: 1
type: string
description: Maximum `100` characters, ending in `.akadns.net.`
links:
type: array
items:
type: object
description: ''
status:
type: string
description: Domain status
LivenessTest:
title: LivenessTest
required:
- disableNonstandardPortWarning
- hostHeader
- httpError3xx
- httpError4xx
- httpError5xx
- name
- requestString
- responseString
- sslClientCertificate
- sslClientPrivateKey
- testInterval
- testObject
- testObjectPassword
- testObjectPort
- testObjectProtocol
- testObjectUsername
- testTimeout
type: object
properties:
disableNonstandardPortWarning:
type: boolean
description: Disables warnings when non-standard ports are used. For example, GTM does not emit a warning to specify port 1234 when the `testObjectProtocol` is `http`, as HTTP typically uses port 80. The default is `false`.
hostHeader:
maxLength: 256
type: string
description: Sent if the `testObjectProtocol` is `http` or `https`, up to 256 non-space, alphanumeric characters.
httpError3xx:
type: boolean
description: Treats a 3xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.
httpError4xx:
type: boolean
description: Treats a 4xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.
httpError5xx:
type: boolean
description: Treats a 5xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.
name:
maxLength: 128
minLength: 1
type: string
description: A descriptive name for the liveness test.
requestString:
maxLength: 4000
type: string
description: Specifies a request string. Required if `testObjectProtocol` is `tcp` or `tcps`. The value is a maximum of 4000 non-space, alphanumeric characters.
responseString:
maxLength: 4000
type: string
description: Specifies a response string. Required if `testObjectProtocol` is `tcp` or `tcps`. Maximum 4000 characters.
sslClientCertificate:
type: string
description: Indicates a Base64-encoded certificate. SSL client certificates are available for `livenessTests` that use secure protocols.
sslClientPrivateKey:
type: string
description: Indicates a Base64-encoded private key. The private key used to generate or request a certificate for `livenessTests` can't have a passphrase nor be used for any other purpose.
testInterval:
minimum: 10
type: integer
description: Indicates the interval at which the liveness test is run, in seconds. Requires a minimum of 10 seconds.
format: int32
testObject:
maxLength: 256
type: string
description: Specifies the static text that acts as a stand-in for the data that you're sending on the network.
testObjectPassword:
maxLength: 128
type: string
description: Specifies the test object's password. It is required if `testObjectProtocol` is `ftp`. Maximum is 128 characters.
testObjectPort:
maximum: 65535
minimum: 1
type: integer
description: Specifies the port number for the `testObject`. Value from `1` to `65535`.
format: int32
testObjectProtocol:
$ref: '#/components/schemas/TestObjectProtocol'
testObjectUsername:
maxLength: 512
type: string
description: A descriptive name for the `testObject`. If `testObjectProtocol` is `ftp`, then `testObjectUsername` is required. The value is a maximum of 256 non-space, alphanumeric characters.
testTimeout:
minimum: 0.001
type: number
description: Specifies the duration of the liveness test before it fails. The range is from `0.001` to `60` seconds. The default value is `25` seconds.
description: Contains information about the liveness tests, which are run periodically to determine whether your servers respond to requests, as discussed in [API concepts](#apiconcepts).
MxRecord:
title: MxRecord
required:
- exchange
- preference
type: object
properties:
exchange:
type: string
description: MX record exchange field
preference:
type: number
description: MX record preference field
description: Specifies the MX records handed out to `MX` record type queries. Note that mapping and liveness testing aren't done. The same MX records are handed out for every request.
Permission:
title: Permission
enum:
- READ
- WRITE
- ADD
- ADD_DATACENTER
type: string
description: 'Identifies the privileges set to modify or delete any of the `properties` within a specific domain. Values include: `READ`, `WRITE`, `ADD`, and `ADD_DATACENTER`.'
Permission1:
title: Permission1
enum:
- READ
- WRITE
- ADD
- ADD_DATACENTER
type: string
description: 'Identifies the privileges set for each group under the account. These privileges let you create a domain, modify, or delete any of the `properties` within a specific domain. Values include: `READ`, `WRITE`, `ADD`, and `ADD_DATACENTER`.'
PropagationStatus:
title: PropagationStatus
enum:
- DENIED
- PENDING
- COMPLETE
type: string
description: Tracks the status of the domain's propagation state. Either `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and does not propagate until the validation errors are resolved.
ResourceInstance:
title: ResourceInstance
required:
- datacenterId
type: object
properties:
datacenterId:
type: integer
description: A unique identifier for an existing data center in the domain.
format: int32
useDefaultLoadObject:
type: boolean
description: Indicates whether a default `loadObject` is used for the resources.
loadServers:
type: array
items:
type: string
description: ''
loadObject:
maxLength: 256
pattern: ^(?!:).*$
type: string
description: Identifies the load object file used to report real-time information about the current load, maximum allowable load, and target load on each resource. The maximum permitted length is 256 characters. [Learn more]({{base.url}}/{{page.language}}/webhelp/global-traffic-management/global-traffic-management-user-guide/).
loadObjectPort:
maximum: 65535
minimum: 0
type: integer
description: Specifies the TCP port of the `loadObject`. The value ranges from `0` to `65535`. If the value is `0`, the default port is either `80` or `443`.
format: int32
description: Contains information about the `resources` that constrain the `properties` within the data center.
ScoreAggregationType:
title: ScoreAggregationType
enum:
- mean
- median
- best
- worst
type: string
description: Specifies how GTM aggregates liveness test scores across different tests, when multiple tests are configured. Values are `mean`, `median`, `best`, or the default `worst`.
TestObjectProtocol:
title: TestObjectProtocol
enum:
- HTTP
- HTTPS
- FTP
- POP
- POPS
- SMTP
- SMTPS
- TCP
- TCPS
type: string
description: Specifies the test protocol. Either`DNS`, `HTTP`, `HTTPS`, `FTP`, `POP`, `POPS`, `SMTP`, `SMTPS`, `TCP`, or `TCPS`. Enable the `testObjectProtocol` for `DNS`. Requires `application/vnd.config-gtm.v1.3+json`.
TrafficTarget:
title: TrafficTarget
type: object
properties:
datacenterId:
type: integer
description: A unique identifier for an existing data center in the domain.
format: int32
enabled:
type: boolean
description: Indicates whether the traffic target is used. You can also omit the traffic target, which has the same result as the `false` value. However, when the value is `false`, GTM continues to store the other traffic target fields in the database. There's no need to store them locally should you want to use the traffic target at a later time.
handoutCName:
maxLength: 255
type: string
description: Specifies an optional data center for the property. The `handoutCName` is used when there are no servers configured for the property. Maximum 63 characters for the labels, 255 characters overall. May contain alphanumeric, hyphens, and underscores, but not literal IP addresses. Leading or trailing hyphens are not allowed.
weight:
minimum: 0
type: number
description: Specifies the traffic weight for the target. This parameter is required when the enclosing property is `failover`, `weighted`, `weighted-with-load-feedback`, or `performance`. The sum of this value, for all enabled targets, needs to add up to 100. For `failover` properties, set this value to `1` for the traffic target you want to mark as _primary_. For `weighted`, `weighted-with-load-feedback` or `performance`, set this to the percentage of the total load.
servers:
type: array
items:
type: string
description: ''
name:
type: string
description: An alternative label for the traffic target.
description: Contains information about where to direct data center traffic. For geographic mapped properties, it is always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can have multiple traffic targets associated with the same data center.
Type:
title: Type
enum:
- failover-only
- static
- weighted
- basic
- full
type: string
description: Indicates the type of domain available based on your contract. Either `failover-only`, `static`, `weighted`, `basic`, or `full`.
Type1:
title: Type1
enum:
- failover
- geographic
- cidrmapping
- weighted-round-robin
- weighted-hashed
- weighted-round-robin-load-feedback
- qtr
- performance
type: string
description: Specifies the load balancing behavior for the property. Either `failover`, `geographic`, `cidrmapping`, `weighted-round-robin`, `weighted-hashed`, `weighted-round-robin-load-feedback`, `qtr`, or `performance`. An additional value of `asmapping` requires the `application/vnd.config-gtm.v1.1+json` media type. See [API versioning](#versioning) for more information.
Type2:
title: Type2
enum:
- XML load object via HTTP
- XML load object via HTTPS
- Non-XML load object via HTTP
- Non-XML load object via HTTPS
- Download score
- Push API
type: string
description: Indicates the kind of `loadObject` format used to determine the load on the resource. Either `XML load object via HTTP`, `XML load object via HTTPS`, `Non-XML load object via HTTP`, `Non-XML load object via HTTPS`, `Download score`, or `Push API`.
DefaultDatacenter4:
title: DefaultDatacenter4
required:
- datacenterId
- nickname
type: object
properties:
datacenterId:
type: integer
description: For each property, an identifier for all other AS zones' CNAME. For example, 5400.
format: int32
nickname:
maxLength: 128
minLength: 1
type: string
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`.
DefaultDatacenter12:
title: DefaultDatacenter12
type: object
properties:
datacenterId:
type: integer
description: For each property, an identifier for all other CIDR zones' CNAME. For example, 5400.
format: int32
nickname:
maxLength: 128
minLength: 1
type: string
description: A descriptive label for the all other CIDR blocks. If omitted, the default is `All Other CIDR Blocks`.
DefaultDatacenter22:
title: DefaultDatacenter22
type: object
properties:
datacenterId:
type: integer
description: For each property, an identifier for all other geographic zones' CNAME. For example, 5400.
format: int32
nickname:
maxLength: 128
minLength: 1
type: string
description: A descriptive label for all other geographic zones. The value ranges from 1 to 128 characters. If omitted, defaults to `Default Mapping`.
DefaultLoadObject2:
title: DefaultLoadObject2
type: object
properties:
loadObject:
maxLength: 256
pattern: ^(?!:).*$
type: string
description: Specifies the load object that GTM requests. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. The value cannot begin with a `:` character, and is limited to a maximum of 256 characters.
loadObjectPort:
maximum: 65535
minimum: 0
type: integer
description: Specifies the TCP port to connect to when requesting the load object. A value of `0` means to use the default port, equivalent to either `80` or `443`.
format: int32
loadServers:
type: array
items:
maxLength: 256
type: string
description: Specifies a list of servers to request the load object from. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, do not use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.
DomainsGeographicMapsResponse1:
title: DomainsGeographicMapsResponse1
type: object
properties:
name:
maxLength: 128
minLength: 1
type: string
description: A descriptive label for the geographic map, up to `128` characters.
defaultDatacenter:
$ref: '#/components/schemas/DefaultDatacenter22'
assignments:
type: array
items:
$ref: '#/components/schemas/Assignment2'
description: ''
links:
type: array
items: {}
description: ''
DomainsStatusCurrentResponse:
title: DomainsStatusCurrentResponse
type: object
properties:
changeId:
maxLength: 36
type: string
description: A unique identifier that is generated when a change occurs to the domain. The maximum length is 36 characters.
links:
type: array
items: {}
description: ''
message:
maxLength: 4000
type: string
description: A notification that is generated when a change occurs to the domain. The maximum length is 4000 characters.
propagationStatus:
allOf:
- $ref: '#/components/schemas/PropagationStatus'
- maxLength: 20
propagationStatusDate:
type: string
description: An ISO 8601 timestamp indicating when a change occurs to the domain.
format: date-time
passingValidation:
type: boolean
description: Indicates if the domain validates.
IdentityContractsResponse:
title: IdentityContractsResponse
type: object
properties:
accountId:
type: string
description: A unique identifier for the account where the contract exists.
contracts:
type: array
items:
$ref: '#/components/schemas/Contract1'
description: ''
IdentityGroupsResponse:
title: IdentityGroupsResponse
type: object
properties:
groups:
type: array
items:
$ref: '#/components/schemas/Group'
description: ''
IdentityResponse:
title: IdentityResponse
type: object
properties:
accountId:
type: string
description: A unique API client identity for a specific account, created in [Control Center](https://control.akamai.com/apps/home-page).
active:
type: boolean
description: Enabled if the account is active.
contracts:
type: array
items:
$ref: '#/components/schemas/Contract'
description: ''
email:
type: string
description: The email address of the client on the account.
firstName:
type: string
description: The first name of the client on the account.
lastName:
type: string
description: The last name of the client on the account.
locale:
type: string
description: Indicates the client's language and country in [RFC 5646](https://tools.ietf.org/html/rfc5646) format.
userName:
type: string
description: The username of the client on the account.
userTimeZone:
type: string
description: The time zone of the client on the account, which specifies an offset from GTM.
RunProposedPropertyLivenessTestsResponse:
title: RunProposedPropertyLivenessTestsResponse
type: object
properties:
result:
type: string
description: Liveness Test results
tags:
- name: AutonomousSystemMaps
- name: CIDRMaps
- name: DataCenters
- name: Domains
- name: GeographicMaps
- name: Identity
- name: Properties
- name: Resources
- name: Status
- name: Tools