Create a database connection

POST

/api/databases

curl --request POST \
  --url https://gateway.example.com/api/databases \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "folderId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "description": "example", "tags": [ "example" ], "manualSizeLimitMb": 1, "interactiveQueryBudgetSeconds": 1, "type": "postgres", "config": { "connectionString": "example", "host": "example", "port": 1, "database": "example", "username": "example", "password": "example", "sslEnabled": true, "tlsVerifyCertificate": true, "tlsCaCertificate": "example" } }'

• Your Gateway instance

Authorizations

• bearerAuth

Parameters

Header Parameters

Idempotency-Key

string

>= 1 characters <= 255 characters

Optional retry key (1-255 printable ASCII characters), bound to your token or session and its current scopes. A retry with the same key and request within 24 hours replays the original response with Idempotency-Replayed: true; a different request under the same key returns 422 IDEMPOTENCY_KEY_REUSED, a retry while the first request still runs returns 409 IDEMPOTENCY_KEY_IN_PROGRESS with Retry-After, and a completed request whose response was not stored returns 409 IDEMPOTENCY_RESPONSE_WITHHELD.

Request Body^required

JSON request body

Media typeapplication/json

One of:

object

object

name

required

string

>= 1 characters <= 255 characters

folderId

string | null format: uuid

description

string | null

<= 10000 characters

tags

Array<string>

<= 32 items

manualSizeLimitMb

integer | null

> 0 <= 1048576

interactiveQueryBudgetSeconds

integer

>= 30 <= 600

type

required

string

Allowed values: postgres

config

required

object

connectionString

string

>= 1 characters <= 4096 characters

host

string

>= 1 characters <= 255 characters

port

integer

>= 1 <= 65535

database

string

>= 1 characters <= 255 characters

username

string

>= 1 characters <= 255 characters

password

string

<= 4096 characters

sslEnabled

boolean

tlsVerifyCertificate

Verify the server TLS certificate chain and hostname. Defaults to true for new connections; false disables verification (insecure).

boolean

tlsCaCertificate

PEM CA certificate bundle trusted instead of the public CA bundle, for servers issued by a private CA. Empty or null clears it.

string | null

<= 65536 characters

object

object

name

required

string

>= 1 characters <= 255 characters

folderId

string | null format: uuid

description

string | null

<= 10000 characters

tags

Array<string>

<= 32 items

type

required

string

Allowed values: redis

config

required

object

connectionString

string

>= 1 characters <= 4096 characters

host

string

>= 1 characters <= 255 characters

port

integer

>= 1 <= 65535

username

string

>= 1 characters <= 255 characters

password

string

<= 4096 characters

db

integer

<= 15

tlsEnabled

boolean

tlsVerifyCertificate

Verify the server TLS certificate chain and hostname. Defaults to true for new connections; false disables verification (insecure).

boolean

tlsCaCertificate

PEM CA certificate bundle trusted instead of the public CA bundle, for servers issued by a private CA. Empty or null clears it.

string | null

<= 65536 characters

object

object

name

required

string

>= 1 characters <= 255 characters

folderId

string | null format: uuid

description

string | null

<= 10000 characters

tags

Array<string>

<= 32 items

type

required

string

Allowed values: clickhouse

interactiveQueryBudgetSeconds

integer

>= 30 <= 600

config

required

object

connectionString

string

>= 1 characters <= 4096 characters

url

string

>= 1 characters <= 4096 characters

host

string

>= 1 characters <= 255 characters

port

integer

>= 1 <= 65535

database

string

>= 1 characters <= 255 characters

username

string

>= 1 characters <= 255 characters

password

string

<= 4096 characters

tlsEnabled

boolean

tlsVerifyCertificate

Verify the server TLS certificate chain and hostname. Defaults to true for new connections; false disables verification (insecure).

boolean

tlsCaCertificate

PEM CA certificate bundle trusted instead of the public CA bundle, for servers issued by a private CA. Empty or null clears it.

string | null

<= 65536 characters

Responses

201

Created

Media typeapplication/json

object

data

required

Resource object. Exact fields depend on the endpoint.

object

id

string

name

string

key

additional properties

Example

{
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "Production Postgres",
    "type": "postgres",
    "healthStatus": "online"
  }
}

400

Bad request

Media typeapplication/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "VALIDATION_ERROR",
  "message": "Request validation failed",
  "details": [
    {
      "path": [
        "name"
      ],
      "message": "Required"
    }
  ]
}

401

Authentication required

Media typeapplication/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "UNAUTHORIZED",
  "message": "Authentication required"
}

403

Forbidden

Media typeapplication/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "FORBIDDEN",
  "message": "Insufficient permissions"
}

404

Not found

Media typeapplication/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "NOT_FOUND",
  "message": "Resource not found"
}

409

Conflict

Media typeapplication/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "CONFLICT",
  "message": "Resource already exists"
}

422

Unprocessable entity

Media typeapplication/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "UNPROCESSABLE_ENTITY",
  "message": "Request could not be processed"
}

500

Internal server error

Media typeapplication/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "INTERNAL_ERROR",
  "message": "Internal server error"
}