Skip to content
ShipSquares

/db-connections/{id}/schema

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

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
id
required
string

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Default Response

Media type application/json
Array<object>
object
name
required
string
tables
required
Array<object>
object
schema
required
string
name
required
string
kind
required
Any of:
string
Allowed values: table
estimatedRows
required
Any of:
integer
Example 
[
  {
    "tables": [
      {
        "kind": "table"
      }
    ]
  }
]

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"
    }
  ]
}