Skip to content

List a directory

View .md
GET

One level, sorted by name.

Authorization

  • Authorizationheaderrequired

    Bearer YOUR_API_KEY. Create a key in the dashboard.

Path parameters

  • sandboxIdstringrequired

    Sandbox ID.

Query parameters

  • pathstring
    Default/home/user

Responses

200Entries.
  • pathstringrequired
  • filesobject[]required
    5 properties
    • namestringrequired
    • pathstringrequired
    • isDirbooleanrequired
    • sizeintegerrequired
    • modifiedAtstring<date-time>required
  • truncatedbooleanrequired

    True when the directory holds more than 10,000 entries.

400Invalid path.
  • codestringrequired
  • messagestringrequired
  • detailsobject
401Unauthorized.
  • codestringrequired
  • messagestringrequired
  • detailsobject
404Sandbox not found, or it belongs to another project.
  • codestringrequired
  • messagestringrequired
  • detailsobject
409`sandbox_not_running`: the sandbox is stopped, stopping, failed or deleted; resume it first. `sandbox_not_ready`: it is still starting and did not become ready in time; retry.
  • codestringrequired
  • messagestringrequired
  • detailsobject