Flat list of all files
The API returns a flat list of all files on Yandex.Disk in alphabetical order. The flat list does not reflect the folder structure, so it is convenient to search for a particular file type spread across different folders.
Request format
Use the GET method to send the request for a list of all files.
https://cloud-api.yandex.net/v1/disk/resources/files
? [limit=<number of files in the list>]
& [media_type=<type of requested files>]
& [offset=<offset from the top of the list>]
& [fields=<properties to include in the response>]
& [preview_size=<preview size>]
& [preview_crop=<whether to crop the preview>]
limit | The number of files that should be described in the response (for example, for paginated output). The default value is 20. |
media_type | The type of files to include in the list. Yandex.Disk detects the type of each downloaded file. To request multiple file types, list them in the parameter value and separate with commas. For example, Supported types:
|
offset | The number of resources from the top of the list that should be skipped in the response (used for paginated output). Let's say the /foo folder contains three files. For a folder metainformation request with the |
fields | List of JSON keys to include in the response. Keys that are not included in this list will be discarded when forming the response. If the parameter is omitted, the response is returned in full, without discarding anything. Key names should be comma-separated, and embedded keys should be separated by dots. For example: |
preview_size | The desired size of the thumbnail (preview) file. The thumbnail link is returned in the You can define the exact size of the preview, or the length of one of the sides. The resulting image can be cropped to a square using the
Possible values |
preview_crop | This parameter crops the preview to the size specified in the Acceptable values:
|
limit | The number of files that should be described in the response (for example, for paginated output). The default value is 20. |
media_type | The type of files to include in the list. Yandex.Disk detects the type of each downloaded file. To request multiple file types, list them in the parameter value and separate with commas. For example, Supported types:
|
offset | The number of resources from the top of the list that should be skipped in the response (used for paginated output). Let's say the /foo folder contains three files. For a folder metainformation request with the |
fields | List of JSON keys to include in the response. Keys that are not included in this list will be discarded when forming the response. If the parameter is omitted, the response is returned in full, without discarding anything. Key names should be comma-separated, and embedded keys should be separated by dots. For example: |
preview_size | The desired size of the thumbnail (preview) file. The thumbnail link is returned in the You can define the exact size of the preview, or the length of one of the sides. The resulting image can be cropped to a square using the
Possible values |
preview_crop | This parameter crops the preview to the size specified in the Acceptable values:
|
Response format
If the request was processed without errors, the Yandex.Disk API responds with the code 200 OK
and returns metainformation about the requested number of files in the response body, in the FilesResourceList
. If the request caused an error, the relevant response code is returned, and the response body contains the error description.
Sample response:
{ "items": [ { "name": "photo2.png", "preview": "https://downloader.disk.yandex.ru/preview/...", "created": "2014-04-22T14:57:13+04:00", "modified": "2014-04-22T14:57:14+04:00", "path": "disk:/foo/photo2.png", "md5": "53f4dc6379c8f95ddf11b9508cfea271", "type": "file", "mime_type": "image/png", "size": 54321 }, { "name": "photo1.png", "preview": "https://downloader.disk.yandex.ru/preview/...", "created": "2014-04-21T14:57:13+04:00", "modified": "2014-04-21T14:57:14+04:00", "path": "disk:/foo/photo1.png", "md5": "4334dc6379c8f95ddf11b9508cfea271", "type": "file", "mime_type": "image/png", "size": 34567 } ], "limit": 20, "offset": 0 }
Element | Description |
---|---|
items | Array of recently uploaded files ( Resource ). |
limit | The maximum number of items in the |
offset | How much to offset the beginning of the list from the first resource in the folder. |
Element | Description |
public_key | Key of a published resource. It is included in the response only if the specified file or folder is published. |
public_url | Link to a published resource. It is included in the response only if the specified file or folder is published. |
_embedded | The resources located in the folder (contains the ResourceList object). It is included in the response only when folder metainformation is requested. |
preview | Link to a small image (preview) for the file. It is included in the response only for files that support graphic formats. The preview can only be requested using the OAuth token of a user who has access to the file itself. |
name | Resource name. |
custom_properties | An object with all attributes set with the Adding metainformation for a resource request. Contains only keys in the name:value format (cannot contain objects or arrays). |
created | The date and time when the resource was created, in ISO 8601 format. |
modified | The date and time when the resource was modified, in ISO 8601 format. |
path | Full path to the resource on Yandex.Disk. In metainformation for a published folder, paths are relative to the folder itself. For published files, the value of the key is always "/". For a resource located in the Trash, this attribute may have a unique ID appended to it (for example, |
origin_path | Path to the resource before it was moved to the Trash. Included in the response only for a request for metainformation about a resource in the Trash. |
md5 | MD5 hash of the file. |
type | Resource type:
|
mime_type | The MIME type of the file. |
size | File size. |
Element | Description |
---|---|
items | Array of recently uploaded files ( Resource ). |
limit | The maximum number of items in the |
offset | How much to offset the beginning of the list from the first resource in the folder. |
Element | Description |
public_key | Key of a published resource. It is included in the response only if the specified file or folder is published. |
public_url | Link to a published resource. It is included in the response only if the specified file or folder is published. |
_embedded | The resources located in the folder (contains the ResourceList object). It is included in the response only when folder metainformation is requested. |
preview | Link to a small image (preview) for the file. It is included in the response only for files that support graphic formats. The preview can only be requested using the OAuth token of a user who has access to the file itself. |
name | Resource name. |
custom_properties | An object with all attributes set with the Adding metainformation for a resource request. Contains only keys in the name:value format (cannot contain objects or arrays). |
created | The date and time when the resource was created, in ISO 8601 format. |
modified | The date and time when the resource was modified, in ISO 8601 format. |
path | Full path to the resource on Yandex.Disk. In metainformation for a published folder, paths are relative to the folder itself. For published files, the value of the key is always "/". For a resource located in the Trash, this attribute may have a unique ID appended to it (for example, |
origin_path | Path to the resource before it was moved to the Trash. Included in the response only for a request for metainformation about a resource in the Trash. |
md5 | MD5 hash of the file. |
type | Resource type:
|
mime_type | The MIME type of the file. |
size | File size. |