API

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

The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as example.akadns.net.

cidrMaps
array of objects
required

The set of CIDR maps assigned to this domain.

cidrMaps*
integer
required
Defaults to 75

Specifies the download penalty score. If the download encounters an error, the web agent computes a score that's 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 fields 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
Defaults to 25

Specifies the timeout penalty score. The web agent then computes a score that's 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.

string | null

Unique identifier of the request to delete the domain. This ID can be used to track the status or audit the deletion process.

emailNotificationList
array of strings
required

Email addresses to notify when a change is made to the domain.

emailNotificationList*
geographicMaps
array of objects
required

The set of geographic maps assigned to this domain.

geographicMaps*
links
array of objects

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.

resources
array of objects or null
required

The resources in the GTM domain.

resources*
status
object

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
enum
required

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

Allowed:
asMaps
array of objects
required

v1.1 The set of AS maps assigned to this domain.

asMaps*
boolean
required
Defaults to false

v1.1 If enabled, GTM collapses CNAME redirections in DNS answers when it knows the target of the CNAME. The default value is false.

boolean
required
Defaults to false

v1.5 Whether DNSSEC Sign&Serve is enabled.

string | null
enum

v1.5 The algorithm currently or last used for DNSSEC Sign&Serve. null if no algorithm has ever been assigned to this domain. Possible values are: RSA_SHA1, RSA_SHA256, RSA_SHA512, ECDSA_P256_SHA256, or ECDSA_P384_SHA384.

Allowed:
datacenters
array of objects
required

The set of data centers assigned to this domain.

datacenters*
properties
array of objects
required

The properties in the GTM domain.

properties*
Response

Updated about 1 month ago

Language
URL
LoadingLoading…
Response
Choose an example:
domain-vnd-config-gtm.v1.8+json

Updated about 1 month ago