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	`GET`: Read a Specific BackupStatus.

BackupStatus attributes

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.

Backup Status

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`.

Read a Specific BackupStatus

Read the status of the back up process.

Required permissions

Requires permissions: Low-level Admin Read

Request syntax

GET /api/admin/databaseBackup/settings/backupStatus?{fields}

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 `entityID` is returned.

Sample

Sample request

                https://example.com/youtrack/api/admin/databaseBackup/settings/backupStatus?fields=backupCancelled,backupError(date,errorMessage),backupInProgress,stopBackup
            

Sample response body

                {
                  "backupInProgress": false,
                  "stopBackup": false,
                  "backupCancelled": false,
                  "backupError": null,
                  "$type": "BackupStatus"
                }
            

Last modified: 7 November 2024