Skip to main content
Sign in

Authentication

All Revision API requests require authentication using an API key with access to the workspaces.

API keys are user-specific, and grant access to workspaces with the same permissions as the user has.

  • A workspace member with the Reader role may only use GET.
  • A workspace Editor may use POST/PUT/PATCH.

Finding Your API Key​

To get an API key:

  1. Visit your Account settings from the profile dropdown in the top right
  2. Find the API Keys section
  3. Create a new key, and give it a name (e.g. "CI/CD Pipeline")
  4. Copy your newly created key

Using Your API Key​

Include your API key in requests using the Authorization header:

Authorization: Bearer your-api-key-here

Example Request​

curl -X GET \
  https://your-workspace.revision.app/api/external/components \
  -H "Authorization: Bearer your-api-key-here" \
  -H "Content-Type: application/json"

All requests must be made over HTTPS.

Revoking Your API Key​

Press the deletion button next to the API key on your account page, and confirm the action.

Revocations are instant and permanent; you'll have to create a new one should you change your mind.