Get Connection
GET
/api/v1/connections/{connection_id}
Get a single database connection by ID.
Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ” connection_id
required
Connection Id
string format: uuid
Responses
Section titled “ Responses ”Successful Response
ConnectionGetResponse
Response for GET /connections/{id}.
object
success
required
Success
Whether the request succeeded.
boolean
data
Any of:
ConnectionResponse
object
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
null
error
Any of:
ErrorDetail
null
Validation Error
HTTPValidationError
object
detail
Detail
Array<object>
ValidationErrorobject
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context