Skip to main content
Version: v1.7.3-7 🚧

Application API Keys

Overview​

The Application API keys page provides an overview of all API keys existing in the system. API keys enable programmatic access to Enterprise h2oGPTe.

Only administrators can view and manage API keys for all users.

Access the Application API Keys page​

  1. In Enterprise h2oGPTe, click Account Circle.
  2. Select System Dashboard.
  3. In the Configuration section, click API Keys.

API Keys

View API keys​

  1. In the API Keys section, select a user from the User dropdown.
  2. View the table of API keys for that user.

The table displays:

  • Name: The API key name
  • Secret key: The masked secret key
  • Collection: The collection the key is restricted to (if applicable)
  • Created: When the key was created
  • Status: Active or Inactive
  • Expiry Date: When the key expires (if set)
  • Inactivity Interval: How long the key can remain unused before it is automatically deactivated (if set)
  • Last Used: When the key was used last
  • Total Calls: The total number of API requests made using the key
  • Actions: Options to manage the key

API Keys table

Create an API key​

Only administrators can create API keys for users.

  1. In the API Keys section, select the user from the User dropdown.
  2. Click + New API key.
  3. Enter a key name.
  4. Optionally, restrict the key to a specific collection. The collection must be owned by the selected user. Leave it blank for a global key.
  5. Optionally, enable Allow key to expire to set an expiration date on the API key. The expiration date must not exceed the global API key expiry limit.
  6. Optionally, enable Set Inactivity Interval to automatically deactivate the API key after a period of inactivity.
  7. Click Generate new key.
  8. Copy and securely store the generated secret key.
Add API Key dialog
important

The secret key is displayed only once when the API key is created. Store it securely, as it cannot be retrieved later.

Manage API keys​

Only administrators can manage API keys. Use the Actions menu (

) for each API key to:

  • Edit expiry
  • Edit key inactivity interval
  • Deactivate the key

Select the checkbox next to the relevant API key, then click Delete to delete the selected API key.

Delete API Keys

note

To learn more about API keys, see APIs.

Feedback