The Data pipeline REST API

Get export status

GET /export

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

There are no parameters for this request.

Example

cURL

Node.js

Java

Python

PHP

1
2
3

curl --request GET \
  --url 'https://your-domain.atlassian.net/export' \
  --header 'Accept: application/json'

Responses

200

401

403

Returns the status of the current or most recent export.

Content type	Value
application/json	ProcessStatusResponse

Trigger an export

POST /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

The start date and time in ISO 8601 format yyyy-MM-ddTHH:mmTZD. For example, 2020-12-30T23:01Z or 2020-12-30T22:01+01:00 (for this format you will need to use URL encoding in your request, for example 2020-12-30T22%3A03%2B01%3A00). Data from before this date will not be included in the export.

Format: date-time

forceExport

boolean

Ignore inconsistent index warning, and force export even if data is not up to date.

Default: false

schemaVersion

string

Schema version to use for the export. Overrides the default schema version number.

Example

cURL

Node.js

Java

Python

PHP

1
2
3

curl --request POST \
  --url 'https://your-domain.atlassian.net/export' \
  --header 'Accept: application/json'

Responses

202

400

401

403

409

422

Returned if the export was successfully triggered.

Content type	Value
application/json	ProcessStatusResponse

Cancel an export

DELETE /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

Request cancellation of a specific job. If blank the latest job will be cancelled.

Example

cURL

Node.js

Java

Python

PHP

1
2
3

curl --request DELETE \
  --url 'https://your-domain.atlassian.net/export' \
  --header 'Accept: application/json'

Responses

200

401

403

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

Content type	Value
application/json	ProcessStatusResponse