Manage API keys

1 min read

API keys allow secure access and data exchange to Lime APIs. This feature is only available to administrators.

Create an API key

1. Access the Configuration tab via the main navigation. 2. Go to the API access section. 3. Click on the Create button. 4. Enter a name for your key. This name should represent the distinct use you will make of the key. For added security, we recommend creating a key for each use (system) so that the key can be revoked if necessary without affecting other uses (systems). 5. Enter an expiration date, if necessary. After this date, access to the API via this key will be automatically revoked. 6. Choose the scopes for the key. These will allow the key to access certain parts of the Lime API (data, system, services, etc.) 7. Click the Create button. 8. Copy and store your key in a safe place.

⚠️
Copy the key and keep it safe, as it will no longer be available after this step.

Revoke an API key

⚠️
Revoking a key will permanently delete all its accesses. This action is irreversible.

1. Access the Configuration tab via the main navigation. 2. Go to the API section. 3. Navigate to the key to be revoked. 4. Click on the three-dot menu. 5. Click on Revoke. 6. Confirm the revocation of the key.

Related articles
Did this answer your question?