Skip to main content
GET
Get main sandbox update status

Authorizations

Authorization
string
header
required

Personal access token, sent as Authorization: Bearer <token>. Each operation lists the permission it needs: read_only or full_access. A full-access token can call every operation. A read-only token can call only the operations that list read_only; anything else returns 403 read_only_credential_route_not_allowed.

Path Parameters

app_id
string
required

ID of the imported app whose main sandbox to read or update.

Response

Successful Response

phase
enum<string>
required

Where the update is: idle when nothing is running, preparing, building, verifying and publishing while a commit moves to the preview, retiring while an old build is removed, and failed when the last update failed.

Available options:
idle,
preparing,
building,
verifying,
publishing,
retiring,
failed
Example:

"idle"

active_generation
ActiveGenerationResponse · object | null
required

The build the preview serves now, or null before the first one.

failure
FailureResponse · object | null
required

The last failure in your repository's code, or null when there's none to act on.

initial_setup_pending
boolean
default:false

true while the app's first setup is still pending. Updates don't run until it finishes.

Example:

false