---
title: "Get Database Metadata"
method: GET
path: "/databases/{id}/metadata"
tags: ["Databases"]
---

# Get Database Metadata

`GET /databases/{id}/metadata`

Get the metadata of a database

## Path parameters

- `id` string, objectid, required — ID of the database

## Response `200`

OK

- ControllersResponseGithubEntityDatabaseMetadata
  - `data` EntityDatabaseMetadata
    - `databases` EntityDatabase[]
      - `name` string
      - `tables` EntityDatabaseTable[]
        - `columns` EntityDatabaseColumn[]
          - `auto_increment` boolean
          - `children` EntityDatabaseColumn[]
          - `default` string
          - `extra` string
          - `hash` string
          - `key` string
          - `name` string
          - `not_null` boolean
          - `original_name` string
          - `primary` boolean
          - `status` string
          - `type` string
        - `indexes` EntityDatabaseIndex[]
          - `columns` EntityDatabaseIndexColumn[]
            - `name` string
            - `order` integer
          - `hash` string
          - `name` string
          - `original_name` string
          - `status` string
          - `type` string
          - `unique` boolean
        - `name` string
  - `error` string
  - `message` string
  - `status` string

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `500` — Internal Server Error

## Changes

- **2026-07-17** `c7a4715c1f13` — 2 breaking, 13 info
  - for the `path` request parameter `id`, the type/format was changed from `string`/`` to `string`/`objectid`
  - the response's body type/format changed from ``/`` to `object`/`` for status `200`
  - api operation id `get_database_metadata` was added
  - api tag `Databases` added
  - …11 more
- **2025-03-03** `14e4eafea538` — 1 breaking, 3 warning, 2 info
  - the response's body type/format changed from `object`/`` to ``/`` for status `200`
  - removed the optional property `code` from the response with the `200` status
  - removed the optional property `data` from the response with the `200` status
  - removed the optional property `message` from the response with the `200` status
  - …2 more
- **2025-03-02** `526e5bdf6dee` — 1 breaking, 3 warning, 8 info
  - added the pattern `^[0-9a-fA-F]{24}$` to the `path` request parameter `id`
  - removed the optional property `data/databases` from the response with the `200` status
  - removed the optional property `error` from the response with the `200` status
  - removed the optional property `status` from the response with the `200` status
  - …8 more

[Change history](https://skmtc.dev/crawlab-team/apis/crawlab-api/changes/databases/:id/metadata/get.md)

---

[API](https://skmtc.dev/crawlab-team/apis/crawlab-api.md) · [All operations](https://skmtc.dev/crawlab-team/apis/crawlab-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/crawlab-team/crawlab-api/revisions/c7a4715c1f13/schema)