Inspect Running and Queued Export Jobs via REST API

This documentation relates to Scroll HTML Exporter v4. This version is currently in beta testing and is not general available yet - learn more here.

For inspecting currently running export jobs and those still waiting in a queue to be started, the exporter provides a separate REST API that is only available on Confluence Data Center.

Only Confluence administrators can access the administrative REST API. They can see and cancel all jobs, regardless of the user who start it.
In multi-node setups the REST API only shows the jobs managed by the respective node. Make sure you can access each node as recommended in the Atlassian documentation.
Standard Confluence authentication mechanisms can be used.
To stop all export jobs, first clear the export job queue and then stop running exports.

Inspect Running Export Jobs

List all export jobs that are currently being processed.

Send a GET request (simply open URL in browser) to:

CODE

<BASE_URL>/plugins/servlet/scroll-html/api/admin/jobs/active

Response

CODE

[
    {
        "id": "f71a510d-39c9-487d-8f00-33c4603ca69d",
        "owner": "/rest/api/user?key=402832228c5da33a018c5da7eae60000"
    }
]

Inspect Inspect Queued Export Jobs

List all export jobs that have been queued but not yet started.

Send a GET request (simply open URL in browser) to:

CODE

<BASE_URL>/plugins/servlet/scroll-html/api/admin/jobs/pending

Response

CODE

[
    {
        "id": "f71a510d-39c9-487d-8f00-33c4603ca69d",
        "owner": "/rest/api/user?key=402832228c5da33a018c5da7eae60000"
    }
]

Cancel All Running Export Jobs

Mark all currently processed export jobs as cancelled. Does not affect queued jobs.

Send a DELETE request to:

CODE

<BASE_URL>/plugins/servlet/scroll-html/api/admin/jobs/active

Response

CODE

{
    "stoppedJobCount": 2
}

Please note that the returned export jobs may continue to run even after receiving the response. There is no way to forcefully stop a thread in a Java virtual machine. Cancelling means that the export job threads will be ‘interrupted’ and they will stop as soon as they check for their own ‘interrupted’ flag. Depending on the current state of the export process and the JVM in general this may take some time.

Clear Export Job Queue

Remove all waiting export jobs from the job queue. Does not affect jobs that are already being processed.

Send a DELETE request to:

CODE

<BASE_URL>/plugins/servlet/scroll-html/api/admin/jobs/pending

Response

CODE

{
    "pendingJobCount": 15
}