List Connections
GET
/api/v1/connections
List all active database connections.
Authorizations
Section titled “Authorizations ”Responses
Section titled “ Responses ”Successful Response
ConnectionListApiResponse
Response for GET /connections.
object
success
required
Success
Whether the request succeeded.
boolean
data
Any of:
ConnectionList
object
connections
required
Connections
List of active database connections.
Array<object>
ConnectionResponseobject
id
required
Id
Unique identifier for the connection.
string format: uuid
name
required
Name
Human-readable label assigned during registration.
string
db_type
required
Db Type
Database provider type. ‘supabase’ or ‘postgres_gcp’.
string
host
required
Host
Database server hostname extracted from the connection string.
string
port
required
Port
Database server port number.
integer
database_name
required
Database Name
Name of the target database on the server.
string
excluded_schemas
Excluded Schemas
Schema names excluded from default introspection for this connection.
Array<string>
is_active
required
Is Active
Whether this connection is active. Inactive connections are soft-deleted.
boolean
created_at
required
Created At
Timestamp when the connection was registered.
string format: date-time
count
required
Count
Total number of active connections returned.
integer
null
error
Any of:
ErrorDetail
null