Endpoints

Manage endpoint access to your Redis™ Database Instance through Public or Private Networks

Set endpoints for a cluster

PUT

https://api.scaleway.com

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

Update an endpoint for a Redis™ Database Instance (Redis™ cluster). You must specify the cluster_id and the endpoints parameters in your request.

Set endpoints for 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 Database Instance where the endpoints have to be set. (UUID format)

Set endpoints for a cluster › Request Body

scaleway.redis.v1.EndpointSpec[] · required

Endpoints to define for the Database Instance.

Set endpoints for a cluster › Responses

200

scaleway.redis.v1.SetEndpointsResponse

scaleway.redis.v1.Endpoint[]

Endpoints defined on the Database Instance.

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

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

Example Request Body

{
  "endpoints": [
    {
      "private_network": {
        "id": "6170692e-7363-616c-6577-61792e636f6d",
        "service_ips": [
          "1.2.3.4/32"
        ],
        "ipam_config": {}
      },
      "public_network": {}
    }
  ]
}

json

Example Responses

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

json

application/json

Add endpoints for a cluster

POST

https://api.scaleway.com

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

Add a new endpoint for a Redis™ Database Instance (Redis™ cluster). You can add private_network or public_network specifications to the body of the request.

Add endpoints for 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 Database Instance you want to add endpoints to. (UUID format)

Add endpoints for a cluster › Request Body

scaleway.redis.v1.EndpointSpec[] · required

Endpoints to add to the Database Instance.

Add endpoints for a cluster › Responses

200

scaleway.redis.v1.AddEndpointsResponse

scaleway.redis.v1.Endpoint[]

Endpoints defined on the Database Instance.

total_count

integer · uint32

Total count of endpoints of the Database Instance.

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

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

Example Request Body

{
  "endpoints": [
    {
      "private_network": {
        "id": "6170692e-7363-616c-6577-61792e636f6d",
        "service_ips": [
          "1.2.3.4/32"
        ],
        "ipam_config": {}
      },
      "public_network": {}
    }
  ]
}

json

Example Responses

{
  "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"
    }
  ],
  "total_count": 0
}

json

application/json

Get an endpoint

GET

https://api.scaleway.com

/redis/v1/zones/{zone}/endpoints/{endpoint_id}

Retrieve information about a Redis™ Database Instance (Redis™ cluster) endpoint. Full details about the endpoint, like ips, port, private_network and public_network specifications are returned in the response.

Get an endpoint › 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

endpoint_id

string · required

UUID of the endpoint you want to get. (UUID format)

Get an endpoint › Responses

200

scaleway.redis.v1.Endpoint

port

integer · uint32

TCP port of the endpoint.

object

Private Network details.

public_network

object

Public network details.

ips

string[]

List of IPv4 addresses of the endpoint. (IP address)

id

string

UUID of the endpoint. (UUID format)

Delete an endpoint for a cluster

DELETE

https://api.scaleway.com

/redis/v1/zones/{zone}/endpoints/{endpoint_id}

Delete the endpoint of a Redis™ Database Instance (Redis™ cluster). You must specify the region and endpoint_id parameters of the endpoint you want to delete. Note that might need to update any environment configurations that point to the deleted endpoint.

Delete an endpoint for 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

endpoint_id

string · required

UUID of the endpoint you want to delete. (UUID format)

Delete an endpoint for 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.

DELETE/redis/v1/zones/{zone}/endpoints/{endpoint_id}

curl -X DELETE \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  "https://api.scaleway.com/redis/v1/zones/{zone}/endpoints/{endpoint_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"
  ]
}

json

application/json

Update an endpoint

PATCH

https://api.scaleway.com

/redis/v1/zones/{zone}/endpoints/{endpoint_id}

Update information about a Redis™ Database Instance (Redis™ cluster) endpoint. Full details about the endpoint, like ips, port, private_network and public_network specifications are returned in the response.

Update an endpoint › 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

endpoint_id

string · required

UUID of the endpoint you want to get. (UUID format)

Update an endpoint › Request Body

object

Private Network details.

public_network

object

Public network details.

Update an endpoint › Responses

200

scaleway.redis.v1.Endpoint

port

integer · uint32

TCP port of the endpoint.

object

Private Network details.

public_network

object

Public network details.

ips

string[]

List of IPv4 addresses of the endpoint. (IP address)

id

string

UUID of the endpoint. (UUID format)

ACL Rules

Set endpoints for a cluster

PUT

https://api.scaleway.com

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

Update an endpoint for a Redis™ Database Instance (Redis™ cluster). You must specify the cluster_id and the endpoints parameters in your request.

Set endpoints for 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 Database Instance where the endpoints have to be set. (UUID format)

Set endpoints for a cluster › Request Body

scaleway.redis.v1.EndpointSpec[] · required

Endpoints to define for the Database Instance.

Set endpoints for a cluster › Responses

200

scaleway.redis.v1.SetEndpointsResponse

scaleway.redis.v1.Endpoint[]

Endpoints defined on the Database Instance.

Add endpoints for a cluster

POST

https://api.scaleway.com

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

Add a new endpoint for a Redis™ Database Instance (Redis™ cluster). You can add private_network or public_network specifications to the body of the request.

Add endpoints for 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 Database Instance you want to add endpoints to. (UUID format)

Add endpoints for a cluster › Request Body

scaleway.redis.v1.EndpointSpec[] · required

Endpoints to add to the Database Instance.

Add endpoints for a cluster › Responses

200

scaleway.redis.v1.AddEndpointsResponse

scaleway.redis.v1.Endpoint[]

Endpoints defined on the Database Instance.

total_count

integer · uint32

Total count of endpoints of the Database Instance.

Get an endpoint

GET

https://api.scaleway.com

/redis/v1/zones/{zone}/endpoints/{endpoint_id}

Get an endpoint › 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

endpoint_id

string · required

UUID of the endpoint you want to get. (UUID format)

Get an endpoint › Responses

200

scaleway.redis.v1.Endpoint

port

integer · uint32

TCP port of the endpoint.

object

Private Network details.

public_network

object

Public network details.

ips

string[]

List of IPv4 addresses of the endpoint. (IP address)

id

string

UUID of the endpoint. (UUID format)

Delete an endpoint for a cluster

DELETE

https://api.scaleway.com

/redis/v1/zones/{zone}/endpoints/{endpoint_id}

Delete an endpoint for 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

endpoint_id

string · required

UUID of the endpoint you want to delete. (UUID format)

Delete an endpoint for 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.

Update an endpoint

PATCH

https://api.scaleway.com

/redis/v1/zones/{zone}/endpoints/{endpoint_id}

Update an endpoint › 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

endpoint_id

string · required

UUID of the endpoint you want to get. (UUID format)

Update an endpoint › Request Body

object

Private Network details.

public_network

object

Public network details.

Update an endpoint › Responses

200

scaleway.redis.v1.Endpoint

port

integer · uint32

TCP port of the endpoint.

object

Private Network details.

public_network

object

Public network details.

ips

string[]

List of IPv4 addresses of the endpoint. (IP address)

id

string

UUID of the endpoint. (UUID format)