Edge Diagnostics API

Number of APIs: 30

Use Edge Diagnostics to identify common problems, such as server, DNS, or network issues, you may experience when delivering content to your users.

With this API, you can: - Diagnose issues in the traffic between a client and edge servers and between an edge and origin server. - Fetch basic data from an edge server, such as an IP, error statistics, and more. - Fetch data required by other operations, such as edge server locations, GTM properties, and more.

Authentication

Create an authentication credential that contains the client token and client secret required to authenticate Akamai API requests.

1. Navigate to the Identity and Access Management section of Akamai Control Center and click Create API Client.

Note: If you don't have access to the Identity and Access Management tool, contact your local Akamai Control Center admin or your Akamai account team for assistance.

1. Click Quick and then Download in the Credentials section.

Note: If you need to refine access levels or permissions, see Create a client with custom permissions.

1. Open the downloaded file with a text editor and add [default] as a header above all text.

  [default]
  client_secret = C113nt53KR3TN6N90yVuAgICxIRwsObLi0E67/N8eRN=
  host = akab-h05tnam3wl42son7nktnlnnx-kbob3i3v.luna.akamaiapis.net
  access_token = akab-acc35t0k3nodujqunph3w7hzp7-gtm6ij
  client_token = akab-c113ntt0k3n4qtari252bfxxbsl-yvsdj

1. Fork the [Akamai Authentication] environment, populate the variables, and [set it for your workspace]

Dependencies

Some of the diagnostic tools this API makes available require certain features to be available under your product and contract. For example, you need Global Traffic Management enabled to run the corresponding tools, otherwise you get a 403 error.

Integration methods

You can use this API collection in these integration methods: - API - CLI

1. Connectivity problems - Run the Connectivity problems scenario

POST https://{{host}}/edge-diagnostics/v1/connectivity-problems

---

2. Connectivity problems - Get the Connectivity problems scenario response

GET https://{{host}}/edge-diagnostics/v1/connectivity-problems/requests/:requestId

---

3. Content problems - Run the Content problems scenario

POST https://{{host}}/edge-diagnostics/v1/content-problems

---

4. Content problems - Get the Content problems scenario response

GET https://{{host}}/edge-diagnostics/v1/content-problems/requests/:requestId

---

5. CURL - Request content with cURL

POST https://{{host}}/edge-diagnostics/v1/curl

---

6. ESI debugger - Get an ESI debugging report

POST https://{{host}}/edge-diagnostics/v1/esi-debugger-api/v1/debug

---

7. DIG - Get domain details with dig

POST https://{{host}}/edge-diagnostics/v1/dig

---

8. Error translator - Translate error string

POST https://{{host}}/edge-diagnostics/v1/error-translator