Sign in

Unpublish app

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

Takes a published app offline.

Visitors get an offline notice instead of the app. You can keep working on it in the editor, and its data, settings, and custom domains stay as they are. To put it back online, publish it again with Deploy an app.

<Note>This endpoint accepts a personal API key belonging to a user with editor access to the app. A read-only key is refused, and workspace API keys are not accepted.</Note>

<Warning>The response includes fields beyond the ones documented here. Don't rely on undocumented response fields, as they can change at any time.</Warning>

post/api/apps/{app_id}/undeploy

Path parameters

app_idstring required

ID of the app to unpublish.

ID of the app to unpublish.

Response

The app, now offline.

idstring required

ID of the app.

namestring required

Display name of the app.

is_unpublishedboolean required

Whether the app is offline. Always true here, because the unpublish succeeded.

last_deployed_atstring date-time required

Time the app was last published, as a UTC timestamp in ISO 8601 format. Unpublishing doesn't change it.

Example response

{
  "id": "6820f3a4e7b91d003c45a1f2",
  "name": "My CRM",
  "is_unpublished": true,
  "last_deployed_at": "2026-08-02T14:30:00"
}

Changes

Changed in 1 of the 14 revisions of this API.1