Skip to content

chore(auth): Remove API key authentication #2935

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 1 commit into
base: szokeasaurusrex/proguard-chunk-upload-default
Choose a base branch
from
Open

chore(auth): Remove API key authentication #2935

wants to merge 1 commit into from
+68 −136

Conversation

@szokeasaurusrex
Copy link
Member

@szokeasaurusrex szokeasaurusrex commented Nov 11, 2025 •
edited
Loading

Description

⚠️ Breaking change: Do not merge until ready to release in a major.

Removed support for the legacy API key authentication method. Users must now use auth tokens instead.

Specifically, users supplying an API key via any of the following options need to generate and use an auth token instead:

  • --api-key CLI flag
  • SENTRY_API_KEY environment variable
  • api_key configuration file field
  • apiKey option in the JavaScript API

Issues

BREAKING CHANGE: API-key based authentication is no longer supported. The --api-key CLI flag and apiKey JS option have been removed; the SENTRY_API_KEY environment variable and api_key configuration file field are no longer read.

@linear
Copy link

linear bot commented Nov 11, 2025

CLI-199 Remove API key authentication

This was referenced Nov 11, 2025
Open
Merged
Merged
Merged
Merged
Open
Open
@szokeasaurusrex Graphite App
Copy link
Member Author

szokeasaurusrex commented Nov 11, 2025 •
edited
Loading

Warning

This pull request is not mergeable via GitHub because a downstack PR is open. Once all requirements are satisfied, merge this PR as a stack on Graphite.
Learn more

This stack of pull requests is managed by Graphite. Learn more about stacking.

