docs(api): explain regional routing and regional domains#18653
docs(api): explain regional routing and regional domains#18653youdie006 wants to merge 1 commit into
Conversation
Document the global vs region-specific domain model, the regional domains, and how to look up an organization's region programmatically.
|
@youdie006 is attempting to deploy a commit to the Sentry Team on Vercel. A member of the Team first needs to authorize it. |
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: ca477d2ba9
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| If you're building an integration, CLI, or CI job, resolve the region at runtime instead of hardcoding a domain. Request the list of regions the authenticated user belongs to: | ||
|
|
||
| ```bash | ||
| curl -H 'Authorization: Bearer <auth_token>' https://sentry.io/api/0/users/me/regions/ |
There was a problem hiding this comment.
For the integrations/CLI/CI scenario described here, this users/me/regions call points external users at an unsupported API: in the Sentry backend, UserRegionsEndpoint.publish_status marks GET as ApiPublishStatus.PRIVATE and the endpoint is documented in code as frontend fan-out support. Publishing it in the public API reference would make third-party tooling depend on a private endpoint that can change or disappear; the region-discovery guidance should use the public organization details response instead.
Useful? React with 👍 / 👎.
1 participant
Closes #18630.
Expands the API docs to explain regional routing and regional domains.
docs/api/index.mdx— rewrites "Choosing the Right API Base Domain": the globalsentry.iovs region-specific domain model (withsentry.iorouting to the correct region so existing integrations keep working, and region-specific domains recommended for org data), a Regional Domains table (US / US2 / EU), and a new "Finding Your Organization's Region Programmatically" subsection documentingGET /api/0/users/me/regions/.docs/organization/data-storage-location/index.mdx— links back to the API base-domain section.Regional domains and the regions endpoint / response shape are grounded in the existing data-storage-location page and the repo's own region handling; illustrative values are labeled as examples rather than invented.
AI disclosure: this PR was drafted with Claude Code (AI-assisted). The changes were verified locally before submitting (see the test plan above).