Files

List a guest directory

Reads directory entry names, types and regular-file sizes through the guest agent. Requires member access, like file downloads. The computer must already be running; listing never resumes it or extends its idle timer. The dashboard Files panel opens the guest user’s Desktop directory by default.

Supported on Linux images with /usr/bin/python3. The fixed helper examines at most 512 entries and returns at most 128 KiB of JSON. A large directory returns truncated: true; the response is an unordered subset, not a page with a continuation token. Open a more specific directory by path to narrow the result.

Entries are inspected without following symbolic links. A directory path whose final component is a symlink is refused. Control characters and non-UTF-8 filenames are omitted and counted in skipped. Metadata can change before a subsequent transfer; the existing file transfer path and size rules still apply. Clicking a name in the dashboard never executes a file.

Requires the member role or higher.

get/computers/{id}/files/list

Request

  • Base URL: https://app.mandala.computer/api/v1
  • URL: https://app.mandala.computer/api/v1/computers/{id}/files/list
  • Auth: HTTP bearer

Path parameters

idstring required

The computer id.

Query parameters

pathstring required

Absolute directory path inside the guest.

Response

A bounded directory listing, with explicit partial and skipped flags.

pathstring required

The requested directory path.

truncatedboolean required

True when the directory exceeded the bounded listing. Entries are a partial, unordered sample, not a complete listing.

skippedinteger required

Number of inspected names omitted because their encoding or control characters cannot be used by this file API.

Changes

No recorded changes to this operation across all 1 revision of this API.