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 | jqgrid_id = DEAllBackupsList,DEBackupsAllList Unique identifier for the jqGrid instance. | String | - | No |
| jqgridLoad | For Example, jqgridLoad = true Set to true to enable jqGrid data loading. | boolean | - | No |
| _search | Set to true if the current request is for searching or filtering data; otherwise, set to false. | boolean | - | No |
| sidx | For Example, sidx = NCMResource__RESOURCENAME The column used to sort the data (server-side sorting). For valid sidx values, please refer to the table below. | String | - | No |
| searchOper | The search operator for simple search (e.g., eq for equals, ne for not equals, bw for begins with). Used for single-field searches. | String | - | No |
| sort | For Example, sort = asc The sort order for the data. Valid values are asc (ascending) or desc (descending). | String | - | No |
| searchString | The value to search for in a simple (single-field) search. Used with searchField and searchOper. This value is provided by the user (for example, the text or content they want to search). | String | - | No |
| searchField | For Example, searchField = NCMResource__RESOURCENAME The column on which to perform a simple search. Used together with searchString and searchOper. For valid searchField values, please refer to the table below. | String | - | No |
| filters | For Example, filters = {"groupOp":"AND","rules":[{"field":"NCMResource__RESOURCENAME","op":"cn","data":"Filter Input"}]} A JSON-encoded string containing advanced multi-field filter criteria generated by jqGrid’s toolbar or multi-search feature. For valid filter values, please refer to the table below. | String | - | No |
| rows | For Example, rows=25 The number of rows to retrieve per page (page size). Controls pagination in jqGrid. Default page size options are 25, 50, 100, 150, 200, 300, 400, and 500. | int | - | No |
| page | The page number to retrieve. Page count is calculated as: Total number of records ÷ Records per page. The API response provides the total number of records. For example: Starting data count = (Page − 1) × Size + 1 Ending data count = Page × Size Example calculation (Page = 11, Size = 100): Starting data count = (11 − 1) × 100 + 1 = 1001 Ending data count = 11 × 100 = 1100 | int | - | No |
NCM Grid Column Index
| Column Value | Column Index | Sortable | Search |
|---|---|---|---|
| Host Name | NCMResource__RESOURCENAME |
|
|
| Operation Status | NCMOperationAudit__OPERATIONSTATUS |
|
|
| Executed On | NCMOperationAudit__EXECUTEDON |
|
|
| Message | NCMOperationAudit__MESSAGE |
|
|
| Invoked By | NCMOperationAudit__INVOKEDBY |
|
|
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
Rate limit: 100 requests per minute. Exceeding this limit will block requests for 1 minute