Managed Database for Redis™ APIv1alpha1

Download OpenAPI

Introduction

Managed Database for Redis™ is a service that provides Redis™ database as a service instances.

Clusters

A Managed Database for Redis™ cluster is composed of one or more Nodes depending of the cluster_size setting.

List clusters

GET
/redis/v1alpha1/zones/{zone}/clusters
Path Parameters
zone
required string
The zone you want to target. Possible values are fr-par-1, fr-par-2, nl-ams-1 and pl-waw-1.
Query Parameters
tags
array
Tags of the clusters to filter upon.
name
nullable string
Name of the clusters to filter upon.
order_by
string
Criteria to use when ordering cluster listing. Possible values are created_at_asc, created_at_desc, name_asc and name_desc. The default value is created_at_asc.
project_id
nullable string
Project ID to list the cluster of (UUID format).
organization_id
nullable string
Organization ID to list the cluster of (UUID format).
page
number
Page number. The default value is 1.
page_size
number
Page size. The default value is 20.
200 Response
clusters
array
List all clusters.
total_count
number
Total count of clusters.
Response Example

Create a cluster

POST
/redis/v1alpha1/zones/{zone}/clusters
Path Parameters
zone
required string
The zone you want to target. Possible values are fr-par-1, fr-par-2, nl-ams-1 and pl-waw-1.
Body
project_id
required string
The project ID on which to create the cluster (UUID format).
name
string
Name of the cluster.
version
required string
Redis™ engine version of the cluster.
tags
array
Tags to apply to the cluster.
node_type
required string
Type of node to use for the cluster.
user_name
required string
Name of the user created when the cluster is created.
password
required string
Password of the user.
cluster_size
nullable number
Number of nodes for the cluster.
acl_rules
array
List of ACLRuleSpec used to secure your publicly exposed cluster.
endpoints
array
Zero or multiple EndpointSpec used to expose your cluster publicly and inside private networks. If no EndpoindSpec is given the cluster will be publicly exposed by default.
tls_enabled
boolean
Whether or not TLS is enabled.
cluster_settings
array
List of cluster settings to be set at cluster initialisation.
Request Example
200 Response
id
string
UUID of the cluster (UUID format).
name
string
Name of the cluster.
project_id
string
Project ID the cluster belongs to (UUID format).
status
string
Status of the cluster. Possible values are unknown, ready, provisioning, configuring, destroying, error, autohealing, locked, suspended and initializing. The default value is unknown.
version
string
Redis™ engine version of the cluster.
endpoints
array
List of cluster endpoints.
tags
array
List of tags applied to the cluster.
node_type
string
Node type of the cluster.
created_at
string
Creation date (Format ISO 8601) (RFC 3339 format).
updated_at
string
Update date (Format ISO 8601) (RFC 3339 format).
tls_enabled
boolean
Whether or not TLS is enabled.
cluster_settings
array
List of cluster settings.
acl_rules
array
List of acl rules.
cluster_size
number
Number of nodes of the cluster.
zone
string
Zone of the cluster.
Response Example

Get a cluster

GET
/redis/v1alpha1/zones/{zone}/clusters/{cluster_id}
Path Parameters
zone
required string
The zone you want to target. Possible values are fr-par-1, fr-par-2, nl-ams-1 and pl-waw-1.
cluster_id
required string
UUID of the cluster (UUID format).
200 Response
id
string
UUID of the cluster (UUID format).
name
string
Name of the cluster.
project_id
string
Project ID the cluster belongs to (UUID format).
status
string
Status of the cluster. Possible values are unknown, ready, provisioning, configuring, destroying, error, autohealing, locked, suspended and initializing. The default value is unknown.
version
string
Redis™ engine version of the cluster.
endpoints
array
List of cluster endpoints.
tags
array
List of tags applied to the cluster.
node_type
string
Node type of the cluster.
created_at
string
Creation date (Format ISO 8601) (RFC 3339 format).
updated_at
string
Update date (Format ISO 8601) (RFC 3339 format).
tls_enabled
boolean
Whether or not TLS is enabled.
cluster_settings
array
List of cluster settings.
acl_rules
array
List of acl rules.
cluster_size
number
Number of nodes of the cluster.
zone
string
Zone of the cluster.
Response Example

Update a cluster

