Data Migration - API Documentation
Overview
The Data Migration feature exports app data from one Countly environment and imports it into another. It supports archive generation, remote transfer, import token flow, lifecycle status tracking, and cleanup operations.
Quick Links
- Data Migration - Export
- Data Migration - Send Existing Export
- Data Migration - Stop Export
- Data Migration - Import
- Data Migration - Report Import Status
- Data Migration - Delete Export
- Data Migration - Delete Import
- Data Migration - Delete All Migration Files
- Data Migration - Get My Exports
- Data Migration - Get My Imports
- Data Migration - Get Status
- Data Migration - Create Import Token
- Data Migration - Validate Remote Connection
- Data Migration - Get Runtime Config
Database Collections
| Collection | Purpose |
|---|---|
countly.data_migrations | Tracks export/import jobs, progress, remote handoff details, and status history fields. |
countly.auth_tokens | Stores scoped import tokens created for migration import endpoint access. |
countly.systemlogs | Stores migration lifecycle audit actions (for example export/import success/failure and callback reporting). |
countly.* and countly_drill.* | Source/target app data collections read during export and written during import. |
Configuration & Settings
| Setting | Default | Effect |
|---|---|---|
Nginx client_max_body_size | Web-server default | Influences practical max import upload size; surfaced by o/datamigration/get_config as fileSizeLimit. |
security request config | Server-defined | Affects outbound remote calls used by validate/send/report migration workflows. |
Operational Flow
- Export app data (
i/datamigration/export) and capture export ID. - Validate remote target (
o/datamigration/validateconnection) if exporting to another server. - Send export (
i/datamigration/sendexport) or transfer archive manually. - Start import (
i/datamigration/import) and track status (o/datamigration/getstatus). - Clean up local artifacts when done (
i/datamigration/delete_export,i/datamigration/delete_import,i/datamigration/delete_all).
Last Updated
2026-02-17