Skip to main content
All requests to the ProxyJam API are authenticated with an API key. Pass the key in the X-API-Key header:

​
Getting your API key

You can generate and manage API keys in your personal account.
The raw key value is shown only once when you create it. Copy it immediately and store it securely.

​
Using your API key

Include the header in every request:

​
Supported endpoints

API keys work on all product endpoints: The following endpoints do not accept API keys and require direct user authentication:
  • /users/* — account and authentication management
  • /auth/* — OAuth flows
  • /payments/* — payment intents and providers
  • /notifications/* — notification preferences

​
Managing keys

  • GET /api-keys — list your keys (prefix and metadata only, not the raw value)
  • DELETE /api-keys/{key_id} — revoke a key (cannot be undone)
Treat your API key like a password. Do not expose it in client-side code, public repositories, or logs.