The System → API keys section creates and manages permanent API access keys with administrator rights. Keys are used to integrate external systems and scripts with the API without interactive sign-in to the web interface.
Keys list
Lists created API keys. When there are no keys, the table is empty (headers only). After creation, rows with key parameters appear in the table.
- “Add” – opens the “Create a new API key” dialog.
- “ID” – system key identifier.
- “Key title” – name set at creation; used to find the key in the list.
- “Created” – key creation date and time.
- “Security settings” – key restriction details (including the IP whitelist, if configured).
Create a new API key
Opened with “Add”. The dialog title is “Create a new API key”.
- “Key title” – required name of the API key; shown in the “Key title” column of the list.
- “IP Whitelist” – restricts key use to client addresses from the list. Whitelisting by client IP is enabled automatically when at least one entry is added; with no entries, IP restriction is not applied.
- “Add” (in the whitelist block) – adds an IP address or range to the allowed clients list.
- “Cancel” – closes the dialog without creating a key.
- “Save” – creates the key and closes the dialog.
Creating a key
Step 1. Open System → API keys.
Step 2. Click “Add”.
Step 3. Enter “Key title”.
Step 4. To restrict access by IP if needed: in “IP Whitelist”, click “Add” and specify client addresses.
Step 5. Click “Save”. The key appears in the list. To discard creation, use “Cancel”.