logo
search
Back to Pixie
COLLAPSE ALL
  • Home
  • About Pixie
    • Pixie Overview
    • Data Sources
    • How Pixie uses eBPF
    • Roadmap
    • FAQ
    • Troubleshooting
  • Installing Pixie
    • Requirements
  • Using Pixie
    • Using the Live UI
    • Using the CLI
    • Using the API
  • Tutorials
  • Reference
    • Admin
      • Authentication
      • Debug Info
      • Deploy Options
      • Environment-Specific Configurations
      • Find a Cluster ID
      • Managing API Keys
      • Managing Deploy Keys
      • Tuning Memory Usage
      • Uninstalling Pixie
      • Updating Pixie
      • User Management & Sharing
      • Verifying Images
    • Architecture
WebsiteSlack Us

Managing API Keys

API keys are used to authenticate custom applications that use the Pixie API to query data from the Pixie Platform.

Pixie API keys are opaque and start with the px-api- prefix. A single API key can be used by multiple applications.

Create an API Key

You can create an API key using either the CLI or Live UI.

Using the CLI

In the terminal, run

px api-key create

Copy the output value labeled Key:

CLI output for `px api-key create` command.

Using the Live UI

To create an API key using the Live UI:

  1. Select your profile picture in the top right corner.
  2. Select "Admin" from menu.
  3. Select the "API Keys" tab along the top of the Admin page.
  4. Select the "+ New Key" button in the top right corner. A new key will be added to the table below.
  5. From the "Actions" column of the table below, select the "..." button, then "Copy Value."
API Key interface in the Live UI Admin page.
This site uses cookies to provide you with a better user experience. By using Pixie, you consent to our use of cookies.