/database-servers (POST)

POST

/database-servers

curl --request POST \
  --url https://example.com/api/v1/database-servers \
  --header 'Content-Type: application/json' \
  --data '{ "host": "example", "port": 1, "adminUrl": "example", "isDefault": true, "tls": true }'

Request Body ^required

Media type application/json

object

host

required

string

>= 1 characters <= 253 characters

port

integer

>= 1 <= 65535

adminUrl

required

string

>= 1 characters <= 2048 characters

isDefault

boolean

tls

boolean

Example ^generated

{
  "host": "example",
  "port": 1,
  "adminUrl": "example",
  "isDefault": true,
  "tls": true
}

Responses

201

Default Response

Media type application/json

object

id

required

string

engine

required

string

host

required

string

port

required

integer

isDefault

required

boolean

tls

required

boolean

createdAt

required

string format: date-time

Example ^generated

{
  "id": "example",
  "engine": "example",
  "host": "example",
  "port": 1,
  "isDefault": true,
  "tls": true,
  "createdAt": "2026-04-15T12:00:00Z"
}

400

Default Response

Media type application/json

object

type

required

string

title

required

string

status

required

integer

code

required

string

detail

string

instance

string

errors

Array<object>

object

path

required

string

message

required

string

Example ^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "code": "example",
  "detail": "example",
  "instance": "example",
  "errors": [
    {
      "path": "example",
      "message": "example"
    }
  ]
}