post https://example.com/settings/v1/system/backup
Backup
This backup will be saved in an S3 bucket in AWS.
The name parameter in the request will be the folder the backup is saved in the s3 bucket.
The full path in which it will be saved is s3://-backup//
E.g. for customer id 123456, biot version 2.3.11 and backup name backup1, the backup will be saved in the s3 path s3://123456-backup/2.3.11/backup1
Request Body Parameters:
| Parameter | Type | Mandatory | Description | Example |
|---|---|---|---|---|
| name | string | true | The name of the backup, it will also be the folder in which the backup is saved | Backup-01-02-2024 |
| description | string | false | The description of the backup | Backup after entity creation |
This API requires SETTINGS_START_BACKUP permission(s).