Adding API Keys
On the API Keys page, you can generate API keys. An API key is one of the authentication methods in the system that can be used by external information systems to interact with the system. API keys are also used by monitoring agents to authenticate with the application server.
API key attributes:
- Key name — must be unique (can be changed in the key profile, in the General tab)
- Key value — a unique character sequence automatically generated when the key is created
- Authentication mode — which attribute will be used for authentication
- Workspace access — which data workspaces the key has access to
Available actions:
- Add a key.
- When clicking the context menu icon, a list of actions for the selected item appears:
- Clicking Configure navigates to the key profile in the Privileges tab
- Delete (button is active when at least one key is selected)
- Search for the required key.
When no keys are loaded in the system, the value of a standard key is generated automatically upon creation.
The key value is displayed in full only once — at the moment of generation. If you want to view the key later, save it. After generation, it is no longer displayed in full on the page.
You must ensure the uniqueness of the API key name:
- A certificate is a file with the .crt or .cert extension
- You can update an API key certificate. To do this, upload a new certificate in the key profile. The old certificate becomes invalid
- The predefined secure API key uses the name Monitoring agent
When adding a key, select the authentication mode:
- SSL certificate
- Standard
- Active Directory
- Standard Windows
When selecting SSL certificate, you can:
- Specify the API key name
- Upload a certificate (a self-signed certificate can be used)
- Delete the uploaded file
In the profile of an API key with SSL certificate authentication, its fingerprint is displayed.
When selecting Standard, you can specify the API key name.
Next, in the API key privileges, set the required access operations for the API key. For more information about privileges in the system, see the Role-based Model section.
In the Workspaces tab for the API key, configure view or edit access to workspaces. To grant access, click the + Access button, select the required workspaces, and click Save.
In the General tab, you can change the key name and view its authentication mode.
On the external system side, you must configure the HTTPS connection, certificate store, and client certificates. After that, you can send GraphQL queries to the system. To enable connection, client authorization must be configured in the system.
Was the article helpful?