Skip to main content

API Keys

Overview​

API keys authenticate your applications to the RenderDoc API. Each key is scoped to your team and can have specific permissions.

Creating API Keys​

  1. Click Create API Key
  2. Enter a descriptive name (e.g., "Production Server", "Development")
  3. Select the key permissions/scopes
  4. Click Create
  5. Important: Copy and save the key immediately - it won't be shown again!

Key Security​

  • API keys are only shown once at creation
  • Store keys securely (environment variables, secret managers)
  • Never commit keys to version control
  • Rotate keys periodically for security

Using API Keys​

Include your API key in the Authorization header:

Authorization: Bearer YOUR_API_KEY

Managing Keys​

View Details​

Click on any key to see:

  • Key prefix (for identification)
  • Creation date
  • Last used date
  • Associated permissions

Delete Keys​

  • Click the delete button on any key
  • Confirm deletion
  • The key is immediately invalidated

Best Practices​

  • Use separate keys for development and production
  • Give keys descriptive names
  • Delete unused keys promptly
  • Monitor the "last used" date to identify stale keys

Quick Start Code​

The page includes ready-to-use code samples showing how to authenticate with your API key in various programming languages.