Learn how to create automatic backups of a Public Cloud instance using OVHcloud APIs.
You can configure a schedule to automate your instance backups. Backups can be used to restore your instance to a previous state or to create a new identical instance.
Requirements
- a Public Cloud project
- at least one Public Cloud instance
- access to the OVHcloud API
Instructions
Create new automatic backups
This API can be used for creating new automatic backups:
POST /cloud/project/{serviceName}/region/{regionName}/workflow/backup
The backups are charged according to the space used with a granularity of 1GB. Refer to the Public Cloud pricing page for Instance Backup pricing.
Required inputs
| Input | Notes |
| ServiceName | API to obtain a list of available services (ServiceName): GET /cloud/project |
| RegionName | API to obtain a list of available regions (RegionName): GET /cloud/project/{serviceName}/region |
| InstanceId | API to obtain a list of Instance IDs: GET /cloud/project/{serviceName}/instance |
| cron | Set to Unix cron format (time zone in UTC) |
| maxExecutionCount | Set the number of executions to process before the end of the task. Zero (0) means that the task will never end. |
| name | The name of the automatic backup schedule |
| rotation | Set the number of backups to retain |
List Backups
This API can be used to list existing automatic backups:
GET /cloud/project/{serviceName}/region/{regionName}/workflow/backup
The result will include a list of backups with their executions.
Delete Backup Flow
This API can be used for deleting an automatic backup:
DELETE /cloud/project/{serviceName}/region/{regionName}/workflow/backup/{backupWorkflowId}
Go further
For more information and tutorials, please see our other Public Cloud support guides or explore the guides for other OVHcloud products and services.