v5.0_Backup and Restore
- Ramya Raman
POST system/files/command/backup
Resource Information
Requires Authentication? | |
Response Formats | json |
HTTP Methods | POST |
Back’s up system files, creating an asynchronous task.
Resource URL
https://{{ip_address}}:{{port}}/api/{{version}}/system/files/command/backup
Example Request
POST
Response
{
"data": {
"uuid": "f3341f06-6238-4cc6-9f02-eceb2b478a80",
"created": 1644427178999,
"type": "Db Backup",
"state": "Running",
"progress": 0,
"attributes": {},
"result": null
},
"metadata": {}
}
Returns all the available system files after successful backup.
Resource URL
https://{{ip_address}}:{{port}}/api/{{version}}/system/files
Example Request
GET
Response
{
"data": [
{
"uuid": "2e95e36a-3976-55ab-be6f-ac83e977564a",
"label": "220323_123131_22031701_backup",
"ext": ".db",
"type": "DB Backup",
"size": 222953,
"created": "2022-03-23T12:31:31.822Z",
"modified": "2022-03-23T12:31:32.109Z",
"version": "22.03.17.01",
"postgres_client": 14.2,
"postgres_server": 14.1
}
],
"metadata": {
"total_items": 1,
"items_per_page": 1,
"total_pages": 1,
"current_page": 1,
"item_count": 1
}
}
POST system/files/command/restore/{uuid}
Resource Information
Requires Authentication? | |
Response Formats | json |
HTTP Methods | POST |
Restores system files that are backed up. Please use the uuid of the system files obtained from GET system/files.
Resource URL
https://{{ip_address}}:{{port}}/api/{{version}}/system/files/command/restore/{uuid}
Parameters
Parameter | Data Type | Description |
|---|---|---|
uuid | string | The UUID of the desired system file. |
Example Request
POST
Response
{
"data": {
"uuid": "bbf7811d-ffd9-42bc-b3e6-f776259498de",
"created": 1647265209073,
"type": "Db Restore",
"state": "Running",
"progress": 0,
"attributes": {
"file": "827ff48c-c242-5cb4-aa56-94ff66026be6"
},
"result": null
},
"metadata": {}
}
GET system/files/download/{uuid}
Resource Information
Requires Authentication? | |
Response Formats | json |
HTTP Methods | GET |
Downloads the system file in binary format.
Resource URL
https://{{ip_address}}:{{port}}/api/{{version}}/system/files/download/{uuid}
Parameters
Parameter | Data Type | Description |
|---|---|---|
uuid | string | The UUID of the desired system file. |
Example Request
GET
Response
System file in a binary format.
DELETE system/files/{uuid}
Resource Information
Requires Authentication? | |
Response Formats | json |
HTTP Methods | DELETE |
Deletes the specific system file.
Resource URL
https://{{ip_address}}:{{port}}/api/{{version}}/system/files/{uuid}
Parameters
Parameter | Data Type | Description |
|---|---|---|
uuid | string | The UUID of the desired system file. |
Example Request
DELETE
Response