Migration Guide for Data Centers
This guide details the process of changing your region for data residency purposes. Each data center region is isolated, and data isn't shared between regions. When you’ve configured Nylas to store data in one region, your application uses that region’s Nylas URLs for API requests. Instructions are provided below to migrate your organization’s data region.
For setting up a new organization and configuring your region for the first time, read the Data Residency guide to get started.
Migrating an Existing Organization
If your organization has set up your data residency for one of our existing regions, follow the steps below to migrate to another region:
Step 1: Create a New Nylas Organization
To migrate your current organization to a new region, create a new application for the new region. Use the links below for your specific region’s Nylas Dashboard.
Location | Dashboard URL | API URL | Scheduler API URL |
---|---|---|---|
United States (Oregon) | https://dashboard.nylas.com |
https://api.nylas.com |
https://api.schedule.nylas.com |
Europe (Ireland) | https://ireland-dashboard.nylas.com |
https://ireland.api.nylas.com |
https://ireland.api.schedule.nylas.com |
Step 2: Set Up Authentication and Begin Migration
Set up your new application's Client ID and Client Secret authentication information. Check your new application’s configuration to make sure it's correct and then begin migrating the new application into your organization.
Step 3: Transfer Billing Information
Contact your Nylas Customer Success Manager with your new application’s information. We'll connect the new application’s billing profile to your current account. The billing department also manages the added data residency region of your new application. Using additional data centers has no additional platform fee.
Step 4: Re-Authenticate Users and Accounts
Users and accounts in your new application’s data residency need to be re-authenticated. They'll need new <ACCESS_TOKEN>
values for your new application.
Step 5: Delete Duplicate Accounts
Revoke credentials for user account information from the former application as you migrate the accounts to the new application. You'll also need to update the billing state for these accounts in the former application to cancelled
. See the Managing Transitioning Accounts section for more information.
Managing Transitioning Accounts
Unique identification values differ between applications in different data regions. Any account_id
or object ID values in the former region's application are different than those in the new region’s application.
Delete Accounts
Since there are two applications connected to your accounts, you'll want to deactivate access to the former region’s application and stop billing.
Use the revoke access tokens endpoint to deactivate access tokens for accounts. To stop billing, contact Nylas with your applications’ ID numbers.
Approaches to Account Migration
The two methods below are options for your data center migration:
Same-Month or Immediate
When you've completed setting up a new application, migrate all user accounts. Make sure to finish the migration within the month and contact Nylas Billing for charge adjustments.
New Accounts First
When you've completed setting up a new application, you can choose to start only new users in the new region. For existing users, migrate accounts and credentials with a targeted approach. Move information from the old to the new application at your discretion.
This strategy helps avoid additional work for setting up new users. However, accounts connected in both applications count toward your active connection total.
Billing
Your organization uses more than one application when migrating between data regions. Account data remains in isolated regions, so you'll need to contact the Nylas team to ensure your existing billing profile is linked to your new application. You can also contact the Nylas billing department for solutions when transitioning data residency.
ID Values
Migrated users are new connections in Nylas. In this situation, all data requires re-syncing and creates new ID values for every object. Merge existing data through unique IDs for calendar and email objects between regions.
For emails, use the RFC-based messageid
in the header of the email. For calendars using Nylas API v2.1 or higher, use the ical_uid
field in an event object.
Webhooks
Update your webhook configuration for the new data residency options.
Nylas SDKs
Update your SDK configurations to use the appropriate URL for your region. See the Nylas SDK API URL Configuration section for more information.