API Keys
In order to access the API, you must generate an API key in the Arkis App settings and include it in the Authorization header of every request. The sections below walk through the process and provide relevant development documentation.
Create a new API key
Go to API Key Management page.
Click Create API Key button in the top right corner.
Enter a token name, select an expiration date from the predefined options or specify a custom date, and choose the desired permissions.
Click Create API Key to proceed.
Visual walkthrough
Go to API Key Management page.
Click on Create API Key button in the top right corner.
Enter a token name, select an expiration date from the predefined options or specify a custom date, and choose the desired permissions.
The token is displayed only once. Make sure to copy it immediately and store it securely. Do not save the token in plain text files. If the token is lost or compromised, it must be manually revoked: Revoke an API key.
Revoke an API key
Only Organization Admins can revoke an API key
Go to API Key Management page.
Locate the key by its name or tail (the last six characters of the key).
Click Revoke.
Visual walkthrough
Go to "API Key Management" page.
Locate the key by its name or tail (the last six characters of the key).
Click "Revoke".
Last updated