API

Managing API Keys

The API Keys management page provides a centralized view of all your API keys, their assigned endpoints, and usage statistics. This makes it easy to understand which keys have access to which resources and track how your API is being used.

Accessing the API Keys Page

To view and manage API keys:

  1. Navigate to Project ? API Keys
  2. You must have the ManageAPIKeys permission to access this page

Only users with the appropriate permissions can view and manage API keys. If you don't have access, contact your project administrator.

Viewing Your API Keys

The API Keys page displays all API keys in your project in a table format with the following information:

Key Information Columns

ColumnDescription
PurposeThe descriptive name you gave the key when creating it (e.g., "Production Access", "Partner Integration")
API KeyThe key prefix followed by *** for security (e.g., abc123xyz-***)
Last calledWhen the key was last used, shown as relative time (e.g., "2 hours ago", "yesterday")
┌─────────────────────────────────────────────────────────────┐
│ Project │ API Keys                                          │
├─────────────────────────────────────────────────────────────┤
│ [Search API Keys...]                    [Create]            │
├─────────────────────────────────────────────────────────────┤
│ Purpose        │ API Key        │ Last called               │
├─────────────────────────────────────────────────────────────┤
│ Production     │ abc123xyz-***  │ 2 hours ago               │
│ Backup Access  │ def456uvw-***  │ 3 days ago                │
│ Partner Acme   │ ghi789rst-***  │ yesterday                 │
└─────────────────────────────────────────────────────────────┘

Searching API Keys

Use the search box at the top of the page to filter keys by:

  • Purpose: Search for keys by their descriptive name
  • Key prefix: Search by the visible portion of the key

This makes it easy to find specific keys in projects with many API keys.

Viewing Endpoint Assignments

Each API key can be expanded to see which endpoints it has access to. This gives you a complete view of what each key can do.

Expanding a Key Row

  1. Click the expand icon (?) on the left side of any API key row
  2. The row expands to show all endpoints assigned to that key
  3. Click again to collapse the view
┌─────────────────────────────────────────────────────────────┐
│ Purpose        │ API Key        │ Last called               │
├─────────────────────────────────────────────────────────────┤
│ Production     │ abc123xyz-***  │ 2 hours ago               │
│   • GET  /api/org/proj/model/1/dataset/42  [Copy]           │
│     # calls: 1523                                           │
│   • POST /api/org/proj/model/1/pipeline/5  [Copy]           │
│     # calls: 84                                             │
├─────────────────────────────────────────────────────────────┤
│ Backup Access  │ def456uvw-***  │ 3 days ago                │
└─────────────────────────────────────────────────────────────┘

Endpoint Details

When you expand a key, you'll see detailed information about each endpoint:

HTTP Method Tag

Each endpoint shows its HTTP method:

  • GET - For dataset endpoints (retrieving data)
  • POST - For pipeline endpoints (triggering actions)

The method is displayed in a colored tag for quick identification.

Endpoint URI

The full endpoint URL path is shown in a monospace font, making it easy to read and identify:

/api/org/proj/model/1/dataset/42

This is the path portion of the full URL (excluding your server domain).

Copy Endpoint URI

Each endpoint has a copy button (??) that allows you to:

  1. Click the copy icon next to any endpoint URI
  2. The full endpoint path is copied to your clipboard
  3. Paste it into your API clients, documentation, or integration code

This saves time when setting up API integrations?no need to manually type or construct URLs.

Call Count

Each endpoint displays the number of times it has been called:

  • Shows # calls: 1523 for example
  • Helps you understand which endpoints are most actively used
  • Useful for monitoring API usage and identifying popular endpoints

Managing Endpoints from the API Keys Page

From the expanded endpoint view, you can:

  • Copy the endpoint URI - Click the copy icon to get the endpoint path
  • Delete the endpoint - Click the delete icon (???) to remove the endpoint
    • A confirmation dialog will appear to prevent accidental deletion
    • Deleting an endpoint removes access for all keys assigned to it

Understanding Usage Information

Last Called Timestamp

The "Last called" column shows when each API key was last used:

  • Recent activity: "2 hours ago", "5 minutes ago"
  • Older activity: "yesterday", "3 days ago", "2 weeks ago"
  • Never used: If a key was created but never used, it may show the creation date

This helps you:

  • Identify active keys: Keys that are being used regularly
  • Find unused keys: Keys that may be ready for cleanup or deletion
  • Track key rotation: See when new keys start being used

Call Counts

The call count for each endpoint helps you understand:

  • Traffic patterns: Which endpoints receive the most requests
  • Key usage: How actively each key is being used
  • Resource planning: Which datasets or pipelines are accessed most frequently

Working with Multiple Endpoints

A single API key can be assigned to multiple endpoints. When you expand a key, you'll see all endpoints it can access:

Expanded Key View:
•  GET  /api/org/proj/model/1/dataset/42    # calls: 1523
•  GET  /api/org/proj/model/1/dataset/87    # calls: 342
•  POST /api/org/proj/model/1/pipeline/5    # calls: 84
•  POST /api/org/proj/model/1/pipeline/12   # calls: 23

This gives you a complete picture of what each key can do across your entire project.

Common Tasks

Finding Which Keys Access an Endpoint

To see which keys can access a specific endpoint:

  1. Open the API Keys page
  2. Expand each key to view its endpoints
  3. Look for the endpoint URI you're interested in
  4. All keys showing that endpoint have access to it

Alternatively, you can search by the endpoint path if you know it.

Identifying Unused Keys

To find keys that aren't being used:

  1. Sort or scan the "Last called" column
  2. Look for keys with very old timestamps
  3. Expand them to see if they have any assigned endpoints
  4. Consider deleting unused keys to reduce security surface area

Monitoring Active Endpoints

To see which endpoints are most popular:

  1. Expand keys with recent "Last called" timestamps
  2. Look at the call counts for each endpoint
  3. Endpoints with high call counts are your most active resources

Best Practices

Regular Review

  • Weekly or monthly reviews: Check the API Keys page regularly to monitor usage
  • Clean up unused keys: Remove keys that haven't been used in a while
  • Review endpoint assignments: Ensure keys only have access to endpoints they need

Organization

  • Use descriptive purposes: Give keys clear, descriptive purposes (e.g., "Production Dataset Access - Q1 2025")
  • Group related endpoints: Assign related endpoints to the same key for easier management
  • Document assignments: Keep track of which keys are used for which integrations

Security

  • Monitor call counts: Unusual spikes in call counts may indicate unauthorized access
  • Review endpoint access: Regularly check which endpoints each key can access
  • Remove unnecessary access: Revoke endpoint access for keys that no longer need it

API Endpoint Assignment

Previous Page

Access Control

Next Page

On this page