Developer Portal for YouTrack and Hub Help

Operations with Specific BackupFile

This resource lets you access the database backup files. The user account that performs the operation must have Low-level Read Administration permissions.

Resource

/api/admin/databaseBackup/backups/{fileID}

Returned entity

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

Supported methods

BackupFile attributes

Represents the backup file.

Related Resources

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

Attributes

This table describes attributes of the BackupFile 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 file. Read-only.

name

String

Name of the backup file. Read-only.

size

Long

Size of the file. Read-only.

creationDate

Long

The timestamp in milliseconds indicating the moment when the backup file was created. Stored as a unix timestamp at UTC. Read-only.

link

String

The link to the backup file. Read-only.

Read a Specific BackupFile

Get data on the specific backup file.

Required permissions

Requires permissions: Low-level Admin Read

Request syntax

GET /api/admin/databaseBackup/backups/{fileID}?{fields}

{fileID}

Name of the file.

Request parameters

Parameter

Type

Description

fields

String

A list of BackupFile attributes that should be returned in the response. If no field is specified, only the entityID is returned.

Sample

Sample request

https://example.youtrack.cloud/api/admin/databaseBackup/backups/2019-02-09-19-03-45.tar.gz?fields=creationDate,file,error,link,name,size,id

Sample response body

{ "name": "2019-02-09-19-03-45.tar.gz", "size": 26696777, "creationDate": 1549728231000, "link": "backupFile/2019-02-09-19-03-45.tar.gz", "error": null, "id": "2019-02-09-19-03-45.tar.gz", "$type": "BackupFile" }
Last modified: 8 February 2024