Authentication

Auth Tokens

Authentication tokens are passed using an auth header, and are used to authenticate as a user or organization account with the API. In our documentation, we have several placeholders that appear between curly braces or chevrons, such as {API_KEY} or <auth_token>, which you will need to replace with one of your authentication tokens in order to use the API call effectively.

For example, when the documentation says:

Copied
curl -H 'Authorization: Bearer {TOKEN}' https://sentry.io/api/0/projects/

If your authentication token is 1a2b3c, then the command should be:

Copied
curl -H 'Authorization: Bearer 1a2b3c' https://sentry.io/api/0/projects/

You can create authentication tokens within Sentry by creating an internal integration. This is also available for self-hosted Sentry.

DSN Authentication

Some API endpoints may allow DSN-based authentication. This is generally very limited and an endpoint will describe if its supported. This works similar to Bearer token authentication, but uses your DSN (Client Key).

Copied
curl -H 'Authorization: DSN {DSN}' https://sentry.io/api/0/projects/

API Keys

API keys are passed using HTTP Basic auth where the username is your api key, and the password is an empty value.

As an example, to get information about the project which your key is bound to, you might make a request like so:

Copied
curl -u {API_KEY}: https://sentry.io/api/0/projects/
Help improve this content
Our documentation is open source and available on GitHub. Your contributions are welcome, whether fixing a typo (drat!) to suggesting an update ("yeah, this would be better").