generated from mintlify/starter
-
Notifications
You must be signed in to change notification settings - Fork 13
Add edge info, edge endpoints, 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
32
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 30 commits
Commits
Show all changes
32 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 f16e8b6
Add different snippet for edge
manototh e4f2c42
Add Edge v1 endpoint, update links to it
manototh fa562e4
Vale feedback
benenharrington c0302ed
Fix Laravel
manototh 852b664
Merge branch 'benen/edge-ingest' of github.com:axiomhq/docs into bene…
benenharrington 3b2f056
Fix examples in V1 api
manototh 741ebea
Merge branch 'benen/edge-ingest' of https://github.com/axiomhq/docs i…
manototh 9eca501
Fix more snippets
manototh 63a6834
Add info to API intro
manototh c477263
Update base-domains.mdx
manototh a695d0c
Update Regions page with clearer status and roadmap
manototh 013e758
Update aws-s3.mdx
manototh 6573889
Merge branch 'main' into benen/edge-ingest
manototh 23ce38e
Update datasets.mdx
manototh dd28beb
Fix typo
benenharrington 61387da
Add info from Dom
manototh 3b6b98a
Implement Michal's review
manototh da87dee
Update regions.mdx
manototh 1a037bd
Update reference/datasets.mdx
manototh 6963804
Merge branch 'main' into benen/edge-ingest
manototh 321dce2
Update reference/datasets.mdx
manototh 26d6721
Move Support additional regions
manototh 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
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,99 @@ | ||
| --- | ||
| 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.' | ||
| --- | ||
|
|
||
| <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. | ||
| </Info> | ||
| import BaseDomains from "/snippets/base-domains.mdx" | ||
|
|
||
| ## Check your region | ||
| Axiom is available in multiple regions to help you comply with data residency requirements and optimize performance. | ||
|
|
||
| Determine the region your organization uses in one of the following ways: | ||
| ## Towards a unified multi-region platform | ||
|
|
||
| - 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: | ||
| Axiom is rolling out support for a unified platform where a single organization can manage datasets across multiple regions. This will give you complete control to decide where your data is stored and processed. | ||
|
|
||
| | Region | Base domain in web app | | ||
| | ---------- | ------------------------------ | | ||
| | US | `https://app.axiom.co` | | ||
| ### Current capabilities | ||
|
|
||
| - Click <img src="/doc-assets/icons/settings.svg" className="inline-icon" alt="Settings icon" /> **Settings > General**, and then find the **Region** section. | ||
| - You choose the default region when you create a new organization. | ||
| - You can choose from two available regions: US and EU. | ||
| - You can’t change the default region after creating the organization. | ||
| - Axiom stores the data you ingest in the default region of your organization. | ||
| - When you run a query, the query executes in your region, but Axiom routes the query results through the US region. This means that when you query data stored the EU region, the query results leave the EU region. | ||
|
|
||
| ## Axiom API reference | ||
| The current implementation is useful if you want to ingest data to the EU region, but your query results can leave the EU region. If your organization has data sovereignty requirements that are stricter than the current implementation, Axiom recommends waiting for the next phase of the rollout before migrating. | ||
|
|
||
| All examples in the documentation use the default US base domain `https://api.axiom.co`. | ||
| ### Roadmap | ||
|
|
||
| | Region | Base domain of API endpoints | Example | | ||
| | ---------- | ------------------------------------ | ------------------------------------------------- | | ||
| | US | `https://api.axiom.co` | `https://api.axiom.co/v1/datasets/DATASET_NAME/ingest` | | ||
| Axiom rolls out its unified multi-region platform in phases. This approach ensures you can migrate when the capabilities align with your specific data residency requirements. | ||
|
|
||
| ## Add new region | ||
| 1. Support additional regions (coming soon) | ||
| 1. Complete data locality (coming soon) | ||
|
|
||
| For more information on managing additional regions, see [Manage add-ons](reference/usage-billing#manage-add-ons). | ||
| - Axiom routes query results through the same region where data is stored. | ||
| - Monitor and dashboard operations respect organization region boundaries. | ||
| - Full compliance with regional data protection requirements (for example, GDPR). | ||
|
|
||
| In this phase, if your organization requires EU data sovereignty, you’ll be able to migrate with confidence. | ||
|
|
||
| 1. Unified multi-region platform (in development) | ||
|
|
||
| - One organization managing datasets across multiple geographic regions. | ||
| - Choose a default region for your organization, add regions to your organization, and configure individual datasets to store data in one of your regions. | ||
| - Unified billing covering all your regions. | ||
|
|
||
| In this phase, regions function as self-contained units that coexist within one organization while preserving data sovereignty guarantees. | ||
|
|
||
| Axiom routes some of your personal data (for example, email and name when you log in) through US servers, and this won’t change in the rollout of the multi-region platform. | ||
|
|
||
| Your view can help shape this roadmap. [Contact Axiom](https://www.axiom.co/contact) if you need a region that’s not currently supported or if you have any other suggestions. | ||
|
|
||
| ## Available regions | ||
|
|
||
| Axiom currently supports the following cloud regions for data ingest: | ||
|
|
||
| <BaseDomains /> | ||
|
|
||
| <Note> | ||
| The base domain of all other API endpoints is `https://api.axiom.co`. | ||
| </Note> | ||
|
|
||
| ## Determine default region | ||
|
|
||
| The default region of your organization determines where Axiom stores your data. | ||
|
|
||
| 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. | ||
|
|
||
| ## 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. | ||
|
|
||
| ## Legacy infrastructure | ||
|
|
||
| Until November 2025, Axiom operated separate infrastructures for two dedicated regional instances: | ||
|
|
||
| | Instance | Base domain of Axiom Console | Base domain of API endpoints | | ||
| | ---------- | ------------------------------ | ----------------------- | | ||
| | US | `https://app.axiom.co` | `https://api.axiom.co` | | ||
| | EU | `https://app.eu.axiom.co` | `https://api.eu.axiom.co` | | ||
|
|
||
| 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 | ||
|
|
||
| ### Migration from legacy EU instance | ||
|
|
||
| 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. | ||
|
|
||
| <Note> | ||
| All examples in the Axiom API reference use the base domain `https://api.axiom.co`, which is the default for the legacy US instance. If your organization uses the legacy EU instance, use the base domain `https://api.eu.axiom.co` until Axiom migrates your organization to the unified platform. | ||
| </Note> |
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 |
|---|---|---|
| @@ -0,0 +1,4 @@ | ||
| --- | ||
| title: Ingest data to dataset | ||
| openapi: "v1-edge post /ingest/{dataset-id}" | ||
| --- |
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.
Uh oh!
There was an error while loading. Please reload this page.