generated from mintlify/starter
-
Notifications
You must be signed in to change notification settings - Fork 13
Update ingest methods to use edge regions #460
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.
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
Open
benenharrington
wants to merge
10
commits into
main
Choose a base branch
from
benen/edge-ingest
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
10 commits
Select commit
Hold shift + click to select a range
183da34
Add details on allowing audit log access to non-Owners
benenharrington c27f78a
Update endpoints for edge ingest
benenharrington 4a4a030
merge main
benenharrington ac82ea7
Stick with existing AXIOM_DOMAIN pattern
benenharrington 0a48e31
Use correct placeholder name
benenharrington 7eab1f1
Update snippets/replace-domain.mdx
benenharrington 3a33a72
Update reference/regions.mdx
benenharrington 89c8d52
Merge branch 'main' into benen/edge-ingest
benenharrington 0b61284
Update region info
benenharrington b3f354e
Clarify query execution language
benenharrington File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,32 +1,76 @@ | ||
| --- | ||
| title: 'Regions' | ||
| description: 'This page explains how to work with Axiom based on your organization’s region.' | ||
| description: 'This page explains how to work with Axiom’s unified multi-region platform.' | ||
| --- | ||
|
|
||
| Axiom is available in multiple regions to help you comply with data residency requirements and optimize performance. | ||
|
|
||
| ## Available regions | ||
|
|
||
| Axiom currently supports the following cloud regions for data ingest: | ||
|
|
||
| | Region | Base domain of edge ingest API endpoints | Example | Cloud provider | | ||
| | ---------- | ------------------------------------ | ------------------------------------------------- | -------------- | | ||
| | US | `https://us-east-1.aws.edge.axiom.co` | `https://us-east-1.aws.edge.axiom.co/v1/ingest/DATASET_NAME` | AWS | | ||
| | EU | `https://eu-central-1.aws.edge.axiom.co` | `https://eu-central-1.aws.edge.axiom.co/v1/ingest/DATASET_NAME` | AWS | | ||
|
|
||
| The base domain of other API endpoints is `https://api.axiom.co`. | ||
|
|
||
| <Info> | ||
| Axiom will support a unified multi-region model by early November 2025. This will allow you to manage data across different regions from a single organization. [Contact Axiom](https://www.axiom.co/contact) to learn more. | ||
| Axiom is developing support for additional regions. [Contact Axiom](https://www.axiom.co/contact) if you need a region that’s not currently supported. | ||
| </Info> | ||
|
|
||
| ## Check your region | ||
| <Info> | ||
| Query execution currently happens in the US region only. This means that data in the EU region can leave the region when queried. As we continue to build out support for multiple regions, we will update query behavior to ensure that query execution happens in the same region as the storage region of the data being queried. | ||
|
Check warning on line 24 in reference/regions.mdx
|
||
| </Info> | ||
|
|
||
| ## Default region | ||
|
|
||
| The default region of your organization determines where the data in your datasets are stored. | ||
|
|
||
| To determine your organization’s default region: | ||
|
|
||
| 1. Click <img src="/doc-assets/icons/settings.svg" className="inline-icon" alt="Settings icon" /> **Settings > General**. | ||
| 1. Find your organization’s default region in the **Region** section. | ||
|
|
||
| <Info> | ||
| Axiom is building support for storing data outside your default region on a dataset-by-dataset basis. | ||
| </Info> | ||
|
|
||
| ## Choose region | ||
|
|
||
| When you create a new organization, choose the region that best meets your data residency requirements and where your infrastructure is located for optimal performance. | ||
|
|
||
| When choosing a region, consider the following factors: | ||
|
|
||
| - **Data residency requirements**: If you need to comply with regulations like GDPR that require data to be stored in specific regions, choose the appropriate region. | ||
| - **Performance**: Choose the region closest to your infrastructure for lower latency. | ||
| - **Team location**: Choose the region that your team is primarily located in for better performance. | ||
|
|
||
| ## Roadmap | ||
|
|
||
| Determine the region your organization uses in one of the following ways: | ||
| ### Legacy infrastructure: Dedicated regional instances | ||
|
|
||
| - Go to the [Axiom app](https://app.axiom.co/) and check the URL. Match the base domain in the Axiom web app with the table below: | ||
| Until November 2025, Axiom operated completely separate infrastructures for different regions: | ||
|
|
||
| | Region | Base domain in web app | | ||
| | ---------- | ------------------------------ | | ||
| | US | `https://app.axiom.co` | | ||
| - **US instance**: `app.axiom.co` hosted in AWS `us-east-1` | ||
| - **EU instance**: `app.eu.axiom.co` hosted in AWS `eu-central-1` | ||
|
|
||
| - Click <img src="/doc-assets/icons/settings.svg" className="inline-icon" alt="Settings icon" /> **Settings > General**, and then find the **Region** section. | ||
| Each instance was entirely independent with separate: | ||
| - Organizations and user accounts | ||
| - Billing and subscription plans | ||
| - API endpoints and ingestion URLs | ||
| - Data storage and query infrastructure | ||
|
|
||
| ## Axiom API reference | ||
| ### Towards a unified multi-region platform | ||
|
|
||
| All examples in the documentation use the default US base domain `https://api.axiom.co`. | ||
| Starting in November 2025, Axiom is rolling out support for a unified platform where a single organization can manage datasets across multiple regions: | ||
|
|
||
| | Region | Base domain of API endpoints | Example | | ||
| | ---------- | ------------------------------------ | ------------------------------------------------- | | ||
| | US | `https://api.axiom.co` | `https://api.axiom.co/v1/datasets/DATASET_NAME/ingest` | | ||
| - **One organization, multiple regions**: Create and manage datasets in different geographic regions from a single account. | ||
| - **Unified billing**: Single subscription covering all your regions. | ||
| - **Cross-region visibility**: View and manage all your data from one console. | ||
| - **Flexible data residency**: Place each dataset in the region that best meets your compliance and performance requirements. | ||
|
|
||
| ## Add new region | ||
| ### Migration from legacy EU instance | ||
|
|
||
| For more information on managing additional regions, see [Manage add-ons](reference/usage-billing#manage-add-ons). | ||
| The unified multi-region model is rolling out progressively. If your organization currently uses the legacy EU instance, Axiom will contact you about the opportunity to migrate to the unified platform. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm a bit confused about these changes. Could you please check if these are correct?