MEmetabase
/api/notify

POST /api/notify/db/{id}

Changed on

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}

Request

  • Base URL
    (relative, and the document was published on a file host, not at the API’s origin)
  • Auth
    API key in header X-API-Key

Path parameters

idinteger required

value must be an integer greater than zero.

Request body

scan'full' | 'schema' nullable
synchronous?boolean nullable
table_idinteger nullable

value must be an integer greater than zero.

table_namestring nullable

value must be a non-blank string.

Response

Successful response

Changes

  • 2e178f5a7934Revision changes
    • breaking

      removed subschema #1 subschema #2 from the request property oneOf list

    • breaking

      removed subschema #1 subschema #2 from the request property oneOf list

    • breaking

      removed subschema #1 subschema #2 from the request property oneOf list

    • info

      added the new optional request property

    • info

      added subschema #1 subschema #2 to the request property anyOf list

    • info

      added subschema #1 subschema #2 to the request property anyOf list

    • info

      added subschema #1 subschema #2 to the request property anyOf list

  • 78297d193ca4Revision changes
    • info

      api operation id post-api-notify-db-id was added