Redis™ Database Instance

List of advanced settings to be set upon Database Instance initialization.

Create a Redis™ Database Instance › Responses

200

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

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.

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.

List of Database Instance settings.

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.

POST/redis/v1/zones/{zone}/clusters

curl -X POST \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "string",
    "node_type": "string",
    "password": "string",
    "project_id": "6170692e-7363-616c-6577-61792e636f6d",
    "tls_enabled": false,
    "user_name": "string",
    "version": "string"
  }' \
  "https://api.scaleway.com/redis/v1/zones/{zone}/clusters"

Example Request Body

{
  "project_id": "6170692e-7363-616c-6577-61792e636f6d",
  "name": "name",
  "version": "version",
  "tags": [
    "string"
  ],
  "node_type": "node_type",
  "user_name": "user_name",
  "password": "password",
  "cluster_size": 0,
  "acl_rules": [
    {
      "ip_cidr": "1.2.3.4/32",
      "description": "description"
    }
  ],
  "endpoints": [
    {
      "private_network": {
        "id": "6170692e-7363-616c-6577-61792e636f6d",
        "service_ips": [
          "1.2.3.4/32"
        ],
        "ipam_config": {}
      },
      "public_network": {}
    }
  ],
  "tls_enabled": true,
  "cluster_settings": [
    {
      "value": "value",
      "name": "name"
    }
  ]
}

json

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

Get a Redis™ Database Instance

GET

https://api.scaleway.com

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

Retrieve information about a Redis™ Database Instance (Redis™ cluster). Specify the cluster_id and region in your request to get information such as id, status, version, tls_enabled, cluster_settings, upgradable_versions and endpoints about your cluster in the response.

Get a Redis™ Database Instance › 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 cluster. (UUID format)

Get a Redis™ Database Instance › Responses

200

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

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.

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.

List of Database Instance settings.

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.

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

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

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

Delete a Redis™ Database Instance

DELETE

https://api.scaleway.com

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

Delete a Redis™ Database Instance (Redis™ cluster), specified by the region and cluster_id parameters. Deleting a Database Instance is permanent, and cannot be undone. Note that upon deletion all your data will be lost.

Delete a Redis™ Database Instance › 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 to delete. (UUID format)

Delete a Redis™ Database Instance › Responses

200

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

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.

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.

List of Database Instance settings.

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}

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

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

Update a Redis™ Database Instance

PATCH

https://api.scaleway.com

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

Update the parameters of a Redis™ Database Instance (Redis™ cluster), including name, tags, user_name and password.

Update a Redis™ Database Instance › 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 to update. (UUID format)

Update a Redis™ Database Instance › Request Body

name

string | null

Name of the Database Instance.

tags

array | null

Database Instance tags.

user_name

string | null

Name of the Database Instance user.

password

string | null

Password of the Database Instance user.

Update a Redis™ Database Instance › Responses

200

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

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.

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.

List of Database Instance settings.

scaleway.redis.v1.ClusterMetricsResponse

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.

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

curl -X PATCH \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{}' \
  "https://api.scaleway.com/redis/v1/zones/{zone}/clusters/{cluster_id}"

Example Request Body

{
  "name": "name",
  "tags": [],
  "user_name": "user_name",
  "password": "password"
}

json

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

Get metrics of a Redis™ Database Instance

GET

https://api.scaleway.com

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

Retrieve the metrics of a Redis™ Database Instance (Redis™ cluster). You can define the period from which to retrieve metrics by specifying the start_date and end_date.

Get metrics of a Redis™ Database Instance › 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 cluster. (UUID format)

Get metrics of a Redis™ Database Instance › query Parameters

start_at

string · date-time

Start date. (RFC 3339 format)

end_at

string · date-time

End date. (RFC 3339 format)

metric_name

string

Name of the metric to gather.

Get metrics of a Redis™ Database Instance › Responses

200

scaleway.std.TimeSeries[]

Time series of metrics of a given cluster.

Scale up a Redis™ Database Instance

POST

https://api.scaleway.com

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

Upgrade your Redis™ Database Instance, either by upgrading to a bigger node type (vertical scaling) or by adding more nodes to your Database Instance to increase your number of endpoints and distribute cache (horizontal scaling, available for clusters only). Note that scaling horizontally your Redis™ Database Instance will not renew its TLS certificate. In order to refresh the TLS certificate, you must use the Renew TLS certificate endpoint.

Scale up a Redis™ Database Instance › 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 to update. (UUID format)

Scale up a Redis™ Database Instance › Request Body

version

string | null

Redis™ engine version of the Database Instance.

node_type

string | null

Type of node to use for the Database Instance.

cluster_size

integer | null · uint32

Number of nodes for the Database Instance.

Scale up a Redis™ Database Instance › Responses

200

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

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.

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.

List of Database Instance settings.