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

Databases

Download schema

Databases can be used to store and manage sets of structured information, or data. The interaction between the user and a database is done using a Database Engine, which provides a structured query language to add, modify or delete information from the database.

List databases in a Database Instance

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

List all databases of a given Database Instance. By default, the databases returned in the list are ordered by creation date in ascending order, though this can be modified via the order_by field. You can define additional parameters for your query, such as name, managed and owner.

List databases in 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 to list the databases of.

List databases in a Database Instance › query Parameters

name
​string

Name of the database.

managed
​boolean

Defines whether or not the database is managed.

owner
​string

User that owns this database.

order_by
​scaleway.rdb.v1.ListDatabasesRequest.OrderBy · enum

Criteria to use when ordering database listing.

Enum values:
name_asc
name_desc
size_asc
size_desc
Default: name_asc
skip_size_retrieval
​boolean

Whether to skip the retrieval of each database size. If true, the size of each returned database will be set to 0.

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

List databases in a Database Instance › Responses

200
scaleway.rdb.v1.ListDatabasesResponse

List of the databases.

total_count
​integer · uint32

Total count of databases present on a Database Instance.

Create a database in a Database Instance

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

Create a new database. You must define the name parameter in the request.

Create a database in 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 to create the database.

Create a database in a Database Instance › Request Body

name
​string

Name of the database.

Create a database in a Database Instance › Responses

200
scaleway.rdb.v1.Database
name
​string

Name of the database.

owner
​string

Name of the database owner.

managed
​boolean

Defines whether the database is managed or not.

size
​integer · uint64

Size of the database. Set to 0 if the size retrieval is too time-consuming or skip_size_retrieval is set to true. (in bytes)

Delete a database in a Database Instance

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

Delete a given database on a Database Instance. You must specify, in the endpoint, the region, instance_id and name parameters of the database you want to delete.

Delete a database in 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 to delete the database.

name
​string · required

Name of the database to delete.

Delete a database in a Database Instance › Responses

No data returned
UsersNodeTypes