Manage your API keys
API keys allow you to use Lynqa services from external applications and integrations, such as Xray or Xqual.
Each API key is linked to an organization. When a new key is created, it is automatically associated with the organization currently selected in My Lynqa.
Important: before creating an API key, make sure the selected organization is the one for which you want to authorize API calls.
Create an API key
A user can create as many API keys as needed.
To create a new key:
Go to the API management page.
Make sure the desired organization is selected.
Enter a descriptive name in the Key name field.
Click Create.
The API key is then generated and displayed only once.
Important: store this key in a safe place. For security reasons, its value cannot be viewed again after the creation window is closed.
Rename an API key
You can change the name of one of your API keys at any time to better identify its purpose (for example: Xray Production, CI/CD, or Local tests).
Renaming has no impact on the key value or on the integrations that use it.
Revoke an API key
An API key can be revoked at any time when it is no longer used or if you think it has been compromised.
Revocation is final: the key becomes invalid immediately and the applications that use it will no longer be able to authenticate with Lynqa.
If necessary, create a new key before revoking the old one to avoid any service interruption.
Key management by administrators
Each user can manage their own API keys: create, rename, and revoke them.
Organization administrators have additional rights that allow them to view and manage the API keys of all members of that organization. In particular, they can revoke a key that has become unnecessary or compromised, even if they are not its owner.