Serverless SQL Databases Backups

List your Serverless SQL Database backups

GET

https://api.scaleway.com

/serverless-sqldb/v1alpha1/regions/{region}/backups

List all Serverless SQL Database backups for a given Scaleway Project or Database. By default, the backups returned in the list are ordered by creation date in descending order, though this can be modified via the order_by field.

List your Serverless SQL Database backups › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

List your Serverless SQL Database backups › query Parameters

database_id

string · required

Filter by the UUID of the Serverless SQL Database.

organization_id

string

Filter by the UUID of the Scaleway organization. (UUID format)

project_id

string

Filter by the UUID of the Scaleway project. (UUID format)

page

integer · int32

Page number.

page_size

integer · uint32

Page size.

order_by

string · enum

Sorting criteria. One of created_at_asc, created_at_desc.

Enum values:

created_at_desc

created_at_asc

Default: created_at_desc

List your Serverless SQL Database backups › Responses

200

scaleway.serverless_sqldb.v1alpha1.ListDatabaseBackupsResponse

scaleway.serverless_sqldb.v1alpha1.DatabaseBackup[]

List of the backups.

total_count

integer · uint64

Length of the backups list.

Get a database backup information

GET

https://api.scaleway.com

/serverless-sqldb/v1alpha1/regions/{region}/backups/{backup_id}

Retrieve information about your Serverless SQL Database backup. You must provide the backup_id parameter.

Get a database backup information › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

backup_id

string · required

UUID of the Serverless SQL Database backup.

Get a database backup information › Responses

200

scaleway.serverless_sqldb.v1alpha1.DatabaseBackup

id

string

UUID that uniquely identifies a Serverless SQL Database backup.

status

string · enum

Status of the Serverless SQL Database backup. One of unknown_status | error | ready | locked.

Enum values:

unknown_status

error

ready

locked

Default: unknown_status

organization_id

string

The ID of your Scaleway organization.

project_id

string

UUID of the Scaleway project.

database_id

string

UUID of the source Serverless SQL Database the backup is created from.

created_at

string · date-time

Creation date. (RFC 3339 format)

expires_at

string · date-time

Expiration date. (RFC 3339 format)

size

integer · uint64

Size (in bytes) of the database backup file. (in bytes)

db_size

integer · uint64

Size (in bytes) of the database when backup has been done. (in bytes)

download_url

string

Download URL of the exported database backup.

download_url_expires_at

string · date-time

Expiration date of the download URL. (RFC 3339 format)

region

string

Region of the database backup.

Export a database backup

POST

https://api.scaleway.com

/serverless-sqldb/v1alpha1/regions/{region}/backups/{backup_id}/export

Export a database backup providing a download link once the export process is completed. You must provide the backup_id parameter.

Export a database backup › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

backup_id

string · required

UUID of the Serverless SQL Database backup.

Export a database backup › Request Body

Export a database backup › Responses

200

scaleway.serverless_sqldb.v1alpha1.DatabaseBackup

id

string

UUID that uniquely identifies a Serverless SQL Database backup.

status

string · enum

Status of the Serverless SQL Database backup. One of unknown_status | error | ready | locked.

Enum values:

unknown_status

error

ready

locked

Default: unknown_status

organization_id

string

The ID of your Scaleway organization.

project_id

string

UUID of the Scaleway project.

database_id

string

UUID of the source Serverless SQL Database the backup is created from.

created_at

string · date-time

Creation date. (RFC 3339 format)

expires_at

string · date-time

Expiration date. (RFC 3339 format)

size

integer · uint64

Size (in bytes) of the database backup file. (in bytes)

db_size

integer · uint64

Size (in bytes) of the database when backup has been done. (in bytes)

download_url

string

Download URL of the exported database backup.

download_url_expires_at

string · date-time

Expiration date of the download URL. (RFC 3339 format)

region

string

Region of the database backup.

Serverless SQL Databases

List your Serverless SQL Database backups

GET

https://api.scaleway.com

/serverless-sqldb/v1alpha1/regions/{region}/backups

List your Serverless SQL Database backups › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

List your Serverless SQL Database backups › query Parameters

database_id

string · required

Filter by the UUID of the Serverless SQL Database.

organization_id

string

Filter by the UUID of the Scaleway organization. (UUID format)

project_id

string

Filter by the UUID of the Scaleway project. (UUID format)

page

integer · int32

Page number.

page_size

integer · uint32

Page size.

order_by

string · enum

Sorting criteria. One of created_at_asc, created_at_desc.

Enum values:

created_at_desc

created_at_asc

Default: created_at_desc

List your Serverless SQL Database backups › Responses

200

scaleway.serverless_sqldb.v1alpha1.ListDatabaseBackupsResponse

scaleway.serverless_sqldb.v1alpha1.DatabaseBackup[]

List of the backups.

total_count

integer · uint64

Length of the backups list.

Get a database backup information

GET

https://api.scaleway.com

/serverless-sqldb/v1alpha1/regions/{region}/backups/{backup_id}

Retrieve information about your Serverless SQL Database backup. You must provide the backup_id parameter.

Get a database backup information › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

backup_id

string · required

UUID of the Serverless SQL Database backup.

Get a database backup information › Responses

200

scaleway.serverless_sqldb.v1alpha1.DatabaseBackup

id

string

UUID that uniquely identifies a Serverless SQL Database backup.

status

string · enum

Status of the Serverless SQL Database backup. One of unknown_status | error | ready | locked.

Enum values:

unknown_status

error

ready

locked

Default: unknown_status

organization_id

string

The ID of your Scaleway organization.

project_id

string

UUID of the Scaleway project.

database_id

string

UUID of the source Serverless SQL Database the backup is created from.

created_at

string · date-time

Creation date. (RFC 3339 format)

expires_at

string · date-time

Expiration date. (RFC 3339 format)

size

integer · uint64

Size (in bytes) of the database backup file. (in bytes)

db_size

integer · uint64

Size (in bytes) of the database when backup has been done. (in bytes)

download_url

string

Download URL of the exported database backup.

download_url_expires_at

string · date-time

Expiration date of the download URL. (RFC 3339 format)

region

string

Region of the database backup.

Export a database backup

POST

https://api.scaleway.com

/serverless-sqldb/v1alpha1/regions/{region}/backups/{backup_id}/export

Export a database backup providing a download link once the export process is completed. You must provide the backup_id parameter.

Export a database backup › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

backup_id

string · required

UUID of the Serverless SQL Database backup.

Export a database backup › Request Body

Export a database backup › Responses

200

scaleway.serverless_sqldb.v1alpha1.DatabaseBackup

id

string

UUID that uniquely identifies a Serverless SQL Database backup.

status

string · enum

Status of the Serverless SQL Database backup. One of unknown_status | error | ready | locked.

Enum values:

unknown_status

error

ready

locked

Default: unknown_status

organization_id

string

The ID of your Scaleway organization.

project_id

string

UUID of the Scaleway project.

database_id

string

UUID of the source Serverless SQL Database the backup is created from.

created_at

string · date-time

Creation date. (RFC 3339 format)

expires_at

string · date-time

Expiration date. (RFC 3339 format)

size

integer · uint64

Size (in bytes) of the database backup file. (in bytes)

db_size

integer · uint64

Size (in bytes) of the database when backup has been done. (in bytes)

download_url

string

Download URL of the exported database backup.

download_url_expires_at

string · date-time

Expiration date of the download URL. (RFC 3339 format)

region

string

Region of the database backup.