The ESI Debugger API

ESI Debugger API helps you troubleshoot, review, and debug your Edge Side Includes (ESI) code. By providing a URL to your website or to your test server, you can generate a comprehensive debugging report. You can receive information about any ESI syntax errors, evaluation messages to check whether the site is working properly, and all environment variables used for your test. Also, it provides features that let you emulate user geographical data and client-browser conditions.

ESI is an XML-based markup language that provides a way to assemble resources in HTTP clients. ESI leverages client tools such as caches to improve end-user performance, reduce processing overhead on the origin server, and enhance availability. It allows for dynamic content assembly at the edge of the network, whether it is in a content delivery network, end-user’s browser, or a reverse proxy right next to the origin server.

Who Should Use This API

Use this API as part of an automated system to debug, test, and view websites containing ESI code. You can use it to debug production websites or test origin sites. For testing purposes, you can set up a test origin server to debug websites before deployment or modification. This API also lets you specify client request headers to emulate browsers and client IP addresses to emulate content targeting EdgeScape GEO data.

Getting Started

  • Review Get started on tools that Akamai provides for all its APIs.

  • Review Authorize your client to create your API access credentials and authorizations. As detailed in the API identity model section, you then access the API using custom hostnames that looks like this: https://akzz-XXXXXXXXXXXXXXXX-XXXXXXXXXXXXXXXX.luna.akamaiapis.net.

  • Review the Authorize your client section to make sure the identity under which you provision the API can access its full range of functionality. Use the Identity Management application to expand access if necessary, or the Identity Management API as a programmatic alternative.

  • To diagnose many common problems Akamai customers experience when delivering content to their end users, see also The Diagnostic Tools API.


Last modified: 6/15/2018