Skip to content
ShipSquares

/db-connections/{id}/query

POST
/db-connections/{id}/query
 
curl --request POST \
  --url https://example.com/api/v1/db-connections/example/query \
  --header 'Content-Type: application/json' \
  --data '{ "sql": "example", "confirm": true }'

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
id
required
string

Request Body required

Section titled “Request Body required ”
Media type application/json
object
sql
required
string
>= 1 characters <= 20000 characters
confirm
boolean
Example generated
{
  "sql": "example",
  "confirm": true
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Default Response

Media type application/json
object
fields
required
Array<object>
object
name
required
string
dataType
required
string
rows
required
Array<object>
object
key
additional properties
rowCount
required
integer
command
required
string
elapsedMs
required
integer
truncated
required
boolean
Example generated
{
  "fields": [
    {
      "name": "example",
      "dataType": "example"
    }
  ],
  "rows": [
    {
      "additionalProperty": "example"
    }
  ],
  "rowCount": 1,
  "command": "example",
  "elapsedMs": 1,
  "truncated": true
}

400

Section titled “400 ”

Default Response

Media type application/json
object
type
required
string
title
required
string
status
required
integer
code
required
string
detail
string
instance
string
errors
Array<object>
object
path
required
string
message
required
string
Example generated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "code": "example",
  "detail": "example",
  "instance": "example",
  "errors": [
    {
      "path": "example",
      "message": "example"
    }
  ]
}

403

Section titled “403 ”

Default Response

Media type application/json
object
type
required
string
title
required
string
status
required
integer
code
required
string
detail
string
instance
string
errors
Array<object>
object
path
required
string
message
required
string
Example generated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "code": "example",
  "detail": "example",
  "instance": "example",
  "errors": [
    {
      "path": "example",
      "message": "example"
    }
  ]
}

404

Section titled “404 ”

Default Response

Media type application/json
object
type
required
string
title
required
string
status
required
integer
code
required
string
detail
string
instance
string
errors
Array<object>
object
path
required
string
message
required
string
Example generated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "code": "example",
  "detail": "example",
  "instance": "example",
  "errors": [
    {
      "path": "example",
      "message": "example"
    }
  ]
}

409

Section titled “409 ”

Default Response

Media type application/json
object
type
required
string
title
required
string
status
required
integer
code
required
string
detail
string
instance
string
errors
Array<object>
object
path
required
string
message
required
string
Example generated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "code": "example",
  "detail": "example",
  "instance": "example",
  "errors": [
    {
      "path": "example",
      "message": "example"
    }
  ]
}