PATCH
/redis/v1alpha1/zones/{zone}/clusters/{cluster_id}
Path Parameters
zone
required string
The zone you want to target. Possible values are fr-par-1, fr-par-2, nl-ams-1 and pl-waw-1.
cluster_id
required string
UUID of the cluster to update (UUID format).
Body
name
nullable string
Name of the cluster.
tags
nullable array
Tags of a given cluster.
user_name
nullable string
Name of the cluster user.
password
nullable string
Password of the cluster user.
Request Example
200 Response
id
string
UUID of the cluster (UUID format).
name
string
Name of the cluster.
project_id
string
Project ID the cluster belongs to (UUID format).
status
string
Status of the cluster. Possible values are unknown, ready, provisioning, configuring, destroying, error, autohealing, locked, suspended and initializing. The default value is unknown.
version
string
Redis™ engine version of the cluster.
endpoints
array
List of cluster endpoints.
tags
array
List of tags applied to the cluster.
node_type
string
Node type of the cluster.
created_at
string
Creation date (Format ISO 8601) (RFC 3339 format).
updated_at
string
Update date (Format ISO 8601) (RFC 3339 format).
tls_enabled
boolean
Whether or not TLS is enabled.
cluster_settings
array
List of cluster settings.
acl_rules
array
List of acl rules.
cluster_size
number
Number of nodes of the cluster.
zone
string
Zone of the cluster.
Response Example

Delete a cluster

DELETE
/redis/v1alpha1/zones/{zone}/clusters/{cluster_id}
Path Parameters
zone
required string
The zone you want to target. Possible values are fr-par-1, fr-par-2, nl-ams-1 and pl-waw-1.
cluster_id
required string
UUID of the cluster to delete (UUID format).
200 Response
id
string
UUID of the cluster (UUID format).
name
string
Name of the cluster.
project_id
string
Project ID the cluster belongs to (UUID format).
status
string
Status of the cluster. Possible values are unknown, ready, provisioning, configuring, destroying, error, autohealing, locked, suspended and initializing. The default value is unknown.
version
string
Redis™ engine version of the cluster.
endpoints
array
List of cluster endpoints.
tags
array
List of tags applied to the cluster.
node_type
string
Node type of the cluster.
created_at
string
Creation date (Format ISO 8601) (RFC 3339 format).
updated_at
string
Update date (Format ISO 8601) (RFC 3339 format).
tls_enabled
boolean
Whether or not TLS is enabled.
cluster_settings
array
List of cluster settings.
acl_rules
array
List of acl rules.
cluster_size
number
Number of nodes of the cluster.
zone
string
Zone of the cluster.
Response Example

Get metrics of a cluster

GET
/redis/v1alpha1/zones/{zone}/clusters/{cluster_id}/metrics
Path Parameters
zone
required string
The zone you want to target. Possible values are fr-par-1, fr-par-2, nl-ams-1 and pl-waw-1.
cluster_id
required string
UUID of the cluster (UUID format).
Query Parameters
start_date
string
Start date to gather metrics from (RFC 3339 format).
end_date
string
End date to gather metrics from (RFC 3339 format).
metric_name
nullable string
Name of the metric to gather.
200 Response
timeseries
array
Time series of metrics of a given cluster.
Response Example

Migrate your cluster architecture

Upgrade your Database for Redis® cluster to a new version or scale it vertically / horizontally. Please note: scaling horizontally your Database for Redis® cluster won't renew its TLS certificate. In order to refresh the SSL certificate, you have to use the dedicated api route.

POST
/redis/v1alpha1/zones/{zone}/clusters/{cluster_id}/migrate
Path Parameters
zone
required string
The zone you want to target. Possible values are fr-par-1, fr-par-2, nl-ams-1 and pl-waw-1.
cluster_id
required string
UUID of the cluster to update (UUID format).
Body
version
string
Redis™ engine version of the cluster. Only one of version, node_type and cluster_size may be set.
node_type
string
Type of node to use for the cluster. Only one of version, node_type and cluster_size may be set.
cluster_size
number
Number of nodes for the cluster. Only one of version, node_type and cluster_size may be set.
Request Example
200 Response
id
string
UUID of the cluster (UUID format).
name
string
Name of the cluster.
project_id
string
Project ID the cluster belongs to (UUID format).
status
string
Status of the cluster. Possible values are unknown, ready, provisioning, configuring, destroying, error, autohealing, locked, suspended and initializing. The default value is unknown.
version
string
Redis™ engine version of the cluster.
endpoints
array
List of cluster endpoints.
tags
array
List of tags applied to the cluster.
node_type
string
Node type of the cluster.
created_at
string
Creation date (Format ISO 8601) (RFC 3339 format).
updated_at
string
Update date (Format ISO 8601) (RFC 3339 format).
tls_enabled
boolean
Whether or not TLS is enabled.
cluster_settings
array
List of cluster settings.
acl_rules
array
List of acl rules.
cluster_size
number
Number of nodes of the cluster.
zone
string
Zone of the cluster.
Response Example

