Get main sandbox update status

Changed on

<Info>This API is in beta. Endpoints, fields, and behavior may still change, so avoid depending on it in production.</Info>

Returns the state of the imported app's main sandbox: the preview that runs the branch the app was imported from, usually your repository's default branch.

When that branch moves, Base44 builds a new candidate at that commit, checks that its services come up healthy, and then switches the preview to it. phase says where that is, and active_generation is the commit the preview serves now. The editor asks for updates while the app is open in it. From CI or a script, call Check for main sandbox updates after a merge, then poll this endpoint.

failure describes the last build or verification failure of your repository's code. A failed phase can still come with a null failure when the cause was on Base44's side or during the app's first setup.

This endpoint is limited to 120 requests per minute per user, reported in the X-RateLimit-* headers.

<Note>This endpoint accepts a personal API key or personal access token belonging to a user with editor access to the app. A read-only key is refused, and workspace API keys are not accepted. Send credentials in a header: an api_key query parameter is refused.</Note>

get/api/apps/{app_id}/imported/main-update

Request

  • Base URL: https://app.base44.com
  • URL: https://app.base44.com/api/apps/{app_id}/imported/main-update
  • Auth: HTTP bearer

Path parameters

app_idstring required

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

Response

Successful Response

phase'idle' | 'preparing' | 'building' | 'verifying' | 'publishing' | 'retiring' | 'failed' 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.

initial_setup_pendingboolean

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

Example response

{
  "phase": "idle",
  "active_generation": {
    "id": "5f1c0e2a9b7d4c3e8a6f1b2d3c4e5f60",
    "commit": "9fceb02d0ae598e95dc970b74767f19372d61af8"
  },
  "failure": {
    "id": "0d4c2b1a9e8f7a6b5c4d3e2f1a0b9c8d",
    "commit": "1a2b3c4d5e6f708192a3b4c5d6e7f8091a2b3c4d",
    "stage": "verification",
    "diagnostics": "The web service didn't become healthy."
  }
}

Changes