Skip to main content
PATCH
curl

Path Parameters

database_connection
string
required

Database connection slug.

Pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$

Body

application/json
driver
enum<string>

Driver: mysql, pgsql, sqlite, or redis

Available options:
mysql,
pgsql,
sqlite,
redis
node_id
integer | null
Required range: x >= 1
host
string | null

Hostname or IP for mysql and pgsql

Maximum string length: 255
Pattern: ^[A-Za-z0-9](?:[A-Za-z0-9.-]{0,253}[A-Za-z0-9])?$(?![\s\S])
port
integer | null

TCP port for mysql and pgsql

Required range: 1 <= x <= 65535
database
string | null

Database name for mysql and pgsql

Maximum string length: 64
Pattern: ^(?:[A-Za-z_][A-Za-z0-9_$]{0,63}|[0-9]{1,3})$(?![\s\S])
path
string | null

Unix absolute sqlite path

Maximum string length: 1024
Pattern: ^\/[^\x00]{1,1023}$(?![\s\S])
username
string | null

Username

Maximum string length: 128
Pattern: ^[\x21-\x7E]{1,128}$(?![\s\S])
password
string | null

Password

Maximum string length: 1024

Response

The request succeeded.

data
object
required
meta
object
required