Create a DBaaS PostgreSQL service
Path parameters
-
name string Required
Service name
Minimum length is
0
, maximum length is63
.
Body Required
-
pgbouncer-settings object
PGBouncer connection pooling settings
-
backup-schedule object
-
variant string
Variant of the PostgreSQL service, may affect the features that are exposed by default
Values are
timescale
oraiven
. -
integrations array[object]
Service integrations to be enabled when creating the service.
-
timescaledb-settings object
TimescaleDB extension configuration values
-
ip-filter array[string]
Allow incoming connections from CIDR address block, e.g. '10.20.0.0/16'
-
termination-protection boolean
Service is protected against termination and powering off
-
fork-from-service string
Service name
Minimum length is
0
, maximum length is63
. -
synchronous-replication string
Synchronous replication type. Note that the service plan also needs to support synchronous replication.
Values are
quorum
oroff
. -
recovery-backup-time string
ISO time of a backup to recover from for services that support arbitrary times
Minimum length is
1
. -
pglookout-settings object
PGLookout settings
-
maintenance object
Automatic maintenance settings
-
admin-username string
Custom username for admin user. This must be set only when a new service is being created.
Minimum length is
1
, maximum length is64
. Format should match the following pattern:^[_A-Za-z0-9][-._A-Za-z0-9]{0,63}$
. -
version string
PostgreSQL major version
Minimum length is
1
. -
plan string Required
Subscription plan
Minimum length is
1
, maximum length is128
. -
work-mem integer(int64)
Sets the maximum amount of memory to be used by a query operation (such as a sort or hash table) before writing to temporary disk files, in MB. Default is 1MB + 0.075% of total RAM (up to 32MB).
Minimum value is
1
, maximum value is1024
. -
pg-settings object
PostgreSQL-specific settings
-
admin-password string
Custom password for admin user. Defaults to random string. This must be set only when a new service is being created.
Minimum length is
8
, maximum length is256
. Format should match the following pattern:^[a-zA-Z0-9-_]+$
. -
migration object
Migrate data from existing server
curl \
-X POST https://api-ch-gva-2.exoscale.com/v2/dbaas-postgres/{name} \
-H "Content-Type: application/json" \
-d '{"pgbouncer-settings":{},"backup-schedule":{"backup-hour":42,"backup-minute":42},"variant":"timescale","integrations":[{"type":"read_replica","source-service":"string","dest-service":"string","settings":{}}],"timescaledb-settings":{},"ip-filter":["string"],"termination-protection":true,"fork-from-service":"string","synchronous-replication":"quorum","recovery-backup-time":"string","pglookout-settings":{},"maintenance":{"dow":"saturday","time":"string"},"admin-username":"string","version":"string","plan":"string","work-mem":42,"shared-buffers-percentage":42,"pg-settings":{},"admin-password":"string","migration":{"host":"string","port":42,"password":"string","ssl":true,"username":"string","dbname":"string","ignore-dbs":"string","method":"dump"}}'
{
"pgbouncer-settings": {},
"backup-schedule": {
"backup-hour": 42,
"backup-minute": 42
},
"variant": "timescale",
"integrations": [
{
"type": "read_replica",
"source-service": "string",
"dest-service": "string",
"settings": {}
}
],
"timescaledb-settings": {},
"ip-filter": [
"string"
],
"termination-protection": true,
"fork-from-service": "string",
"synchronous-replication": "quorum",
"recovery-backup-time": "string",
"pglookout-settings": {},
"maintenance": {
"dow": "saturday",
"time": "string"
},
"admin-username": "string",
"version": "string",
"plan": "string",
"work-mem": 42,
"shared-buffers-percentage": 42,
"pg-settings": {},
"admin-password": "string",
"migration": {
"host": "string",
"port": 42,
"password": "string",
"ssl": true,
"username": "string",
"dbname": "string",
"ignore-dbs": "string",
"method": "dump"
}
}
{
"id": "string",
"reason": "incorrect",
"reference": {
"id": "string",
"link": "string",
"command": "string"
},
"message": "string",
"state": "failure"
}