Skip to content
ShipSquares

/db-connections/{id}/tables/{schema}/{table}

GET
/db-connections/{id}/tables/{schema}/{table}
 
curl --request GET \
  --url https://example.com/api/v1/db-connections/example/tables/example/example

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
id
required
string
schema
required
string
table
required
string

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Default Response

Media type application/json
object
schema
required
string
name
required
string
columns
required
Array<object>
object
name
required
string
dataType
required
string
uiType
required
string
nullable
required
boolean
default
required
Any of:
string
isPrimaryKey
required
boolean
primaryKey
required
Array<string>
indexes
required
Array<object>
object
name
required
string
columns
required
Array<string>
unique
required
boolean
primary
required
boolean
foreignKeys
required
Array<object>
object
name
required
string
columns
required
Array<string>
refSchema
required
string
refTable
required
string
refColumns
required
Array<string>
Example generated
{
  "schema": "example",
  "name": "example",
  "columns": [
    {
      "name": "example",
      "dataType": "example",
      "uiType": "example",
      "nullable": true,
      "default": "example",
      "isPrimaryKey": true
    }
  ],
  "primaryKey": [
    "example"
  ],
  "indexes": [
    {
      "name": "example",
      "columns": [
        "example"
      ],
      "unique": true,
      "primary": true
    }
  ],
  "foreignKeys": [
    {
      "name": "example",
      "columns": [
        "example"
      ],
      "refSchema": "example",
      "refTable": "example",
      "refColumns": [
        "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"
    }
  ]
}