API v2: Backup¶
Fudo allows configuring multiple backup target destinations, where data can be stored. Each backup target can have S3, Backblaze, FTP, or SFTP as a destination place.
Data Structures¶
| Attribute | Type | Required | Description |
|---|---|---|---|
| id | string | Unique and read-only object Identifier | |
| name | string | yes | Unique, case insensitive object name |
| type | string {backblaze, ftp, s3, sftp} | yes | Immutable, case insensitive |
| path | string | ||
| configuration | string | yes | Protected |
| created_at | datetime | Read-only | |
| modified_at | datetime | Read-only | |
| removed | boolean | Read-only |
Request for Retrieving Available Attributes of the BackupModel
| Method | GET
|
| Path | /api/v2/objspec/backup
|
Note
To check allowed methods, available URL parameters and possible responses please refer to the API Overview section.
The next chapter describes procedures for creating separate requests.
Creating a Backup Target¶
Request
| Method | POST
|
| Path | /api/v2/backup
|
| Headers | Content-Type: Application/JSON
|
| Body | BackupModel
|
Example Request
Sending POST https://10.0.0.0/api/v2/backup
curl -s -k -X POST -H 'Authorization: sgfeea6jsaz4mum9su8w61877n1g06sk' 'https://10.0.214.98/api/v2/backup' -H 'Content-Type: application/json' -d'{"name": "FTP_Backup","type": "ftp","ftp_address": "10.0.130.100"}'
Response
{
"result": "success",
"backup": {
"id": "801640733671948290"
}
}
Retrieving Backup Definitions List¶
Request
| Method | GET
|
| Path | /api/v2/backup
|
Example Request
Sending GET https://10.0.0.0/api/v2/backup
"result": "success",
"backup": [
{
"id": "9124292845052624897",
"name": "FTP_Backup",
"type": "ftp",
"path": "",
"created_at": "2024-06-16 13:50:42.355762-07",
"modified_at": "2024-06-16 14:29:47.217872-07"
},
{
"id": "9124292845052624898",
"name": "Backblaze_Backup",
"type": "backblaze",
"path": "myBucket\/",
"created_at": "2024-06-16 14:29:47.226305-07",
"modified_at": "2024-06-16 14:29:47.226305-07"
}
]
Assigning a Backup Definition to a Session¶
Request
| Method | POST
|
| Path | /api/v2/session/<session_id>/backup/<backup_id>
|