Cloud Backup API, REST: Backup.ListFiles
ListFiles of the backup.
HTTP request
GET https://backup.api.yandexcloud.kz/backup/v1/backups/{backupId}/files
Path parameters
|
Field |
Description |
|
backupId |
string Required field. Backup ID. |
Query parameters
|
Field |
Description |
|
folderId |
string Required field. Folder ID. |
|
sourceId |
string Empty source will list disks of the backup. |
Response
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
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.
|
|
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 |
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 To work with values in this field, use the APIs described in the |
Actions
|
Field |
Description |
|
restoreToDisk |
boolean Allows to send request to restore item to disk |
|
goToLocation |
boolean Allows to move to location by id. |