Diagnostic Tools API

The Diagnostic Tools API offers programmatic access to a subset of Akamai’s diagnostic toolset available in Luna Control Center. With these tools you can self-diagnose and solve many common problems Akamai customers experience.

  • Locations: Returns a list of active Akamai server locations, from which you can run diagnostic tools.
  • dig: Run dig from the Akamai network to get a view of DNS information not local to you.
  • mtr: Run mtr from the Akamai network to a hostname.
  • Akamai Translator: Retrieve information about an Akamaized URL.
  • Error Translator: Translate an Akamai error code or reference number.
  • IP Geolocator: Retrieve the location details for an IP address.
  • Verify CDN IP: Verify whether or not the IP provided is on this CDN.

The Diagnostic Tools API responds to requests with standard HTTP status codes. When there’s a validation failure or when a resource fails to process your request, the API returns error messages in the HTTP Problem JSON format.

Who Should Use This API

If you want to programmatically problem-solve issues with your Akamai-enabled property, you should consider using this API.

Getting Started

  • Review the OPEN API Introduction to orient yourself with the OPEN APIs.

  • Visit the akamai-open repository to download reference EdgeGrid clients and sample code.

  • Review OPEN API Provisioning to create your access credentials and authorizations, making sure you enable read access for the Diagnostic Tools API.

  • To make API calls to Diagnostic Tools, you may need to add items to your contract. Please contact your Akamai account team for assistance.

  • Get help from the {OPEN} developer community and provide feedback. You can also contact your Akamai representative for support. We want to hear from you!

Rate Limiting

The API applies a dynamic system of rate limiting for each API endpoint based on the total number of requests allowed within a given burst. Clients may rely on contextual HTTP response headers:

  • X-RateLimit-Limit: the total number of requests allowed.
  • X-RateLimit-Remaining: how many requests remain.

For each endpoint’s limit, there is a corresponding interval at which the number of remaining requests increments by one until it once again reaches the limit. The table below shows the total number of requests allowed for each endpoint and the interval (in seconds) at which remaining requests replenish. For example, with a request limit of 90 and a replenishment interval of 960 seconds, you can send a single burst of 90 requests, but then must wait 16 minutes to make each additional request, so that the effective daily limit is 180.

Interface Endpoint Request
Limit
Replenishment
Interval
Akamai Translator /diagnostic-tools/v1/akamaitranslator 90 960
dig /diagnostic-tools/v1/dig 90 960
Error Translator /diagnostic-tools/v1/errortranslator 90 960
IP Geolocator /diagnostic-tools/v1/ipgeolocator 250 300
Locations /diagnostic-tools/v1/locations 180 480
mtr /diagnostic-tools/v1/mtr 90 960
Verify CDN IP /diagnostic-tools/v1/verifycdnip 90 960