Deploy a managed database instance

POST

/api/databases/managed

curl --request POST \
  --url https://gateway.example.com/api/databases/managed \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "type": "postgres", "version": "example", "nodeId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "storageSizeGb": 1, "cpuCores": 1, "memoryMb": 1, "swapMb": 0, "tags": [ "example" ], "publishTcp": false, "publishNativeTcp": true, "publishedPort": 1, "publishedNativePort": 1, "tlsEnabled": true, "databaseName": "example", "ownerUsername": "example", "clickhouseConfigXml": "example", "redisConfig": { "maxmemoryPercent": 1, "maxmemoryPolicy": "noeviction", "appendOnly": true, "appendFsync": "always", "rdbSnapshotsEnabled": true, "rdbSaveSeconds": 1, "rdbSaveChanges": 1, "autoAofRewritePercentage": 1, "autoAofRewriteMinSizeMb": 1, "maxclients": 1, "timeoutSeconds": 1, "tcpKeepaliveSeconds": 1, "slowlogThresholdMicroseconds": 1, "slowlogMaxLen": 1, "activeDefrag": true } }'

• Your Gateway instance

Authorizations

• bearerAuth

Request Body^required

JSON request body

Media typeapplication/json

object

name

required

string

>= 1 characters <= 255 characters

type

required

string

Allowed values: postgres redis clickhouse

version

required

string

>= 1 characters <= 128 characters

nodeId

required

string format: uuid

storageSizeGb

required

number

>= 0.1 <= 16384

cpuCores

required

number

>= 0.1 <= 128

memoryMb

required

integer

>= 128 <= 1048576

swapMb

integer

0 <= 1048576

tags

Array<string>

<= 32 items

publishTcp

boolean

publishNativeTcp

boolean

publishedPort

integer

>= 1 <= 65535

publishedNativePort

integer

>= 1 <= 65535

tlsEnabled

boolean

default: true

databaseName

string

>= 1 characters <= 63 characters

ownerUsername

string

>= 1 characters <= 63 characters

clickhouseConfigXml

string

>= 1 characters <= 32768 characters

redisConfig

object

maxmemoryPercent

required

integer

>= 10 <= 95

maxmemoryPolicy

required

string

Allowed values: noeviction allkeys-lru allkeys-lfu allkeys-random volatile-lru volatile-lfu volatile-random volatile-ttl

appendOnly

required

boolean

appendFsync

required

string

Allowed values: always everysec no

rdbSnapshotsEnabled

required

boolean

rdbSaveSeconds

required

integer

>= 1 <= 31536000

rdbSaveChanges

required

integer

>= 1 <= 1000000000

autoAofRewritePercentage

required

integer

<= 10000

autoAofRewriteMinSizeMb

required

integer

>= 1 <= 1048576

maxclients

required

integer

>= 1 <= 1000000

timeoutSeconds

required

integer

<= 31536000

tcpKeepaliveSeconds

required

integer

<= 31536000

slowlogThresholdMicroseconds

required

integer

>= -1 <= 2147483647

slowlogMaxLen

required

integer

<= 1000000

activeDefrag

required

boolean

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"
}