Yandex Cloud
Search
Contact UsGet started
  • Blog
  • Pricing
  • Documentation
  • All Services
  • System Status
    • Featured
    • Infrastructure & Network
    • Data Platform
    • Containers
    • Developer tools
    • Serverless
    • Security
    • Monitoring & Resources
    • ML & AI
    • Business tools
  • All Solutions
    • By industry
    • By use case
    • Economics and Pricing
    • Security
    • Technical Support
    • Customer Stories
    • Start testing with double trial credits
    • Cloud credits to scale your IT product
    • Gateway to Russia
    • Cloud for Startups
    • Education and Science
    • Yandex Cloud Partner program
  • Blog
  • Pricing
  • Documentation
© 2025 Direct Cursus Technology L.L.C.
Yandex Cloud Backup
  • Getting started
    • All guides
    • Activating the service
    • Viewing service resource operations
    • Limiting RAM usage by the Cloud Backup agent
    • Viewing backup statistics
  • Access management
  • Pricing policy
  • Terraform reference
    • API authentication
      • Overview
        • Overview
        • List
        • ListArchives
        • ListFiles
        • Get
        • StartRecovery
        • Delete
  • Monitoring metrics
  • Audit Trails events
  • Release notes
  • Troubleshooting

In this article:

  • HTTP request
  • Path parameters
  • Query parameters
  • Response
  • BackupFile
  • Actions
  1. API reference
  2. REST
  3. Backup
  4. ListFiles

Cloud Backup API, REST: Backup.ListFiles

Written by
Yandex Cloud
Updated at November 26, 2024
  • HTTP request
  • Path parameters
  • Query parameters
  • Response
  • BackupFile
  • Actions

ListFiles of the backup.

HTTP requestHTTP request

GET https://backup.api.cloud.yandex.net/backup/v1/backups/{backupId}/files

Path parametersPath parameters

Field

Description

backupId

string

Required field. Backup ID.

Query parametersQuery parameters

Field

Description

folderId

string

Required field. Folder ID.

sourceId

string

Empty source will list disks of the backup.

ResponseResponse

HTTP Code: 200 - OK

{
  "files": [
    {
      "id": "string",
      "parentId": "string",
      "type": "string",
      "fullPath": "string",
      "name": "string",
      "size": "string",
      "actions": {
        "restoreToDisk": "boolean",
        "goToLocation": "boolean"
      },
      "modifiedAt": "string"
    }
  ]
}

Field

Description

files[]

BackupFile

BackupFileBackupFile

BackupFile represents a single unit of file or directory system inside the backup.

Field

Description

id

string

Required field. ID of the item. Should be used as source ID in case of listing.

parentId

string

Might be empty if this is root directory.

type

enum (Type)

Required field. Type of the item.

  • TYPE_UNSPECIFIED
  • TYPE_DIR
  • TYPE_FILE

fullPath

string

Required field. Absolute path of the item.

name

string

Required field. Name of the directory / file.

size

string (int64)

Size in bytes of the item.

actions

Actions

Required field. Actions that might be done on the object.

modifiedAt

string (date-time)

Required field. String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

ActionsActions

Field

Description

restoreToDisk

boolean

Allows to send request to restore item to disk

goToLocation

boolean

Allows to move to location by id.

Was the article helpful?

Previous
ListArchives
Next
Get
© 2025 Direct Cursus Technology L.L.C.