API Keys
Overview
API keys are unique to your organization. An API key is used by our logging integration methods as a unique identifier to route log data to your account. Using an API key alongside a Service name and Service namespace in your logging configurations, alows us to route log data to the correct service.
Manage Api Keys
Navigate to the the Settings > API Keys item from the application sidebar to manage your API Keys.
Create a new API key
- Select Create a new API Key
- Choose a name for this key
- Select a Role (Ingestion Role, Search Role or Admin Role)
- Select Create Key to be presented with the new api key. Please copy this to a safe location as it will not appear again
API Key Roles
Bronto allows users to specificy roles in order to limit what resources an api key can access. We currently provide the following roles:
| Role Name | Description | Required for following features |
|---|---|---|
| Admin | Access to all read write permissions on an account | Creating API Keys |
| Search | Read permissions for an accounts data | Interacting with Rest API |
| Ingestion | Used for writing and sending data to a service in your account | Log ingestion |
Edit API Keys
- Within the API Key page, hover over a key you wish to edit, click pencil icon that appears on the right side
- Here you can edit the roles assocaited with the key and the key name
- Under Permissions we list the various part of the product this given key can interact with
Deleting API Keys
- Within the API Key page hover over a key you wish to permenantly delete
- Select the trash icon to delete
- Note: Deleting a key will permanently impact any services currently using it and revoke any access where it is being used