Scaleway logo
Managed Database for PostgreSQL and MySQL API
Managed Database for PostgreSQL and MySQL API

ACLs

Download schema

Network Access Control Lists allow you to control incoming network traffic by setting up ACL rules.

List ACL rules of a Database Instance

GET
https://api.scaleway.com
/rdb/v1/regions/{region}/instances/{instance_id}/acls

List the ACL rules for a given Database Instance. The response is an array of ACL objects, each one representing an ACL that denies, allows or redirects traffic based on certain conditions.

List ACL rules of a Database Instance › path Parameters

region
​string · enum · required

The region you want to target

Enum values:
fr-par
nl-ams
pl-waw
instance_id
​string · required

UUID of the Database Instance.

List ACL rules of a Database Instance › query Parameters

page
​google.protobuf.Int32Value · int32
page_size
​integer · uint32

List ACL rules of a Database Instance › Responses

200
scaleway.rdb.v1.ListInstanceACLRulesResponse

List of ACL rules present on a Database Instance.

total_count
​integer · uint32

Total count of ACL rules present on a Database Instance.

Set ACL rules for a Database Instance

PUT
https://api.scaleway.com
/rdb/v1/regions/{region}/instances/{instance_id}/acls

Replace all the ACL rules of a Database Instance.

Set ACL rules for a Database Instance › path Parameters

region
​string · enum · required

The region you want to target

Enum values:
fr-par
nl-ams
pl-waw
instance_id
​string · required

UUID of the Database Instance where the ACL rules must be set.

Set ACL rules for a Database Instance › Request Body

​scaleway.rdb.v1.ACLRuleRequest[] · required

ACL rules to define for the Database Instance.

Set ACL rules for a Database Instance › Responses

200
scaleway.rdb.v1.SetInstanceACLRulesResponse

ACLs rules configured for a Database Instance.

Add an ACL rule to a Database Instance

POST
https://api.scaleway.com
/rdb/v1/regions/{region}/instances/{instance_id}/acls

Add an additional ACL rule to a Database Instance.

Add an ACL rule to a Database Instance › path Parameters

region
​string · enum · required

The region you want to target

Enum values:
fr-par
nl-ams
pl-waw
instance_id
​string · required

UUID of the Database Instance you want to add ACL rules to.

Add an ACL rule to a Database Instance › Request Body

​scaleway.rdb.v1.ACLRuleRequest[] · required

ACL rules to add to the Database Instance.

Add an ACL rule to a Database Instance › Responses

200
scaleway.rdb.v1.AddInstanceACLRulesResponse

ACL Rules enabled for the Database Instance.

Delete ACL rules of a Database Instance

DELETE
https://api.scaleway.com
/rdb/v1/regions/{region}/instances/{instance_id}/acls

Delete one or more ACL rules of a Database Instance.

Delete ACL rules of a Database Instance › path Parameters

region
​string · enum · required

The region you want to target

Enum values:
fr-par
nl-ams
pl-waw
instance_id
​string · required

UUID of the Database Instance you want to delete an ACL rule from.

Delete ACL rules of a Database Instance › Request Body

acl_rule_ips
​string[] · required

IP addresses defined in the ACL rules of the Database Instance.

Delete ACL rules of a Database Instance › Responses

200
scaleway.rdb.v1.DeleteInstanceACLRulesResponse

IP addresses defined in the ACL rules of the Database Instance.

Read ReplicasInstance Settings