Error

A valid request URL is required to generate request examples

{
  "data": {
    "ok": true,
    "checks": [
      {
        "name": "<string>",
        "ok": true,
        "detail": "<string>",
        "critical": true
      }
    ]
  }
}

Integrations

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.

POST

integrations

{kind}

sql

test

Error

A valid request URL is required to generate request examples

{
  "data": {
    "ok": true,
    "checks": [
      {
        "name": "<string>",
        "ok": true,
        "detail": "<string>",
        "critical": true
      }
    ]
  }
}

Authorizations

Authorization

string

header

required

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.

Path Parameters

kind

enum<string>

required

Available options:

google_calendar,

google_sheets,

calendly,

hubspot,

square,

opentable,

shopify,

postgres,

mysql

Body

application/json

credentials

object

host, port, database, user, password, sslmode (verify-full|verify-ca|require), ca_pem (optional).

Show child attributes

Response

The ordered named-check results.

data

object

Show child attributes

Discover an integration's schema Generate database setup scripts

⌘I