listtasks

List maintenance tasks (backup, optimization, or reindexing).



HTTP Request: GET

Parameters:

NameValueDescriptionformat
timeline

Type: integer

0 for current tasks, greater than 0 for past tasks.

If > 0 timeline represents the maximum age in hours of past tasks (coutend from their start).

format
  • "text" : (the default) returns tab-separated lines, each containing the fields described below.
  • "json" : returns an array containing one map for each statistic (see below) .

Response:

   mime-type: text/plain

   mime-type: application/json

Whatever the format, the response contains the following fields:

FieldDescription
TypeType of operation: "backup", "reindexing", "compaction"
DatabaseName of the database or of the Library session.
StartTimestart-time of the task in ISO format
EndTimeend-time of the task (estimated in the case of running tasks)
DurationDuration (estimated in the case of running tasks)
ProgressPercentage of the task accomplished ("100%" for past tasks)

Error codes:

AccessControl
if the user does not have the admin role.