Database Management

Download schema

Manage databases within a deployment.

List databases within a deployment

GET

https://api.scaleway.com

/datawarehouse/v1beta1/regions/{region}/deployments/{deployment_id}/databases

List databases within a deployment › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

deployment_id

string · required

UUID of the deployment.

List databases within a deployment › query Parameters

name

string

Name of the database to filter by.

order_by

string · enum

Criteria to use when ordering database listings.

Enum values:

name_asc

name_desc

size_asc

size_desc

Default: name_asc

page

integer · int32

page_size

integer · uint32

List databases within a deployment › Responses

200

scaleway.datawarehouse.v1beta1.ListDatabasesResponse

scaleway.datawarehouse.v1beta1.Database[]

List of databases associated with the deployment.

total_count

integer · uint32

Total count of databases associated with the deployment.

Create a new database within a deployment

POST

https://api.scaleway.com

/datawarehouse/v1beta1/regions/{region}/deployments/{deployment_id}/databases

Create a new database within a deployment › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

deployment_id

string · required

UUID of the deployment.

Create a new database within a deployment › Request Body

name

string

Name of the database.

Create a new database within a deployment › Responses

200

scaleway.datawarehouse.v1beta1.Database

name

string

Name of the database.

size

integer · uint64

Size of the database. (in bytes)

Delete a database from a deployment

DELETE

https://api.scaleway.com

/datawarehouse/v1beta1/regions/{region}/deployments/{deployment_id}/databases/{name}

Delete a database from a deployment › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

deployment_id

string · required

UUID of the deployment.

name

string · required

Name of the database to delete.

Delete a database from a deployment › Responses

No data returned

User Management Endpoint Management

List databases within a deployment

GET

https://api.scaleway.com

/datawarehouse/v1beta1/regions/{region}/deployments/{deployment_id}/databases

List databases within a deployment › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

deployment_id

string · required

UUID of the deployment.

List databases within a deployment › query Parameters

name

string

Name of the database to filter by.

order_by

string · enum

Criteria to use when ordering database listings.

Enum values:

name_asc

name_desc

size_asc

size_desc

Default: name_asc

page

integer · int32

page_size

integer · uint32

List databases within a deployment › Responses

200

scaleway.datawarehouse.v1beta1.ListDatabasesResponse

scaleway.datawarehouse.v1beta1.Database[]

List of databases associated with the deployment.

total_count

integer · uint32

Total count of databases associated with the deployment.

Create a new database within a deployment

POST

https://api.scaleway.com

/datawarehouse/v1beta1/regions/{region}/deployments/{deployment_id}/databases

Create a new database within a deployment › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

deployment_id

string · required

UUID of the deployment.

Create a new database within a deployment › Request Body

name

string

Name of the database.

Create a new database within a deployment › Responses

200

scaleway.datawarehouse.v1beta1.Database

name

string

Name of the database.

size

integer · uint64

Size of the database. (in bytes)

Delete a database from a deployment

DELETE

https://api.scaleway.com

/datawarehouse/v1beta1/regions/{region}/deployments/{deployment_id}/databases/{name}

Delete a database from a deployment › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

deployment_id

string · required

UUID of the deployment.

name

string · required

Name of the database to delete.

Delete a database from a deployment › Responses

No data returned