Creating A New Key
The API access is based around the concept of username and API key combinations. There are 2 ways to create a new API key.
- In the API using the create key method, see Create Key article
- In the User Interface (see Managing Your Keys section below)
Using Your Key
Once generated, a key will allow access to the API indefinitely until the user either deletes the key or marks it as 'inactive'.
Once a key has been generated, all other routes will be accessible. These will take the standard basic authentication header of email/key combination.
You do not need to create a new key for each new request.
Managing Your Keys
Your keys can be managed from the Equinox UI.
- Head to the System menu using the link in the top bar.
- Click User Details
- Scroll down to the API Keys section.
Add A New Key
In the header of the API Keys section you will find a form to create a new API Key.
Retrieve An API Key
In the API Keys section, click the Show Key button to temporarily show your API Key.
Activate/Deactivate A Key
In the API Keys section, click the green/red button to activate/deactivate a key.