Skip to main content
GET
List background operations

Authorizations

Authorization
string
header
required

Send your API token as Authorization: Bearer <api-token>.

Path Parameters

databaseID
string
required

The database's _id. 24-character hexadecimal ID.

Pattern: ^[0-9a-fA-F]{24}$

Query Parameters

teamID
string

Run the request in the context of a team you belong to, instead of your personal account. 24-character hexadecimal ID.

Pattern: ^[0-9a-fA-F]{24}$
type
enum<string>

DatabaseDump: backup. DatabaseResetPassword: password reset. VolumeResize: disk resize. DatabaseRestore: restore. MssqlPutBakFile / ClickhousePutBakFile: backup file import.

Available options:
DatabaseDump,
DatabaseResetPassword,
VolumeResize,
DatabaseRestore,
MssqlPutBakFile,
ClickhousePutBakFile
status
enum<string>
Available options:
queued,
in_progress,
succeeded,
failed
interval
enum<string>

Only with type=DatabaseDump. Filter backups by interval.

Available options:
manual,
hourly,
daily,
weekly,
monthly
page
integer
default:1
Required range: x >= 1
count
integer
default:10
Required range: 1 <= x <= 100

Response

Operations.

totalOperations
integer
operations
object[]