Skip to content

Commit 7d6ce16

Browse files
committed
feat: Add more context on data storage locations and API endpoints
Give more context on how/when to use our API base domains. Refs #11058
1 parent 1a5f173 commit 7d6ce16

File tree

2 files changed

+25
-1
lines changed

2 files changed

+25
-1
lines changed

docs/api/index.mdx

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,3 +20,17 @@ Sentry's web API is **v0** and under development. Public endpoints, especially t
2020
- [Requests](/api/requests/)
2121
- [Tutorial: Create a Sentry Authentication Token](/api/guides/create-auth-token/)
2222
- [Tutorial: Create and List Teams with the Sentry API](/api/guides/teams-tutorial/)
23+
24+
## Finding the API base domain
25+
26+
While many of the API examples use `sentry.io` as the host for API endpoints, if
27+
you want to take advantage of [data storage location](https://docs.sentry.io/organization/data-storage-location/#what-types-of-data-are-stored-where) you should use the region
28+
specific domains instead.
29+
30+
- US region is hosted on `us.sentry.io`
31+
- DE region is hosted on `de.sentry.io`.
32+
33+
To find out which API resources are available on region base domains see [what
34+
types of data are stored
35+
where](https://docs.sentry.io/organization/data-storage-location/#what-types-of-data-are-stored-where) for more information.
36+

docs/organization/data-storage-location/index.mdx

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,9 +53,19 @@ Here’s a list of the types of data that may be stored in the US.
5353
- Sentry applications
5454
- SSO, SAML, and SCIM metadata
5555

56-
5756
Metadata that lets Sentry identify an organization will be replicated out of the organization's data storage location to facilitate login, and backwards-compatible APIs. You can always confirm the location of your organization by viewing your organization's settings page.
5857

58+
## Using Data Storage Location APIs
59+
60+
To ensure that your API requests are only processed within your selected data storage location use the region specific domain for your data storage location:
61+
62+
| **Data Storage Location** | **API domain** |
63+
| ----------------------------- | -------------- |
64+
| United States of America (US) | us.sentry.io |
65+
| European Union (EU) | de.sentry.io |
66+
67+
For [data stored in the US](https://docs.sentry.io/organization/data-storage-location/#data-stored-in-us) your API domain should be `sentry.io`.
68+
5969
## Switching Data Storage Locations for Existing Organizations
6070

6171
### SaaS

0 commit comments

Comments
 (0)