SnozeDevelopers
API referenceDatabase publish

Publish a database to the web

Turns a database into a public read-only data page and returns the stored configuration, deriving the slug from `slug` or the database label and de-duplicating it against every published page, database, and view in the one global `/wp` address space. Requires a signed-in workspace session with full (`databases:write`) access to the database's item; a database that is not in the workspace tree, or that does not exist, is rejected as not publishable.

PUT
/v1/workspaces/{workspaceId}/databases/{databaseId}/publish

Authorization

apiKey
headerAuthorizationBearer <snoze_sk_…>

Workspace API key created in Workspace settings → API keys. Scopes on the key bound what it can read and write.

Path Parameters

workspaceId*string
databaseId*string

Request Body

application/json
  1. body
slug?string|null
seoIndexed?boolean|null
updateMode?|null

Response Body

Success

application/json
  1. response
data*
Example Request
curl -X PUT 'https://api.snoze.dev/v1/workspaces/string/databases/string/publish' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response
{  "data": {    "enabled": true,    "slug": "string",    "seoIndexed": true,    "publishedAt": "string",    "updateMode": "snapshot"  }}

Withdraw a database from the web

Disables the database's public page while retaining its slug, so republishing later reuses the same address; a database that was never published is left untouched. Requires a signed-in workspace session with full (`databases:write`) access to the database's item.

Read the publish-to-web settings of a standalone view

Returns the standalone view's public configuration, or `enabled: false` when it has never been published. Requires a signed-in workspace session with view read access plus `records:read` on the source database, and a personal view can only be inspected by its owner; only standalone views can be published, so an embedded view or an unknown view is rejected as not publishable.