Skip to main content

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​

Step 1: Open AI Studio​

  1. Log in to Bridge as a tenant user.
  2. In the left sidebar, click AI Studio. This opens AI Studio in a new tab.

Models sidebar — Open in Playground

Step 2: Navigate to Settings​

  1. In the AI Studio tab, click Settings in the sidebar.

navigate to settings tabs

Step 3: Add an API Key​

  1. Click Add API Key.
  2. Enter a Name for the key and set Type to JupyterLab.
  3. Click Create Key to generate the key.
  4. Copy the key immediately — it is only shown once. Store it securely.

AI Studio Models page with Add API Key button

Api key copy

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.

Revoke Api Key

Api key copy

Last updated on