Scaleway logo
Managed Database for PostgreSQL and MySQL API

Advanced Database Instance settings allow you to tune the behavior of your database engines to better fit your needs.

Available settings depend on the database engine and its version. Note that some settings can only be defined upon database engine initialization. These are called init settings. You can find a full list of the settings available in the response body of the list available database engines endpoint.

Each advanced setting entry has a default value that users can override. The deletion of a setting entry will restore the setting to default value. Some of the defaults values can be different from the engine's defaults, as we optimize them to the Scaleway platform.


Set Database Instance advanced settings

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

Update an advanced setting for a Database Instance. Settings added upon database engine initialization can only be defined once, and cannot, therefore, be updated.

Set Database Instance advanced settings › 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 settings must be set.

Set Database Instance advanced settings › Request Body

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

Settings to define for the Database Instance.

Set Database Instance advanced settings › Responses

200

Settings configured for a Database Instance.


Add Database Instance advanced settings

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

Add an advanced setting to a Database Instance. You must set the name and the value of each setting.

Add Database Instance advanced settings › 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 settings to.

Add Database Instance advanced settings › Request Body

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

Settings to add to the Database Instance.

Add Database Instance advanced settings › Responses

200

Settings available on the Database Instance.


Delete Database Instance advanced settings

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

Delete an advanced setting in a Database Instance. You must specify the names of the settings you want to delete in the request.

Delete Database Instance advanced settings › 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 to delete settings from.

Delete Database Instance advanced settings › Request Body

setting_names
​string[] · required

Settings names to delete.

Delete Database Instance advanced settings › Responses

200

Settings names to delete from the Database Instance.