ACL Rules

Network Access Control Lists (ACLs) allow you to manage network inbound traffic by setting up ACL rules.

Get an ACL rule

GET

https://api.scaleway.com

/redis/v1/zones/{zone}/acls/{acl_id}

Retrieve information about an ACL rule of a Redis™ Database Instance (Redis™ cluster). You must specify the acl_id of the rule in your request.

Get an ACL rule › 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

acl_id

string · required

UUID of the ACL rule you want to get. (UUID format)

Get an ACL rule › Responses

200

scaleway.redis.v1.ACLRule

id

string

ID of the rule. (UUID format)

ip_cidr

string

IPv4 network address of the rule. (IP network)

description

string

Description of the rule.

Delete an ACL rule for a cluster

DELETE

https://api.scaleway.com

/redis/v1/zones/{zone}/acls/{acl_id}

Delete an ACL rule of a Redis™ Database Instance (Redis™ cluster). You must specify the acl_id of the rule you want to delete in your request.

Delete an ACL rule 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

acl_id

string · required

UUID of the ACL rule you want to delete. (UUID format)

Delete an ACL rule 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}/acls/{acl_id}

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

Set ACL rules for a cluster

PUT

https://api.scaleway.com

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

Replace all the ACL rules of a Redis™ Database Instance (Redis™ cluster).

Set ACL rules 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 ACL rules have to be set. (UUID format)

Set ACL rules for a cluster › Request Body

scaleway.redis.v1.ACLRuleSpec[] · required

ACLs rules to define for the cluster.

Set ACL rules for a cluster › Responses

200

scaleway.redis.v1.SetAclRulesResponse

scaleway.redis.v1.ACLRule[]

ACL Rules enabled for the Database Instance.

Add ACL rules for a cluster

POST

https://api.scaleway.com

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

Add an additional ACL rule to a Redis™ Database Instance (Redis™ cluster).

Add ACL rules 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 ACL rules to. (UUID format)

Add ACL rules for a cluster › Request Body

scaleway.redis.v1.ACLRuleSpec[] · required

ACLs rules to add to the cluster.

Add ACL rules for a cluster › Responses

200

scaleway.redis.v1.AddAclRulesResponse

scaleway.redis.v1.ACLRule[]

ACL Rules enabled for the Database Instance.

total_count

integer · uint32

Total count of ACL rules of the Database Instance.

Advanced Settings Endpoints

Get an ACL rule

GET

https://api.scaleway.com

/redis/v1/zones/{zone}/acls/{acl_id}

Retrieve information about an ACL rule of a Redis™ Database Instance (Redis™ cluster). You must specify the acl_id of the rule in your request.

Get an ACL rule › 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

acl_id

string · required

UUID of the ACL rule you want to get. (UUID format)

Get an ACL rule › Responses

200

scaleway.redis.v1.ACLRule

id

string

ID of the rule. (UUID format)

ip_cidr

string

IPv4 network address of the rule. (IP network)

description

string

Description of the rule.

Delete an ACL rule for a cluster

DELETE

https://api.scaleway.com

/redis/v1/zones/{zone}/acls/{acl_id}

Delete an ACL rule of a Redis™ Database Instance (Redis™ cluster). You must specify the acl_id of the rule you want to delete in your request.

Delete an ACL rule 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

acl_id

string · required

UUID of the ACL rule you want to delete. (UUID format)

Delete an ACL rule 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.

Set ACL rules for a cluster

PUT

https://api.scaleway.com

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

Replace all the ACL rules of a Redis™ Database Instance (Redis™ cluster).

Set ACL rules 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 ACL rules have to be set. (UUID format)

Set ACL rules for a cluster › Request Body

scaleway.redis.v1.ACLRuleSpec[] · required

ACLs rules to define for the cluster.

Set ACL rules for a cluster › Responses

200

scaleway.redis.v1.SetAclRulesResponse

scaleway.redis.v1.ACLRule[]

ACL Rules enabled for the Database Instance.

Add ACL rules for a cluster

POST

https://api.scaleway.com

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

Add an additional ACL rule to a Redis™ Database Instance (Redis™ cluster).

Add ACL rules 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 ACL rules to. (UUID format)

Add ACL rules for a cluster › Request Body

scaleway.redis.v1.ACLRuleSpec[] · required

ACLs rules to add to the cluster.

Add ACL rules for a cluster › Responses

200

scaleway.redis.v1.AddAclRulesResponse

scaleway.redis.v1.ACLRule[]

ACL Rules enabled for the Database Instance.

total_count

integer · uint32

Total count of ACL rules of the Database Instance.