Data Migration - Stop Export

Endpoint

/i/datamigration/stop_export

Overview

Marks an export as stopped when it is still in export pipeline states.

Authentication

Countly API supports three authentication methods:

1. API key query parameter: api_key=YOUR_API_KEY
2. Auth token query parameter: auth_token=YOUR_AUTH_TOKEN
3. Auth token header: countly-token: YOUR_AUTH_TOKEN

Permissions

Requires data_migration Update permission.

Request Parameters

Parameter	Type	Required	Description
exportid	String	Yes	Export ID to stop.
args	JSON String (Object)	No	Optional JSON-stringified helper args.
api_key	String	Conditional	Required if auth_token is not provided.
auth_token	String	Conditional	Required if api_key is not provided.

Response

Success Response

{
  "result": "data-migration.export-already-stopped"
}

Response Fields

Field	Type	Description
result	String	Export stop status key.

Error Responses

• 404

{
  "result": "data-migration.export-already-finished"
}

• 404

{
  "result": "data-migration.export-already-failed"
}

• 404

{
  "result": "data-migration.export-already-sent"
}

• 404

{
  "result": "data-migration.data-migration.exportid_not_provided"
}

Behavior/Processing

Behavior Modes

Mode	Trigger	Processing Path	Response Shape
Stop accepted	Export exists and is in packing or exporting step	Sets stopped=true in migration record.	Wrapped data-migration.export-already-stopped
Cannot stop	Export already finished/failed/sent	Returns status-specific error key.	Wrapped error key

Impact on Other Data

• Updates stopped flag in countly.data_migrations.

Database Collections

Collection	Used for	Data touched by this endpoint
countly.data_migrations	Export status lookup and update	Reads export status/step and sets stopped=true when eligible.

---

Examples

Stop an active export

/i/datamigration/stop_export?
  exportid=f9b35d90be5f2240eafced7c6bfdf130856cd0a7

Limitations

• The success message key is data-migration.export-already-stopped, even in the first successful stop transition.

Related Endpoints

• Data Migration - Export
• Data Migration - Get Status

Last Updated

2026-02-17