What’s an API Key?

Alveo permits access to its Collections directly by programs which use Alveo's HTTP web API. (See HTTP API Reference for details of the operation of this API.)

However, programs must also have authority to use an Alveo account in order to access Alveo data. They must present an API Key to Alveo to demonstrate this authority. This key is a sequence of apparently meaningless characters which acts like a combined User Name and Password for an Alveo account.

On creation your Alveo account does not have an API Key, but every account can generate and view their API Key.

To generate an API key for your account...
  • Click on your email address at the top right of the main screen to show the Administration options menu.
  • Move the mouse over API Key in the menu which is displayed. The API Key sub-menu is displayed.
  • Click on Regenerate API Key in this sub-menu. A unique API Key will be stored for your account.
To view your account's API key...
  • Click on your email address at the top right of the main screen to show the Administration options menu.
  • Move the mouse over API Key in the menu. Your account's API Key is displayed at the top of the sub-menu in grey, as shown below.

APIKey

When you access Galaxy from the Alveo menus, this string of characters is automatically passed to Galaxy so that it can use it to access Alveo for your data requests. To use EMU/R you need to load this API Key into the R environment. See Using Alveo Data with EMU/R for more information. This API Key can also be used by other programs which require Alveo access. Use the Copy to Clipboard sub-menu item to allow pasting into other applications, or the Download API Key sub-menu item to download a small file (named alveo.config) which can be used by other tools (for example, Java, R or Python tools) to access your Alveo data.

If you believe your API Key has been compromised, generate a new one using the Regenerate API Key sub-menu item. The old API Key will be disabled and the new one will now be used for Galaxy access. You will also need to update the API Key value in any programs or scripts which use your old one.

If you do not want to have an API Key, select Delete API Key from the sub-menu. Your API Key will be deleted and not re-generated, so no API Key will be available for your Alveo account. You will not be able to use Galaxy / Alveo nor import data to EMU/R until you generate a new API Key.