/api/database

GET /api/database/{id}/schemas

Changed on

Returns a list of all the schemas with tables found for the database id. Excludes schemas with no tables.

Optional filters:

  • can-query=true - filter to only schemas containing tables the user can query
get/api/database/{id}/schemas

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_editable_data_modelboolean nullable

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

include_hiddenboolean nullable

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

can-queryboolean nullable

Response

Successful response

string[] required

Changes

    • warning

      deleted the query request parameter can-write-metadata

    • info

      the query request parameter include_editable_data_model became optional

    • info

      the query request parameter include_hidden became optional

    • warning

      deleted the query request parameter include_workspace