dbaas

Create a DBaaS PostgreSQL service

post/dbaas-postgres/{name}

Request

Base URL
https://api-ch-gva-2.exoscale.com/v2
Auth
none declared
TypeScript
https://skmtc.dev/exoscale/apis/exoscale-api/docs/dbaas-postgres/:name/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

namestring required

Request body

variant'timescale' | 'aiven'

ip-filterstring[]

Allow incoming connections from CIDR address block, e.g. '10.20.0.0/16'

termination-protectionboolean

Service is protected against termination and powering off

fork-from-servicestring

synchronous-replication'quorum' | 'off'

recovery-backup-timestring

ISO time of a backup to recover from for services that support arbitrary times

admin-usernamestring

Custom username for admin user. This must be set only when a new service is being created.

version'14' | '17' | '15' | '18' | '13' | '16'

planstring required

Subscription plan

work-meminteger

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).

shared-buffers-percentageinteger

Percentage of total RAM that the database server uses for shared memory buffers. Valid range is 20-60 (float), which corresponds to 20% - 60%. This setting adjusts the shared_buffers configuration value.

admin-passwordstring

Custom password for admin user. Defaults to random string. This must be set only when a new service is being created.

Example request

{
  "pgbouncer-settings": {
    "ignore_startup_parameters": [
      "extra_float_digits",
      "search_path"
    ],
    "server_lifetime": 3600,
    "autodb_pool_mode": "session",
    "server_idle_timeout": 600,
    "max_prepared_statements": 100,
    "autodb_idle_timeout": 3600
  },
  "timescaledb-settings": {
    "max_background_workers": 8
  },
  "pg-settings": {
    "track_activity_query_size": 1024,
    "timezone": "Europe/Helsinki",
    "track_io_timing": "off",
    "pg_stat_monitor.pgsm_max_buckets": 10,
    "wal": {
      "wal_writer_delay": 50
    },
    "default_toast_compression": "lz4",
    "deadlock_timeout": 1000,
    "autovacuum": {
      "autovacuum_freeze_max_age": 200000000
    },
    "password_encryption": "scram-sha-256",
    "pg_partman_bgw.interval": 3600,
    "track_commit_timestamp": "off",
    "pg_partman_bgw.role": "myrolename",
    "temp_file_limit": 5000000,
    "jit": true,
    "bg-writer": {
      "bgwriter_delay": 200,
      "bgwriter_flush_after": 512,
      "bgwriter_lru_maxpages": 100,
      "bgwriter_lru_multiplier": 2
    }
  }
}

Response

200

idstring uuid

Operation ID

Operation failure reason

messagestring

Operation message

state'failure' | 'pending' | 'success' | 'timeout'

Operation status

Changes

No recorded changes to this operation across all 1 revision of this API.