Skip to main content
GET
Get the archive status

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

200 - application/json

Archive status

state
enum<string>
required
Available options:
active,
quiescing,
quiesced,
restoring
Example:

"quiesced"

export
object

Export reports the export started asynchronously, if there was one. It is how a caller that did not wait for the export learns that the archive is on the storage, or why it is not.

readOnlyRoot
boolean

ReadOnlyRoot reports whether the root mount was remounted read-only, which is what actually stops writes; false means the freeze relies only on the API refusing calls, and the reason says why.

Example:

true

reason
string

Reason is a human readable explanation of why the sandbox is frozen.

Example:

"archive export"

restore
object

Restore reports the archive this sandbox was started from, if it was started from one: how far its restore has got, and how it ended.

since
string

Since is when the sandbox left StateActive.

stoppedProcesses
string[]

StoppedProcesses are the process identifiers stopped while quiescing.

Last modified on August 26, 2026