Skip to content
DashboardGet API key

Read a file

View .md
GET

Authorization

  • Authorizationheaderrequired

    Bearer YOUR_API_KEY. Create a key in the dashboard.

Path parameters

  • sandboxIdstringrequired

    Sandbox ID.

Query parameters

  • pathstringrequired

    Absolute, or relative to /home/user. Must resolve under /home/user or /tmp.

  • encodingstring

    Use base64 for binary files.

    One ofutf8base64
    Defaultutf8

Responses

200The file.
  • fileobjectrequired
    4 properties
    • pathstringrequired
    • contentstring

      Present on read.

    • encodingstring
      One ofutf8base64
    • sizeintegerrequired

      Bytes.

400Missing or invalid `path`, or a path outside `/home/user` and `/tmp`.
  • 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
413`file_too_large`: the file is larger than 5 MiB.
  • codestringrequired
  • messagestringrequired
  • detailsobject