Backup Status

This resource lets you get the status of the back up process.

Resource	/api/admin/databaseBackup/settings/backupStatus
Returned entity	BackupStatus. For the description of the entity attributes, see Supported Fields section.

BackupStatus attributes

Represents the current status of the backup process.

This table describes attributes of the BackupStatus entity.

To receive an attribute in the response from server, specify it explicitly in the request parameter fields.
To update an attribute, provide it in the body of a POST request.

Field	Type	Description
backupInProgress	Boolean	If `true`, the backup is currently running. Otherwise, `false` `Read-only`.
backupCancelled	Boolean	If `true`, the last back up operation was cancelled. Otherwise, `false`. `Read-only`.
backupError	BackupError	The error that appeared during the previous backup process. Returns `null`, if there was no error. `Read-only`. `Can be null`.

Last modified: 30 March 2021