Body Required

• pgbouncer-settings object

  PGBouncer connection pooling settings

  Hide pgbouncer-settings attributes Show pgbouncer-settings attributes object

  • min_pool_size integer

    Minimum value is 0, maximum value is 10000. Default value is 0.

  • ignore_startup_parameters array[string]

    Not more than 32 elements. Values are extra_float_digits or search_path.

  • server_lifetime integer

    Minimum value is 60, maximum value is 86400. Default value is 3600.

  • autodb_pool_mode string

    Values are transaction, session, or statement. Default value is transaction.

  • server_idle_timeout integer

    Minimum value is 0, maximum value is 86400. Default value is 600.

  • autodb_max_db_connections integer

    Minimum value is 0, maximum value is 2147483647.

  • max_prepared_statements integer

    Minimum value is 0, maximum value is 3000. Default value is 100.

  • server_reset_query_always boolean

    Default value is false.

  • autodb_pool_size integer

    Minimum value is 0, maximum value is 10000. Default value is 0.

  • autodb_idle_timeout integer

    Minimum value is 0, maximum value is 86400. Default value is 3600.

• backup-schedule object
  Hide backup-schedule attributes Show backup-schedule attributes object

  • backup-hour integer(int64) | null

    The hour of day (in UTC) when backup for the service is started. New backup is only started if previous backup has already completed.

    Minimum value is 0, maximum value is 23.

  • backup-minute integer(int64) | null

    The minute of an hour when backup for the service is started. New backup is only started if previous backup has already completed.

    Minimum value is 0, maximum value is 59.

• variant string

  Variant of the PostgreSQL service, may affect the features that are exposed by default

  Values are timescale or aiven.

• integrations array[object]

  Service integrations to be enabled when creating the service.

  Hide integrations attributes Show integrations attributes object

  • type string Required

    Integration type

    Value is read_replica.

  • source-service string

    A source service

    Minimum length is 0, maximum length is 63.

  • dest-service string

    A destination service

    Minimum length is 0, maximum length is 63.

  • settings object

    Integration settings

• timescaledb-settings object

  TimescaleDB extension configuration values

  Hide timescaledb-settings attribute Show timescaledb-settings attribute object

  • max_background_workers integer

    The number of background workers for timescaledb operations. You should configure this setting to the sum of your number of databases and the total number of concurrent background workers you want running at any given point in time. Changing this parameter causes a service restart.

    Minimum value is 1, maximum value is 4096. Default value is 16.

• 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

• pgaudit-settings object

  PGAudit settings

  Hide pgaudit-settings attributes Show pgaudit-settings attributes object

  • role string

    Specifies the master role to use for object audit logging.

    Maximum length is 64. Format should match the following pattern: ^[_A-Za-z0-9][-._A-Za-z0-9]{0,63}$.

  • log_parameter boolean

    Specifies that audit logging should include the parameters that were passed with the statement.

    Default value is false.

  • log_rows boolean

    Default value is false.

  • log_level string

    Specifies the log level that will be used for log entries.

    Values are debug1, debug2, debug3, debug4, debug5, info, notice, warning, or log. Default value is log.

  • log_relation boolean

    Specifies whether session audit logging should create a separate log entry for each relation (TABLE, VIEW, etc.) referenced in a SELECT or DML statement.

    Default value is false.

  • log_statement_once boolean

    Specifies whether logging will include the statement text and parameters with the first log entry for a statement/substatement combination or with every entry.

    Default value is false.

  • log_max_string_length integer

    Crop parameters representation and whole statements if they exceed this threshold. A (default) value of -1 disable the truncation.

    Minimum value is -1, maximum value is 102400. Default value is -1.

  • log_catalog boolean

    Specifies that session logging should be enabled in the case where all relations in a statement are in pg_catalog.

    Default value is true.

  • log_nested_statements boolean

    This GUC allows to turn off logging nested statements, that is, statements that are executed as part of another ExecutorRun.

    Default value is true.

  • log_statement boolean

    Specifies whether logging will include the statement text and parameters (if enabled).

    Default value is true.

  • log_client boolean

    Specifies whether log messages will be visible to a client process such as psql.

    Default value is false.

  • feature_enabled boolean

    Enable pgaudit extension. When enabled, pgaudit extension will be automatically installed.Otherwise, extension will be uninstalled but auditing configurations will be preserved.

    Default value is false.

  • log array[string]

    Specifies which classes of statements will be logged by session audit logging.

    Values are all, ddl, function, misc, misc_set, read, role, or write.

  • log_parameter_max_size integer

    Specifies that parameter values longer than this setting (in bytes) should not be logged, but replaced with .

    Default value is 0.

• fork-from-service string

  Service to fork from

  Minimum length is 0, maximum length is 63.

• synchronous-replication string

  Synchronous replication type. Note that the service plan also needs to support synchronous replication.

  Values are quorum or off.

