Advanced Settings

Download schema

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

PUT

https://api.scaleway.com

/redis/v1/zones/{zone}/clusters/{cluster_id}/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.

Set advanced settings › path Parameters

zone

string · enum · required

The zone you want to target

Enum values:

fr-par-1

fr-par-2

nl-ams-1

nl-ams-2

pl-waw-1

pl-waw-2

cluster_id

string · required

UUID of the Database Instance where the settings must be set. (UUID format)

Set advanced settings › Request Body

scaleway.redis.v1.ClusterSetting[] · required

Settings to define for the Database Instance.

Set advanced settings › Responses

200

scaleway.redis.v1.ClusterSettingsResponse

scaleway.redis.v1.ClusterSetting[]

Settings configured for a given Database Instance.

Add advanced settings

POST

https://api.scaleway.com

/redis/v1/zones/{zone}/clusters/{cluster_id}/settings

Add an advanced setting to a Redis™ Database Instance (Redis™ cluster). You must set the name and the value of each setting.

Add advanced settings › path Parameters

zone

string · enum · required

The zone you want to target

Enum values:

fr-par-1

fr-par-2

nl-ams-1

nl-ams-2

pl-waw-1

pl-waw-2

cluster_id

string · required

UUID of the Database Instance you want to add settings to. (UUID format)

Add advanced settings › Request Body

scaleway.redis.v1.ClusterSetting[] · required

Settings to add to the cluster.

Add advanced settings › Responses

200

scaleway.redis.v1.ClusterSettingsResponse

scaleway.redis.v1.ClusterSetting[]

Settings configured for a given Database Instance.

Delete advanced setting

DELETE

https://api.scaleway.com

/redis/v1/zones/{zone}/clusters/{cluster_id}/settings/{setting_name}

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.

Delete advanced setting › path Parameters

zone

string · enum · required

The zone you want to target

Enum values:

fr-par-1

fr-par-2

nl-ams-1

nl-ams-2

pl-waw-1

pl-waw-2

cluster_id

string · required

UUID of the Database Instance where the settings must be set. (UUID format)

setting_name

string · required

Setting name to delete.

Delete advanced setting › Responses

200

scaleway.redis.v1.Cluster

id

string

UUID of the Database Instance. (UUID format)

name

string

Name of the Database Instance.

project_id

string

Project ID the Database Instance belongs to. (UUID format)

status

scaleway.redis.v1.Cluster.Status · enum

Status of the Database Instance.

Enum values:

unknown

ready

provisioning

configuring

deleting

error

autohealing

locked

Default: unknown

version

string

Redis™ engine version of the Database Instance.

scaleway.redis.v1.Endpoint[]

List of Database Instance endpoints.

tags

string[]

List of tags applied to the Database Instance.

node_type

string

Node type of the Database Instance.

created_at

string | null · date-time

Creation date (Format ISO 8601). (RFC 3339 format)

updated_at

string | null · date-time

Update date (Format ISO 8601). (RFC 3339 format)

tls_enabled

boolean

Defines whether or not TLS is enabled.

scaleway.redis.v1.ClusterSetting[]

List of Database Instance settings.

scaleway.redis.v1.ACLRule[]

List of ACL rules.

cluster_size

integer · uint32

Number of nodes of the Database Instance cluster.

zone

string

Zone of the Database Instance.

user_name

string

Name of the user associated to the cluster.

upgradable_versions

string[]

List of engine versions the Database Instance can upgrade to.

srn

string

Scaleway Resource Name of the Database Instance.

DELETE/redis/v1/zones/{zone}/clusters/{cluster_id}/settings/{setting_name}

curl -X DELETE \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  "https://api.scaleway.com/redis/v1/zones/{zone}/clusters/{cluster_id}/settings/{setting_name}"

Example Responses

{
  "id": "6170692e-7363-616c-6577-61792e636f6d",
  "name": "name",
  "project_id": "6170692e-7363-616c-6577-61792e636f6d",
  "status": "unknown",
  "version": "version",
  "endpoints": [
    {
      "port": 0,
      "private_network": {
        "id": "6170692e-7363-616c-6577-61792e636f6d",
        "service_ips": [
          "1.2.3.4/32"
        ],
        "zone": "zone",
        "provisioning_mode": "static"
      },
      "public_network": {},
      "ips": [
        "1.2.3.4"
      ],
      "id": "6170692e-7363-616c-6577-61792e636f6d"
    }
  ],
  "tags": [
    "string"
  ],
  "node_type": "node_type",
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "tls_enabled": true,
  "cluster_settings": [
    {
      "value": "value",
      "name": "name"
    }
  ],
  "acl_rules": [
    {
      "id": "6170692e-7363-616c-6577-61792e636f6d",
      "ip_cidr": "1.2.3.4/32",
      "description": "description"
    }
  ],
  "cluster_size": 0,
  "zone": "zone",
  "user_name": "user_name",
  "upgradable_versions": [
    "string"
  ],
  "srn": "srn"
}

json

application/json

TLS Certificates ACL Rules