---
schema: rendered-html/v1
title: "Database Backup Settings | Developer Portal for YouTrack and Hub Documentation"
source_url: https://www.jetbrains.com/help/youtrack/devportal/resource-api-admin-databaseBackup-settings.html
generated_at: 2026-06-11T15:10:07.686128+00:00
---

Feedback

Thanks for your feedback!

Was this page helpful?

YesNo

Developer Portal for YouTrack and Hub

- Developer Portal
- Apps
- MCP Tools
- YouTrack Workflows
- YouTrack Import Scripts
- YouTrack Form API
- YouTrack REST API
- Get Started with REST API
- REST API Reference
- Entities
- Resources
- Activity Items
- Issue Activities Page
- Build Bundles
- Enum Bundles
- Owned Bundles
- State Bundles
- User Bundles
- Version Bundles
- Custom Fields
- Field Types
- Backup Files
- [Database Backup Settings](resource-api-admin-databaseBackup-settings.html)
- Operations with Specific DatabaseBackupSettings
- Sub-resources
- [Global Settings](jetbrains__com__help__youtrack__devportal__resource-api-admin-globalsettings.md)
- [Organizations](jetbrains__com__help__youtrack__devportal__resource-api-admin-organizations.md)
- Projects
- Telemetry data
- Global Time Tracking Settings
- Agiles
- Articles
- Assigned Roles
- Commands
- Command Suggestions
- User Groups
- Issue Link Types
- Issue Tag
- Issues
- Issue Count
- Permissions
- Roles
- Saved Queries
- Search Suggestions
- Tags
- Users
- My User Profile
- Issue Work Items
- REST API Use Cases
- REST API Troubleshooting
- Color Indices List
- Hub REST API

1. YouTrack REST API
2. REST API Reference
3. Resources
4. [Database Backup Settings](#0)

# Database Backup Settings﻿

Last modified: 23 May 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](/help/youtrack/devportal/resource-api-admin-databaseBackup-settings.html#DatabaseBackupSettings-supported-fields) section. |
| Supported sub-resources | - /api/admin/databaseBackup/settings : Operations with Specific DatabaseBackupSettings - /api/admin/databaseBackup/settings/backupStatus : Backup Status |

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

- [Database Backup Settings](/help/youtrack/devportal/resource-api-admin-databaseBackup-settings.html)
- [DatabaseBackupSettings attributes](/help/youtrack/devportal/resource-api-admin-databaseBackup-settings.html#DatabaseBackupSettings-supported-fields)

Operations with Specific BackupFileOperations with Specific DatabaseBackupSettings

- Privacy & Security
- Terms Of Use
- Trademarks
- Legal

Copyright © 2000–2026 JetBrains s.r.o.
