Skip to content

Latest commit

 

History

History
227 lines (132 loc) · 8.42 KB

BackupsApi.md

File metadata and controls

227 lines (132 loc) · 8.42 KB

\BackupsApi

All URIs are relative to https://api.scaleway.com

Method HTTP request Description
create_database_backup POST /rdb/v1/regions/{region}/backups Create a database backup
delete_database_backup DELETE /rdb/v1/regions/{region}/backups/{database_backup_id} Delete a database backup
export_database_backup POST /rdb/v1/regions/{region}/backups/{database_backup_id}/export Export a database backup
get_database_backup GET /rdb/v1/regions/{region}/backups/{database_backup_id} Get a database backup
list_database_backups GET /rdb/v1/regions/{region}/backups List database backups
restore_database_backup POST /rdb/v1/regions/{region}/backups/{database_backup_id}/restore Restore a database backup
update_database_backup PATCH /rdb/v1/regions/{region}/backups/{database_backup_id} Update a database backup

create_database_backup

crate::models::ScalewayPeriodRdbPeriodV1PeriodDatabaseBackup create_database_backup(region, create_database_backup_request) Create a database backup

Parameters

Name Type Description Required Notes
region String The region you want to target [required]
create_database_backup_request CreateDatabaseBackupRequest [required]

Return type

crate::models::ScalewayPeriodRdbPeriodV1PeriodDatabaseBackup

Authorization

scaleway

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_database_backup

crate::models::ScalewayPeriodRdbPeriodV1PeriodDatabaseBackup delete_database_backup(region, database_backup_id) Delete a database backup

Parameters

Name Type Description Required Notes
region String The region you want to target [required]
database_backup_id String UUID of the database backup to delete [required]

Return type

crate::models::ScalewayPeriodRdbPeriodV1PeriodDatabaseBackup

Authorization

scaleway

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

export_database_backup

crate::models::ScalewayPeriodRdbPeriodV1PeriodDatabaseBackup export_database_backup(region, database_backup_id, body) Export a database backup

Parameters

Name Type Description Required Notes
region String The region you want to target [required]
database_backup_id String UUID of the database backup you want to export [required]
body serde_json::Value [required]

Return type

crate::models::ScalewayPeriodRdbPeriodV1PeriodDatabaseBackup

Authorization

scaleway

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_database_backup

crate::models::ScalewayPeriodRdbPeriodV1PeriodDatabaseBackup get_database_backup(region, database_backup_id) Get a database backup

Parameters

Name Type Description Required Notes
region String The region you want to target [required]
database_backup_id String UUID of the database backup [required]

Return type

crate::models::ScalewayPeriodRdbPeriodV1PeriodDatabaseBackup

Authorization

scaleway

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list_database_backups

crate::models::ScalewayPeriodRdbPeriodV1PeriodListDatabaseBackupsResponse list_database_backups(region, name, order_by, instance_id, organization_id, project_id, page, page_size) List database backups

Parameters

Name Type Description Required Notes
region String The region you want to target [required]
name Option<String> Name of the database backups
order_by Option<String> Criteria to use when ordering database backups listing [default to created_at_asc]
instance_id Option<String> UUID of the instance
organization_id Option<String> Organization ID the database backups belongs to
project_id Option<String> Project ID the database backups belongs to
page Option<i32> Page number [default to 1]
page_size Option<i32> Page size [default to 20]

Return type

crate::models::ScalewayPeriodRdbPeriodV1PeriodListDatabaseBackupsResponse

Authorization

scaleway

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

restore_database_backup

crate::models::ScalewayPeriodRdbPeriodV1PeriodDatabaseBackup restore_database_backup(region, database_backup_id, restore_database_backup_request) Restore a database backup

Parameters

Name Type Description Required Notes
region String The region you want to target [required]
database_backup_id String Backup of a logical database [required]
restore_database_backup_request RestoreDatabaseBackupRequest [required]

Return type

crate::models::ScalewayPeriodRdbPeriodV1PeriodDatabaseBackup

Authorization

scaleway

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_database_backup

crate::models::ScalewayPeriodRdbPeriodV1PeriodDatabaseBackup update_database_backup(region, database_backup_id, update_database_backup_request) Update a database backup

Parameters

Name Type Description Required Notes
region String The region you want to target [required]
database_backup_id String UUID of the database backup to update [required]
update_database_backup_request UpdateDatabaseBackupRequest [required]

Return type

crate::models::ScalewayPeriodRdbPeriodV1PeriodDatabaseBackup

Authorization

scaleway

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]