Diagnostic Tools API (Deprecated)


The Diagnostic Tools API is now deprecated. We strongly encourage you to switch to the new Edge Diagnostics API by September 30, 2022. Starting from October 1, 2022, the Diagnostic Tools API will be discontinued.

To learn more about Edge Diagnostics API, visit the Edge Diagnostics API documentation.

Once you extend your web content onto the ​Akamai​ edge network and apply various ​Akamai​ features to accelerate and manipulate content, you need to be able to troubleshoot any problems your own users may encounter. The Diagnostic Tools API allows you to diagnose many common problems ​Akamai​ customers experience when delivering content to their end users. It offers a programmatic alternative to many of the features available in ​Akamai Control Center​, under the SupportDiagnostic Tools menu.

Version 2 of the Diagnostic Tools API includes these features:

  • The new API now allows you to access data asynchronously to avoid long-running requests that often time out. See Asynchronous requests for more information.
  • It allows you to run many familiar networking tools such as dig, mtr, and curl, or get logs either from locations on the ​Akamai​ edge network, or from specific ​Akamai​ IP addresses.
  • A new error statistics feature allows you to research how edge servers communicate both with user client requests, and with your origin server.
  • You are also able to aggregate error statistics for each CP code, the main system you use to organize categories of web content.
  • This API version allows you to diagnose problems with any Global Traffic Management properties (subdomains) you administer.
  • In addition to running tests on specific edge server locations or IP addresses, you can send individual end users diagnostic links to trace what happens to their requests.
  • This API version lets you troubleshoot, review, and debug your Edge Side Includes (ESI) code. It also lets you emulate specific client-browser and geographical conditions. See ESI Debugger for more information.

See Diagnostic utilities for more information on available tools.

Use this API to implement your own problem-resolution dashboard for ​Akamai​-provisioned content, or to integrate it with other similar debugging tools. Use the end-user operations to implement interfaces to solicit feedback from your own users. In addition to helping solve any problems your end users experience, consider also leveraging these batch tools to design more proactive interfaces to monitor performance.