Managing Your Project's API Key

Managing Your Project's API Key

 

The API tab in Project Settings is where admins view, copy, and rotate the project's API key. The key lets external systems connect to your project's data through the Eyrus API.

Who can use it: Users with the Full access or Project admin role.

Please note: Treat your API key like a password. Anyone who has it can read this project's data through the Eyrus API. Only share it with people and systems that need it.

 

Where to find it

  1. From the main menu, select Settings.
  2. Select API in the left-hand menu.
api image.png

 

View and copy the key

  • The key is masked by default.
  • Select the eye icon to reveal it.
  • Select the copy icon to copy it to your clipboard.

Below the key, you'll see when it was last updated and by whom.

 

Generate a key

If your project doesn't have an API key yet, select Generate key to create one.

generate snip.png

 

Rotate the key

Rotate the key if you think it's been shared with someone who shouldn't have it, or when your security policy calls for it.

  1. Select Rotate key.
  2. Type ROTATE to confirm.
  3. Copy the new key and update it in every system that connects to Eyrus.

Important: The old key stops working right away. Any integration still using it will lose access until you update it with the new key. Coordinate with your IT team or integration partner before rotating.

rotate key.png

 

API documentation

The API tab also links to the Eyrus API documentation, with endpoints, authentication, and request examples. Select View API docs, or copy the documentation URL: https://data.eyrus.com

Related articles: Eyrus API Access 

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