Skip to content

Get database connection schema

GET
/api/databases/{type}/schema

Returns the connection-form field schema for a database type. Public — no authentication required.

type
required
string

Connection-form field schema.

object
success
required
boolean
data
required
object
fields
required
Array<object>
object
name
required
string
label
required
string
type
required
string
Allowed values: string number boolean password textarea select
required
boolean
default
helperText
string
placeholder
string
rows
number
options
Array<object>
object
label
required
string
value
path
string
advanced
boolean
group
string
visibleWhen
object
field
required
string
equals

Database type not found

object
success
boolean
error
required
string
Example
Human-readable error message