Download a Backup File

Download a specific backup file.

Steps to download a backup file

  1. Get the download URL of a backup file
  2. Download the backup file

Request URL

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

Request parameter

Parameter Required Type Description
file_name Yes Integer The name of the backup file.
Note: You can query the backup file ID using Search Specific Backup File.

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.
file String The name of the backup file.
download_resource_url String The download URL of the backup file.
Note: The download URL is only valid for 30 minutes.

Examples

Request Example

Get the download URL of a backup file.

GET /openapi/v1.0/backup/download?access_token=d8JNSpRBo8VdEiGmn0x7UDs1vF70jtrq&file_name=Backup-local.bak HTTP/1.1

Host: yeastardocs.example.yeastarcloud.com

Response Example

HTTP/1.1 200 OK
{
    "errcode": 0,
    "errmsg": "SUCCESS",
    "file": "Backup-local.bak",
    "download_resource_url": "/api/download/Backup-X.20.0.X-download-20250827143149-UK4RSlRdmVEOGr8c.bak"
}

Download the backup file

After obtaining the download URL for the backup file, combine it with the {base_url} and append the {access_token} parameter. Then, use the complete link to download the desired backup file.

Download link format

{base_url}/{download_resource_url}?access_token={access_token}

Download link example

https://yeastardocs.example.yeastarcloud.com/api/download/Backup-X.20.0.X-download-20250827143149-UK4RSlRdmVEOGr8c.bak?access_token=WQMR0cuirhX264oZMa9pV03T9li924NS