Managing an API Key
In the portal, API keys are managed through the API key dashboard.
To get there:
- Select the Hubs tab from the main, left-hand navigation.
- Select the API Keys section from the Hubs sub-navigation.
Creating an API Key
Use the Create button on the API key dashboard to open the API key create wizard.
| Field | Description |
|---|---|
| Name | A human readable name for the API key. |
| IP Restrictions | A list of IPs this API key can be used from. Default is that the API key can be used from any IP address. |
| Role | A role for the API key. This is how the key's permissions and capabilities are garnered. |
Key Obfuscation
Keys will only be shown once and then obfuscated. Copy the key to a secure place. If lost, recreate a new key.
Managing an API Key
Most resources have a settings page where users can make changes, but given the limited amount of information to display directly on the API key dashboard, the update form is listed directly on the dashboard.
Here, users can change the name, IP restrictions, or role for the API key.
To delete the key, use the delete form and submit.