---
title: "GET /v1/sandboxes/{id}/fs/list"
method: GET
path: "/v1/sandboxes/{id}/fs/list"
tags: ["Sandboxes"]
---

# GET /v1/sandboxes/{id}/fs/list

`GET /v1/sandboxes/{id}/fs/list`

## Request

- Base URL: `/api` (relative, and the document was published on a file host, not at the API’s origin)
- URL: `/api/v1/sandboxes/{id}/fs/list`
- Auth: HTTP bearer

## Path parameters

- `id` string, required

## Query parameters

- `path` string, required
- `page` integer
- `page_size` integer

## Response `200`

One page of directory entries (exists=false when missing, is_dir=false for a file — not errors)

- DirectoryListingResponse
  - `entries` DirectoryEntry[], required: Directories first, then everything else, each group in byte order of the name. One page of the directory.
    - `kind` 'file' | 'directory' | 'symlink' | 'other', required: What a directory entry is. Symlinks are reported, never followed.
    - `name` string, required: Name within the directory, without any path.
  - `exists` boolean, required: `false` when the path does not exist (not an error).
  - `has_more` boolean, required: More entries exist after this page.
  - `is_dir` boolean, required: `false` when the path exists but is not a directory.
  - `page` integer, required: 1-based page these entries are.
  - `page_size` integer, required: Entries per page that was applied (default 20, at most 100).
  - `path` string, required
  - `total` integer, required: Entries in the whole directory, so `ceil(total / page_size)` is the number of pages. At most 10000: see `truncated`.
  - `truncated` boolean, required: The directory has more entries than the listing reads (10000), so `total` and the pages cover only the first 10000 names the filesystem returned.

## Other responses

- `400`: Validation error, or the directory is not readable by the sandbox user
- `404`: Sandbox not found
- `409`: Sandbox is not running (stopped or paused), so its filesystem cannot be listed

## Changes

> 75 revisions in range; 1 not diffed.

- **2026-10-14** `5cf062ead579`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/gotempsh/apis/temps/changes/v1/sandboxes/:id/fs/list/get.md)

---

[API](https://skmtc.dev/gotempsh/apis/temps.md) · [All operations](https://skmtc.dev/gotempsh/apis/temps/llms.txt) · [OpenAPI document](https://skmtc.dev/gotempsh/apis/temps/revisions/4153d360b2ff?raw)