Get database connection schema

GET

/api/databases/{type}/schema

const url = 'http://localhost:8080/api/databases/example/schema';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url http://localhost:8080/api/databases/example/schema

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

Parameters

Path Parameters

type

required

string

Responses

200

Connection-form field schema.

application/json

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

Example

{
  "success": true,
  "data": {
    "fields": [
      {
        "type": "string"
      }
    ]
  }
}

404

Database type not found

application/json

object

success

boolean

error

required

string

Example

{
  "error": "Human-readable error message"
}