You can create one key or multiple keys inside a collection by assigning them custom or automatically generated unique values and specifying other classificatory information if required. API keys serve as unique identifiers that enable edge servers to authenticate, track, and manage API consumers.
- In API Keys and Traffic Management, from the key collections list, select the collection where you want to create keys.
In the collection panel, on the
Keys tab, click
The Create key(s) window opens.
Follow one of these steps:
If... Then... If you want to enter key values manually, follow these steps:
- From the drop-down menu, select Enter value(s) manually.
- In the Key value field,
enter comma separated unique values for the keys that you create.Note: Based on the number of unique values you enter, the system automatically calculates the number of keys to create.
If you want the system to generate key values, follow these steps:
- From the drop-down menu, select Generate values.
- In the Number of keys field, enter the number of keys that you want to generate.
In the Key label field, enter a
meaningful label for API Gateway reporting.
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.
To make key labels incremental, set the
switch to Yes.
Note: The label’s increment starts with an underscore character followed by a numerical value based on the number of keys that you enter. For example, if you choose to generate 8 keys, the increments range from “_0” to “_7”. If you choose to generate 125 keys, the increments range from “_000” to “_124”.
- Optional: In the Description text box, enter additional information related to the keys you create.
In the Tags field, enter or select
the tags that you want to associate with the keys.
The maximum number of tags that you can add is 10. Tags are additional key categories that let you filter keys in a collection.
The new keys appear in the collection.