Get Backup Operation History
API EndPoint : getBackupsList
This API returns the complete history of configuration backup operations stored in the database, including details such as execution status, timestamp, device name, and the user who performed the backup and is useful for auditing and tracking.
HTTP Method
GET
API URL
http://localhost:8060/api/json/ncmbackup/getBackupsList?apiKey=********&RESOURCEID=101Parameters
| Param Name | Description | Data Type | Regex | Is Mandatory |
|---|---|---|---|---|
| apiKey | API Key to access your server. | - | - | Yes |
| RESOURCEID | Resource id of the device. If a resource ID is provided, the response is limited to the backup history of that specific device; if no resource ID is passed, the backup history of all devices is returned. | long | - | No |
| jqgrid_id | Unique identifier for the jqGrid instance. Used to distinguish between multiple grids on the same page or in the same API call. | String | - | No |
| jqgridLoad | Indicates whether the jqGrid should perform a fresh load or reload its data. | boolean | - | No |
| _search | Set to true if the current request is for searching/filtering data, and false otherwise. | boolean | - | No |
| nd | Timestamp value used for cache busting, ensuring fresh data is retrieved from the server rather than from browser cache. | long | - | No |
| rows | The number of rows to retrieve per page (page size). Controls pagination in jqGrid. | int | - | No |
| page | The current page number to be retrieved. Enables pagination functionality in jqGrid. | int | - | No |
| sidx | The column name by which to sort the data. Used for server-side sorting in jqGrid. | String | - | No |
| sord | The sort order for the data, either asc (ascending) or desc (descending). | String | - | No |
| filters | JSON-encoded string containing advanced multi-field filter criteria generated by jqGrid's toolbar or multi-search. | String | - | No |
| searchOper | The search operator for simple search (e.g., eq for equals, ne for not equals, bw for begins with, etc.). Used with single-field search. | String | - | No |
| searchString | The value to search for in a simple (single-field) search. Used with searchField and searchOper. | String | - | No |
| searchField | The column name to perform a simple search on. Used with searchString and searchOper to define single-field search criteria. | String | - | No |
Sample Response
HTTP Code: 200
{ "total": 1, "records": "22", "page": 1, "rows": [ { "id": 783, "cell": [ 783, "CiscoRouter140.manageenginge.com", "FAILURE", "Nov 07, 2025 13:10 PM", "Failure occured during the operation execution", "admin", 305, "" ] }, { "id": 780, "cell": [ 780, "CiscoRouter140.manageenginge.com", "SUCCESS", "Nov 07, 2025 12:18 PM", "Backup operation executed successfully", "admin", 305, "" ] } ] }Error Response
View common error responsesRate limit: 100 requests per minute. Exceeding this limit will block requests for 1 minute