API
TrainingSupportCommunity

Get started

To configure this API for the first time:

  • Review Add EdgeKV to your contract to confirm that you have entitlements for both EdgeWorkers and EdgeKV products on contract. In Akamai Control Center, use the services menu and find Account Admin > Contracts. Click into a Contract ID and make sure the entries for both EdgeWorkers and EdgeKV are present.

  • Review Manage access to EdgeKV for instructions on assigning roles to create and manage access to EdgeKV in Control Center​. You need different permissions to access API functions.

  • Before you can use the management API or CLI, you need to Create authentication credentials.

  • To enable this API, select the API service named EdgeKV, and choose READ-WRITE as the access level.

  • Refer to the steps in the Create an EdgeKV-enabled EdgeWorkers function to learn how to enhance your EdgeWorkers code with a key-value database.

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 developer community. You can also contact your ​Akamai​ account representative for support. We want to hear from you!

Import the Edge Compute API Postman collection

You can import the API Postman collection with the click of a button.

Postman offers a user-friendly UI that allows you to make API calls and set up automated workflows. Postman has the Akamai EdgeGrid authentication method built in, so you can easily authenticate and start using the EdgeCompute API Postman collection.

For complete information about the supported API client tools refer to the Get Started with APIs documentation.

  1. If you have not already installed Postman, visit the Postman website and install the applicable version for your system.

  2. Click the Run in Postman button below to open Postman and import the EdgeCompute API Postman collection.

Run in Postman

  1. You can then make APIs call using the EdgeKV Postman collection.

👍

For instructions on how to apply authentication and make API calls with Postman refer to the Akamai Developer Tools documentation.