szokeasaurusrex added a commit that referenced this pull request Nov 11, 2025
@szokeasaurusrex
chore(auth): Remove API key authentication (#2935)
f36d018 
### Description
⚠️ **Breaking change:** Do not merge until ready to release in a major.

Removed support for the legacy API key authentication method. Users must now use auth tokens instead.

Specifically, users supplying an API key via any of the following options need to generate and use an auth token instead:

  - `--api-key` CLI flag
  - `SENTRY_API_KEY` environment variable
  - `api_key` configuration file field
  - `apiKey` option in the JavaScript API

### Issues
- Resolves #2873
- Resolves [CLI-199](https://linear.app/getsentry/issue/CLI-199/remove-api-key-authentication)

_____

BREAKING CHANGE: API-key based authentication is no longer supported. The `--api-key` CLI flag and `apiKey` JS option have been removed; the `SENTRY_API_KEY` environment variable and `api_key` configuration file field are no longer read.
@szokeasaurusrex szokeasaurusrex force-pushed the szokeasaurusrex/remove-auth-key branch from 6a6e1d8 to f36d018 Compare November 11, 2025 10:19
@szokeasaurusrex szokeasaurusrex marked this pull request as ready for review November 11, 2025 10:20
@szokeasaurusrex szokeasaurusrex requested review from a team as code owners November 11, 2025 10:20
@szokeasaurusrex szokeasaurusrex requested review from Lms24 and removed request for a team and Lms24 November 11, 2025 10:20
@szokeasaurusrex
Copy link
Member Author

szokeasaurusrex commented Nov 11, 2025

@andreiborza would appreciate if you could just check the JS API portion. I will be raising a PR to deprecate the options in 2.x so this removal doesn't come as a surprise to anyone

@szokeasaurusrex szokeasaurusrex added the v3.0 Breaking changes to include in version 3.0.0 of Sentry CLI label Nov 11, 2025
szokeasaurusrex added a commit that referenced this pull request Nov 11, 2025
@szokeasaurusrex
chore(auth): Remove API key authentication (#2935)
d298164 
⚠️ **Breaking change:** Do not merge until ready to release in a major.

Removed support for the legacy API key authentication method. Users must now use auth tokens instead.

Specifically, users supplying an API key via any of the following options need to generate and use an auth token instead:

  - `--api-key` CLI flag
  - `SENTRY_API_KEY` environment variable
  - `api_key` configuration file field
  - `apiKey` option in the JavaScript API

- Resolves #2873
- Resolves [CLI-199](https://linear.app/getsentry/issue/CLI-199/remove-api-key-authentication)

_____

BREAKING CHANGE: API-key based authentication is no longer supported. The `--api-key` CLI flag and `apiKey` JS option have been removed; the `SENTRY_API_KEY` environment variable and `api_key` configuration file field are no longer read.
@szokeasaurusrex szokeasaurusrex force-pushed the szokeasaurusrex/remove-auth-key branch from f36d018 to d298164 Compare November 11, 2025 10:29
szokeasaurusrex added a commit that referenced this pull request Nov 11, 2025
@szokeasaurusrex
chore(auth): Remove API key authentication (#2935)
5e0f541 
### Description
⚠️ **Breaking change:** Do not merge until ready to release in a major.

Removed support for the legacy API key authentication method. Users must now use auth tokens instead.

Specifically, users supplying an API key via any of the following options need to generate and use an auth token instead:

  - `--api-key` CLI flag
  - `SENTRY_API_KEY` environment variable
  - `api_key` configuration file field
  - `apiKey` option in the JavaScript API

### Issues
- Resolves #2873
- Resolves [CLI-199](https://linear.app/getsentry/issue/CLI-199/remove-api-key-authentication)

_____

BREAKING CHANGE: API-key based authentication is no longer supported. The `--api-key` CLI flag and `apiKey` JS option have been removed; the `SENTRY_API_KEY` environment variable and `api_key` configuration file field are no longer read.
@szokeasaurusrex szokeasaurusrex force-pushed the szokeasaurusrex/remove-auth-key branch from d298164 to 5e0f541 Compare November 11, 2025 10:29
szokeasaurusrex added a commit that referenced this pull request Nov 11, 2025
@szokeasaurusrex
chore(auth): Remove API key authentication (#2935)
2b4adc9 
### Description
⚠️ **Breaking change:** Do not merge until ready to release in a major.

Removed support for the legacy API key authentication method. Users must now use auth tokens instead.

Specifically, users supplying an API key via any of the following options need to generate and use an auth token instead:

  - `--api-key` CLI flag
  - `SENTRY_API_KEY` environment variable
  - `api_key` configuration file field
  - `apiKey` option in the JavaScript API

### Issues
- Resolves #2873
- Resolves [CLI-199](https://linear.app/getsentry/issue/CLI-199/remove-api-key-authentication)

_____

BREAKING CHANGE: API-key based authentication is no longer supported. The `--api-key` CLI flag and `apiKey` JS option have been removed; the `SENTRY_API_KEY` environment variable and `api_key` configuration file field are no longer read.
@szokeasaurusrex szokeasaurusrex force-pushed the szokeasaurusrex/remove-auth-key branch from 5e0f541 to 2b4adc9 Compare November 11, 2025 11:13
andreiborza
andreiborza approved these changes Nov 11, 2025
View reviewed changes
Copy link
Member

@andreiborza andreiborza left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

JS part is fine 👍

loewenheim
loewenheim reviewed Nov 11, 2025
View reviewed changes
Copy link
Contributor

@loewenheim loewenheim left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are the test output changes in some way caused by this removal?

@szokeasaurusrex
Copy link
Member Author

szokeasaurusrex commented Nov 11, 2025

Are the test output changes in some way caused by this removal?

It appears so; I suspect these changes, which remove the previously only hidden --api-key flag from the top-level command, are to blame. I have no idea why Clap reorders some of the arguments after this change. It indeed seems weird, but from what I can tell, it is only that stuff is being moved around, and I don't see any actual changes to the content.

szokeasaurusrex added a commit that referenced this pull request Nov 11, 2025
@szokeasaurusrex
chore(auth): Remove API key authentication (#2935)
9dddf45 
⚠️ **Breaking change:** Do not merge until ready to release in a major.

Removed support for the legacy API key authentication method. Users must now use auth tokens instead.

Specifically, users supplying an API key via any of the following options need to generate and use an auth token instead:

  - `--api-key` CLI flag
  - `SENTRY_API_KEY` environment variable
  - `api_key` configuration file field
  - `apiKey` option in the JavaScript API

- Resolves #2873
- Resolves [CLI-199](https://linear.app/getsentry/issue/CLI-199/remove-api-key-authentication)

_____

BREAKING CHANGE: API-key based authentication is no longer supported. The `--api-key` CLI flag and `apiKey` JS option have been removed; the `SENTRY_API_KEY` environment variable and `api_key` configuration file field are no longer read.
@szokeasaurusrex szokeasaurusrex force-pushed the szokeasaurusrex/proguard-chunk-upload-default branch from 3739a7f to fdebdc8 Compare November 11, 2025 14:29
@szokeasaurusrex szokeasaurusrex force-pushed the szokeasaurusrex/remove-auth-key branch from 2b4adc9 to 9dddf45 Compare November 11, 2025 14:29
szokeasaurusrex added a commit that referenced this pull request Nov 11, 2025
@szokeasaurusrex
chore(auth): Remove API key authentication (#2935)
9a12665 
⚠️ **Breaking change:** Do not merge until ready to release in a major.

Removed support for the legacy API key authentication method. Users must now use auth tokens instead.

Specifically, users supplying an API key via any of the following options need to generate and use an auth token instead:

  - `--api-key` CLI flag
  - `SENTRY_API_KEY` environment variable
  - `api_key` configuration file field
  - `apiKey` option in the JavaScript API

- Resolves #2873
- Resolves [CLI-199](https://linear.app/getsentry/issue/CLI-199/remove-api-key-authentication)

_____

BREAKING CHANGE: API-key based authentication is no longer supported. The `--api-key` CLI flag and `apiKey` JS option have been removed; the `SENTRY_API_KEY` environment variable and `api_key` configuration file field are no longer read.
@szokeasaurusrex szokeasaurusrex force-pushed the szokeasaurusrex/remove-auth-key branch from 9dddf45 to 9a12665 Compare November 11, 2025 14:33
@szokeasaurusrex szokeasaurusrex force-pushed the szokeasaurusrex/proguard-chunk-upload-default branch 2 times, most recently from c4cf949 to 8f67a63 Compare November 11, 2025 14:43
szokeasaurusrex added a commit that referenced this pull request Nov 11, 2025
@szokeasaurusrex
chore(auth): Remove API key authentication (#2935)
ac20051 
⚠️ **Breaking change:** Do not merge until ready to release in a major.

Removed support for the legacy API key authentication method. Users must now use auth tokens instead.

Specifically, users supplying an API key via any of the following options need to generate and use an auth token instead:

  - `--api-key` CLI flag
  - `SENTRY_API_KEY` environment variable
  - `api_key` configuration file field
  - `apiKey` option in the JavaScript API

- Resolves #2873
- Resolves [CLI-199](https://linear.app/getsentry/issue/CLI-199/remove-api-key-authentication)

_____

BREAKING CHANGE: API-key based authentication is no longer supported. The `--api-key` CLI flag and `apiKey` JS option have been removed; the `SENTRY_API_KEY` environment variable and `api_key` configuration file field are no longer read.
@szokeasaurusrex szokeasaurusrex force-pushed the szokeasaurusrex/remove-auth-key branch from 9a12665 to ac20051 Compare November 11, 2025 14:43
This was referenced Nov 11, 2025
Open
Open
@szokeasaurusrex
chore(auth): Remove API key authentication (#2935)
c26fb76 
⚠️ **Breaking change:** Do not merge until ready to release in a major.

Removed support for the legacy API key authentication method. Users must now use auth tokens instead.

Specifically, users supplying an API key via any of the following options need to generate and use an auth token instead:

  - `--api-key` CLI flag
  - `SENTRY_API_KEY` environment variable
  - `api_key` configuration file field
  - `apiKey` option in the JavaScript API

- Resolves #2873
- Resolves [CLI-199](https://linear.app/getsentry/issue/CLI-199/remove-api-key-authentication)

_____

BREAKING CHANGE: API-key based authentication is no longer supported. The `--api-key` CLI flag and `apiKey` JS option have been removed; the `SENTRY_API_KEY` environment variable and `api_key` configuration file field are no longer read.
@szokeasaurusrex szokeasaurusrex force-pushed the szokeasaurusrex/remove-auth-key branch from ac20051 to c26fb76 Compare November 12, 2025 15:25
@szokeasaurusrex szokeasaurusrex force-pushed the szokeasaurusrex/proguard-chunk-upload-default branch from 8f67a63 to 5eff8ca Compare November 12, 2025 15:25
@szokeasaurusrex szokeasaurusrex mentioned this pull request Nov 12, 2025
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@loewenheim loewenheim loewenheim approved these changes

@andreiborza andreiborza andreiborza approved these changes

Assignees

No one assigned

Labels

v3.0 Breaking changes to include in version 3.0.0 of Sentry CLI

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@szokeasaurusrex @loewenheim @andreiborza