Generate and Delete API Keys

An application programming interface key, or API key, is a code that allows an external application long-term access to the Nexus API endpoints that require API key authentication.


What you must know upfront

When creating API keys in Riffyn Nexus, you need to understand:

  • API keys are visible only once. You must save the API key in a secure place for future reference.

  • If you lose your API key, you must delete the API key and generate a new one. 

  • API keys remain valid until you revoke access. Deleting an API key invalidates the key, and any future requests using the deleted key will return an authentication error.


Generate an API key

To generate an API Key, follow these steps.

  1. To open your Security Settings, click the profile icon noun_user_avatar_363640.png in the upper right corner of the app.
  2. Go to the API Key section.
  3. Click Generate.
  4. Enter a unique Name for your API Key. Tip: Include the date and where you intend to use that key.
  5. Click Next to generate the API key.
  6. Click Copy to copy the API key.
  7. Save the API key in a secure place for future reference.
  8. Paste the API key into the script or external application that you are connecting to Riffyn Nexus.
  9. Click Next to return to Security Settings. The new API key should appear in your list of active API keys.

Rename an API Key

To rename an existing API Key, follow these steps.

  1. From your Security Settings (Profile icon > Security Settings), go to the API Key section.
  2. Hover over the API key you want to rename.
  3. Click the pencil icon
  4. Rename your API key.
  5. Click the checkmark to save your edit. 

Delete an API key

To delete an existing API Key, follow these steps.

  1. From your Security Settings (Profile icon > Security Settings), go to the API Key section.
  2. Hover over the API key you want to delete.
  3. Click the circular 'x' icon to delete the API key.

 

 

Was this article helpful?
1 out of 1 found this helpful