v12

latestOpenAPI 3.1.0AGPL-3.0raw.githubusercontent.com2026-05-286377631.6 MB
/api/notify

POST /api/notify/db/{id}

Notification about a potential schema change to one of our Databases. Caller can optionally specify a :table_id or :table_name in the body to limit updates to a single Table. Optional Parameter :scan can be "full" or "schema" for a full sync or a schema sync, available regardless if a :table_id or :table_name is passed. This endpoint is secured by an API key that needs to be passed as a X-METABASE-APIKEY header which needs to be defined in the MB_API_KEY environment variable

post/api/notify/db/{id}

Path parameters

idinteger required

value must be an integer greater than zero.

Request body

scan'full' | 'schema' nullable
table_idinteger nullable

value must be an integer greater than zero.

table_namestring nullable

Response

Successful response