API Keys

API access key management

bg-dots
bg-dots

The System → API Keys section is used to create and manage API access keys. A persistent key is created with administrator rights and does not require sending an account login and password to obtain the key.

Key list

Contains the table of created API keys.

  • “Add” – opens the dialog to create a key.

  • “ID” – key identifier.

  • “Key title” – key name.

  • “Created” – creation date and time.

  • “Security settings” – key restriction parameters.

Add key

Opened by the “Add” button. The “Create a new API key” dialog contains parameters of the new key.

  • “Key title” – name of the API key.
  • “IP Whitelist” – restricts access by client IP addresses; the whitelist is enabled automatically when entries are added.
  • “Add” (in the whitelist block) – adds an IP address to the list.
  • “Cancel” – returns to the list without saving.
  • “Save” – creates the key.
Oauth 2.0 Security policies