Operations with Specific BackupStatus
This resource lets you get the status of the back up process.
Resource | |
|---|---|
Returned entity | BackupStatus. For the description of the entity attributes, see Supported Fields section. |
Supported methods |
Represents the current status of the backup process.
Below you can find the list of resources that let you work with this entity.
This table describes attributes of the BackupStatus entity.
To receive an attribute in the response from the server, specify it explicitly in the
fieldsrequest parameter.To update an attribute, provide it in the body of a POST request.
Field | Type | Description |
|---|---|---|
id | String | The ID of the BackupStatus. |
backupInProgress | Boolean | If |
backupCancelled | Boolean | If |
backupError | The error that appeared during the previous backup process. Returns |
Read the status of the back up process.
Requires permissions: Low-level Admin Read
GET /api/admin/databaseBackup/settings/backupStatus?{fields}null | Database ID of BackupStatus |
|---|
Parameter | Type | Description |
|---|---|---|
fields | String | A list of BackupStatus attributes that should be returned in the response. If no field is specified, only the |
https://example.com/youtrack/api/admin/databaseBackup/settings/backupStatus?fields=backupCancelled,backupError(date,errorMessage),backupInProgress,stopBackup{
"backupInProgress": false,
"stopBackup": false,
"backupCancelled": false,
"backupError": null,
"$type": "BackupStatus"
}