An API Key allows you to securely connect external tools and services to your LIGR Live Organisation for programmatic access to your data.
Before You Start
Before generating an API Key, make sure:
• You are logged in to LIGR Live with an account that has the correct permissions (typically Owner or Admin)
• You know which external tool or service you intend to connect
Accessing the API Section
Your API Key is managed from within your Profile area.
1. Log in to LIGR Live.
2. Click your profile icon in the top corner of the screen.
3. Select Profile from the dropdown menu.
4. Navigate to the Permissions and API section.
[ Image placeholder: Profile dropdown menu showing the Profile option ]
Generating Your API Key
Once you are in the Permissions and API section, you can create a new key.
1. Locate the API area within the page.
2. Click Generate API Key.
3. Your new API Key will be displayed on screen.
4. Copy the key immediately and store it in a secure location.
[ Image placeholder: Permissions and API page showing the Generate API Key button and the generated key field ]
Important
Your API Key will only be fully visible at the time of generation. If you lose it, you will need to generate a new one.
Using Your API Key
Once generated, your API Key can be used to authenticate requests from external systems to LIGR Live. Paste the key into the configuration settings of the tool you are integrating.
Revoking or Regenerating an API Key
If your key is ever compromised, or if you no longer need it, you should remove it immediately.
1. Return to the Permissions and API section of your Profile.
2. Locate the existing API Key.
3. Click the option to revoke or regenerate the key.
4. If regenerating, update any connected tools with the new key so they continue to work.
[ Image placeholder: API Key management area showing revoke and regenerate options ]
Tips
• Treat your API Key like a password — never share it publicly or commit it to code repositories.
• Regenerate your key periodically as a security best practice.
• Use a password manager or secrets vault to store your key safely.
• Keep a record of which tools and services are using your key so you can update them if you regenerate it.
Common Issues
• Cannot see the Generate API Key button: Your user role may not have permission to manage API access. Contact the Owner or an Admin of your Organisation.
• Lost the API Key after generating: For security reasons, the key cannot be retrieved after the initial display. Generate a new key and update your connected tools.
• External tool is not authenticating: Check that the key has been copied in full with no extra spaces, and that it has not been revoked.
• Integration stopped working suddenly: Your API Key may have been regenerated or revoked. Generate a new key and update the integration.