Database Backup Settings

Last modified: 19 March 2025

This resource lets you configure settings of the database backup.

Resource

/api/admin/databaseBackup/settings

Returned entity

DatabaseBackupSettings. For the description of the entity attributes, see Supported Fields section.

Supported sub-resources

DatabaseBackupSettings attributes

Represents database backup settings of the YouTrack instance.

Related Resources

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

  • Database Backup Settings

Attributes

This table describes attributes of the DatabaseBackupSettings 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 backup status. Read-only.

location

String

The location of the backups storage folder. Can be null.

filesToKeep

Int

The number of backup files that should be stored.

cronExpression

String

The cron expression that defines the schedule of the automatic backups. Can be null.

archiveFormat

Enumeration

The current selected format of backup files. Supported values are TAR_GZ or ZIP.

isOn

Boolean

If `true`, the automatic regular backup is enabled. Otherwise, `false`.

availableDiskSpace

Long

The size of available disk space. Read-only.

notifiedUsers

Array of Users

The list of users who get notifications about backup failures.

backupStatus

BackupStatus

The current status of the backup. Read-only.