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 these API services and set the access level to READ-WRITE:

    • Sandbox API
    • Property Manager (PAPI)


If the property contains the EdgeWorker logic, then the Sandbox user must have at least read-only access to Edge Worker granted.

  • Download and configure the Sandbox Client, a proxy server that routes bidirectional requests between your development machine and the Akamai network via a secure gateway.

The code examples in this API reference don't contain the required authentication code syntax you need to make API calls. For examples you can copy and paste, check out Recipes. To learn how to apply authentication in a variety of programming languages when using Akamai APIs, see 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!