---
title: "Query Database"
method: POST
path: "/databases/{id}/query"
tags: ["Databases"]
---

# Query Database

`POST /databases/{id}/query`

Query a database

## Path parameters

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

## Request body

- QueryDatabaseInput
  - `database` string — Name of the database to query
  - `query` string, required — SQL query to execute

## Response `200`

OK

- ControllersResponseGithubEntityDatabaseQueryResults
  - `data` EntityDatabaseQueryResults
    - `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
    - `error` string
    - `output` string
    - `rows` object[]
  - `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)