TLS Certificates

Download schema

Transport Layer Security (TLS) is an Internet security protocol that enables data to be securely exchanged over a network using in transit encryption. If you set the tls_enabled parameter to true when creating or updating a cluster, a TLS certificate will be automatically generated for your Redis™ Database Instance to ensure secure connections.

Get the TLS certificate of a cluster

GET

https://api.scaleway.com

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

Retrieve information about the TLS certificate of a Redis™ Database Instance (Redis™ cluster). Details like name and content are returned in the response.

Get the TLS certificate of a cluster › 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 the TLS certificate of a cluster › Responses

200

scaleway.std.File

name

string

content_type

string

content

string

Renew the TLS certificate of a cluster

POST

https://api.scaleway.com

/redis/v1/zones/{zone}/clusters/{cluster_id}/renew-certificate

Renew a TLS certificate for a Redis™ Database Instance (Redis™ cluster). Renewing a certificate means that you will not be able to connect to your Database Instance using the previous certificate. You will also need to download and update the new certificate for all database clients.

Renew the TLS certificate of a cluster › 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)

Renew the TLS certificate of a cluster › Request Body

Renew the TLS certificate of a cluster › 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

string · 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 · date-time

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

updated_at

string · 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.

POST/redis/v1/zones/{zone}/clusters/{cluster_id}/renew-certificate

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

Example Request Body

{}

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"
  ]
}

json

application/json

Redis™ engine versions Advanced Settings

Get the TLS certificate of a cluster

GET

https://api.scaleway.com

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

Retrieve information about the TLS certificate of a Redis™ Database Instance (Redis™ cluster). Details like name and content are returned in the response.

Get the TLS certificate of a cluster › 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 the TLS certificate of a cluster › Responses

200

scaleway.std.File

name

string

content_type

string

content

string

Renew the TLS certificate of a cluster

POST

https://api.scaleway.com

/redis/v1/zones/{zone}/clusters/{cluster_id}/renew-certificate

Renew the TLS certificate of a cluster › 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)

Renew the TLS certificate of a cluster › Request Body

Renew the TLS certificate of a cluster › 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

string · 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 · date-time

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

updated_at

string · 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.