Skip to content
ReflexDB

Instance OpenAPI spec

GET
/databases/{id}/openapi.json
 
curl --request GET \
  --url https://api.reflexdb.cloud/v1/databases/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/openapi.json \
  --header 'Authorization: Bearer <token>'

Proxies GET /openapi.json from the running reflex-server instance. Describes the query endpoint for the specific tables and columns in this database’s compiled schema.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
id
required
string format: uuid

Database ID

Responses

Section titled “ Responses ”

200

Section titled “200 ”

OpenAPI 3.x spec object

Media type application/json

OpenAPI 3.x spec object

object
key
additional properties
any
Example generated
{}

403

Section titled “403 ”

Default Response

Media type application/json
Error
object
error
required
string
message
string
Example generated
{
  "error": "example",
  "message": "example"
}

404

Section titled “404 ”

Default Response

Media type application/json
Error
object
error
required
string
message
string
Example generated
{
  "error": "example",
  "message": "example"
}

502

Section titled “502 ”

Default Response

Media type application/json
Error
object
error
required
string
message
string
Example generated
{
  "error": "example",
  "message": "example"
}

503

Section titled “503 ”

Default Response

Media type application/json
Error
object
error
required
string
message
string
Example generated
{
  "error": "example",
  "message": "example"
}