Get Backup Info
Purpose
To fetch information about the latest scheduled backup.
Request URL
https://www.zohoapis.com/crm/bulk/v2/backup
Request Method
GET
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 |
Response Structure
Attribute | Data Type | Description |
---|---|---|
id | String | The ID of the scheduled job. |
scheduled_date | DateTime | The date and time at which the next backup is scheduled to take place. This key is null if you do not specify the rrule while scheduling the backup. |
start_date | DateTime | The date and time at which the first backup takes place. This key is null if you do not specify the rrule while scheduling the backup. |
requester | JSON Object | Details of the user who scheduled the backup. The details include the name, record ID, and the ZUID of the user. |
status | String | The status of the scheduled backup. The possible values are SCHEDULED, INPROGRESS, PAYMENT_FAILED, FAILED, FINISHED, COMPLETED, and STOPPED. |
Possible Errors
HTTP Status | Error Code | Message | Reason |
---|---|---|---|
204 | NO_CONTENT | -- | You have not scheduled any backup. |
403 | NO_PERMISSION | permission denied | You do not have the permission to schedule a backup. Users with Administrator profile only can schedule a backup. |
Sample Request
Copiedcurl "https://www.zohoapis.com/crm/bulk/v2/backup"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
Sample Response
Copied{
"backup": {
"id": "3652397000001730002",
"scheduled_date": null,
"start_date": "2020-02-19T13:30:00+05:30",
"rrule": "RRULE:FREQ=DAILY;COUNT=3",
"requester": {
"id": "3652397000000186017",
"name": "Patricia Boyle",
"zuid": "678521418"
},
"status": "COMPLETED"
}
}