Key collections are top-level components of the API Keys and Traffic Management application. Inside key collections, you can create and manage API keys, edit access control lists for endpoints and resources, and set user quota limits.
The key collection panel consists of the following main elements:
- The Collection notes section
- The Quota settings section
- The Keys tab
- The Access control list tab
You can add or edit information about a key collection by clicking the pencil icon () next to Collection notes and entering data in the text field that appears.
In the upper part of every key collection panel, you can set a user quota limit for all keys in a collection. This limit determines the maximum numbers of successful API requests within a selected time period.
On the Keys tab, you can view and manage keys included in a collection. You can perform a variety of single and batch operations on your keys, including:
- Creating keys
- Importing keys
- Exporting keys
- Moving keys to another collection
- Editing information about keys
- Revoking keys
- Restoring revoked keys
- Resetting key quota
The table in the Keys section displays the following details about each key included in a collection:
- Key label
- A plain-language identifier that you assign to a key during the key creation process. API Gateway reports use key labels to display various data related to API usage. The more meaningful you make the label, the more easily you’ll be able to identify your keys when analyzing API Gateway reports.
- Key ID
- An Akamai-generated internal identifier used in API Gateway reports.
- Key value
- A user-defined or Akamai-generated value that clients pass in their requests for identification purposes. Edge servers verify the value and authenticate the request sender.
- Additional information about a key and its purpose.
- Additional plain-language categories by which you can filter keys in a collection.
- Quota used
- The number of requests sent by a key and the percentage of quota used in the current time period. The date when this column was last updated is in the top-right corner of the Keys section.
For your convenience, you can use different filtering, sorting, and searching options to view only specific keys that match particular criteria.
You can choose to display keys of a certain type by selecting the appropriate option in the Key type area:
- All keys in a collection.
- All keys in a collection that API consumers can use to access endpoints and resources specified in the Access control list tab.
- All keys in a collection that you revoked access for. API consumers cannot use these keys to access endpoints and resources specified in the Access control list tab. The following icon denotes a revoked key:
- All keys in a collection for which changes are being propagated in the Akamai network. This process usually takes 5-10 minutes. The following icon denotes a pending key:
You can use the Search keys bar to find keys that contain a specific set of signs as part of their ID, label, description, or tags.
You can sort keys alphabetically by their label, ID, description, or, if enabled, the remaining quota.
By default, the maximum number of keys that you can store in your collections is 1000 per one API Gateway contract. For example, if your account has two contracts, you can store 2000 keys. Child contracts may have individual limits assigned by your account representative. Otherwise, they inherit the limit from the parent contract. If you want the key limit associated with a contract to change, contact your Akamai account representative.
Access control list
On the Access control list tab, you can view all endpoints and resources associated with your current account context. You can decide which private endpoints and resources should be accessible to API consumers who identify with keys from a particular collection.