Delete a Backup File

Delete a backup file.

Request URL

GET {base_url}/{api_path}/backup/delete?file_name={filename}&access_token={access_token}

Request parameters

Parameter Required Type Description
file_name Yes String The name of the backup file.
Note: You can query backup file name 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.

Examples

Request example

GET /openapi/v1.0/backup/delete?access_token=s6xUEUQ43Mtp5eRo0hCvfGFOvym7HeaQ&file_name=Backup-X.17.0.10-20241025090454-local.bak HTTP/1.1

Host: yeastardocs.example.yeastarcloud.com

Response example

HTTP/1.1 200 OK
{
    "errcode": 0,
    "errmsg": "SUCCESS"
}