Body Required

• valkey-settings object

  Valkey.conf settings

  Hide valkey-settings attributes Show valkey-settings attributes object

  • ssl boolean

    Default value is true.

  • lfu_log_factor integer

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

  • frequent_snapshots boolean

    When enabled, Valkey will create frequent local RDB snapshots. When disabled, Valkey will only take RDB snapshots when a backup is created, based on the backup schedule. This setting is ignored when valkey_persistence is set to off.

    Default value is true.

  • maxmemory_policy string | null

    Values are noeviction, allkeys-lru, volatile-lru, allkeys-random, volatile-random, volatile-ttl, volatile-lfu, or allkeys-lfu. Default value is noeviction.

  • io_threads integer

    Set Valkey IO thread count. Changing this will cause a restart of the Valkey service.

    Minimum value is 1, maximum value is 32.

  • lfu_decay_time integer

    Minimum value is 1, maximum value is 120. Default value is 1.

  • pubsub_client_output_buffer_limit integer

    Set output buffer limit for pub / sub clients in MB. The value is the hard limit, the soft limit is 1/4 of the hard limit. When setting the limit, be mindful of the available memory in the selected service plan.

    Minimum value is 32, maximum value is 512.

  • active_expire_effort integer

    Valkey reclaims expired keys both when accessed and in the background. The background process scans for expired keys to free memory. Increasing the active-expire-effort setting (default 1, max 10) uses more CPU to reclaim expired keys faster, reducing memory usage but potentially increasing latency.

    Minimum value is 1, maximum value is 10. Default value is 1.

  • notify_keyspace_events string

    Maximum length is 32. Format should match the following pattern: ^[KEg\$lshzxentdmA]*$. Default value is empty.

  • persistence string

    When persistence is 'rdb', Valkey does RDB dumps each 10 minutes if any key is changed. Also RDB dumps are done according to backup schedule for backup purposes. When persistence is 'off', no RDB dumps and backups are done, so data can be lost at any moment if service is restarted for any reason, or if service is powered off. Also service can't be forked.

    Values are off or rdb.

  • timeout integer

    Minimum value is 0, maximum value is 31536000. Default value is 300.

  • acl_channels_default string

    Determines default pub/sub channels' ACL for new users if ACL is not supplied. When this option is not defined, all_channels is assumed to keep backward compatibility. This option doesn't affect Valkey configuration acl-pubsub-default.

    Values are allchannels or resetchannels.

  • number_of_databases integer

    Set number of Valkey databases. Changing this will cause a restart of the Valkey service.

    Minimum value is 1, maximum value is 128.

• 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 to fork from

  Minimum length is 0, maximum length is 63.

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

• version string

  Valkey major version

  Minimum length is 1.

• recovery-backup-name string

  Name of a backup to recover from for services that support backup names

  Minimum length is 1.

• plan string Required

  Subscription plan

  Minimum length is 1, maximum length is 128.

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