Once enabled, a logged-in user can retrieve an API key via username > External Tool Access:
Click Generate API Key to create a key.
The API key is a long, randomly generated token that provides an alternative authentication credential for use with APIs; it has the prefix "apikey|".
Click Copy to Clipboard to grab it. The button will read Copied! when the copy has completed. Then click Done.
You can then use this key in a .netrc file or via clients that authenticate using Basic authentication. All access to the system will be subject to your authorization and logged with your user information.
To avoid embedding credentials into your code, you can use the API key as a password within a .netrc file. When doing so, the username is "apikey" (instead of your email address) and the password is the entire API key including the prefix. This is the recommended method of using an API key; it is compatible with all LabKey client libraries.
machine localhost
login apikey
password apikey|the_rest_of_the_long_api_key_copied
Any API use via a LabKey client library will be able to access the server with your permissions, until the key expires or is terminated by an administrator.
A site administrator can manage API keys generated on the server using the APIKey query. Link to it from the top of the username > External Tool Settings page.
You will see the keys that have been generated on this server, listed by username and displaying the time of creation as well as expiration (where applicable). Note that session keys are not listed here, and there is no ability for a non-admin user to see or delete their own keys.
To revoke an API Key, such as in a case where it has been compromised or shared, select the row and click (Delete). To revoke all API keys, select all rows and delete.
| previousnext |
| expand allcollapse all |