Nodes Types

Node types powering your cluster.

List available node types

GET
/redis/v1alpha1/zones/{zone}/node-types
Path Parameters
zone
required string
The zone you want to target. Possible values are fr-par-1, fr-par-2, nl-ams-1 and pl-waw-1.
Query Parameters
include_disabled_types
boolean
Whether or not to include disabled types.
page
number
Page number. The default value is 1.
page_size
number
Page size. The default value is 20.
200 Response
node_types
array
Types of the node.
total_count
number
Total count of node-types available.
Response Example

Redis™ Versions

Redis™ versions powering your cluster.

List available Redis™ versions

GET
/redis/v1alpha1/zones/{zone}/versions
Path Parameters
zone
required string
The zone you want to target. Possible values are fr-par-1, fr-par-2, nl-ams-1 and pl-waw-1.
Query Parameters
include_disabled
boolean
Whether or not to include disabled Redis™ engine versions.
include_beta
boolean
Whether or not to include beta Redis™ engine versions.
include_deprecated
boolean
Whether or not to include deprecated Redis™ engine versions.
version_name
nullable string
List Redis™ engine versions that match a given name pattern.
page
number
Page number. The default value is 1.
page_size
number
Page size. The default value is 20.
200 Response
versions
array
List of the available Redis™ engine versions.
total_count
number
Total count of available Redis™ engine versions.
Response Example

Certificate

Manage TLS certificate of your cluster.

Get the TLS certificate of a cluster

GET
/redis/v1alpha1/zones/{zone}/clusters/{cluster_id}/certificate
Path Parameters
zone
required string
The zone you want to target. Possible values are fr-par-1, fr-par-2, nl-ams-1 and pl-waw-1.
cluster_id
required string
UUID of the cluster (UUID format).
200 Response
name
string
content_type
string
content
string
Response Example

Renew the TLS certificate of a cluster

POST
/redis/v1alpha1/zones/{zone}/clusters/{cluster_id}/renew-certificate
Path Parameters
zone
required string
The zone you want to target. Possible values are fr-par-1, fr-par-2, nl-ams-1 and pl-waw-1.
cluster_id
required string
UUID of the cluster (UUID format).
Body
Request Example
204 Response
Empty response

Settings

Available Redis™ settings. Available settings depend on the Redis™ version.

Add cluster settings

POST
/redis/v1alpha1/zones/{zone}/clusters/{cluster_id}/settings
Path Parameters
zone
required string
The zone you want to target. Possible values are fr-par-1, fr-par-2, nl-ams-1 and pl-waw-1.
cluster_id
required string
UUID of the cluster you want to add settings to (UUID format).
Body
settings
required array
Settings to add on the cluster.
Request Example
200 Response
settings
array
Settings configured for a given cluster.
Response Example

Set cluster settings

PUT
/redis/v1alpha1/zones/{zone}/clusters/{cluster_id}/settings
Path Parameters
zone
required string
The zone you want to target. Possible values are fr-par-1, fr-par-2, nl-ams-1 and pl-waw-1.
cluster_id
required string
UUID of the cluster where the settings has to be set (UUID format).
Body
settings
required array
Settings to define for the cluster.
Request Example
200 Response
settings
array
Settings configured for a given cluster.
Response Example

Delete a cluster setting

DELETE
/redis/v1alpha1/zones/{zone}/clusters/{cluster_id}/settings
Path Parameters
zone
required string
The zone you want to target. Possible values are fr-par-1, fr-par-2, nl-ams-1 and pl-waw-1.
cluster_id
required string
UUID of the cluster where the settings has to be set (UUID format).
Body
settings_name
string
Setting name to delete.
Request Example
204 Response
Empty response

ACL Rules

Network Access Control List allows to control network inbound traffic allowed by setting up ACL rules. ACL rules could be created, edited, deleted.

Get an ACL rule

GET
/redis/v1alpha1/zones/{zone}/acls/{acl_id}
Path Parameters
zone
required string
The zone you want to target. Possible values are fr-par-1, fr-par-2, nl-ams-1 and pl-waw-1.
acl_id
required string
UUID of the acl rule you want to get (UUID format).
200 Response
id
string
ID of the rule (UUID format).
ip
nullable string
IPv4 network address of the rule (IP network).
description
nullable string
Description of the rule.
Response Example

