API

Create or update a resource

put
https://{hostname}/config-gtm/v1/domains//resources/

Run this operation to create or update a resource.

Path Params
string
required

Name of the resource to create or update.

string
required

The full GTM domain name.

Query Params
string | null

Specifies change descriptions for audit trail and domain's change history. The maximum is 4000 characters.

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 resources in the GTM domain.

string
enum
required
length ≤ 15

Specifies how GTM handles different load numbers when multiple load servers are used for a data center or property. Possible values are: 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.

Allowed:
string | null

Specifies the name of the property that this resource constrains, or ** to constrain all properties. To remove the property constraint, set the field to null.

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

The resources that constrain the properties within the data center.

resourceInstances
string
enum
required

Indicates the kind of loadObject format used to determine the load on the resource. Possible values are: 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.

Allowed:
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.

Responses

Updated about 1 month ago

Language
URL
LoadingLoading…
Response
Choose an example:
application/json

Updated about 1 month ago