• Export
  • Config
Server
Data pipeline / Reference / REST API

Export

Postman Collection
OpenAPI
GET

Get export status

Returns the status of the export in progress, or most recent export if there is no export in progress.

In the examples below, substitute https://your-domain.atlassian.net/ with the Data Center URL https://myexamplesite.com/rest/datapipeline/latest/ where myexamplesite is your domain. Remember to include your context path if you have one configured.

Request

This request has no parameters.

Responses

Returns the status of the current or most recent export.

application/json

ProcessStatusResponse
GET/export
1 2 3 curl --request GET \ --url 'https://your-domain.atlassian.net/export' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 { "cancelledTime": "<string>", "completedTime": "<string>", "config": { "empty": true, "exportFrom": "<string>", "forcedExport": true }, "errors": [ { "key": "<string>", "message": "<string>" } ], "jobId": 2154, "nodeId": "<string>", "optedOutEntities": [ { "identifiers": [ "<string>" ], "type": "<string>" } ], "rootExportPath": "<string>", "schema": { "status": "ACTIVE", "version": 2154 }, "startTime": "<string>", "statistics": { "empty": true, "exportedEntities": 2154, "writtenRows": 2154 }, "status": "CANCELLATION_REQUESTED", "warnings": [ { "key": "<string>", "message": "<string>" } ] }
POST

Trigger an export

Exports the full data set from your Data Center application.

The export will start immediately, and includes data for the timeframe specified, or from the last 365 days if a fromDate is not specified.

In the examples below, substitute https://your-domain.atlassian.net/ with the Data Center URL https://myexamplesite.com/rest/datapipeline/latest/ where myexamplesite is your domain. Remember to include your context path if you have one configured.

Request

Query parameters

fromDate

string

forceExport

boolean

schemaVersion

string

Responses

Returned if the export was successfully triggered.

application/json

ProcessStatusResponse
POST/export
1 2 3 curl --request POST \ --url 'https://your-domain.atlassian.net/export' \ --header 'Accept: application/json'
202Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 { "cancelledTime": "<string>", "completedTime": "<string>", "config": { "empty": true, "exportFrom": "<string>", "forcedExport": true }, "errors": [ { "key": "<string>", "message": "<string>" } ], "jobId": 2154, "nodeId": "<string>", "optedOutEntities": [ { "identifiers": [ "<string>" ], "type": "<string>" } ], "rootExportPath": "<string>", "schema": { "status": "ACTIVE", "version": 2154 }, "startTime": "<string>", "statistics": { "empty": true, "exportedEntities": 2154, "writtenRows": 2154 }, "status": "CANCELLATION_REQUESTED", "warnings": [ { "key": "<string>", "message": "<string>" } ] }
DEL

Cancel an export

Cancels the current export. If the export process was killed due to a crash, you will need to manually cancel it before you can trigger a new export.

In the examples below, substitute https://your-domain.atlassian.net/ with the Data Center URL https://myexamplesite.com/rest/datapipeline/latest/ where myexamplesite is your domain. Remember to include your context path if you have one configured.

Request

Query parameters

jobId

string

Responses

Returns a confirmation that the cancellation has been requested if an export process was running.

application/json

ProcessStatusResponse
DEL/export
1 2 3 curl --request DELETE \ --url 'https://your-domain.atlassian.net/export' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 { "cancelledTime": "<string>", "completedTime": "<string>", "config": { "empty": true, "exportFrom": "<string>", "forcedExport": true }, "errors": [ { "key": "<string>", "message": "<string>" } ], "jobId": 2154, "nodeId": "<string>", "optedOutEntities": [ { "identifiers": [ "<string>" ], "type": "<string>" } ], "rootExportPath": "<string>", "schema": { "status": "ACTIVE", "version": 2154 }, "startTime": "<string>", "statistics": { "empty": true, "exportedEntities": 2154, "writtenRows": 2154 }, "status": "CANCELLATION_REQUESTED", "warnings": [ { "key": "<string>", "message": "<string>" } ] }