Delete an ACL rule for a given cluster

DELETE
/redis/v1alpha1/zones/{zone}/acls/{acl_id}
Path Parameters
zone
required string
The zone you want to target. Possible values are fr-par-1, fr-par-2, nl-ams-1 and pl-waw-1.
acl_id
required string
UUID of the acl rule you want to delete (UUID format).
204 Response
Empty response

Add ACL rules for a given cluster

POST
/redis/v1alpha1/zones/{zone}/clusters/{cluster_id}/acls
Path Parameters
zone
required string
The zone you want to target. Possible values are fr-par-1, fr-par-2, nl-ams-1 and pl-waw-1.
cluster_id
required string
UUID of the cluster you want to add acl rules to (UUID format).
Body
acl_rules
required array
ACLs rules to add to the cluster.
Request Example
200 Response
acl_rules
array
ACL Rules enabled on the cluster.
Response Example

Set ACL rules for a given cluster

PUT
/redis/v1alpha1/zones/{zone}/clusters/{cluster_id}/acls
Path Parameters
zone
required string
The zone you want to target. Possible values are fr-par-1, fr-par-2, nl-ams-1 and pl-waw-1.
cluster_id
required string
UUID of the cluster where the ACL rules has to be set (UUID format).
Body
acl_rules
required array
ACLs rules to define for the cluster.
Request Example
200 Response
acl_rules
array
ACL Rules enabled on the cluster.
Response Example

Endpoints

Manage endpoints to access to your cluster trough Public or Private networks

Add endpoints for a given cluster

POST
/redis/v1alpha1/zones/{zone}/clusters/{cluster_id}/endpoints
Path Parameters
zone
required string
The zone you want to target. Possible values are fr-par-1, fr-par-2, nl-ams-1 and pl-waw-1.
cluster_id
required string
UUID of the cluster you want to add endpoints to (UUID format).
Body
endpoints
required array
Endpoints to add to the cluster.
Request Example
200 Response
endpoints
array
Endpoints defined on the cluster.
total_count
number
Total count of endpoints of the cluster.
Response Example

Set endpoints for a given cluster

PUT
/redis/v1alpha1/zones/{zone}/clusters/{cluster_id}/endpoints
Path Parameters
zone
required string
The zone you want to target. Possible values are fr-par-1, fr-par-2, nl-ams-1 and pl-waw-1.
cluster_id
required string
UUID of the cluster where the endpoints has to be set (UUID format).
Body
endpoints
required array
Endpoints to define for the cluster.
Request Example
200 Response
endpoints
array
Endpoints defined on the cluster.
total_count
number
Total count of endpoints of the cluster.
Response Example

Get an endpoint

GET
/redis/v1alpha1/zones/{zone}/endpoints/{endpoint_id}
Path Parameters
zone
required string
The zone you want to target. Possible values are fr-par-1, fr-par-2, nl-ams-1 and pl-waw-1.
endpoint_id
required string
UUID of the endpoint you want to get (UUID format).
200 Response
port
number
TCP port of the endpoint.
private_network
object
Private network details. Only one of private_network and public_network may be set.
public_network
object
Public network details. Only one of private_network and public_network may be set.
ips
array
Lis of IPv4 address of the endpoint (IP address).
id
string
UUID of the endpoint (UUID format).
Response Example

Delete an endpoint for a given cluster

DELETE
/redis/v1alpha1/zones/{zone}/endpoints/{endpoint_id}
Path Parameters
zone
required string
The zone you want to target. Possible values are fr-par-1, fr-par-2, nl-ams-1 and pl-waw-1.
endpoint_id
required string
UUID of the endpoint you want to delete (UUID format).
204 Response
Empty response

MISC

MISC methods

UpdateEndpoint

PATCH
/redis/v1alpha1/zones/{zone}/endpoints/{endpoint_id}
Path Parameters
zone
required string
The zone you want to target. Possible values are fr-par-1, fr-par-2, nl-ams-1 and pl-waw-1.
endpoint_id
required string
(UUID format).
Body
endpoint
object
Request Example
200 Response
port
number
TCP port of the endpoint.
private_network
object
Private network details. Only one of private_network and public_network may be set.
public_network
object
Public network details. Only one of private_network and public_network may be set.
ips
array
Lis of IPv4 address of the endpoint (IP address).
id
string
UUID of the endpoint (UUID format).
Response Example