Get Data Backup Download URLs

Purpose

To fetch the download URLs of the latest scheduled backup. These download URLs can be used to download the backed up data for your account.

Endpoints

Request Details

Request URL

{api-domain}/crm/bulk/{version}/backup/urls

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Scope

scope=ZohoCRM.bulk.backup.ALL
(or)
scope=ZohoCRM.bulk.backup.READ

Possible operation types

ALL - Full access to backup data
READ - Fetch information about a scheduled backup

Sample Request

Copiedcurl "https://www.zohoapis.com/crm/bulk/v5/backup/urls"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"

Response JSON Keys

  • data_linksURL

    The download URL of the scheduled backup that contains module-specific data (individual CSVs) of the fields, module metadata, and the record images.
    Example: "https://download-accl.zoho.com/v2/crm/123456789/backup/3652397000001763003/Data_001.zip"
    Here, 123456789 is the unique ID (zgid) of the org whose data you have backed up,
    3652397000001763003 is the ID of the backup job, and
    Data_001.zip is the file name.

  • attachment_linksURL

    The download URL of the scheduled backup that contains all the attachments of records in all the modules.
    Example: "https://download-accl.zoho.com/v2/crm/123456789/backup/3652397000001763003/Attachments_001.zip"
    Here, 123456789 is the unique ID (zgid) of the org whose data you have backed up,
    3652397000001763003 is the ID of the backup job, and
    Attachments_001.zip is the file name.

  • expiry_dateDateTime

    The expiry date of the backup links, beyond which the files are not available for download.

Note

When there are no download links available, the system responds with a No content body with status code 204.

Possible Errors

  • INVALID_URL_PATTERNHTTP 404

    Please check if the URL trying to access is a correct one
    Resolution: The request URL specified is incorrect. Specify a valid request URL. Refer to request URL section above.

  • OAUTH_SCOPE_MISMATCHHTTP 401

    Unauthorized
    Resolution: Client does not have the required scope. Create a new client with valid scope. Refer to scope section above for more details.

  • NO_PERMISSIONHTTP 403

    Permission denied to read
    Resolution: The user does not have permission to read data backup history data. Contact your system administrator.

  • INTERNAL_ERRORHTTP 500

    Internal Server Error
    Resolution: Unexpected and unhandled exception in Server. Contact support team.

  • INVALID_REQUEST_METHODHTTP 400

    The http request method type is not a valid one
    Resolution: You have specified an invalid HTTP method to access the API URL. Specify a valid request method. Refer to endpoints section above.

Sample Response

Copied{
    "urls": {
        "data_links": [
            "https://download-accl.zoho.com/v2/crm/757345985/backup/4876876000001594004/Data_001.zip"
        ],
        "attachment_links": [
            "https://download-accl.zoho.com/v2/crm/757345985/backup/4876876000001594004/Attachments_001.zip"
        ],
        "expiry_date": "2022-06-30T17:31:03+05:30"
    }
}