Data Migration - Get Runtime Config

Endpoint

/o/datamigration/get_config

Overview

Returns data migration runtime defaults, including export folder path and detected upload size limit from Nginx configuration when available.

Authentication

Pass api_key or auth_token as a query parameter, or send countly-token as a header. See Authentication.

Permissions

Requires data_migration Read permission.

Request Parameters

Parameter	Type	Required	Description
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.

Examples

Get migration runtime config

/o/datamigration/get_config

Response

Success Response

{
  "result": {
    "def_path": "/path/to/core/plugins/data_migration/export",
    "fileSizeLimit": 102400
  }
}

Response Fields

Field	Type	Description
result.def_path	String	Default export directory path on server.
result.fileSizeLimit	Number	Detected upload limit in KB, or 0 when not detected.

Error Responses

This handler normally returns 200 with fallback values even when Nginx config discovery fails.

Behavior

Behavior Modes

Mode	Trigger	Processing Path	Response Shape
Nginx parsed	nginx -t and config parse succeed	Returns default path plus parsed client_max_body_size converted to KB.	Wrapped config object
Fallback	Nginx parse not available/fails	Returns default path and fileSizeLimit=0.	Wrapped config object

Impact on Other Data

• Read-only endpoint.

Limitations

• If Nginx config parser fails inside callback, handler may not return detailed parse error context.

Related Endpoints

• Data Migration - Import

Implementation details

Configuration Impact

Setting	Default	Affects	User-visible impact
Nginx client_max_body_size	Nginx default	Import file-size guidance	Returned fileSizeLimit reflects detected max request body size (converted to KB).

Database Collections

This endpoint does not read or write database collections directly.