Files API, REST: File.List

List files in a specific folder.

HTTP request

GET https://rest-assistant.api.cloud.yandex.net/files/v1/files

Query parameters

Request message for listing files in a specific folder.

Field

Description

folderId

string

Required field. Folder ID from which to list files.

pageSize

string (int64)

Maximum number of files to return per page.

pageToken

string

Token to retrieve the next page of results.

Response

HTTP Code: 200 - OK

{
          "files": [
            {
              "id": "string",
              "folderId": "string",
              "name": "string",
              "description": "string",
              "mimeType": "string",
              "createdBy": "string",
              "createdAt": "string",
              "updatedBy": "string",
              "updatedAt": "string",
              "expirationConfig": {
                "expirationPolicy": "string",
                "ttlDays": "string"
              },
              "expiresAt": "string",
              "labels": "object"
            }
          ],
          "nextPageToken": "string"
        }

Response message for the list operation.

Field

Description

files[]

File

List of files in the specified folder.

nextPageToken

string

Token to retrieve the next page of results.

File

Field

Description

id

string

Unique identifier of the file.

folderId

string

ID of the folder that the file belongs to.

name

string

Name of the file.

description

string

Description of the file.

mimeType

string

MIME type of the file, indicating the file's format (e.g., "application/pdf")

createdBy

string

Identifier of the subject who created this file.

createdAt

string (date-time)

Timestamp representing when the file was created.

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).

updatedBy

string

Identifier of the subject who last updated this file.

updatedAt

string (date-time)

Timestamp representing the last time this file was updated.

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).

expirationConfig

ExpirationConfig

Configuration for the expiration of the file, defining when and how the file will expire.

expiresAt

string (date-time)

Timestamp representing when the file will expire.

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).

labels

object (map<string, string>)

Set of key-value pairs that can be used to organize and categorize the file.

ExpirationConfig

Field

Description

expirationPolicy

enum (ExpirationPolicy)

  • EXPIRATION_POLICY_UNSPECIFIED
  • STATIC
  • SINCE_LAST_ACTIVE

ttlDays

string (int64)
Previous
Delete
Next
Overview