Advanced settings allow you to tune the behavior of your Redis™ database engine to better fit your needs. Available settings depend on the version of the Redis™ engine. Note that some settings can only be defined upon the Redis™ engine initialization. These are called init settings. You can find a full list of the settings available in the response body of the list available Redis™ versions endpoint.
Each advanced setting entry has a default value that users can override. The deletion of a setting entry will restore the setting to default value. Some of the defaults values can be different from the engine's defaults, as we optimize them to the Scaleway platform.
Set advanced settings
Update an advanced setting for a Redis™ Database Instance (Redis™ cluster). Settings added upon database engine initialization can only be defined once, and cannot, therefore, be updated.
path Parameters
zoneThe zone you want to target
cluster_idUUID of the Database Instance where the settings must be set. (UUID format)
Set advanced settings › Request Body
Settings to define for the Database Instance.
Set advanced settings › Responses
Settings configured for a given Database Instance.
Add advanced settings
Add an advanced setting to a Redis™ Database Instance (Redis™ cluster). You must set the name and the value of each setting.
path Parameters
zoneThe zone you want to target
cluster_idUUID of the Database Instance you want to add settings to. (UUID format)
Add advanced settings › Request Body
Settings to add to the cluster.
Add advanced settings › Responses
Settings configured for a given Database Instance.
Delete advanced setting
Delete an advanced setting in a Redis™ Database Instance (Redis™ cluster). You must specify the names of the settings you want to delete in the request body.
path Parameters
zoneThe zone you want to target
cluster_idUUID of the Database Instance where the settings must be set. (UUID format)
setting_nameSetting name to delete.
Delete advanced setting › Responses
idUUID of the Database Instance. (UUID format)
nameName of the Database Instance.
project_idProject ID the Database Instance belongs to. (UUID format)
statusStatus of the Database Instance.
versionRedis™ engine version of the Database Instance.
List of Database Instance endpoints.
tagsList of tags applied to the Database Instance.
node_typeNode type of the Database Instance.
created_atCreation date (Format ISO 8601). (RFC 3339 format)
updated_atUpdate date (Format ISO 8601). (RFC 3339 format)
tls_enabledDefines whether or not TLS is enabled.
List of Database Instance settings.
List of ACL rules.
cluster_sizeNumber of nodes of the Database Instance cluster.
zoneZone of the Database Instance.
user_nameName of the user associated to the cluster.
upgradable_versionsList of engine versions the Database Instance can upgrade to.