Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.userpilot.com/llms.txt

Use this file to discover all available pages before exploring further.

Userpilot APIs use API tokens to authenticate requests. You can view and manage your API key in the Environment Page of your Userpilot dashboard.

ā€‹
How to Use Your API Key

Include your API key in the Authorization header of every API request: 
-H 'Authorization: Token {{API_KEY}}'
Your API key carries many privileges. Keep it secure and do not share it in publicly accessible areas.

ā€‹
Where to Find Your API Key

  1. Log in to your Userpilot dashboard.
  2. Go to the Environment Page.
  3. Copy your API key from the API Key section.
All API requests must be made over HTTPS.

ā€‹
Security Best Practices

  • Never expose your API key in client-side code or public repositories.
  • Rotate your API keys regularly.
  • If you suspect your API key has been compromised, regenerate it immediately from the dashboard.