Get started

To configure this API for the first time:

  • You need different permissions to access API functions. You can manage these permissions in ​Control Center​. Learn more about the access control model.

  • Before you can use this API, you need to Create authentication credentials.

  • To enable this API, choose the API service named Edge Diagnostics, and set the access level to READ-WRITE.


    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. Make sure the identity under which you deploy the API has access to all the features for which you want diagnostic data.

The code examples shown in this API documentation are for reference but do not contain the required authentication code syntax you need to make API calls. For code samples you can copy and paste, check out the Recipes. To learn how to apply authentication in a variety of programming languages when using ​Akamai​ APIs, refer to Authenticate with EdgeGrid.


Provide feedback or ask a question in the Akamai Developer Discussion Forum. You can also contact your ​Akamai​ account representative for support. We want to hear from you!