Get current export path

GET /config/export-path

Return the current export path. This is the directory that the data pipeline will write files to.

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

Example

1
2
3

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

Responses

Change export path

PUT /config/export-path

Create or update a custom export path. This is the directory that the data pipeline will write files to.

In the body of the request pass the absolute path to your preferred directory, for example:

1
2
{
  "path": "/tmp/new/path"
}

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

Example

1
2
3

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

Responses

Revert to default export path

DELETE /config/export-path

Delete the custom export path and revert to the default path. This is the path that the data pipeline will export files to.

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

Example

1
2
3

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

Responses

Get current export schedule

GET /config/schedule

Administrators can schedule regular exports. Get the details of the current export schedule, if a schedule exists.

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

Example

1
2
3

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

Responses

Create or update export schedule

PUT /config/schedule

Administrators can schedule regular exports. Create a new export schedule or update the current export schedule.

In the body of the request pass the date and time intervals and export parameters, as follows:

1
2
{
 "days": ["sun", "tue"],
 "time": "00:00:00",
 "repeatIntervalInWeeks": 3,
 "fromDate": "2020-07-26T11:14:00Z",
 "schemaVersion": 2
}

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

Example

1
2

curl --request PUT \
  --url 'https://your-domain.atlassian.net/config/schedule'

Responses

Delete export schedule

DELETE /config/schedule

Turn off scheduled exports, and delete the current export schedule.

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

Example

1
2

curl --request DELETE \
  --url 'https://your-domain.atlassian.net/config/schedule'

Responses

Get schema versions

GET /config/schema

Get a list of all supported schema versions.

The export schema defines the structure of the export. We only introduce new schema versions for breaking changes, such as removing a field, or if the way the data is structured changes. New fields are simply added to the latest schema version. Older schema versions will be marked as deprecated, and may be removed in future versions. You can still export using these versions, just be aware we won’t update them with any new fields.

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

Example

1
2
3

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

Responses

Get opt-out list

GET /config/optout

Return the list of entities (projects or spaces) that will be excluded from the export.

Administrators can choose to exclude particular Jira projects, Confluence spaces, and Bitbucket projects from the export by adding these spaces to the opt-out list.

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

Example

1
2
3

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

Responses

Add entities to opt-out list

POST /config/optout

Exclude specific entities (projects or spaces) from the export by adding them to the opt-out list.

In the body of the request pass the project keys (Jira and Bitbucket) or space keys (Confluence) to exclude, for example:

1
2
{
  "type": "PROJECT",
  "keys": ["IT","BUGS","TEST"]
}

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

Example

1
2
3

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

Responses

Remove entities from opt-out list

DELETE /config/optout

Remove specific entities (projects or spaces) from the opt-out list. Once removed from the list, these entities will be included in the next export.

In the body of the request pass the PROJECT keys (Jira and Bitbucket) or SPACE keys (Confluence) to remove, for example:

1
2
{
  "type": "SPACE",
  "keys": ["DESIGN","HR"]
}

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

Example

1
2
3

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

Responses