MEmetabase
/api/database

GET /api/database/{id}/metadata

Changed on

Get metadata about a Database, including all of its Tables and Fields. Returns DB, fields, and field values. By default only non-hidden tables are returned. Passing include_hidden=true includes them.

Passing include_sensitive_fields=true includes fields with visibility_type sensitive, for tables whose data model the current user can edit.

Passing include_editable_data_model will only return tables for which the current user has data model editing permissions. Granting data model permissions to non-admins requires Enterprise Edition code and a token with the advanced-permissions feature; without both, this is admin-only. In addition, if the user has no data access for the DB (aka block permissions), it will return only the DB name, ID and tables, with no additional metadata.

get/api/database/{id}/metadata

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.

Query parameters

include_hiddenboolean nullable

value must be a valid boolean string ('true' or 'false').

include_sensitive_fieldsboolean nullable

value must be a valid boolean string ('true' or 'false').

include_editable_data_modelboolean nullable

value must be a valid boolean string ('true' or 'false').

remove_inactiveboolean nullable

value must be a valid boolean string ('true' or 'false').

skip_fieldsboolean nullable

value must be a valid boolean string ('true' or 'false').

Response

Successful response

Changes

  • 2e178f5a7934Revision changes
    • info

      added the new optional query request parameter include_sensitive_fields

    • info

      the query request parameter include_editable_data_model became optional

    • info

      the query request parameter include_hidden became optional

    • info

      the query request parameter remove_inactive became optional

    • info

      the query request parameter skip_fields became optional

  • 78297d193ca4Revision changes
    • info

      api operation id get-api-database-id-metadata was added