products:cockpit:1.0:userguide:settings:agents:api_keys
Table of Contents
API Keys
API keys are used by collectors to authenticate against the Cockpit when establishing their connection. Each collector must present a valid API key in its configuration to be accepted by the Cockpit.
Managing API keys
- Use the Create button to generate a new API key (name required, description optional).
- The key value is displayed only once at creation time — use the copy icon on the row to save it to your clipboard before closing the modal.
- Keys can be deleted individually using the row action button, or in bulk using the selection checkboxes and the Delete selection button.
Table columns
| Column | Description |
|---|---|
| Name | Label identifying the API key |
| Description | Optional free-text description |
| Key | Masked key value. Use the copy icon to copy it to the clipboard |
| Updated date | Date and time of the last modification |
| Created by | Username of the user who created the key |
Notes
- A key cannot be retrieved after its creation — if lost, delete it and create a new one.
- Deleting a key immediately invalidates any collector using it. The affected collector will go OFFLINE until reconfigured with a valid key.
products/cockpit/1.0/userguide/settings/agents/api_keys.txt · Last modified: by sfidan