The Key and Quota Management API

The Key and Quota Management API together with the API Endpoints API allow you to deploy your APIs over the Akamai network. The Key and Quota Management API lets you create and manage API keys that serve as unique identifiers for API consumers. API keys exist inside higher-level units called key collections. At the key collection level, you can set a quota limit for the number of successful requests that individual API keys can make and you can edit access control lists (ACLs) associated with your API endpoints and resources.

Who Should Use This API

You can use this API if you need to programmatically create and manage API keys on the Akamai platform, and generate reports with data related to quota usage. The Key and Quota Management API lets you group keys into manageable collections. Inside a collection, you can perform the following operations on keys:

  • Create or generate keys

  • Import keys

  • Edit information about keys

  • Revoke and restore keys

  • Move keys to another collection

  • Filter and sort keys according to various criteria

The Key and Quota Management API allows you to configure the following two additional global options that control access and usage of your API by API consumers who identify with keys from a particular collection:

  • User quota settings determine the maximum number of requests that API consumers can send to your API within a specific time period. When the quota limit is reached, Akamai edge servers stop forwarding requests to your origin server. The traffic returns to normal after the quota reset. Using this API, you can generate two quota reports that help you learn about the quota usage in your key collections.

  • Access control lists (ACLs) provide information about endpoints and resources accessible to API consumers.

Getting Started

Before using this API for the first time:

  • Review the closely related API Endpoints API, in particular, the Endpoint object.

  • 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:

  • 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.

Last modified: 5/22/2018