Rate this page:
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.
This request has no parameters.
Returns the current export path.
1
2
3
curl --request GET \
--url 'https://your-domain.atlassian.net/config/export-path' \
--header 'Accept: application/json'1
2
3
{
"path": "<string>"
}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 3{ "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.
This request has no parameters.
Returns details of the updated export path.
1
2
3
curl --request PUT \
--url 'https://your-domain.atlassian.net/config/export-path' \
--header 'Accept: application/json'1
2
3
{
"path": "<string>"
}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.
This request has no parameters.
Returns the updated export path.
1
2
3
curl --request DELETE \
--url 'https://your-domain.atlassian.net/config/export-path' \
--header 'Accept: application/json'1
2
3
{
"path": "<string>"
}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.
This request has no parameters.
Returns details of the current export schedule if a schedule exists. Returns an empty response if a schedule does not exist.
1
2
3
curl --request GET \
--url 'https://your-domain.atlassian.net/config/schedule' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
{
"days": [
"MONDAY"
],
"fromDate": "<string>",
"nextRunTime": "<string>",
"repeatIntervalInWeeks": 2154,
"schema": {
"status": "ACTIVE",
"version": 2154
},
"time": "<string>",
"zoneId": "<string>"
}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 3 4 5 6 7{ "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.
This request has no parameters.
Returns confirmation that the request to create schedule has been received.
1
2
curl --request PUT \
--url 'https://your-domain.atlassian.net/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.
This request has no parameters.
Returns confirmation that the schedule was succesfully deleted, if a schedule exists.
1
2
curl --request DELETE \
--url 'https://your-domain.atlassian.net/config/schedule'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.
This request has no parameters.
Returns a list of supported schema versions in descending order.
array<SchemaResponse>
1
2
3
curl --request GET \
--url 'https://your-domain.atlassian.net/config/schema' \
--header 'Accept: application/json'1
2
3
4
5
6
[
{
"status": "ACTIVE",
"version": 2154
}
]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.
This request has no parameters.
Returns all the entities (projects and spaces) currently in the opt-out list.
1
2
3
curl --request GET \
--url 'https://your-domain.atlassian.net/config/optout' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
{
"optedOutEntities": [
{
"displayName": "<string>",
"identifier": "<string>",
"key": "<string>",
"type": "<string>",
"uri": "<string>"
}
]
}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 3 4{ "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.
boolean
Returns the entities (projects or spaces) that have been added to the opt-out list.
1
2
3
curl --request POST \
--url 'https://your-domain.atlassian.net/config/optout' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
{
"entitiesNotFound": [
{
"displayName": "<string>",
"identifier": "<string>",
"key": "<string>",
"type": "<string>",
"uri": "<string>"
}
],
"entitiesProcessed": [
{
"displayName": "<string>",
"identifier": "<string>",
"key": "<string>",
"type": "<string>",
"uri": "<string>"
}
]
}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 3 4{ "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.
boolean
Returns the entities (projects or spaces) that have been removed from the opt-out list.
1
2
3
curl --request DELETE \
--url 'https://your-domain.atlassian.net/config/optout' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
{
"entitiesNotFound": [
{
"displayName": "<string>",
"identifier": "<string>",
"key": "<string>",
"type": "<string>",
"uri": "<string>"
}
],
"entitiesProcessed": [
{
"displayName": "<string>",
"identifier": "<string>",
"key": "<string>",
"type": "<string>",
"uri": "<string>"
}
]
}