Skip to content
DashboardGet API key

Get a background command

View .md
GET

Status and output of a command started with background: true. Readable while the sandbox is starting or running.

Authorization

  • Authorizationheaderrequired

    Bearer YOUR_API_KEY. Create a key in the dashboard.

Path parameters

  • sandboxIdstringrequired

    Sandbox ID.

  • commandIdstringrequired

    Background command ID, as returned when it was started.

Responses

200The command.
  • commandobjectrequired

    A background command.

    11 properties
    • idstringrequired
    • commandstringrequired
    • statusstringrequired

      unknown: the machine restarted its process supervisor and lost track of it; the output shown is what was written to disk.

      One ofrunningfinishedunknown
    • exitCodeintegerrequirednullable
    • stdoutstringrequired

      The last 1 MiB of standard output.

    • stderrstringrequired

      The last 1 MiB of standard error.

    • stdoutTruncatedboolean
    • stderrTruncatedboolean
    • startedAtstring<date-time>nullable
    • finishedAtstring<date-time>nullable
    • createdAtstring<date-time>required
401Unauthorized.
  • codestringrequired
  • messagestringrequired
  • detailsobject
404Sandbox or command not found.
  • 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