Search Specific Backup File

Search specific backup files from the backup files list.

Request URL

GET {base_url}/{api_path}/backup/search?access_token={access_token}

Request parameters

Parameter Required Type Description
page No Integer Define which page is displayed.
page_size No Integer Define how many records per page.
sort_by No String Define the sorting field.

Valid value:

  • file_name
  • backup_time
order_by No String Define the display order.

Valid value:

  • asc: Ascending order
  • desc: Descending order
search_value No String Define a keyword from the backup file name or memo to search backup file by the keyword.

Response parameters

Parameter Type Description
errcode Integer Returned error code.
  • 0: Succeed.
  • Non-zero value: Failed.
Note: You can check the error code and error message in Error Code and Error Message.
errmsg String Returned message.
  • SUCCESS: Succeed.
  • FAILURE: Failed.
total_number Integer The total number of backup files matching the search criteria.
backup_list Array<Backup_Info> The information of backup files.
Backup_Info
Parameter Type Description
file_name String The name of the backup file.
backup_time String The time when the backup is created.
memo String The remark of the backup file.

Examples

Request example

Search for backup file for version 18.0.89 from the backup file list.

GET /openapi/v1.0/backup/search?access_token=85dEVrxzolca3XhiLZNuxQNUnvEdaapY&search_value=18.0.89 HTTP/1.1
Host: 192.168.5.150:8088

Response example

HTTP/1.1 200 OK
{
    "errcode": 0,
    "errmsg": "SUCCESS",
    "total_number": 1,
    "backup_list": [
        {
            "file_name": "Backup-X.18.0.89-20250313132238-local.bak",
            "backup_time": "2025/03/13 13:24:15",
            "memo": ""
        }
    ]
}