Manage API Keys

JupyterHub uses API keys to authenticate programmatic access to your notebook server — for example, when connecting from scripts, extensions, or external tools. This page explains how to create and revoke API keys.

Create an API Key

1. Go to Settings and Click on "Add API Key".
2. Provide a name for the API key.
3. Select type as JupyterLab and click on "Create Key".
4. Once the key is created, it is displayed on the screen.

Copy your API Key now

Make sure to copy and save the API key at a safe place. You will not be able to view it again after closing.

Use an API Key

Pass the API key as a token in the Authorization header of API requests to your JupyterHub server:

curl -X GET https://jupyter.armada.ai/hub/api/users \
  -H "Authorization: token <your-api-key>"

You can also configure Jupyter client libraries and extensions to use the key for programmatic notebook access.

Revoke an API Key

1. Go to Settings. Here you will see all the api keys.
2. To revoke an api key, just click on the bin icon and then click on the "Revoke API Key" button to confirm.

The key is immediately invalidated and can no longer be used.