Sign in

Deploy an app

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

Deploys your app to production, publishing your latest changes so they go live for its users. By default the app's current version is deployed. To deploy a specific saved version instead, pass its ID in the request body.

post/api/apps/{app_id}/deploy

Path parameters

app_idstring required

ID of the app to deploy.

ID of the app to deploy.

Request body

checkpoint_idstring nullable

ID of a specific saved version of the app to deploy. If omitted, the app's current version is deployed.

Example request

{
  "checkpoint_id": "6886b8d390dc7e2f4a2c91b3"
}

Response

Successful Response

app_idstring required

ID of the app that was deployed.

checkpoint_idstring nullable required

ID of the saved version associated with this deploy, or null if the app has no saved versions. The git commit hash identifies the exact code that was deployed.

git_commit_hashstring required

Git commit hash of the code that was deployed.

deployed_atstring date-time required

Time the app was deployed, as a UTC timestamp in ISO 8601 format.

Example response

{
  "app_id": "6820f3a4e7b91d003c45a1f2",
  "checkpoint_id": "6886b8d390dc7e2f4a2c91b3",
  "git_commit_hash": "a1b2c3d4e5f67890abcdef1234567890abcdef12",
  "deployed_at": "2026-08-02T14:30:00"
}

Changes