Skip to content
Hayonix

API reference · Schema

SandboxFileList

  • objectstringrequired

    Always `list`: the type of this object

    One oflist

  • pathstringrequired

    The directory listed, relative to the workspace

  • The items

    Show 6 fields of data
    • objectstringrequired

      Always `sandbox_file`: the type of this object

      One ofsandbox_file

    • namestringrequired

      Its name

    • pathstringrequired

      Relative to the workspace

    • typestringrequired

      `file`, `directory`, `symlink` (a symbolic link) or `other` (for example a socket)

      One offiledirectorysymlinkother

    • sizeintegerrequired

      Size in bytes

    • modified_atstring (date-time)required

      Time modified (ISO 8601, UTC)

  • next_cursorany JSON | nullrequired

    Always null: a listing is one page, cut short when `truncated` is true

  • truncatedbooleanrequired

    More than 1000 entries: the rest are left out

Example
{
  "object": "list",
  "path": "string",
  "data": [
    {
      "object": "sandbox_file",
      "name": "string",
      "path": "string",
      "type": "file",
      "size": 1,
      "modified_at": "2026-01-01T00:00:00.000Z"
    }
  ],
  "next_cursor": {},
  "truncated": true
}

Used by