Operations with Specific BackupStatus
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. |
Supported methods |
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 |
backupCancelled | Boolean | If |
backupError | BackupError | The error that appeared during the previous backup process. Returns |
Read a Specific BackupStatus
Read the status of the back up process.
Required permissions
Requires Low-level Admin Read permission.
Request syntax
Request parameters
Parameter | Type | Description |
---|---|---|
fields | String | A list of BackupStatus attributes that should be returned in the response. If no field is specified,only the |