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

---

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