connections

Probe a connection's health

Run a dialect-appropriate SELECT 1 ping and best-effort version probe against the connection identified by id (name match first, id match second). Returns latency, server version, current database, and current schema. Costs 1 quota unit per call.

get/v1/connections/{id}/health

Request

  • Base URL: https://data.thinair.co
  • URL: https://data.thinair.co/v1/connections/{id}/health
  • Auth: API key in header x-api-key

Path parameters

idstring required

Connection name or id (see /v1/connections).

Example:fleet

Response

Probe completed (the connection may have reported ok: false for an auth or origin failure — still a 200; the body's ok is the success signal).

okboolean required

True when the ping succeeded.

db_type'postgres' | 'mysql' | 'mssql' required
versionstring required
current_databasestring nullable required
current_schemastring nullable required
ping_msinteger required

Wall time of the SELECT 1 ping in milliseconds.

total_msinteger required

Wall time of the full probe (ping + version + schema lookup).

connectionstring required

Resolved connection name (matches the row in /v1/connections).

Example response

{
  "version": "PostgreSQL 16.2 on x86_64-pc-linux-gnu"
}

Changes

No recorded changes to this operation across all 1 revision of this API.