Database dictionary

Use this API to list the tables in a GitLab database and retrieve the database dictionary entry for a single table.

Retrieving the entry for a single table requires administrator access to the instance.

Retrieve dictionary details

GET /api/v4/admin/databases/{database_name}/dictionary/tables/{table_name}

Parameters

Name	Type	Description
`database_name` Path, required	String	Name of the database Allowed values: `main`, `ci` Minimum length: `1`
`table_name` Path, required	String	Name of the table

Responses

Code	Description	Schema
`200`	OK	APIEntitiesDictionaryTable
`400`	Bad Request	—
`401`	401 Unauthorized	—
`403`	403 Forbidden	—
`404`	404 Not found	—

GET /api/v4/databases/{database_name}/dictionary/tables

Returns database dictionary tables filtered by database and optional table size

Parameters

Name	Type	Description
`database_name` Path, required	String	Name of the database Allowed values: `main`, `ci`, `sec` Minimum length: `1`
`table_size` Query	String	Filter by table size classification Allowed values: `small`, `medium`, `large`, `over_limit`

Responses

Code	Description	Schema
`200`	OK	Array of APIEntitiesDictionaryTable
`400`	Bad Request	—
`401`	401 Unauthorized	—
`403`	403 Forbidden	—
`404`	Not Found	—

Objects returned by the operations above and objects nested in their request bodies.