A valid request URL is required to generate request examples{
"data": {
"ok": true,
"checks": [
{
"name": "connect",
"ok": true,
"detail": "Reached host over TLS in 42ms",
"critical": true
},
{
"name": "authenticate",
"ok": true,
"detail": "Authenticated as flowyte_readonly",
"critical": true
},
{
"name": "read_schema",
"ok": true,
"detail": "Read 18 tables",
"critical": true
},
{
"name": "read_only_session",
"ok": true,
"detail": "Session is read-only",
"critical": false
}
]
}
}{
"type": "about:blank",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "<string>",
"errors": [
{
"field": "<string>",
"message": "<string>"
}
]
}{
"type": "about:blank",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "<string>",
"errors": [
{
"field": "<string>",
"message": "<string>"
}
]
}Test a database connection
For a SQL database connector (Postgres or MySQL), runs an ordered set of checks against the credentials you supply — reachability and TLS, authentication, reading the schema, a timed read probe, a read-only-session proof, and a live-call latency verdict — without storing anything (this powers the connect wizard’s “Test connection” button). Always returns 200 with the ordered check results and an overall ok flag; a failed check is data to render, not an error. A host that resolves to a private, loopback, or metadata address is refused.
A valid request URL is required to generate request examples{
"data": {
"ok": true,
"checks": [
{
"name": "connect",
"ok": true,
"detail": "Reached host over TLS in 42ms",
"critical": true
},
{
"name": "authenticate",
"ok": true,
"detail": "Authenticated as flowyte_readonly",
"critical": true
},
{
"name": "read_schema",
"ok": true,
"detail": "Read 18 tables",
"critical": true
},
{
"name": "read_only_session",
"ok": true,
"detail": "Session is read-only",
"critical": false
}
]
}
}{
"type": "about:blank",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "<string>",
"errors": [
{
"field": "<string>",
"message": "<string>"
}
]
}{
"type": "about:blank",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "<string>",
"errors": [
{
"field": "<string>",
"message": "<string>"
}
]
}Authorizations
Flowyte secret API key (Authorization: Bearer flowyte_sk_live_…). Scope-gated; is scoped to your organization — a key can never reach another tenant. The listed scopes in each operation's apiKey requirement are the scopes that key must hold. The tokenUrl is nominal: keys are minted in the dashboard.
- Token URL
- /api/v1/api-keys
Path Parameters
The integration provider (connector). One of the supported connector slugs: native providers (google_calendar, google_sheets, calendly, hubspot, ``, square, opentable, shopify), SQL databases (postgres, mysql), the universal Zapier MCP fallback (zapier), or Composio (composio).
google_calendar, google_sheets, calendly, hubspot, square, opentable, shopify, postgres, mysql, zapier, composio Body
host, port, database, user, password, sslmode (verify-full|verify-ca|require), ca_pem (optional).
Show child attributes
Show child attributes
Response
The ordered named-check results.
Show child attributes
Show child attributes