---
schema: rendered-html/v1
title: "Operations with Specific BackupStatus | Developer Portal for YouTrack and Hub Documentation"
source_url: https://www.jetbrains.com/help/youtrack/devportal/operations-api-admin-databaseBackup-settings-backupStatus.html
generated_at: 2026-06-11T15:04:29.429488+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
- [Operations with Specific DatabaseBackupSettings](jetbrains__com__help__youtrack__devportal__operations-api-admin-databasebackup-settings.md)
- Sub-resources
- Backup Status
- [Operations with Specific BackupStatus](operations-api-admin-databaseBackup-settings-backupStatus.html)
- Global Settings
- Organizations
- 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
5. [Sub-resources](#0)
6. Backup Status
7. [Operations with Specific BackupStatus](#0)

# Operations with Specific BackupStatus﻿

Last modified: 24 March 2026

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](/help/youtrack/devportal/operations-api-admin-databaseBackup-settings-backupStatus.html#BackupStatus-supported-fields) section. |
| Supported methods | - `GET`: [Read a Specific BackupStatus](/help/youtrack/devportal/operations-api-admin-databaseBackup-settings-backupStatus.html#get-BackupStatus-method). |

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

| null | The database ID of BackupStatus |
| --- | --- |

### 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"
}
```

- [Operations with Specific BackupStatus](/help/youtrack/devportal/operations-api-admin-databaseBackup-settings-backupStatus.html)
- [BackupStatus attributes](/help/youtrack/devportal/operations-api-admin-databaseBackup-settings-backupStatus.html#BackupStatus-supported-fields)
- [Read a Specific BackupStatus](/help/youtrack/devportal/operations-api-admin-databaseBackup-settings-backupStatus.html#get-BackupStatus-method)

Backup StatusGlobal Settings

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

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

![](https://bat.bing.com/action/0?ti=5220035&tm=gtm002&Ver=2&mid=ba4ab6bd-cdfc-4f42-8a7e-73ae673c7093&bo=4&sid=452929b065a111f19a7fe7356f74a419&vid=aa3122f0648711f1a10d6d095e10fd87&vids=0&msclkid=N&pi=918639831&lg=en-US&sw=1920&sh=1080&sc=24&tl=Operations%20with%20Specific%20BackupStatus%20%7C%20Developer%20Portal%20for%20YouTrack%20and%20Hub%20Documentation&p=https%3A%2F%2Fwww.jetbrains.com%2Fhelp%2Fyoutrack%2Fdevportal%2Foperations-api-admin-databaseBackup-settings-backupStatus.html&r=&lt=787&pt=1781190267375,33,33,,,2,2,2,2,2,,3,30,31,37,195,195,195,785,787,787&pn=0,0&evt=pageLoad&sv=2&asc=G&cdb=AQAS&rn=893431)