• 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

  Hide pglookout-settings attribute Show pglookout-settings attribute object

  • max_failover_replication_time_lag integer

    Number of seconds of master unavailability before triggering database failover to standby

    Minimum value is 10, maximum value is 9223372036854775807. Default value is 60.

• maintenance object

  Automatic maintenance settings

  Hide maintenance attributes Show maintenance attributes object

  • dow string Required

    Day of week for installing updates

    Values are saturday, tuesday, never, wednesday, sunday, friday, monday, or thursday.

  • time string Required

    Time for installing updates, UTC

    Minimum length is 8, maximum length is 8.

• 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 is 64. Format should match the following pattern: ^[_A-Za-z0-9][-._A-Za-z0-9]{0,63}$.

• version string

  PostgreSQL major version

  Values are 14, 17, 15, 18, 13, or 16.

• plan string Required

  Subscription plan

  Minimum length is 1, maximum length is 128.

• 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 is 1024.

• shared-buffers-percentage integer(int64)

  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.

  Minimum value is 20, maximum value is 60.

• pg-settings object

  PostgreSQL-specific settings

  Additional properties are NOT allowed.

  Hide pg-settings attributes Show pg-settings attributes object

  • track_activity_query_size integer

    Specifies the number of bytes reserved to track the currently executing command for each active session. Changing this parameter causes a service restart.

    Minimum value is 1024, maximum value is 10240.

  • timezone string

    PostgreSQL service timezone

    Maximum length is 64. Format should match the following pattern: ^[\w/]*$.

  • track_io_timing string

    Enables timing of database I/O calls. The default is off. When on, it will repeatedly query the operating system for the current time, which may cause significant overhead on some platforms.

    Values are off or on.

  • pg_stat_monitor.pgsm_enable_query_plan boolean

    Enables or disables query plan monitoring. Changing this parameter causes a service restart. Only available for PostgreSQL 13+.

  • max_files_per_process integer

    PostgreSQL maximum number of files that can be open per process. The default is 1000 (upstream default). Changing this parameter causes a service restart.

    Minimum value is 1000, maximum value is 4096.

  • pg_stat_monitor.pgsm_max_buckets integer

    Sets the maximum number of buckets. Changing this parameter causes a service restart. Only available for PostgreSQL 13+.

    Minimum value is 1, maximum value is 10.

  • io_max_concurrency integer

    EXPERIMENTAL: Controls the maximum number of I/O operations that one process can execute simultaneously. Version 18 and up only. Changing this parameter causes a service restart.

    Minimum value is -1, maximum value is 1024. Default value is -1.

  • wal object
    Hide wal attributes Show wal attributes object

    • max_slot_wal_keep_size integer

      PostgreSQL maximum WAL size (MB) reserved for replication slots. If -1 is specified, replication slots may retain an unlimited amount of WAL files. The default is -1 (upstream default). wal_keep_size minimum WAL size setting takes precedence over this.

      Minimum value is -1, maximum value is 2147483647.

    • max_wal_senders integer

      PostgreSQL maximum WAL senders. The default is 20. Changing this parameter causes a service restart.

      Minimum value is 20, maximum value is 256.

    • wal_sender_timeout integer

      Terminate replication connections that are inactive for longer than this amount of time, in milliseconds.

      Minimum value is 0, maximum value is 10800000.

    • wal_writer_delay integer

      WAL flush interval in milliseconds. The default is 200. Setting this parameter to a lower value may negatively impact performance.

      Minimum value is 10, maximum value is 200.

  • default_toast_compression string

    Specifies the default TOAST compression method for values of compressible columns. The default is lz4. Only available for PostgreSQL 14+.

    Values are lz4 or pglz.

  • deadlock_timeout integer

    This is the amount of time, in milliseconds, to wait on a lock before checking to see if there is a deadlock condition. The default is 1000 (upstream default).

    Minimum value is 500, maximum value is 1800000.

  • idle_in_transaction_session_timeout integer

    Time out sessions with open transactions after this number of milliseconds

    Minimum value is 0, maximum value is 604800000.

  • max_pred_locks_per_transaction integer

    PostgreSQL maximum predicate locks per transaction. The default is 64 (upstream default). Changing this parameter causes a service restart.

    Minimum value is 64, maximum value is 5120.

  • max_replication_slots integer

    PostgreSQL maximum replication slots. The default is 20. Changing this parameter causes a service restart.

    Minimum value is 8, maximum value is 256.

  • max_sync_workers_per_subscription integer

    Maximum number of synchronization workers per subscription. The default is 2.

    Minimum value is 2, maximum value is 8.

  • autovacuum object
    Hide autovacuum attributes Show autovacuum attributes object

    • log_autovacuum_min_duration integer

      Causes each action executed by autovacuum to be logged if it ran for at least the specified number of milliseconds. Setting this to zero logs all autovacuum actions. Minus-one disables logging autovacuum actions. The default is 1000.

      Minimum value is -1, maximum value is 2147483647.

    • autovacuum_vacuum_cost_limit integer

      Specifies the cost limit value that will be used in automatic VACUUM operations. If -1 is specified, the regular vacuum_cost_limit value will be used. The default is -1 (upstream default).

      Minimum value is -1, maximum value is 10000.

    • autovacuum_max_workers integer

      Specifies the maximum number of autovacuum processes (other than the autovacuum launcher) that may be running at any one time. The default is 3. Changing this parameter causes a service restart.

      Minimum value is 1, maximum value is 20.

    • autovacuum_vacuum_threshold integer

      Specifies the minimum number of updated or deleted tuples needed to trigger a VACUUM in any one table. The default is 50.

      Minimum value is 0, maximum value is 2147483647.

    • autovacuum_naptime integer

      Specifies the minimum delay between autovacuum runs on any given database. The delay is measured in seconds. The default is 60.

      Minimum value is 1, maximum value is 86400.

    • autovacuum_vacuum_scale_factor number

      Specifies a fraction of the table size to add to autovacuum_vacuum_threshold when deciding whether to trigger a VACUUM (e.g. 0.2 for 20% of the table size). The default is 0.2.

      Minimum value is 0.0, maximum value is 1.0.

    • autovacuum_vacuum_cost_delay integer

      Specifies the cost delay value that will be used in automatic VACUUM operations. If -1 is specified, the regular vacuum_cost_delay value will be used. The default is 2 (upstream default).

      Minimum value is -1, maximum value is 100.

    • autovacuum_analyze_scale_factor number

      Specifies a fraction of the table size to add to autovacuum_analyze_threshold when deciding whether to trigger an ANALYZE (e.g. 0.2 for 20% of the table size). The default is 0.2.

      Minimum value is 0.0, maximum value is 1.0.

    • autovacuum_analyze_threshold integer

      Specifies the minimum number of inserted, updated or deleted tuples needed to trigger an ANALYZE in any one table. The default is 50.

      Minimum value is 0, maximum value is 2147483647.

    • autovacuum_freeze_max_age integer

      Specifies the maximum age (in transactions) that a table's pg_class.relfrozenxid field can attain before a VACUUM operation is forced to prevent transaction ID wraparound within the table. The system launches autovacuum processes to prevent wraparound even when autovacuum is otherwise disabled. Changing this parameter causes a service restart.

      Minimum value is 200000000, maximum value is 1500000000.

  • max_parallel_workers_per_gather integer

    Sets the maximum number of workers that can be started by a single Gather or Gather Merge node. The default is 2 (upstream default).

    Minimum value is 0, maximum value is 96.

  • io_combine_limit integer

    EXPERIMENTAL: Controls the largest I/O size in operations that combine I/O in 8kB units. Version 17 and up only.

    Minimum value is 1, maximum value is 32. Default value is 16.

  • password_encryption string | null

    Chooses the algorithm for encrypting passwords.

    Values are md5 or scram-sha-256.

  • io_workers integer

    EXPERIMENTAL: Number of IO worker processes, for io_method=worker. Version 18 and up only. Changing this parameter causes a service restart.

    Minimum value is 1, maximum value is 32. Default value is 3.

  • pg_partman_bgw.interval integer

    Sets the time interval in seconds to run pg_partman's scheduled tasks. The default is 3600.

    Minimum value is 3600, maximum value is 604800.

  • log_line_prefix string

    Choose from one of the available log formats.

    Values are 'pid=%p,user=%u,db=%d,app=%a,client=%h ', 'pid=%p,user=%u,db=%d,app=%a,client=%h,txid=%x,qid=%Q ', '%t [%p]: [%l-1] user=%u,db=%d,app=%a,client=%h ', or '%m [%p] %q[user=%u,db=%d,app=%a] '.

  • log_temp_files integer

    Log statements for each temporary file created larger than this number of kilobytes, -1 disables

    Minimum value is -1, maximum value is 2147483647.

  • max_locks_per_transaction integer

    PostgreSQL maximum locks per transaction. Changing this parameter causes a service restart.

    Minimum value is 64, maximum value is 6400.

  • track_commit_timestamp string

    Record commit time of transactions. Changing this parameter causes a service restart.

    Values are off or on.

  • track_functions string

    Enables tracking of function call counts and time used.

    Values are all, pl, or none.

  • io_max_combine_limit integer

    EXPERIMENTAL: Controls the largest I/O size in operations that combine I/O in 8kB units, and silently limits the user-settable parameter io_combine_limit. Version 18 and up only. Changing this parameter causes a service restart.

    Minimum value is 1, maximum value is 128. Default value is 16.

  • io_method string

    EXPERIMENTAL: Controls the maximum number of I/O operations that one process can execute simultaneously. Version 18 and up only. Changing this parameter causes a service restart.

    Values are worker, sync, or io_uring. Default value is worker.

  • max_stack_depth integer

    Maximum depth of the stack in bytes. The default is 2097152 (upstream default).

    Minimum value is 2097152, maximum value is 6291456.

  • max_parallel_workers integer

    Sets the maximum number of workers that the system can support for parallel queries. The default is 8 (upstream default).

    Minimum value is 0, maximum value is 96.

  • pg_partman_bgw.role string

    Controls which role to use for pg_partman's scheduled background tasks.

    Maximum length is 64. Format should match the following pattern: ^[_A-Za-z0-9][-._A-Za-z0-9]{0,63}$.

  • max_logical_replication_workers integer

    PostgreSQL maximum logical replication workers (taken from the pool of max_parallel_workers). The default is 4 (upstream default). Changing this parameter causes a service restart.

    Minimum value is 4, maximum value is 256.

  • max_prepared_transactions integer

    PostgreSQL maximum prepared transactions. The default is 0. Changing this parameter causes a service restart.

    Minimum value is 0, maximum value is 10000.

  • max_worker_processes integer

    Sets the maximum number of background processes that the system can support. The default is 8. Changing this parameter causes a service restart.

    Minimum value is 8, maximum value is 288.

  • pg_stat_statements.track string

    Controls which statements are counted. Specify top to track top-level statements (those issued directly by clients), all to also track nested statements (such as statements invoked within functions), or none to disable statement statistics collection. The default is top.

    Values are all, top, or none.

  • temp_file_limit integer

    PostgreSQL temporary file limit in KiB, -1 for unlimited

    Minimum value is -1, maximum value is 2147483647.

  • log_error_verbosity string

    Controls the amount of detail written in the server log for each message that is logged.

    Values are TERSE, DEFAULT, or VERBOSE.

  • log_min_duration_statement integer

    Log statements that take more than this number of milliseconds to run, -1 disables

    Minimum value is -1, maximum value is 86400000.

  • max_standby_streaming_delay integer

    Max standby streaming delay in milliseconds. The default is 30000 (upstream default).

    Minimum value is 1, maximum value is 43200000.

  • jit boolean

    Controls system-wide use of Just-in-Time Compilation (JIT).

  • max_standby_archive_delay integer

    Max standby archive delay in milliseconds. The default is 30000 (upstream default).

    Minimum value is 1, maximum value is 43200000.

  • bg-writer object
    Hide bg-writer attributes Show bg-writer attributes object

    • bgwriter_delay integer

      Specifies the delay between activity rounds for the background writer in milliseconds. The default is 200.

      Minimum value is 10, maximum value is 10000.

    • bgwriter_flush_after integer

      Whenever more than bgwriter_flush_after bytes have been written by the background writer, attempt to force the OS to issue these writes to the underlying storage. Specified in kilobytes. Setting of 0 disables forced writeback. The default is 512.

      Minimum value is 0, maximum value is 2048.

    • bgwriter_lru_maxpages integer

      In each round, no more than this many buffers will be written by the background writer. Setting this to zero disables background writing. The default is 100.

      Minimum value is 0, maximum value is 1073741823.

    • bgwriter_lru_multiplier number

      The average recent need for new buffers is multiplied by bgwriter_lru_multiplier to arrive at an estimate of the number that will be needed during the next round, (up to bgwriter_lru_maxpages). 1.0 represents a “just in time” policy of writing exactly the number of buffers predicted to be needed. Larger values provide some cushion against spikes in demand, while smaller values intentionally leave writes to be done by server processes. The default is 2.0.

      Minimum value is 0, maximum value is 10.

• 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 is 256. Format should match the following pattern: ^[a-zA-Z0-9-_]+$.

• migration object

  Migrate data from existing server

  Hide migration attributes Show migration attributes object

  • host string Required

    Hostname or IP address of the server where to migrate data from

    Minimum length is 1, maximum length is 255.

  • port integer(int64) Required

    Port number of the server where to migrate data from

    Minimum value is 1, maximum value is 65535.

  • password string

    Password for authentication with the server where to migrate data from

    Minimum length is 1, maximum length is 255.

  • ssl boolean

    The server where to migrate data from is secured with SSL

  • username string

    User name for authentication with the server where to migrate data from

    Minimum length is 1, maximum length is 255.

  • dbname string

    Database name for bootstrapping the initial connection

    Minimum length is 1, maximum length is 63.

  • ignore-dbs string

    Comma-separated list of databases, which should be ignored during migration (supported by MySQL only at the moment)

    Minimum length is 1, maximum length is 2048.

  • method string

    The migration method to be used

    Values are dump or replication.