Akamai: Global Traffic Management API
Use load balancing to manage website and mobile performance demands.
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Use load balancing to manage website and mobile performance demands.
Endpoints 50
Collections
- GETList Akamai cloud regions
/collections/akamai-cloud-regions?accountSwitchKey={{accountSwitchKey}}This operation returns a list of available Akamai cloud regions. Use these regions when creating a data center with a cloudProvider of akamai-cloud. Each… - GETList datacenter IDs
/collections/datacenter-ids?pageSize={{pageSize}}&offset={{offset}}&accountSwitchKey={{accountSwitchKey}}Returns a paginated list of valid datacenter IDs available for use as virtual datacenters. - GETList supported geo codes
/collections/supported-geo-codes?accountSwitchKey={{accountSwitchKey}}Returns the full hierarchy of supported geographic codes — continents, countries, and states or provinces — that you can use when configuring geographic maps. - GETList DNS record set types
/data/recordset-types?domain={{domain}}&accountSwitchKey={{accountSwitchKey}}Returns the DNS record types supported for GTM properties, optionally filtered by domain.
Domains
- GETList domains
/domains?accountSwitchKey={{accountSwitchKey}}Returns a list of GTM domain summaries under your contract. - POSTCreate a domain
/domains?contractId={{contractId}}&gid={{gid}}&accountSwitchKey={{accountSwitchKey}}Creates a new GTM domain. - POSTSubmit a bulk domain delete request
/domains/delete-requests?bypassSafetyChecks={{bypassSafetyChecks}}&accountSwitchKey={{accountSwitchKey}}Submits an asynchronous request to delete one or more GTM domains. Poll the returned requestId using the status endpoint to track progress. - GETGet delete request status
/domains/delete-requests/:requestId?accountSwitchKey={{accountSwitchKey}}Returns the current status of a bulk domain delete request, including how many domains have been successfully deleted, failed, and whether processing is… - GETGet delete request result
/domains/delete-requests/:requestId/result?accountSwitchKey={{accountSwitchKey}}Returns the final result of a completed bulk domain delete request, listing which domains were successfully deleted and which failed. Only available once… - GETGet a domain
/domains/:domainName?accountSwitchKey={{accountSwitchKey}}Returns information for a specific GTM domain. - PUTUpdate a domain
/domains/:domainName?accountSwitchKey={{accountSwitchKey}}Updates a specific GTM domain. - GETGet domain authorities
/domains/:domainName/authorities?accountSwitchKey={{accountSwitchKey}}Returns authorities for a specific GTM domain if it is a custom domain and not hosted on config-gtm. - GETGet domain features
/domains/:domainName/features?accountSwitchKey={{accountSwitchKey}}Returns the contract features available for a specific GTM domain, including the set of supported property types and security features such as DNSSEC. - GETList domain history
/domains/:domainName/history?page={{page}}&pageSize={{pageSize}}&accountSwitchKey={{accountSwitchKey}}Returns a list of each change made to the domain. - GETGet current status
/domains/:domainName/status/current?accountSwitchKey={{accountSwitchKey}}This operation returns information about the current condition of the change in the domain's activation. - GETGet status for a domain version
/domains/:domainName/status/:versionId?accountSwitchKey={{accountSwitchKey}}Returns the propagation status for a specific domain version, identified by its changeId. - GETGet a domain summary
/domains/:domainName/summary?accountSwitchKey={{accountSwitchKey}}Returns summary information for a specific GTM domain, including its activation state, last modification details, and DNSSEC configuration.
AS maps
- GETList AS maps
/domains/:domainName/as-maps?accountSwitchKey={{accountSwitchKey}}Returns a list of AS maps. - GETGet an AS map
/domains/:domainName/as-maps/:mapName?accountSwitchKey={{accountSwitchKey}}Returns information for a specific AS map. - PUTCreate or update an AS map
/domains/:domainName/as-maps/:mapName?domainModificationComments={{domainModificationComments}}&accountSwitchKey={{accountSwitchKey}}Run this operation to create or update an AS map. - DELETERemove an AS map
/domains/:domainName/as-maps/:mapName?accountSwitchKey={{accountSwitchKey}}Removes a specific AS map.
CIDR maps
- GETList CIDR maps
/domains/:domainName/cidr-maps?accountSwitchKey={{accountSwitchKey}}Returns a list of CIDR maps. - GETGet a CIDR map
/domains/:domainName/cidr-maps/:mapName?accountSwitchKey={{accountSwitchKey}}Returns information for a specific CIDR map. - PUTCreate or update a CIDR map
/domains/:domainName/cidr-maps/:mapName?domainModificationComments={{domainModificationComments}}&accountSwitchKey={{accountSwitchKey}}Run this operation to create or update a CIDR map. - DELETERemove a CIDR map
/domains/:domainName/cidr-maps/:mapName?accountSwitchKey={{accountSwitchKey}}Removes a specific CIDR map.
Data centers
- GETList data centers
/domains/:domainName/datacenters?accountSwitchKey={{accountSwitchKey}}This operation returns a list of data centers. - POSTCreate a data center
/domains/:domainName/datacenters?accountSwitchKey={{accountSwitchKey}}This operation creates a specific data center. - POSTCreate an IPv4 data center for ip-version-selector
/domains/:domainName/datacenters/datacenter-for-ip-version-selector-ipv4?accountSwitchKey={{accountSwitchKey}}This operation creates a data center which is solely reserved for use by properties of the IP Version Selector type qtr. The data center created by this… - POSTCreate an IPv6 data center for ip-version-selector
/domains/:domainName/datacenters/datacenter-for-ip-version-selector-ipv6?accountSwitchKey={{accountSwitchKey}}This operation creates a data center which is solely reserved for use by properties of type qtr (IP Version Selector). The data center created by this… - POSTCreate a default data center
/domains/:domainName/datacenters/default-datacenter-for-maps?accountSwitchKey={{accountSwitchKey}}This operation creates a data center for use by the map-type properties CIDR, Geographic or AS mapping as the default data center. - GETGet a data center
/domains/:domainName/datacenters/:datacenterId?accountSwitchKey={{accountSwitchKey}}This operation returns information for a specific data center. - PUTUpdate a data center
/domains/:domainName/datacenters/:datacenterId?domainModificationComments={{domainModificationComments}}&accountSwitchKey={{accountSwitchKey}}This operation updates a specific data center. - DELETERemove a data center
/domains/:domainName/datacenters/:datacenterId?accountSwitchKey={{accountSwitchKey}}Remove a data center: This operation removes a data center. You can only remove a data center when no properties or resources are assigned to it.
Geographic maps
- GETList geographic maps
/domains/:domainName/geographic-maps?accountSwitchKey={{accountSwitchKey}}Returns a list of geographic maps. - GETGet a geographic map
/domains/:domainName/geographic-maps/:mapName?accountSwitchKey={{accountSwitchKey}}Returns information for a specific geographic map. - PUTCreate or update a geographic map
/domains/:domainName/geographic-maps/:mapName?domainModificationComments={{domainModificationComments}}&accountSwitchKey={{accountSwitchKey}}Run this operation to create or update a geographic map. - DELETERemove a geographic map
/domains/:domainName/geographic-maps/:mapName?accountSwitchKey={{accountSwitchKey}}Removes a geographic map.
Properties
- GETList properties
/domains/:domainName/properties?accountSwitchKey={{accountSwitchKey}}Returns a list of GTM properties. - PUTReplace all properties
/domains/:domainName/properties?domainModificationComments={{domainModificationComments}}&accountSwitchKey={{accountSwitchKey}}Replaces the complete set of properties on a domain with those specified in the request body. - PATCHAdd or update properties
/domains/:domainName/properties?domainModificationComments={{domainModificationComments}}&accountSwitchKey={{accountSwitchKey}}Adds or updates properties on a domain without replacing the entire set. Properties not included in the request body are left unchanged. - GETGet a property
/domains/:domainName/properties/:propertyName?accountSwitchKey={{accountSwitchKey}}Returns information for a specific GTM property. - PUTCreate or update a property
/domains/:domainName/properties/:propertyName?domainModificationComments={{domainModificationComments}}&accountSwitchKey={{accountSwitchKey}}Run this operation to create or update a GTM property. - DELETERemove a property
/domains/:domainName/properties/:propertyName?accountSwitchKey={{accountSwitchKey}}Removes a specific GTM property.
Resources
- GETList resources
/domains/:domainName/resources?accountSwitchKey={{accountSwitchKey}}Returns a list of resources created within the domain that constrain one or more properties in a data center. - GETGet a resource
/domains/:domainName/resources/:resourceName?accountSwitchKey={{accountSwitchKey}}Returns information for a specific resource. - PUTCreate or update a resource
/domains/:domainName/resources/:resourceName?domainModificationComments={{domainModificationComments}}&accountSwitchKey={{accountSwitchKey}}Run this operation to create or update a resource. - DELETERemove a resource
/domains/:domainName/resources/:resourceName?accountSwitchKey={{accountSwitchKey}}Removes a specific resource.
Identity
- GETGet identity
/identity?gid={{gid}}&accountSwitchKey={{accountSwitchKey}}This operation returns information about the API client. Run this operation for details on the API client contract such as available load balancing features…
Contracts
- GETList contracts
/identity/contracts?gid={{gid}}&accountSwitchKey={{accountSwitchKey}}This operation returns a list of API client contracts. When you Create a domain, you may need a contractId under certain circumstances. Run this operation to…
Groups
- GETList groups
/identity/groups?gid={{gid}}&accountSwitchKey={{accountSwitchKey}}This operation returns a list of API client groups and their parameters. When you Create a domain, you may need a groupId under certain circumstances. Run…
API details
- Base URL
https://{hostname}/config-gtm/v1- Authentication
- None declared in the description
- Operations
- 50 operations on 33 pathsGET 29PUT 8POST 6DELETE 6PATCH 1
- Main resources
- Domains 13Data centers 8Properties 6AS maps 4CIDR maps 4Collections 4Geographic maps 4Resources 4Contracts 1Groups 1
- Response formats
application/jsondatacenter-vnd-config-gtm.v1.0+jsondatacenter-vnd-config-gtm.v1.1+jsondatacenter-vnd-config-gtm.v1.2+json- Description format
- OpenAPI 3.0.0, API version
v1 - Links
- Documentation · OpenAPI document
- Listed from
- Akamai's published OpenAPI description (akamai/akamai-apis) (Apache-2.0)
How to test the Akamai: Global Traffic Management API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Akamai: Global Traffic Management API collection, without the publisher's secrets.
- Add your credentialsOpen the collection's variables or an environment and enter your API key or token, if the API needs one.
- Send a requestPick an endpoint, for example “List Akamai cloud regions” (GET /collections/akamai-cloud-regions?accountSwitchKey={{accountSwitchKey}}), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Akamai: Global Traffic Management API?
Use load balancing to manage website and mobile performance demands. It is listed under Developer tools and has 50 endpoints.
Who publishes the Akamai: Global Traffic Management API?
It is listed from Akamai's public API description (an OpenAPI document), not published by Akamai on Swastik Codes. Anyone who controls akamai.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Akamai: Global Traffic Management API?
Requests go to https://{hostname}/config-gtm/v1. Endpoint paths are added to this base URL.
How do I authenticate with the Akamai: Global Traffic Management API?
Its OpenAPI description does not declare an authentication scheme. Some endpoints may be open; check the provider's documentation before relying on that.
How many endpoints does the Akamai: Global Traffic Management API have?
50 operations on 33 paths (29 GET, 8 PUT, 6 POST, 6 DELETE, 1 PATCH). The largest groups are Domains, Data centers, Properties, AS maps.
Is forking the Akamai: Global Traffic Management API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.