Rate this page:

Long-running task

Get long-running tasks

GET /wiki/rest/api/longtask

Returns information about all active long-running tasks (e.g. space export), such as how long each task has been running and the percentage of each task that has completed.

Permissions required: Permission to access the Confluence site ('Can use' global permission).

App scope required: READ

Request

Query parameters
start

integer

The starting index of the returned tasks.

Default: 0, Minimum: 0, Format: int32
limit

integer

The maximum number of tasks to return per page. Note, this may be restricted by fixed system limits.

Default: 100, Minimum: 0, Format: int32

Example

1
2
3
curl --request GET \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/longtask' \
  --header 'Accept: application/json'

Responses

Returned if the requested tasks are returned.

Content typeValue
application/json

LongTaskStatusArray

Get long-running task

GET /wiki/rest/api/longtask/{id}

Returns information about an active long-running task (e.g. space export), such as how long it has been running and the percentage of the task that has completed.

Permissions required: Permission to access the Confluence site ('Can use' global permission).

App scope required: READ

OAuth scopes required: 
read:confluence-space.summary

Request

Path parameters
id Required

string

The ID of the task.

Example

1
2
3
curl --request GET \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/longtask/{id}' \
  --header 'Accept: application/json'

Responses

Returned if the requested task is returned.

Content typeValue
application/json

allOf [LongTaskStatus, object]

Rate this page: