Metainformation about a file or folder

To request metainformation about files and folders, specify the path to the corresponding resource on Yandex.Disk. Metainformation includes the properties of files and folders, and the properties and contents of subfolders.

For metainformation about a public resource that does not belong to the user, there is a separate request.

Request format

Use the GET method to send a request for metainformation. The request URL is slightly different for requesting resources located in the Trash.

https://cloud-api.yandex.net/v1/disk/resources
 ? path=<resource path>
 & [fields=<properties to include in the response>]
 & [limit=<maximum number of returned resources>]
 & [offset=<offset from the top of the list>]
 & [preview_crop=<whether to crop the preview>]
 & [preview_size=<preview size>]
 & [sort=<sorting attribute>]
Query parameters
path *

The path to the desired resource is relative to the Yandex.Disk root directory. The path to a resource in the Trash should be relative to the Trash root directory.

The path in the parameter value should be URL-encoded.

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: name, _embedded. items. path.

limit

The number of resources in the folder that should be described in the response (for example, for paginated output).

The default value is 20.

offset

The number of resources in the folder that should be skipped in the response (use for paginated output). The list is sorted according to the sort parameter value.

Let's say the /foo folder contains three files. For a folder metainformation request with the offset=1 parameter, the Yandex.Disk API returns only the second and third file descriptions.

preview_crop

This parameter crops the preview to the size specified in the preview_size parameter.

Acceptable values:

  • false — The parameter is ignored (default value).

  • true — Crop the preview as follows:

    • If only the width or height is passed, the image is reduced to this size with the proportions preserved. Then a square with the specified length of side is cut out of the center of the reduced image.

    • If the exact size is passed (for example, "120x240"), a section is cut from the center of the source image with the maximum size in the set proportions of width to height. Then the cropped section is scaled to the specified dimensions.

preview_size

The desired size of the thumbnail (preview) file. The thumbnail link is returned in the preview key.

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 preview_crop parameter.

Possible values
  • Predefined length of the longest side.

    The image is reduced to the specified length of the longest side, and the proportions of the source image are preserved. For example, for the "S" size and a 120×200 image, a 90×150 preview is generated. For a 300×100 image, the preview is 150×50.

    Supported values:

    • "S" — 150 pixels.

    • "M" — 300 pixels.
    • "L" — 500 pixels.
    • "XL" — 800 pixels.
    • "XXL" — 1024 pixels.
    • "XXXL" — 1280 pixels.
  • The exact width (for example, "120" or "120x") or the exact height (for example, "x145").

    The image is reduced to the specified width or height, and the proportions of the source image are preserved.

    If the preview_crop parameter is passed, a square with the set side length is cut out of the center of the reduced image.

  • The exact size (in the <width>x<height> format, for example "120x240").

    The image is reduced to the smallest of the specified dimensions, and the proportions of the source image are preserved.

    If the preview_crop parameter is passed, a section is cut from the center of the source image with the maximum size in the set proportions of width to height (in the example, this is 1 to 2). Then the cropped section is scaled to the specified dimensions.

sort

The attribute used to sort the list of resources in the folder. The following properties of the Resource object can be used as a value:

  • name (resource name)
  • path (path to the resource on Yandex.Disk)
  • created (date the resource was created)
  • modified (date the resource was modified)
  • size (file size)

To sort in reverse order, add a hyphen to the parameter value, for example: sort=-name.

*  Required

Response format

If the request was processed without errors, the Yandex.Disk API responds with the code 200 OK and returns the metainformation about the requested resource in the response body, in the Resource object. If the request caused an error, the relevant response code is returned, and the response body contains the error description.

For non-empty folders, the response includes the ResourceList object (under the _embedded name). Each resource in the folder is an element of the items array. Regardless of the requested sorting, resources in the array are ordered by type: first all the subfolders are listed, then all the files.

An example response is shown for the published folder /foo, which contains the folder /bar and the file photo.png:

{  "public_key": "HQsmHLoeyBlJf8Eu1jlmzuU+ZaLkjPkgcvmokRUCIo8=",  "_embedded": {    "sort": "",    "path": "disk:/foo",    "items": [      {        "path": "disk:/foo/bar",        "type": "dir",        "name": "bar",        "modified": "2014-04-22T10:32:49+04:00",        "created": "2014-04-22T10:32:49+04:00"      },      {        "name": "photo.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/photo.png",        "md5": "4334dc6379c8f95ddf11b9508cfea271",        "type": "file",        "mime_type": "image/png",        "size": 34567      }    ],    "limit": 20,    "offset": 0  },  "name": "foo",  "created": "2014-04-21T14:54:42+04:00",  "custom_properties": {"foo":"1", "bar":"2"},  "public_url": "https://yadi.sk/d/2AEJCiNTZGiYX",  "modified": "2014-04-22T10:32:49+04:00",  "path": "disk:/foo",  "type": "dir"}
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, trash:/foo_1408546879). Use this ID to differentiate the resource from other deleted resources with the same name.

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:

  • “dir” — folder
  • “file” — file
mime_type The MIME type of the file.
size File size.
Element Description
sort

The field used for sorting the list.

public_key

The key of a published folder that contains resources from this list.

It is included in the response only if metainformation about a public folder is requested.

items

Array of resources (Resource) contained in the folder.

Regardless of the requested sorting, resources in the array are ordered by type: first all the subfolders are listed, then all the files.

limit

The maximum number of items in the items array; set in the request.

offset

How much to offset the beginning of the list from the first resource in the folder.

path

The path to the folder whose contents are described in this ResourceList object.

For a public folder, the value of the attribute is always "/".

total

The total number of resources in the folder.