GitLab Database dictionary API

openapi: 3.2.0
info:
  title: GitLab REST Database dictionary API
  description: GitLab REST API used to interact with a GitLab installation.
  termsOfService: https://handbook.gitlab.com/handbook/legal/api-terms/
  version: '19.6'
  license:
    name: CC BY-SA 4.0
    url: https://gitlab.com/gitlab-org/gitlab/-/blob/master/LICENSE
    x-gitlab-description: The license applies to the OpenAPI specification document itself. For terms governing use of the GitLab API, see the termsOfService field.
servers:
- url: https://{hostname}
  description: GitLab REST API
  variables:
    hostname:
      default: gitlab.com
      description: Your GitLab instance hostname
security:
- http: []
- oauth2: []
- apiKey: []
tags:
- name: Database dictionary
  description: '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.'
  x-displayName: Database dictionary
paths:
  /api/v4/databases/{database_name}/dictionary/tables:
    get:
      operationId: getApiV4DatabasesDatabaseNameDictionaryTables
      summary: List dictionary tables
      description: Returns database dictionary tables filtered by database and optional table size
      tags:
      - Database dictionary
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/APIEntitiesDictionaryTable'
        '401':
          description: 401 Unauthorized
        '403':
          description: 403 Forbidden
        '404':
          description: Not Found
        '400':
          description: Bad Request
      parameters:
      - name: database_name
        required: true
        description: Name of the database.
        schema:
          type: string
          enum:
          - main
          - ci
          - sec
          - embedding
          - geo
          minLength: 1
        in: path
      - name: table_size
        required: false
        description: Filter by table size classification.
        schema:
          type:
          - string
          - 'null'
          enum:
          - small
          - medium
          - large
          - over_limit
          - null
        in: query
  /api/v4/admin/databases/{database_name}/dictionary/tables/{table_name}:
    get:
      operationId: getApiV4AdminDatabasesDatabaseNameDictionaryTablesTableName
      summary: Retrieve dictionary details
      description: Provides table schema and column information from the GitLab database dictionary.
      tags:
      - Database dictionary
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesDictionaryTable'
        '401':
          description: 401 Unauthorized
        '403':
          description: 403 Forbidden
        '404':
          description: 404 Not found
        '400':
          description: Bad Request
      parameters:
      - name: database_name
        required: true
        description: Name of the database.
        schema:
          type: string
          enum:
          - main
          - ci
          minLength: 1
        in: path
      - name: table_name
        required: true
        description: Name of the table.
        schema:
          type: string
        in: path
components:
  schemas:
    APIEntitiesDictionaryTable:
      type: object
      properties:
        table_name:
          type: string
          example: users
        feature_categories:
          type: array
          example:
          - database
          items:
            type: string
        table_size:
          type: string
          example: small
  securitySchemes:
    http:
      type: http
      scheme: bearer
    oauth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://gitlab.com/oauth/authorize
          tokenUrl: https://gitlab.com/oauth/token
          refreshUrl: https://gitlab.com/oauth/token
          scopes:
            api: Grants complete read/write access to the API, including all groups and projects, the container registry, the dependency proxy, and the package registry.
            read_api: Grants read access to the API, including all groups and projects, the container registry, and the package registry.
            read_user: Grants read-only access to your profile through the /user API endpoint, which includes username, public email, and full name. Also grants access to read-only API endpoints under /users.
            create_runner: Grants create access to the runners.
            manage_runner: Grants access to manage the runners.
            k8s_proxy: Grants permission to perform Kubernetes API calls using the agent for Kubernetes.
            self_rotate: Grants permission for token to rotate itself.
            mcp: Grants read-write access to remote Model Context Protocol (MCP) server for tools execution.
            mcp_orbit: Grants access to the Orbit Knowledge Graph MCP server for graph queries and schema retrieval.
    apiKey:
      type: apiKey
      name: PRIVATE-TOKEN
      in: header