Get Data Backup Details
Purpose
To fetch information about the latest data backup scheduled for your CRM account.
Endpoints
- GET /backup
Request Details
Request URL
{api-domain}/crm/bulk/v8/backup
Header
Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
Scope
ZohoCRM.bulk.backup.ALL
(or)
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/v8/backup"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"Response JSON
- idstring
The unique identifier for the backup request.
- scheduled_dateDateTime
The date and time at which the next backup is scheduled to occur, formatted in ISO 8601. This key is null if you do not specify the rrule while scheduling the backup.
- start_dateDateTime
The date and time when the backup process was initially set to start, formatted in ISO 8601. This reflects when the backup was first scheduled. This key is null if you do not specify the rrule while scheduling the backup.
- rrulestring
The recurrence rule that defines how often the backup is scheduled.
- requesterJSON object
Details of the user who initiated the backup. The details include the name, record ID, and the ZUID of the user.
- statusstring
Represents the status of the scheduled backup.
Possible values:
STOPPED - The backup is scheduled and will occur at the specified time.
SCHEDULED - The backup is currently being processed.
INPROGRESS - The backup has been successfully completed.
COMPLETED - The backup process has been halted.
FAILED - The backup process encountered an error and could not be completed.
Possible Errors
- INVALID_REQUEST_METHODHTTP 400
The request method is incorrect.
Resolution: Use the HTTP GET method to make this API call. Any other request method will result in this error. - OAUTH_SCOPE_MISMATCHHTTP 401
The access token you have used to make this API call does not have the required scope.
Resolution: Generate a new access token with the required scopes for this API. Refer to the Scope section at the beginning of this page for the list of required scopes. - NO_PERMISSIONHTTP 403
Permission denied to read
Resolution: The user does not have permission to read data backup data. Contact your system administrator. - INVALID_URL_PATTERNHTTP 404
The request URL is incorrect.
Resolution: Specify a valid request URL. Refer to the request URL section at the beginning of this page for more details. - INTERNAL_ERRORHTTP 500
Unexpected and unhandled exception in the server.
Resolution: Contact the support team at support@zohocrm.com.
Sample Response
Copied{
"backup": {
"id": "4876876000001593003",
"scheduled_date": "2022-07-26T09:58:45+05:30",
"start_date": "2022-07-12T12:30:00+05:30",
"rrule": "RRULE:FREQ=WEEKLY;INTERVAL=2;BYDAY=TU",
"requester": {
"id": "4876876000000327001",
"name": "Patricia Boyle",
"zuid": "7534658674"
},
"status": "SCHEDULED"
}
}