API
Start typing to search…

Create a domain

post https://{hostname}/config-gtm/v1/domains

Creates a new GTM domain.

Query Params
string

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.

integer

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.

string

For customers who manage more than one account, this runs the operation from another account. The Identity and Access Management API provides a list of available account switch keys.

Body Params
cidrMaps
array of objects
required

Contains information about the set of CIDR maps assigned to this domain.

cidrMaps*
datacenters
array of objects
required

Contains information about the set of data centers assigned to this domain.

datacenters*
integer
required

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.

string | null
required

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 doesn't contain sslClientCertificate and sslClientPrivateKey values, use this and the defaultSslClientPrivateKey object members to generate a certificate. In this case, use a separate, throwaway private key when generating a certificate or certificate signing request (CSR). You shouldn't use this key for any other purpose. See also defaultSslClientPrivateKey within this object.

string | null
required

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.

integer
required

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.

emailNotificationList
array of strings
required

A list of email addresses to notify when a change is made to the domain.

emailNotificationList*
geographicMaps
array of objects
required

Contains information about the set of geographic maps assigned to this domain.

geographicMaps*
links
array of objects

Provides a URL path that allows direct navigation to the domain.

links
boolean
required

Indicates whether you're using resources to control load balancing. Resources represent a constraint on how much load a data center can absorb. The value is true if you're using load feedback.

number | null
required
0 to 1000000

Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is 0, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as 10.0 percent. The value ranges from 0 to 1000000 percent.

string | null
required

A descriptive note about changes to the domain. The maximum is 4000 characters.

string
required
length between 1 and 100

The full GTM domain name that needs to end in .akadns.net, up to 100 characters.

properties
array of objects
required

Contains information about the properties in the GTM domain.

properties*
resources
array of objects or null
required

Contains information about the resources in the GTM domain.

resources*
status
object

Specifies the condition of the change in the domain's activation.

string
required

Indicates the type of domain available based on your contract. Either failover-only, static, weighted, basic, or full.

Response

Response body
object
object | null

Contains information about the resources in the GTM domain.

string
required
length ≤ 15

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.

sum median latest

string | null

Provides information about the purpose of the property.

string | null

Specifies the name of the property that this resource constrains, or ** to constrain all properties.

number | null
0 to 1

For internal use only. Unless Akamai indicates otherwise, omit the value or set it to null.

string | null

A descriptive note to help you track what the resource constrains. For example, aggregate bandwidth for all properties. A maximum of 256 characters.

string | null

Optionally specifies the host header used when fetching the load object.

string | null

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.

number | null
0 to 1

For internal use only. Unless Akamai indicates otherwise, omit the value or set it to null.

links
array of objects

Specifies the URL path that allows direct navigation to the resource.

links
object
string

Provides a hypermedia link to the complete URL that uniquely defines a resource.

string

Indicates the link relationship of the object.

number | null
0 to 1000000

Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is 0, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as 10.0 percent. The value ranges from 0 to 1000000 percent.

number | null
≥ 1

For internal use only. Unless Akamai indicates otherwise, omit the value or set it to null.

string
required
length ≤ 150

A descriptive label for the resource. A maximum 150 non-space characters.

resourceInstances
array of objects

Contains information about the resources that constrain the properties within the data center.

resourceInstances
object
integer
required

A unique identifier for an existing data center in the domain.

string | null

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.

integer
0 to 65535

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.

array of strings | null

Specifies a list of servers from which to request the load object. 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, don't use non-routable RFC 1918 addresses.

loadServers
boolean

Indicates whether a default loadObject is used for the resources.

string
required

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.

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

integer | null

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, it rejects the entire load object 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, select Alerts from the Common Services category, then create a Load Object File Invalid or Cannot be Fetched alert. Learn more.

status
object

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 operation, which returns information about the current condition of the change in the domain's activation.

string
length ≤ 36

Read-only A unique identifier generated when a change occurs to the domain. The maximum length is 36 characters.

links
array of objects

Specifies the URL path that allows direct navigation to the domain.

string
length ≤ 4000

Read-only A notification generated when a change occurs to the domain. The maximum length is 4000 characters.

boolean

Read-only Indicates if the domain validates.

string
length ≤ 20

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 doesn't propagate until the validation errors are resolved.

PENDING COMPLETE DENIED

date-time

Read-only An ISO 8601 timestamp indicating when a change occurs to the domain.

Headers
object
string

Updated 6 months ago

Did this page help you?
Language
Authentication
Remember to add your authentication credentials to run this code.
URL

Updated 6 months ago

Did this page help you?