Lynx clients that use the Lynx Web API can be required to provide an API key to Lynx. This helps to ensure that only authorized client systems can call the Lynx API. An API key is automatically generated when you first install Lynx. You will need to distribute this key to any client systems that need it.
It is possible to turn off the API key requirement, but this not recommended. This may be helpful in the use case where you have a client system that cannot provide an API key.
Change the API Key
If for some reason you need to change your API key, see the steps below.
If you update the API key, you must update all clients with the new key.
-
Click the Generate button. A warning message will appear at the top about updating your clients.
.png)
-
Click Save to overwrite the current key with the new one.
-
Click the Copy button.
- Note: The value should store to your Windows clipboard, assuming your browser is compatible. If not, then manually select and copy the key.
-
Paste the API key into your code (or however you deal with sending a key value in your request header).