Get user database connection status

Get PostgreSQL connection configuration status for the authenticated user.

get/api/v1/database/connection

Request

  • Base URL: https://localhost:3000
  • URL: https://localhost:3000/api/v1/database/connection
  • Auth: OAuth 2 (authorization code, authorization URL /oauth/authorize, token URL /oauth/token)

Response

User database connection status

configuredboolean
connector_idstring
session_userstring
credential_identitystring nullable
hoststring nullable
portinteger nullable
databasestring nullable
usernamestring nullable
sslstring nullable
password_setboolean
sourcestring nullable

Example response

{
  "connector_id": "postgres",
  "session_user": "user@example.com",
  "port": 5432,
  "ssl": "prefer",
  "source": "user"
}

Changes

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