Cloady Docs
API ReferenceEndpointsDatabase

List a database component's schemas and tables

GET
/api/workspaces/{workspaceSlug}/apps/{appSlug}/db/schema

Authorization

cloady
AuthorizationBearer <token>

Personal API token (cldy_…)

In: header

Path Parameters

workspaceSlug*string
appSlug*string

Query Parameters

component*string
schema?string
env?string

Value in

  • "production"
  • "preview"
  • "development"
region?string

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/workspaces/string/apps/string/db/schema?component=string"
{  "engine": "postgres",  "schemas": [    "string"  ],  "schema": "string",  "tables": [    {      "name": "string",      "kind": "table",      "rows": 0,      "cols": [        {          "key": "string",          "type": "string",          "pk": true        }      ]    }  ]}

Get the connection credentials for a database component GET

Read from the running pod's resolved environment at call time, so the container is the source of truth rather than the template. `component` is a compose service running a database.

Run a query against a database component POST

Runs over a real protocol driver, not a shell, and executes whatever is sent — including writes and DDL. Redis and MongoDB take their own command syntax rather than SQL.