BackupStatus

Last modified: 14 October 2024

Represents the current status of the backup process.

Related Resources

Below you can find the list of resources that let you work with this entity.

Attributes

This table describes attributes of the BackupStatus entity.

  • To receive an attribute in the response from the server, specify it explicitly in the fields request parameter.

  • To update an attribute, provide it in the body of a POST request.

Field

Type

Description

id

String

The ID of the BackupStatus. Read-only.

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.