GuidesAdmin GuidesAPI Keys

API Keys Admin

API keys allow external systems to access your Nucleus data through the Partner API. Only admins can create and manage keys.

Creating an API Key

  1. Go to Settings in the sidebar.
  2. Click the API Keys tab.
  3. Click New Key.
  4. Enter a descriptive name (e.g., “Data Export”, “BI Tool Integration”).
  5. Click Create.
  6. Copy the key immediately.
⚠️

The API key is shown only once. If you lose it, you must delete the key and create a new one.

Using an API Key

Include the key in the Authorization header of your API requests:

Authorization: Bearer YOUR_API_KEY

API keys authenticate against the Partner API endpoints. They are rate-limited to 1,000 requests per hour.

Managing Keys

The API Keys table shows all active keys with their name and creation date. The key value itself is not displayed after creation.

Deleting a Key

  1. Find the key in the list.
  2. Click Delete.
  3. Confirm the deletion.

The key is revoked immediately. Any system using that key will start receiving 401 Unauthorized responses.

Best Practices

  • Create separate keys for each integration or partner so you can revoke one without affecting others.
  • Delete keys that are no longer in use.
  • Never share API keys in emails or chat. Use a secure channel.
  • Rotate keys periodically by creating a new key, updating the integration, then deleting the old key.