Skip to main content
GET
List a directory in a session's sandbox

Authorizations

Authorization
string
header
required

API key with the vk_ prefix. Create one from the dashboard.

Path Parameters

session_id
string
required

Session ID

Query Parameters

path
string

Absolute path under /workspace (listing default: /workspace). Other query parameters (list=1) are accepted and ignored: a directory is always listed.

Response

The path and, for a directory, its entries

O11: what a path in /workspace is (GET /v1/sessions/{id}/files): symlinks resolved; a directory carries its immediate entries.

path
string
required

The resolved path (symlinks followed; always under /workspace).

type
string
required

file | directory | symlink | ...

object
string
required
size
integer<int64> | null

Bytes, for a file.

entries
object[]

A directory's entries, sorted by name (at most 1000).

truncated
boolean

More than 1000 entries: the rest were left out.