Device

Get Unmanaged Devices

API EndPoint : getUnManagedDevices

Provides the details of all unmanaged devices, including resource ID, Hostname name and IP Address.

HTTP Method

GET

API URL

http://localhost:8060/api/json/v2/ncmdevice/getUnManagedDevices?apiKey=********

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
jqgrid_id	jqgrid_id = UnmanagedDevices 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
IP Address	NCMResource__ADDRESS

Sample Response

HTTP Code: 200

{
    "total": 1,
    "records": "10",
    "page": 1,
    "rows": [
        {
            "ProbeName": "",
            "ResourceName": "10.5.X.X",
            "IP_ADDRESS": "10.5.X.X",
            "id": 305
        },
        {
            "ProbeName": "",
            "ResourceName": "10.5.X.X",
            "IP_ADDRESS": "10.5.X.X",
            "id": 303
        },
        {
            "ProbeName": "",
            "ResourceName": "10.5.X.X",
            "IP_ADDRESS": "10.5.X.X",
            "id": 301
        },
        {
            "ProbeName": "",
            "ResourceName": "10.5.X.X",
            "IP_ADDRESS": "10.5.X.X",
            "id": 304
        },
        {
            "ProbeName": "",
            "ResourceName": "10.5.X.X",
            "IP_ADDRESS": "10.5.X.X",
            "id": 302
        },
        {
            "ProbeName": "",
            "ResourceName": "10.5.X.X",
            "IP_ADDRESS": "10.5.X.X",
            "id": 306
        },
        {
            "ProbeName": "",
            "ResourceName": "10.5.X.X",
            "IP_ADDRESS": "10.5.X.X",
            "id": 308
        },
        {
            "ProbeName": "",
            "ResourceName": "10.5.X.X",
            "IP_ADDRESS": "10.5.X.X",
            "id": 310
        },
        {
            "ProbeName": "",
            "ResourceName": "10.5.X.X",
            "IP_ADDRESS": "10.5.X.X",
            "id": 307
        },
        {
            "ProbeName": "",
            "ResourceName": "10.5.X.X",
            "IP_ADDRESS": "10.5.X.X",
            "id": 309
        }
    ]
}

Error Response

View common error responses

Rate limit: 100 requests per minute. Exceeding this limit will block requests for 1 minute

Update SNMP Mapping

API EndPoint : updateSNMPMapping

Updates/associates the SNMP Credential Profile for one or more devices.

HTTP Method

POST

API URL

http://localhost:8060/api/json/ncmdevice/updateSNMPMapping?apiKey=********&isDGSelected=false&selectedProfile=12345&selectedDevices=[301,302,303]

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
isDGSelected	Set to true if a Device Group is selected, and provide its ID in the selectedDG parameter. If set to false, specify the resource IDs of individual devices in the selectedDevices parameter.	boolean	-	yes
selectedProfile	Provide the ID of the SNMP Credential Profile. This value can be obtained from the profileID field within the "Profiles" object in the response returned by the deviceSNMPPreRender API.	long	-	yes
selectedDG	ID of the selected Device Group. This value can be obtained from the response of getDeviceGroupsList API.	long	-	No
selectedDevices	Resource ids of the devices	JSONArray	-	No

Sample Response

HTTP Code: 200

{"isSuccess":true}

Error Response

View common error responses

Rate limit: 100 requests per minute. Exceeding this limit will block requests for 1 minute

Device SNMP Prerender

API EndPoint : deviceSNMPPreRender

Provides a list of available device groups, SNMP credential profiles, and devices, along with information on which devices are currently selected. This helps you choose and assign SNMP credentials to specific devices or device groups easily.

HTTP Method

GET

API URL

http://localhost:8060/api/json/ncmdevice/deviceSNMPPreRender?apiKey=********&selectedDevices=[301,305,309]

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
selectedDevices	Resource ids of the devices	JSONArray	-	No

Sample Response

HTTP Code: 200

{
    "LoginId": 1,
    "DG_DESCRIPTION": {
        "1": "ncm.default_devicegroup.description",
        "2": "ncm.ciscorouter_group.description",
        "3": "ncm.ciscoswitch_group.description",
        "4": "ncm.bkupfailure_group.description",
        "5": "ncm.devicegroup.cisco.ios.desc",
        "6": "ncm.devicegroup.cisco.asa.desc"
    },
    "DG_INFO": {
        "1": "All Devices Group",
        "2": "CiscoRouter Group",
        "3": "CiscoSwitch Group",
        "4": "Backup Failure Group",
        "5": "CIS Cisco IOS Group",
        "6": "CIS Cisco ASA Group"
    },
    "Profiles": {
        "profiles": [
            {
                "profileName": "Snmp_Public",
                "profileID": "1"
            },
            {
                "profileName": "Snmp_Test",
                "profileID": "601"
            }
        ]
    },
    "Resources": {
        "1": "10.5.X.X",
        "2": "10.5.X.X",
        "310": "10.5.X.X",
        "301": "10.5.X.X",
        "302": "10.5.X.X",
        "303": "10.5.X.X",
        "304": "10.5.X.X",
        "305": "10.5.X.X",
        "307": "10.5.X.X",
        "308": "10.5.X.X",
        "309": "10.5.X.X"
    },
    "SelectedResources": {
        "3": "10.5.X.X",
        "4": "10.5.X.X",
        "306": "10.5.X.X"
    },
    "SHOW_ONLY_PUBLIC_DEVICE_GROUP": true,
    "isSuccess": true
}

Error Response

View common error responses

Rate limit: 100 requests per minute. Exceeding this limit will block requests for 1 minute

List All Devices

API EndPoint : listAllDevices

@Deprecated: Provides a list of all managed devices in NCM. Its an older version API where response format quite different. Use "/api/json/v2/ncmdevice/listAllDevices" as alternative.

HTTP Method

GET

API URL

http://localhost:8060/api/json/ncmdevice/listAllDevices?apiKey=********&SSHKEYID=101

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
SSHKEYID	ID of the SSH key	long	-	No
PROFILEID	Use this parameter to retrieve devices linked to a particular Credential Profile. The Profile ID can be found in the response of the credProfList API.	long	-	No
SEARCH_STRING	Use this parameter to search for devices by IPAddress, hostname, series, model, or DeviceType.	String	-	No
EXPORT_AS_INV_REPORT	Set to true if you want to export the details as Inventory Report.	boolean	-	No

Sample Response

HTTP Code: 200

{
    "total": 1,
    "records": "4",
    "page": 1,
    "rows": [
        {
            "id": 1,
            "cell": [
                1,
                true,
                "SSH",
                "Live",
                "10.5.X.X",
                "10.5.X.X",
                "Cisco Router",
                "[NA]",
                "[NA]",
                "IOS",
                "[NA]",
                "Backup__SUCCESS",
                false,
                "[NA]",
                "[NA]",
                "[NA]",
                "[NA]",
                true,
                "SUCCESS",
                false,
                true,
                "SUCCESS",
                ""
            ]
        },
        {
            "id": 2,
            "cell": [
                2,
                true,
                "SSH",
                "Live",
                "10.5.X.X",
                "10.5.X.X",
                "FortiGate Firewall Version6",
                "[NA]",
                "[NA]",
                "FortiOS",
                "[NA]",
                "Backup__SUCCESS",
                false,
                "[NA]",
                "[NA]",
                "[NA]",
                "[NA]",
                true,
                "SUCCESS",
                false,
                true,
                "SUCCESS",
                ""
            ]
        },
        {
            "id": 309,
            "cell": [
                309,
                false,
                "[NA]",
                "Live",
                "10.5.X.X",
                "10.5.X.X",
                "ArubaOS-Cx Switch",
                "[NA]",
                "[NA]",
                "[NA]",
                "[NA]",
                "None__NOTSTARTED",
                "[NA]",
                "[NA]",
                "[NA]",
                "[NA]",
                "[NA]",
                true,
                "NOTSTARTED",
                "[NA]",
                "[NA]",
                "NOTSTARTED",
                ""
            ]
        },
        {
            "id": 4,
            "cell": [
                4,
                true,
                "SSH",
                "Live",
                "10.5.X.X",
                "10.5.X.X",
                "Juniper EX4200 Switch",
                "[NA]",
                "[NA]",
                "[NA]",
                "[NA]",
                "Backup__SUCCESS",
                false,
                "[NA]",
                "[NA]",
                "[NA]",
                "[NA]",
                true,
                "SUCCESS",
                false,
                true,
                "SUCCESS",
                ""
            ]
        }
    ]
}

Error Response

View common error responses

Rate limit: 100 requests per minute. Exceeding this limit will block requests for 1 minute

List All Devices V2

API EndPoint : listAllDevices

It is a primary API to get the details of devices that are managed in NCM.

Details that can be fetched are STARTUP_CONFLICT, SERIALNUMBER, DT_NAME, OPERATIONTYPE, ENDOFSUPPORTDATE, OPERATIONSTATUS, RESOURCENAME, OSTYPE, id (resourceId/deviceId), VALIDITY, DEVICE_TYPE, SERIES, ENDOFSALEDATE, BACKUP_STATUS, COMPLIANCE_STATUS, CUSTOM_COLUMN2, CUSTOM_COLUMN3, MANAGED, MODEL, CUSTOM_COLUMN1, PROTOCOL_DISPLAYNAME, BASELINE_CONFLICT, OSVERSION, REST_DT_ID, VENDOR, IP_ADDRESS

HTTP Method

GET

API URL

http://localhost:8060/api/json/v2/ncmdevice/listAllDevices?apiKey=********&SSHKEYID=101

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
SSHKEYID	Use this parameter to retrieve devices associated with a specific SSH Key. The SSH Key ID can be obtained from the response of the listNCMSSHKeys API.	long	-	No
PROFILEID	Use this parameter to retrieve devices linked to a particular Credential Profile. The Profile ID can be found in the response of the credProfList API.	long	-	No
SEARCH_STRING	Use this parameter to search for devices by IPAddress, hostname, series, model, or DeviceType.	String	-	No
EXPORT_AS_INV_REPORT	Set to true if you want to export the details as Inventory Report.	boolean	-	No
skipMarkedDevices	This parameter is used only when NCM is used as Addon in RMM Central. In RMM Central when a device is deleted, we mark it as deleted, but it may not be deleted immediately. If this parameter is true, the returned devices will skip the devices that are marked for deletion. We use handleRMMShortfall API to mark the devices, instead of directly deleting them.	boolean	-	No
jqgrid_id	jqgrid_id = Devices 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
IP Address	NCMResource__ADDRESS
Vendor	NCMVendor__DISPLAYNAME
Template Name	NCMDeviceTemplate__DISPLAYNAME
Device Type	NCMPersonality__DISPLAYNAME
Series	NCMResource__SERIES
Model	NCMResource__MODEL
OS Type	NCMResource__OSTYPE
OS Version	NCMResource__OSVERSION
Serial Number	NCMResource__SERIALNUMBER
Last Operation Status	NCMOperationStateHolder__OPERATIONSTATUS
Config Conflict	NCMResourcesConfConflict__ISCONFLICT
Compliance Status	NCMResourceCompStatus__COMPLIANCE_STATUS
Baseline Conflict	NCMBaseRunningConflict__ISCONFLICT
Column 1	NCMResourceCustomColumn__COLUMNVALUE1
Column 2	NCMResourceCustomColumn__COLUMNVALUE2
Column 3	NCMResourceCustomColumn__COLUMNVALUE3
End Of Sale Date	NCMEoldata__EndOfSaleDate
End Of Support Date	NCMEoldata__LastDateOfSupport

Sample Response

HTTP Code: 200

{
    "total": 1,
    "records": "4",
    "page": 1,
    "rows": [
        {
            "DEVICE_TYPE": "Cisco Router",
            "SERIES": "[NA]",
            "STARTUP_CONFLICT": false,
            "BACKUP_STATUS": "SUCCESS",
            "DT_NAME": "Cisco IOS Router",
            "COMPLIANCE_STATUS": "[NA]",
            "OPERATIONTYPE": "Backup",
            "MANAGED": true,
            "MODEL": "[NA]",
            "PROTOCOL_DISPLAYNAME": "SSH",
            "OPERATIONSTATUS": "SUCCESS",
            "RESOURCENAME": "10.5.X.X",
            "VENDOR": "Cisco",
            "IP_ADDRESS": "10.5.X.X",
            "id": 1,
            "VALIDITY": true
        },
        {
            "DEVICE_TYPE": "FortiGate Firewall Version6",
            "SERIES": "[NA]",
            "STARTUP_CONFLICT": false,
            "BACKUP_STATUS": "SUCCESS",
            "DT_NAME": "FortiGate Firewall Version 6",
            "COMPLIANCE_STATUS": "[NA]",
            "OPERATIONTYPE": "Backup",
            "MANAGED": true,
            "MODEL": "[NA]",
            "PROTOCOL_DISPLAYNAME": "SSH",
            "OPERATIONSTATUS": "SUCCESS",
            "RESOURCENAME": "10.5.X.X",
            "REST_DT_ID": 1,
            "VENDOR": "Fortinet",
            "IP_ADDRESS": "10.5.X.X",
            "id": 2,
            "VALIDITY": true
        },
        {
            "DEVICE_TYPE": "ArubaOS-Cx Switch",
            "SERIES": "[NA]",
            "STARTUP_CONFLICT": "[NA]",
            "BACKUP_STATUS": "NOTSTARTED",
            "DT_NAME": "ArubaOS-CX Switch",
            "COMPLIANCE_STATUS": "[NA]",
            "OPERATIONTYPE": "None",
            "MANAGED": true,
            "MODEL": "[NA]",
            "PROTOCOL_DISPLAYNAME": "[NA]",
            "OPERATIONSTATUS": "NOTSTARTED",
            "RESOURCENAME": "10.5.X.X",
            "REST_DT_ID": 10,
            "VENDOR": "Aruba",
            "IP_ADDRESS": "10.5.X.X",
            "id": 309,
            "VALIDITY": false
        },
        {
            "DEVICE_TYPE": "Juniper EX4200 Switch",
            "SERIES": "[NA]",
            "STARTUP_CONFLICT": false,
            "BACKUP_STATUS": "SUCCESS",
            "DT_NAME": "Juniper EX4200 Switch",
            "COMPLIANCE_STATUS": "[NA]",
            "OPERATIONTYPE": "Backup",
            "MANAGED": true,
            "MODEL": "[NA]",
            "PROTOCOL_DISPLAYNAME": "SSH",
            "OPERATIONSTATUS": "SUCCESS",
            "RESOURCENAME": "10.5.X.X",
            "REST_DT_ID": 4,
            "VENDOR": "Juniper",
            "IP_ADDRESS": "10.5.X.X",
            "id": 4,
            "VALIDITY": true
        }
    ],
    "columnsList": [
        "cb",
        "subgrid",
        "CRED_VALIDITY",
        "RESOURCENAME",
        "IP_ADDRESS",
        "DT_NAME",
        "DEVICE_TYPE",
        "SERIES",
        "MODEL",
        "LAST_OPERATIONSTATUS",
        "STARTUP_CONFLICT",
        "COMPLIANCE_STATUS"
    ]
}

Error Response

View common error responses

Rate limit: 100 requests per minute. Exceeding this limit will block requests for 1 minute

Last Operation Details

API EndPoint : lastOperationDetails

Provides the status of the most recent operation performed on a specific device by specifying the device’s IP address or resource ID. This API can be used for polling to repeatedly check the operation status—such as Backup, Upload, Script Execution, Copy Running to Startup, or Compliance Check—until the process completes or succeeds from the time it was initiated.

HTTP Method

GET

API URL

http://localhost:8060/api/json/ncmdevice/lastOperationDetails?apiKey=********&deviceId=305

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
deviceId	Resource id of the device	long	-	No
ip	IPAddress of the device	-	^(?:(?:(?:25[0-5]\|2[0-4][0-9]\|[01]?[0-9][0-9]?).){3}(?:25[0-5]\|2[0-4][0-9]\|[01]?[0-9][0-9]?)\|(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}\|([0-9a-fA-F]{1,4}:){1,7}:\|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}\|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}\|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}\|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}\|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}\|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})\|:((:[0-9a-fA-F]{1,4}){1,7}\|:)\|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}\|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]\|(2[0-4]\|1{0,1}[0-9]){0,1}[0-9]).){3,3}(25[0-5]\|(2[0-4]\|1{0,1}[0-9]){0,1}[0-9])\|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]\|(2[0-4]\|1{0,1}[0-9]){0,1}[0-9]).){3,3}(25[0-5]\|(2[0-4]\|1{0,1}[0-9]){0,1}[0-9])))$	No

Sample Response

HTTP Code: 200

{
  "lastopstat": "SUCCESS",
  "lastsuccess": 1762178270627,
  "lastoptype": "Backup"
}

Error Response

View common error responses

Rate limit: 100 requests per minute. Exceeding this limit will block requests for 1 minute

Device Summary

API EndPoint : devSummary

Provides a summary of device details including basic info, hardware specs, OS and model, configuration details with conflict status, compliance status, credential status, supported templates of the device's vendor, interface details, recent operation status, and export links for reports. Useful for monitoring, management, and audit of a specific device.

HTTP Method

GET

API URL

http://localhost:8060/api/json/ncmdevice/devSummary?apiKey=********&snapType=NCMDevice&deviceid=305

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
deviceId	Resource id of the device	long	-	No
ip	IPAddress of the device	-	^(?:(?:(?:25[0-5]\|2[0-4][0-9]\|[01]?[0-9][0-9]?).){3}(?:25[0-5]\|2[0-4][0-9]\|[01]?[0-9][0-9]?)\|(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}\|([0-9a-fA-F]{1,4}:){1,7}:\|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}\|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}\|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}\|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}\|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}\|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})\|:((:[0-9a-fA-F]{1,4}){1,7}\|:)\|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}\|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]\|(2[0-4]\|1{0,1}[0-9]){0,1}[0-9]).){3,3}(25[0-5]\|(2[0-4]\|1{0,1}[0-9]){0,1}[0-9])\|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]\|(2[0-4]\|1{0,1}[0-9]){0,1}[0-9]).){3,3}(25[0-5]\|(2[0-4]\|1{0,1}[0-9]){0,1}[0-9])))$	No
snapType	Snapshot Name @Internal: This parameter is intended for internal use to support loading the GUI with multiple tabs. The value should be set as `NCMDevice`, which provides metadata necessary for the internal GUI rendering framework. Its NOT A MANDATORY param.	-	^(NCMDevice)$	No

Sample Response

HTTP Code: 200

{
    "devDetails": {
        "isTagAssociated": false,
        "showCustomColumn": true,
        "AssocSNMPProfile": "Public",
        "CredentialValidity": true,
        "ENDOFSUPPORTDATE": "31-Dec-2022",
        "restEnabled": false,
        "SystemDescriptionTruncated": "Cisco IOS Software, C2951...",
        "SystemContact": "test",
        "managed": true,
        "OSVersion": "15.4(3)M5",
        "AllConfigsSize": "547.64 KB",
        "HostName": "10.5.X.X",
        "cred": "SSH - TFTP",
        "SerialNo": "FGL153210AY",
        "credTitle": "Click here to update credentials.",
        "SUMMARY_NOT_AVAILABLE": false,
        "ENDOFSALEDATE": "09-Dec-2017",
        "SystemDescription": "Cisco IOS Software, C2951 Software (C2951-UNIVERSALK9-M), Version 15.4(3)M5, RELEASE SOFTWARE (fc1)rnTechnical Support: http://www.cisco.com/techsupportrnCopyright (c) 1986-2016 by Cisco Systems, Inc.rnCompiled Tue 09-Feb-16 05:48 by prod_rel_team",
        "DeviceTemplates": [
            {
                "templateDispName": "Cisco IOS Router",
                "templateName": "Cisco_IOS_Router"
            },
            {
                "templateDispName": "Cisco IOS Switch",
                "templateName": "Cisco_IOS_Switch"
            },
            {
                "templateDispName": "Cisco Aironet AccessPoint",
                "templateName": "Cisco_Aironet_AccessPoint"
            },
            {
                "templateDispName": "Cisco Access Server",
                "templateName": "Cisco_AccessServer"
            },
            {
                "templateDispName": "Cisco ASA",
                "templateName": "Cisco_ASA"
            },
            {
                "templateDispName": "Cisco ASA MultiContext",
                "templateName": "Cisco_ASA_MultiContext"
            },
            {
                "templateDispName": "Cisco CatOS Switch",
                "templateName": "Cisco_CatOS_Switch"
            },
            {
                "templateDispName": "Cisco CatOS Switch 1900",
                "templateName": "Cisco_CatOS_Switch_1900"
            },
            {
                "templateDispName": "Cisco Content Switch",
                "templateName": "Cisco_Content_Switch"
            },
            {
                "templateDispName": "Cisco PIX Firewall Version 7.x",
                "templateName": "Cisco_PIX_Firewall_Version_7"
            },
            {
                "templateDispName": "Cisco PIX Firewall Version 6.x",
                "templateName": "Cisco_PIX_Firewall_Version_6"
            },
            {
                "templateDispName": "Cisco PIX FWSM",
                "templateName": "Cisco_PIX_Firewall_FWSM"
            },
            {
                "templateDispName": "Cisco IAD",
                "templateName": "Cisco_IAD"
            },
            {
                "templateDispName": "Cisco Voice Gateway",
                "templateName": "Cisco_VoiceGateway"
            },
            {
                "templateDispName": "Cisco VPN Concentrator",
                "templateName": "Cisco_VPN_Concentrator"
            },
            {
                "templateDispName": "Cisco MDS Switch",
                "templateName": "Cisco_MDS_Switch"
            },
            {
                "templateDispName": "Cisco WLAN Controller",
                "templateName": "Cisco_WLAN_Controller"
            },
            {
                "templateDispName": "Cisco WAAS",
                "templateName": "Cisco_WAAS"
            },
            {
                "templateDispName": "Cisco ACE Module",
                "templateName": "Cisco_ACE_Module"
            },
            {
                "templateDispName": "Cisco IOS XR",
                "templateName": "Cisco_IOSXR"
            },
            {
                "templateDispName": "Cisco Intrusions Detection Sensor IDS",
                "templateName": "Cisco_Intrusions_Detection_Sensor"
            },
            {
                "templateDispName": "Cisco Nexus Switch",
                "templateName": "Cisco_Nexus_Switch"
            },
            {
                "templateDispName": "Cisco ASA WAN",
                "templateName": "Cisco_ASA_INT"
            },
            {
                "templateDispName": "Cisco PIX FWSM 4.x",
                "templateName": "Cisco_PIX_Firewall_FWSM_V4"
            },
            {
                "templateDispName": "Cisco ASR Router",
                "templateName": "Cisco_ASR_Router"
            },
            {
                "templateDispName": "Cisco Ironport",
                "templateName": "Cisco_Iron_Port"
            },
            {
                "templateDispName": "Cisco 300 Series Switch",
                "templateName": "Cisco_300_Switch"
            },
            {
                "templateDispName": "Cisco ASR Mobile Gateway",
                "templateName": "Cisco_ASR_5000"
            },
            {
                "templateDispName": "Cisco Integrated Services Router ISR",
                "templateName": "Cisco_Integrated_Services_Router"
            },
            {
                "templateDispName": "Cisco Nexus VDC",
                "templateName": "Cisco_Nexus_VDC"
            },
            {
                "templateDispName": "Cisco Multiservice Switch Router",
                "templateName": "Cisco_Multiservice_Switch_Router"
            },
            {
                "templateDispName": "Cisco IOS XE",
                "templateName": "Cisco_IOS_XE"
            },
            {
                "templateDispName": "Cisco Small Business Switch",
                "templateName": "Cisco_Small_Business_Switch"
            },
            {
                "templateDispName": "Cisco ACS",
                "templateName": "Cisco_ACS"
            },
            {
                "templateDispName": "Cisco Virtual Service Router",
                "templateName": "Cisco_Virtual_Service_Router"
            },
            {
                "templateDispName": "Mobile Wireless Router",
                "templateName": "Mobile_Wireless_Router"
            },
            {
                "templateDispName": "Cisco Connected Grid Router",
                "templateName": "Cisco_Connected_Grid_Router"
            },
            {
                "templateDispName": "Cisco Campus Switch Router",
                "templateName": "Cisco_Campus_Switch_Router"
            },
            {
                "templateDispName": "Cisco Multiservice Access Concentrator",
                "templateName": "Cisco_Multiservice_Access_Concentrator"
            },
            {
                "templateDispName": "Cisco Workgroup Concentrator",
                "templateName": "Cisco_Workgroup_Concentrator"
            },
            {
                "templateDispName": "Cisco File Engine",
                "templateName": "Cisco_File_Engine"
            },
            {
                "templateDispName": "Cisco GSM Port",
                "templateName": "Cisco_GSM_Port"
            },
            {
                "templateDispName": "Cisco AGS Router",
                "templateName": "Cisco_AGS_Router"
            },
            {
                "templateDispName": "Cisco Ether Switch",
                "templateName": "Cisco_Ether_Switch"
            },
            {
                "templateDispName": "Cisco Broadband Aggregators",
                "templateName": "Cisco_Broadband_Aggregators"
            },
            {
                "templateDispName": "Cisco Broadband Network Termination Unit",
                "templateName": "Cisco_Broadband_Network_Termination_Unit"
            },
            {
                "templateDispName": "Cisco Universal Broadband Router",
                "templateName": "Cisco_Universal_Broadband_Router"
            },
            {
                "templateDispName": "Cisco Service Ready Platform SRP",
                "templateName": "Cisco_Service_Ready_Platform_SRP"
            },
            {
                "templateDispName": "Cisco WAE",
                "templateName": "Cisco_WAE"
            },
            {
                "templateDispName": "Cisco LightStream ATM Switch",
                "templateName": "Cisco_LightStream_ATM_Switch"
            },
            {
                "templateDispName": "Cisco Unified Computing System",
                "templateName": "Cisco_Unified_Computing_System"
            },
            {
                "templateDispName": "Cisco Multiservice Platform router",
                "templateName": "Cisco_Multiservice_Platform_router"
            },
            {
                "templateDispName": "Cisco MDE",
                "templateName": "Cisco_MDE"
            },
            {
                "templateDispName": "Cisco Media Convergence Server MCS",
                "templateName": "Cisco_Media_Convergence_Server_MCS"
            },
            {
                "templateDispName": "Cisco RF Gateway",
                "templateName": "Cisco_RF_Gateway"
            },
            {
                "templateDispName": "Cisco Wireless Mobile Interface Card",
                "templateName": "Cisco_Wireless_Mobile_Interface_Card"
            },
            {
                "templateDispName": "Cisco Identity Services Engine ISE",
                "templateName": "Cisco_Identity_Services_Engine_ISE"
            },
            {
                "templateDispName": "Cisco Unified Communications UC",
                "templateName": "Cisco_Unified_Communications_UC"
            },
            {
                "templateDispName": "VEdge Router",
                "templateName": "VEdge_Router"
            },
            {
                "templateDispName": "Cisco Content Engine",
                "templateName": "Cisco_Content_Engine"
            },
            {
                "templateDispName": "Cisco Email Security Appliance",
                "templateName": "Cisco_Email_Security_Appliance"
            },
            {
                "templateDispName": "Cisco Hub",
                "templateName": "Cisco_Hub"
            },
            {
                "templateDispName": "Cisco SCE",
                "templateName": "Cisco_SCE"
            },
            {
                "templateDispName": "Cisco Industrial Ethernet Switch IE",
                "templateName": "Cisco_Industrial_Ethernet_Switch_IE"
            },
            {
                "templateDispName": "Cisco ISDN Access Routers",
                "templateName": "Cisco_ISDN_Access_Routers"
            },
            {
                "templateDispName": "Cisco Universal Access Server",
                "templateName": "Cisco_Universal_Access_Server"
            },
            {
                "templateDispName": "Cisco Network Convergence System NCS",
                "templateName": "Cisco_Network_Convergence_System_NCS"
            },
            {
                "templateDispName": "Cisco Communications Media Module",
                "templateName": "Cisco_Communications_Media_Module"
            },
            {
                "templateDispName": "Cisco C9800 Wireless Controller",
                "templateName": "Cisco_C9800_Wireless_Controller"
            },
            {
                "templateDispName": "Cisco Services Module",
                "templateName": "Cisco_Services_Module"
            },
            {
                "templateDispName": "Cisco WLAN Controller 5520",
                "templateName": "Cisco_WLAN_Controller_5520"
            },
            {
                "templateDispName": "Cisco Integrated Communication System",
                "templateName": "Cisco_Integrated_Communication_System"
            },
            {
                "templateDispName": "Cisco Modular Ethernet Switch",
                "templateName": "Cisco_Modular_Ethernet_Switch"
            },
            {
                "templateDispName": "Cisco Firepower Threat Defense",
                "templateName": "Cisco_Firepower_Threat_Defense"
            },
            {
                "templateDispName": "Cisco Prime",
                "templateName": "Cisco_Prime"
            },
            {
                "templateDispName": "Cisco ASR 1000 Series Router",
                "templateName": "Cisco_ASR_1000_Series_Router"
            },
            {
                "templateDispName": "Cisco Supervisor Engine",
                "templateName": "Cisco_Supervisor_Engine"
            },
            {
                "templateDispName": "Cisco Service Ready Engine SRE",
                "templateName": "Cisco_Service_Ready_Engine_SRE"
            },
            {
                "templateDispName": "Cisco CIMC",
                "templateName": "Cisco_CIMC"
            },
            {
                "templateDispName": "Cisco Modular Access Router",
                "templateName": "Cisco_Modular_Access_Router"
            },
            {
                "templateDispName": "Cisco Catalyst 9200 Switch",
                "templateName": "Cisco_Catalyst_9200_Switch"
            },
            {
                "templateDispName": "Cisco APIC Fabric Controller",
                "templateName": "Cisco_APIC_Fabric_Controller"
            },
            {
                "templateDispName": "Cisco Firepower",
                "templateName": "Cisco_Firepower"
            },
            {
                "templateDispName": "Cisco Mobile Wireless Router",
                "templateName": "Cisco_Mobile_Wireless_Router"
            },
            {
                "templateDispName": "Cisco IGS Router",
                "templateName": "Cisco_IGS_Router"
            },
            {
                "templateDispName": "Cisco Firewall Services Module",
                "templateName": "Cisco_Firewall_Services_Module"
            },
            {
                "templateDispName": "Cisco Intrusions Prevention Sensor IPS",
                "templateName": "Cisco_Intrusions_Prevention_Sensor_IPS"
            },
            {
                "templateDispName": "Cisco Integrated Encryption Router",
                "templateName": "Cisco_Integrated_Encryption_Router"
            }
        ],
        "SyslogChangeDetection": "Disabled",
        "COLUMNVALUE1": "[NA]",
        "COLUMNVALUE2": "[NA]",
        "PROTOCOL": "SSH - TFTP",
        "COLUMNVALUE3": "[NA]",
        "DeviceTemplateName": "Cisco Integrated Services Router ISR",
        "vendorName": "Cisco",
        "COLUMNNAME2": "Custom Column 2",
        "COLUMNNAME1": "Custom Column 1",
        "COLUMNNAME3": "Custom Column 3",
        "SystemLocation": "Not Available",
        "imgUrl": "/apiclient/fluidicv2/img/ncm/ready_ico.gif",
        "DeviceType": "CiscoRouter",
        "Series": "C2951",
        "LastOperationStatus": "SUCCESS",
        "MACAddress": "[NA]",
        "LastSuccessfulOperationAt": "Nov 3, 2025 07:43 PM",
        "templateName": "Cisco_Integrated_Services_Router",
        "LastOperationType": "ComplianceCheck",
        "OSType": "IOS",
        "ImageFileName": "c2951-universalk9-mz.SPA.154-3.M5.bin",
        "Model": "CISCO2951/K9",
        "fileformat": "Text",
        "IPAddress": "10.5.X.X"
    },
    "EXPORT_CONFIG_CHANGE_PDF_LINK": "&CUSTOMIZE_DATA_VIEWNAME=ConfigChangesReport_RTab&DEVICE_GROUP_ID=&DG_ID=&DEVICE_ID=",
    "TemplateActions": [],
    "EXPORT_CONFIG_CHANGE_COMPL_PDF_LINK": "&CUSTOMIZE_DATA_VIEWNAME=Device_ComplianceReport&REP_CRI=ALL_RULES&DEVICE_ID=",
    "EXPORT_ANNOTATION_PDF_LINK": "&CUSTOMIZE_DATA_VIEWNAME=AnnotationReport_RTab&DEVICE_ID=",
    "confDetails": {
        "WarningCount": 0,
        "CritcalCount": 14,
        "ENDOFSALEDATE": "09-Dec-2017",
        "baseRunninConflict": {
            "conflict": false
        },
        "SuccessCount": 29,
        "StartupBaseline": {
            "image": "None",
            "versionId": 601,
            "versionNo": 1
        },
        "cmpchartData": {
            "DraftCount": 0,
            "RunningCount": 1,
            "StartupCount": 1
        },
        "RunningBaseline": {
            "image": "None",
            "versionId": 602,
            "versionNo": 1
        },
        "startupRunninConflict": {
            "conflict": false
        },
        "ENDOFSUPPORTDATE": "31-Dec-2022",
        "MajorCount": 22,
        "Running": {
            "image": " Version 1",
            "versionId": 602,
            "versionNo": 1
        },
        "Startup": {
            "image": " Version 1",
            "versionId": 601,
            "versionNo": 1
        },
        "BackupStatus": "SUCCESS"
    },
    "opmDeviceName": "10.5.X.X",
    "availability": [
        "OnHold,1762194626160,1762233686160,On Hold",
        "UP,1762194626160,1762194626160,Up",
        "UP,1762233686160,1762233686160,Up"
    ],
    "moid": 607,
    "RESOOURCEID": 305,
    "isOPMDevice": true,
    "EXPORT_CONFIG_CHANGE_TERND_PDF_LINK": "&CUSTOMIZE_DATA_VIEWNAME=ConfigChangeTrendReport_RTab&DEVICE_ID=",
    "lastOperationDetails": {
        "AUDIT_INFO_AVAILABLE": false
    },
    "isNipperReportAvailable": true,
    "EXPORT_CONFIG_CHANGE_DEV_AUDIT_PDF_LINK": "&CUSTOMIZE_DATA_VIEWNAME=OperationAuditReport_RTab&DEVICE_ID=",
    "HardwareValue": [
        {
            "value": "Not Available",
            "key": "CPU"
        },
        {
            "value": "250880K",
            "key": "Flash Size"
        },
        {
            "value": "revision 1.1",
            "key": "CPU Revision"
        },
        {
            "value": "0x2102",
            "key": "Configuration Register"
        },
        {
            "value": "487424K/36864K",
            "key": "DRAM Size"
        },
        {
            "value": "255K",
            "key": "NVRAM Size"
        },
        {
            "value": "Not Available",
            "key": "MAC Address"
        },
        {
            "value": "c2951-universalk9-mz.SPA.154-3.M5.bin",
            "key": "Image File Name"
        },
        {
            "value": "FGL153210AY",
            "key": "Serial Number"
        }
    ],
    "InterfaceDetails": [
        {
            "Description": "[NA]",
            "InterfaceName": "Backplane-GigabitEthernet0/3",
            "IpAddress": "[NA]",
            "id": 1
        },
        {
            "Description": "[NA]",
            "InterfaceName": "Embedded-Service-Engine0/0",
            "IpAddress": "[NA]",
            "id": 5
        },
        {
            "Description": "[NA]",
            "InterfaceName": "Null0",
            "IpAddress": "[NA]",
            "id": 6
        },
        {
            "Description": "[NA]",
            "InterfaceName": "Loopback0",
            "IpAddress": "[NA]",
            "id": 7
        },
        {
            "Description": "[NA]",
            "InterfaceName": "GigabitEthernet0/1.1",
            "IpAddress": "[NA]",
            "id": 8
        },
        {
            "Description": "[NA]",
            "InterfaceName": "Loopback234",
            "IpAddress": "[NA]",
            "id": 10
        },
        {
            "Description": "[NA]",
            "InterfaceName": "Loopback55",
            "IpAddress": "[NA]",
            "id": 11
        },
        {
            "Description": "[NA]",
            "InterfaceName": "Loopback555",
            "IpAddress": "[NA]",
            "id": 12
        },
        {
            "Description": "[NA]",
            "InterfaceName": "Loopback51",
            "IpAddress": "[NA]",
            "id": 13
        },
        {
            "Description": "[NA]",
            "InterfaceName": "Loopback50",
            "IpAddress": "[NA]",
            "id": 14
        },
        {
            "Description": "[NA]",
            "InterfaceName": "Port-channel1",
            "IpAddress": "[NA]",
            "id": 15
        },
        {
            "Description": "[NA]",
            "InterfaceName": "Loopback10",
            "IpAddress": "10.5.X.X",
            "id": 9
        },
        {
            "Description": "[NA]",
            "InterfaceName": "GigabitEthernet0/0",
            "IpAddress": "10.5.X.X",
            "id": 2
        },
        {
            "Description": "[NA]",
            "InterfaceName": "GigabitEthernet0/1",
            "IpAddress": "10.5.X.X",
            "id": 3
        },
        {
            "Description": "[NA]",
            "InterfaceName": "GigabitEthernet0/2",
            "IpAddress": "10.5.X.X",
            "id": 4
        }
    ],
    "cmpdetails": [
        {
            "majaoCount": 22,
            "successCount": 29,
            "warningCount": 0,
            "criticalCount": 14
        }
    ]
}

Error Response

View common error responses

Rate limit: 100 requests per minute. Exceeding this limit will block requests for 1 minute

Get Device Summary For ResourceID

API EndPoint : getDevSummaryforResId

Provides the details of Backup Status, Compliance Status, EOL Status and Configuration Details of a specific device.

HTTP Method

GET

API URL

http://localhost:8060/api/json/ncmdevice/getDevSummaryforResId?RESOURCEID=305&apiKey=********

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
RESOURCEID	Resource id of the device	long	-	yes
POST	RESOURCEID	Resource id of the device	long	No
HOSTNAME	Host Name of the device	-	^([p{L}p{N}P{InBasicLatin}s.:-_])+$	yes
IPADDRESS	IPAddress of the device - When updating the IP address of an existing device, ensure that the new IP address does not already exist in NCM. Or else it If you need to switch IP addresses between two devices (A and B), use a temporary IP address (C) to swap them safely.	-	^(?:(?:(?:25[0-5]\|2[0-4][0-9]\|[01]?[0-9][0-9]?).){3}(?:25[0-5]\|2[0-4][0-9]\|[01]?[0-9][0-9]?)\|(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}\|([0-9a-fA-F]{1,4}:){1,7}:\|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}\|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}\|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}\|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}\|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}\|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})\|:((:[0-9a-fA-F]{1,4}){1,7}\|:)\|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}\|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]\|(2[0-4]\|1{0,1}[0-9]){0,1}[0-9]).){3,3}(25[0-5]\|(2[0-4]\|1{0,1}[0-9]){0,1}[0-9])\|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]\|(2[0-4]\|1{0,1}[0-9]){0,1}[0-9]).){3,3}(25[0-5]\|(2[0-4]\|1{0,1}[0-9]){0,1}[0-9])))$	yes
OSVERSION	OS Version	-	^([p{L}p{N}P{InBasicLatin}.,:s-_()[]])+$	yes
OSTYPE	OS Type	-	^([p{L}p{N}P{InBasicLatin}.,s-_[]])+$	yes
MODEL	Model	-	^([p{L}p{N}P{InBasicLatin}.!:@#$s-_+\/',[]()])+$	yes
SERIES	Series	-	^([p{L}p{N}P{InBasicLatin}.!:@#$s-_+\/',[]()])+$	yes
SYSTEMDESCRIPTION	System Description	-	^([p{L}p{N}P{InBasicLatin}.,!:@#$%s-_\/'[]()])+$	yes
SYSTEMLOCATION	System Location	-	^([p{L}p{N}P{InBasicLatin}.,!:@#$%s-_\/'[]()])+$	yes
SYSTEMCONTACT	System Contact	-	^([p{L}p{N}P{InBasicLatin}.,!:@#$%s-_\/'[]()])+$	yes
COLUMNNAME1	Custom Column Name 1	-	^([p{L}p{N}P{InBasicLatin}.!:@#$s-_\/'[],])+$	yes
COLUMNNAME2	Custom Column Name 2	-	^([p{L}p{N}P{InBasicLatin}.!:@#$s-_\/'[],])+$	yes
COLUMNNAME3	Custom Column Name 3	-	^([p{L}p{N}P{InBasicLatin}.!:@#$s-_\/'[],])+$	yes
OLD_TEMPLATE_NAME	Old Device Template Name - This value can be obtained from the "templateName" field in the "DeviceTemplates" array within the response of the devSummary API for the corresponding device.	-	[p{L}p{N}P{InBasicLatin}-_s./]+	yes
NEW_TEMPLATE_NAME	New Device Template Name - This value can be obtained from the "templateName" field in the "DeviceTemplates" array within the response of the devSummary API for the corresponding device.	-	[p{L}p{N}P{InBasicLatin}-_s./]+	yes

Sample Response

HTTP Code: 200

{
    "WarningCount": 1,
    "CritcalCount": 16,
    "ENDOFSALEDATE": "09-Dec-2017",
    "baseRunninConflict": {
        "conflict": false
    },
    "SuccessCount": 31,
    "StartupBaseline": {
        "image": "None",
        "versionId": 613,
        "versionNo": 2
    },
    "RunningBaseline": {
        "image": "None",
        "versionId": 621,
        "versionNo": 5
    },
    "startupRunninConflict": {
        "conflict": true
    },
    "ENDOFSUPPORTDATE": "31-Dec-2022",
    "MajorCount": 23,
    "Running": {
        "image": " Version 5",
        "versionId": 621,
        "versionNo": 5
    },
    "Startup": {
        "image": " Version 2",
        "versionId": 613,
        "versionNo": 2
    },
    "BackupStatus": "FAILURE"
}

Error Response

View common error responses

Rate limit: 100 requests per minute. Exceeding this limit will block requests for 1 minute

Update Device System Information

API EndPoint : updateDevSysInfo

This API provides a way to manually update key attributes for multiple network devices, similar to the updateDevSummary API. With updateDevSysInfo, you can modify details such as Series, Model, OS Type, OS Version, System Description, System Location, System Contact, custom column values, End of Sale Date, and End of Support Date.

Key differences from updateDevSummary API:

- Enables bulk updates, allowing the same values to be applied to multiple devices at once.

- Devices are identified by their IP addresses instead of RESOURCEIDs.

- Only the required fields can be updated; not all parameters are mandatory.

HTTP Method

POST

API URL

http://localhost:8060/api/json/ncmdevice/updateDevSysInfo?IPADDRESSES=["192.168.XX.XXX","192.168.XX.XXX"]&apiKey=********&SERIES="CiscoSeries"&ENDOFSALEDATE="09-Dec-2017"

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
IPADDRESSES	IPAddress	JSONArray	-	yes
OSVERSION	OS Version	-	^([p{L}p{N}P{InBasicLatin}.,:s-_()[]])+$	No
OSTYPE	OS Type	-	^([p{L}p{N}P{InBasicLatin}.,s-_[]])+$	No
MODEL	Model	-	^([p{L}p{N}P{InBasicLatin}.!:@#$s-_+\/',[]()])+$	No
SERIES	Series	-	^([p{L}p{N}P{InBasicLatin}.!:@#$s-_+\/',[]()])+$	No
SYSTEMDESCRIPTION	System Description	-	^([p{L}p{N}P{InBasicLatin}.,!:@#$%s-_\/'[]()])+$	No
SYSTEMLOCATION	System Location	-	^([p{L}p{N}P{InBasicLatin}.,!:@#$%s-_\/'[]()])+$	No
SYSTEMCONTACT	System Contact	-	^([p{L}p{N}P{InBasicLatin}.,!:@#$%s-_\/'[]()])+$	No
COLUMNNAME1	Custom Column Name 1	-	^([p{L}p{N}P{InBasicLatin}.!:@#$s-_\/'[],])+$	No
COLUMNNAME2	Custom Column Name 2	-	^([p{L}p{N}P{InBasicLatin}.!:@#$s-_\/'[],])+$	No
COLUMNNAME3	Custom Column Name 3	-	^([p{L}p{N}P{InBasicLatin}.!:@#$s-_\/'[],])+$	No
ENDOFSALEDATE	End of Sale Date - Date Format should be DD-Mmm-YYYY	-	^(([0][1-9])\|([1-2][0-9])\|([3][0-1]))-(Jan\|Feb\|Mar\|Apr\|May\|Jun\|Jul\|Aug\|Sep\|Oct\|Nov\|Dec)-d{4}$	No
ENDOFSUPPORTDATE	End of Support Date - Date Format should be DD-Mmm-YYYY	-	^(([0][1-9])\|([1-2][0-9])\|([3][0-1]))-(Jan\|Feb\|Mar\|Apr\|May\|Jun\|Jul\|Aug\|Sep\|Oct\|Nov\|Dec)-d{4}$	No

Sample Response

HTTP Code: 200

{
  "statusMsg": "Device system information is updated successfully",
  "isSuccess": true
}

Error Response

View common error responses

Rate limit: 100 requests per minute. Exceeding this limit will block requests for 1 minute

Get Device Configlets History

API EndPoint : getDevConfiglets

This API returns the execution history of configuration scripts (Configlets) for a specific device. The response provides comprehensive information for each execution, including the status (Success or Failure), the description of the result, Audit ID, Configlet name, execution time, and Execution ID.

Note: You can use the EXECUTION_ID and RESOURCE_ID from this API response to download the Configlet execution PDF report via the NCMReportPDFGenerator API, or view detailed results using the detailedResult API.

HTTP Method

GET

API URL

http://localhost:8060/api/json/ncmdevice/getDevConfiglets?apiKey=********&deviceId=305

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
deviceId	Resource id of the device	long	-	yes

Sample Response

HTTP Code: 200

{
    "gridData": [
        {
            "Status": "SUCCESS",
            "Description": "Script executed successfully",
            "AuditId": 669,
            "TemplateName": "Show Version Script",
            "ExceutionId": 6,
            "ExecutedAt": "Nov 04, 2025 11:47 AM",
            "rid": 305
        },
        {
            "Status": "FAILURE",
            "Description": "Failure occured during the operation execution",
            "AuditId": 664,
            "TemplateName": "Cisco_Show_Version_Script",
            "ExceutionId": 5,
            "ExecutedAt": "Nov 04, 2025 11:45 AM",
            "rid": 305
        },
        {
            "Status": "FAILURE",
            "Description": "Failure occured during the operation execution",
            "AuditId": 646,
            "TemplateName": "Cisco_Show_Version_Script",
            "ExceutionId": 4,
            "ExecutedAt": "Nov 03, 2025 19:42 PM",
            "rid": 305
        },
        {
            "Status": "SUCCESS",
            "Description": "Script executed successfully",
            "AuditId": 644,
            "TemplateName": "Cisco_Show_Version_Script",
            "ExceutionId": 3,
            "ExecutedAt": "Nov 03, 2025 19:40 PM",
            "rid": 305
        },
        {
            "Status": "SUCCESS",
            "Description": "Script executed successfully",
            "AuditId": 642,
            "TemplateName": "Cisco_Show_Version_Script",
            "ExceutionId": 2,
            "ExecutedAt": "Nov 03, 2025 19:39 PM",
            "rid": 305
        },
        {
            "Status": "SUCCESS",
            "Description": "Script executed successfully",
            "AuditId": 640,
            "TemplateName": "Cisco_Show_Version_Script",
            "ExceutionId": 1,
            "ExecutedAt": "Nov 03, 2025 19:38 PM",
            "rid": 305
        }
    ]
}

Error Response

View common error responses

Rate limit: 100 requests per minute. Exceeding this limit will block requests for 1 minute

Get Device Security Report

API EndPoint : getDevReport

Get security report for Particular Device

HTTP Method

POST

API URL

http://localhost:8060/api/json/ncmdevice/getDevReport?apiKey=********&deviceId=101&reportType=SecurityAuditReport

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
deviceId	Resource ID of the device for which security report need to be generated	long	-	yes
reportType	Type of the security report - Device Configuration or Security Audit	-	^(DeviceConfigurationReport\|SecurityAuditReport)$	yes

Sample Response

HTTP Code: 200

{"statusMsg":"Security audit report successfully generated for 10.5.X.X.","clientUrl":"http://test-123:8888/schedule_results/Nipper_Reports/SecurityAuditReport_For_23701_10.5.X.X.html","isNipperReport":false,"isSuccess":true}

Error Response

View common error responses

Rate limit: 100 requests per minute. Exceeding this limit will block requests for 1 minute

Add Device Group

API EndPoint : addDeviceGroup

This API allows you to create a new Device Group or edit an existing Device Group by either selecting individual existing devices (using SpecificDeviceCriteria), including existing device groups as subgroups (SubGroup), or by specifying multiple selection criteria across various fields. Criteria options include Hostname, IP Address, Vendor, Device Type, Series, Model, OS Type, OS Version, System Location, System Description, System Contact, Backup Status, Startup-Running Conflict, Compliance Status, and Custom Column Values.

Note:

1. To retrieve information about existing devices, device groups, and available fields for criteria formation, use the getNCMDeviceSelectionDetails API.

2. To retrieve details of a specific device group that needs to be updated, use the deviceGroupEditPreRender API.

3. The parameter IS_EDIT_VIEW determines the intended operation for the Device Group, indicating whether the request is to add a new group or update an existing one.

HTTP Method

POST

API URL

http://localhost:8060/api/json/ncmdevice/addDeviceGroup?apiKey=********&IS_EDIT_VIEW=false&DEVICE_GROUP_NAME="Chennai DG"&DG_DESCRIPTION="Chennai DG"&ComponentSelection="SpecificDeviceCriteria"&SELECTEDDEVICES=[101,102,103]&GLOBAL_DEVICE_GROUP=false&isDistribute=false&TAG_ID=2"

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
SELECTEDDEVICES	Resource ids of the devices - If ComponentSelection set to SpecifiDeviceCriteria, then this param will have an array of Resource Ids, and they can be obtained from getNCMDeviceSelectionDetails API.	JSONArray	-	No
SELECTEDDEVICEGROUPS	IDs of the device groups - If ComponentSelection set to SubGroup, then this param will have an array of Device Group Ids, and they can be obtained from getNCMDeviceSelectionDetails API.	JSONArray	-	No
DEVICE_GROUP_NAME	Name of the device group to be added/updated.	-	[p{L}p{N}P{InBasicLatin}-_s./]+	No
DG_DESCRIPTION	Description of the device group to be added/updated.	-	^([p{L}p{N}P{InBasicLatin}.!:#$s-_',])+$	No
GLOBAL_DEVICE_GROUP	This boolean value specifies the visibility or ownership of a device group—whether it is global (visible to all users) or private (visible only to the user who created it). Note: 1. Only public groups will be available for compliance status. 2. Once a group is made public it can't be changed to private.	boolean	-	No
IS_EDIT_VIEW	This boolean value indicates the type of operation to be performed on the Device Group, specifying whether the action is to add a new group or edit an existing one.	boolean	-	No
ComponentSelection	Component Selection - The value may be set to SpecificDeviceCriteria, SubGroup, or DeviceByCriteria. This option determines the method for creating a device group: by selecting individual devices, including existing device groups, or specifying criteria-based selection.	-	^(DeviceByCriteria\|SubGroup\|SpecificDeviceCriteria)$	yes
QUERYID	Query ID - This value is required only when updating (editing) an existing device group. This value can be obtained from QUERYID filed from the response of deviceGroupEditPreRender API.	long	-	No
TAG_ID	For device group addition, this parameter associates the specified TAG to the Device Group only if the user does not already have any TAG assigned. For device group editing, this parameter allows reassociation to the provided TAG from the existing TAG. However, associating a TAG to device groups that do not already have a TAG is not permitted. Note: The TAG_ID can be retrieved from the response of the listAllTags API.	long	-	No
CRITERIA_LIST	When ComponentSelection is set to DeviceByCriteria, this parameter should contain a list of JSON objects representing the selection criteria. Notes: - Each JSON object must include four fields: Comparator, Field, Condition, and Value. - The valid options for Field and Condition can be referenced from the parameters and condition fields in the response of the getNCMDeviceSelectionDetails API. - Comparator value can be either "and" or "or". Example: [{"Comparator":"and","Field":"RESOURCENAME","Condition":"LIKE","Value":"Cisco"},{"Comparator":"or","Field":"VENDORNAME","Condition":"LIKE","Value":"Cisco"},{"Comparator":"or","Field":"DISPLAYTYPE","Condition":"LIKE","Value":"Cisco"}]	JSONArray	-	No
isDistribute	This parameter is relevant only for enterprise editions (Central) and specifies whether the device group created in Central should be added to all Probes. Note that distribution to probes is permitted only when adding a group; it is not allowed when editing an existing group.	boolean	-	No

Sample Response

HTTP Code: 200

{
  "statusMsg": "Device group Core Devices added successfully",
  "isSuccess": true
}

Error Response

View common error responses

Rate limit: 100 requests per minute. Exceeding this limit will block requests for 1 minute

Update Device Group

API EndPoint : addDeviceGroup

Note:

1. To retrieve information about existing devices, device groups, and available fields for criteria formation, use the getNCMDeviceSelectionDetails API.

2. To retrieve details of a specific device group that needs to be updated, use the deviceGroupEditPreRender API.

3. The parameter IS_EDIT_VIEW determines the intended operation for the Device Group, indicating whether the request is to add a new group or update an existing one.

HTTP Method

POST

API URL

http://localhost:8060/api/json/ncmdevice/addDeviceGroup?apiKey=********&IS_EDIT_VIEW=true&DEVICE_GROUP_NAME="Chennai DG"&DG_DESCRIPTION="Chennai DG"&ComponentSelection="SpecificDeviceCriteria"&SELECTEDDEVICES=[101,102,103]&GLOBAL_DEVICE_GROUP=false&isDistribute=false&TAG_ID=2&DEVICE_GROUP_ID=307

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
SELECTEDDEVICES	Resource ids of the devices - If ComponentSelection set to SpecifiDeviceCriteria, then this param will have an array of Resource Ids, and they can be obtained from getNCMDeviceSelectionDetails API.	JSONArray	-	No
SELECTEDDEVICEGROUPS	IDs of the device groups - If ComponentSelection set to SubGroup, then this param will have an array of Device Group Ids, and they can be obtained from getNCMDeviceSelectionDetails API.	JSONArray	-	No
DEVICE_GROUP_ID	ID of the device group. This value can be obtained from the response of getDeviceGroupsList API.	long	-	No
DEVICE_GROUP_NAME	Name of the device group to be added/updated.	-	[p{L}p{N}P{InBasicLatin}-_s./]+	No
DG_DESCRIPTION	Description of the device group to be added/updated.	-	^([p{L}p{N}P{InBasicLatin}.!:#$s-_',])+$	No
GLOBAL_DEVICE_GROUP	This boolean value specifies the visibility or ownership of a device group—whether it is global (visible to all users) or private (visible only to the user who created it). Note: 1. Only public groups will be available for compliance status. 2. Once a group is made public it can't be changed to private.	boolean	-	No
IS_EDIT_VIEW	This boolean value indicates the type of operation to be performed on the Device Group, specifying whether the action is to add a new group or edit an existing one.	boolean	-	No
ComponentSelection	Component Selection - The value may be set to SpecificDeviceCriteria, SubGroup, or DeviceByCriteria. This option determines the method for creating a device group: by selecting individual devices, including existing device groups, or specifying criteria-based selection.	-	^(DeviceByCriteria\|SubGroup\|SpecificDeviceCriteria)$	yes
QUERYID	Query ID - This value is required only when updating (editing) an existing device group. This value can be obtained from QUERYID filed from the response of deviceGroupEditPreRender API.	long	-	No
TAG_ID	For device group addition, this parameter associates the specified TAG to the Device Group only if the user does not already have any TAG assigned. For device group editing, this parameter allows reassociation to the provided TAG from the existing TAG. However, associating a TAG to device groups that do not already have a TAG is not permitted. Note: The TAG_ID can be retrieved from the response of the listAllTags API.	long	-	No
CRITERIA_LIST	When ComponentSelection is set to DeviceByCriteria, this parameter should contain a list of JSON objects representing the selection criteria. Notes: - Each JSON object must include four fields: Comparator, Field, Condition, and Value. - The valid options for Field and Condition can be referenced from the parameters and condition fields in the response of the getNCMDeviceSelectionDetails API. - Comparator value can be either "and" or "or". Example: [{"Comparator":"and","Field":"RESOURCENAME","Condition":"LIKE","Value":"Cisco"},{"Comparator":"or","Field":"VENDORNAME","Condition":"LIKE","Value":"Cisco"},{"Comparator":"or","Field":"DISPLAYTYPE","Condition":"LIKE","Value":"Cisco"}]	JSONArray	-	No
isDistribute	This parameter is relevant only for enterprise editions (Central) and specifies whether the device group created in Central should be added to all Probes. Note that distribution to probes is permitted only when adding a group; it is not allowed when editing an existing group.	boolean	-	No

Sample Response

HTTP Code: 200

{
  "statusMsg": "Device group Core Devices updated successfully",
  "isSuccess": true
}

Error Response

View common error responses

Rate limit: 100 requests per minute. Exceeding this limit will block requests for 1 minute

Get Device Group List

API EndPoint : getDeviceGroupsList

This API retrieves a concise list of all device groups available.

Use Cases:

- For quick reference, lookup, or mapping of device group IDs to their names.

- When only basic identification (ID and name) of device groups is required, rather than full details.

HTTP Method

GET

API URL

http://localhost:8060/api/json/ncmdevice/getDeviceGroupsList?apiKey=********

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes

Sample Response

HTTP Code: 200

"dGroups": [
{
"name": "All Devices Group",
"id": 1
},
{
"name": "Backup Failure Group",
"id": 4
},
{
"name": "Chennai Devices Group",
"id": 306
},
{
"name": "Chennai DG",
"id": 307
},
{
"name": "CIS Cisco ASA Group",
"id": 6
},
{
"name": "CIS Cisco IOS Group",
"id": 5
},
{
"name": "Cisco Only Group",
"id": 305
},
{
"name": "CiscoRouter Group",
"id": 2
},
{
"name": "Tenkasi DG",
"id": 308
}
]
}

Error Response

View common error responses

Rate limit: 100 requests per minute. Exceeding this limit will block requests for 1 minute

List Device Group Details

API EndPoint : listDeviceGroupDetails

This API retrieves supplementary information for a specified Device Group, including color codes for status visualization in the GUI. The response includes Device Group ID, Name, Description, backup status (Success, Failure, Not Backed Up), startup-running conflict status (InSync, Conflict, NotAvailable), compliance status (Compliant, Violation, NotAvailable), visibility as a public group, default group status, and the total number of devices in the group.

HTTP Method

GET

API URL

http://localhost:8060/api/json/ncmdevice/listDeviceGroupDetails?apiKey=********&dGroupId=101

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
dGroupId	ID of the device group - This value can be obtained from the response of getDeviceGroupsList API.	long	-	yes

Sample Response

HTTP Code: 200

{
 "dGroup": {
 "backupData": {
 "data": [
 [
 "Success",
 1,
 "backupStatus",
 "success"
 ],
 [
 "Failure",
 4,
 "backupStatus",
 "failure"
 ],
 [
 "Not Backed Up",
 10,
 "backupStatus",
 "not_backed_up"
 ]
 ]
 },
 "startupConflict": {
 "data": [
 [
 "In Sync",
 4,
 "startupStatus",
 "insync"
 ],
 [
 "Conflict",
 1,
 "startupStatus",
 "conflict"
 ],
 [
 "Not Available",
 10,
 "startupStatus",
 "NA"
 ]
 ]
 },
 "deviceCount": 15,
 "baselineConflict": {
 "data": [
 [
 "In Sync",
 0,
 "baselineStatus",
 "insync"
 ],
 [
 "Conflict",
 5,
 "baselineStatus",
 "conflict"
 ],
 [
 "Not Available",
 10,
 "baselineStatus",
 "NA"
 ]
 ]
 },
 "compliance": {
 "data": [
 [
 "Compliant",
 0,
 "complainceStatus",
 "compliant"
 ],
 [
 "Violation",
 1,
 "complainceStatus",
 "violation"
 ],
 [
 "Not Available",
 14,
 "complainceStatus",
 "NA"
 ]
 ]
 },
 "name": "All Devices Group",
 "id": 1,
 "isGlobalGroup": true,
 "colors": [
 "#46bb7d",
 "#fa5b5b",
 "#faad5a"
 ],
 "desc": "This device group contains all the devices present in the inventory"
 }
}

Error Response

View common error responses

Rate limit: 100 requests per minute. Exceeding this limit will block requests for 1 minute

BackUp Status

API EndPoint : backupStatus

This API retrieves a list of devices from a specified device group based on their backup status, which can be Success, Failure, or Not Backed Up.

HTTP Method

GET

API URL

http://localhost:8060/api/json/ncmdevice/backupStatus?apiKey=********&DEVICE_GROUP_ID=1&status=not_backed_up

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
DEVICE_GROUP_ID	ID of the device group. This value can be obtained from the response of getDeviceGroupsList API.	long	-	yes
status	This param decides the Backup Status of the devices to be viewed. success : Lists devices whose backup status is marked as Success. failure : Lists devices with a backup status of Failure. not_backed_up : Lists devices that have not been backed up.	-	^(success\|failure\|not_backed_up)$	No
jqgrid_id	jqgrid_id = backupStatus 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
Device Type	NCMResource__DISPLAYTYPE
IP Address	NCMResource__ADDRESS
Last Operation Status	NCMOperationStateHolder__OPERATIONSTATUS
Last Backup at	NCMBackupStateHolder__TIMESTAMP

Sample Response

HTTP Code: 200

{
"total": 1,
"records": "1",
"page": 1,
"rows": [
{
"id": 305,
"cell": [
305,
"SUCCESS",
"10.5.X.X",
"CiscoRouter",
"10.5.X.X",
"ComplianceCheck__SUCCESS",
true,
"Nov 04, 2025 16:20 PM",
""
]
}
]
}

Error Response

View common error responses

Rate limit: 100 requests per minute. Exceeding this limit will block requests for 1 minute

Device Group Resources

API EndPoint : deviceGroupResources

This API retrieves a list of devices from a specified device group based on their backup status, which can be Success, Failure, or Not Backed Up.

HTTP Method

GET

API URL

http://localhost:8060/api/json/ncmdevice/deviceGroupResources?apiKey=********&DEVICE_GROUP_ID=301

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
DEVICE_GROUP_ID	ID of the device group. This value can be obtained from the response of getDeviceGroupsList API.	long	-	yes
status	This param decides the Backup Status of the devices to be viewed. success : Lists devices whose backup status is marked as Success. failure : Lists devices with a backup status of Failure. not_backed_up : Lists devices that have not been backed up.	-	^(success\|failure\|not_backed_up)$	No
PROFILEID	@Deprecated: Not a mandatory param. ID of the credential profile	long	-	No
SEARCH_STRING	@Deprecated: Not a mandatory param. Search String	String	-	No
type	@Deprecated: Not a mandatory param. Type of the report	String	-	No
value	@Deprecated: Not a mandatory param. Value	String	-	No
TABLE_DATA	@Deprecated: Not a mandatory param. Table Data	-	^(DeviceByCriteria\|SubGroup)$	No
OSVERSION	@Deprecated: Not a mandatory param. OS Version	String	-	No
OSTYPE	@Deprecated: Not a mandatory param. OS Type	String	-	No
DEVICE_TYPE	@Deprecated: Not a mandatory param. Device Type	String	-	No
MODEL	@Deprecated: Not a mandatory param. Model	String	-	No
jqgrid_id	jqgrid_id = DEDGroupDevicesList 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
IP Address	NCMResource__ADDRESS
Device Type	NCMPersonality__DISPLAYNAME
Series	NCMResource__SERIES
Model	NCMResource__MODEL
OS Type	NCMResource__OSTYPE
OS Version	NCMResource__OSVERSION
Last Operation Status	NCMOperationStateHolder__OPERATIONSTATUS
Config Conflict	NCMResourcesConfConflict__ISCONFLICT
Compliance Status	NCMResourceCompStatus__COMPLIANCE_STATUS
Column 1	NCMResourceCustomColumn__COLUMNVALUE1
Column 2	NCMResourceCustomColumn__COLUMNVALUE2
Column 3	NCMResourceCustomColumn__COLUMNVALUE3
Baseline Conflict	NCMBaseRunningConflict__ISCONFLICT
Backup Status	NCMBackupStateHolder__BACKUP_STATUS

Sample Response

HTTP Code: 200

{
 "total": 1,
 "records": "1",
 "page": 1,
 "rows": [
 {
 "id": 305,
 "cell": [
 305,
 "SUCCESS",
 "10.5.X.X",
 "CiscoRouter",
 "10.5.X.X",
 "ComplianceCheck__SUCCESS",
 true,
 "Nov 04, 2025 16:20 PM",
 ""
 ]
 }
 ]
}

Error Response

View common error responses

Rate limit: 100 requests per minute. Exceeding this limit will block requests for 1 minute

Manage Device

API EndPoint : manage

This API is used to update the management status of selected network devices by marking them as "managed", enabling them to be actively managed through NCM operations.

HTTP Method

POST

API URL

http://localhost:8060/api/json/ncmdevice/manage?apiKey=********&RESOURCEID=[101,102,103]

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
RESOURCEID	Resource ids of the devices	JSONArray	-	No

Sample Response

HTTP Code: 200

{
    "statusMsg": "Device(s) status changed to 'Manage' successfully ",
    "isSuccess": true
}

Error Response

View common error responses

Rate limit: 100 requests per minute. Exceeding this limit will block requests for 1 minute

Unmanage Device

API EndPoint : unmanage

This API is used to update the management status of selected network devices by marking them "unmanaged", effectively excluding them from NCM operations. This option is useful when you want to retain configuration data and related information for the devices without actively managing them, as an alternative to deleting the devices immediately.

HTTP Method

POST

API URL

http://localhost:8060/api/json/ncmdevice/unmanage?apiKey=********&RESOURCEID=[101,102,103]

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
RESOURCEID	Resource ids of the devices	JSONArray	-	No

Sample Response

HTTP Code: 200

{
    "statusMsg": "Device(s) status changed to 'Unmanage' successfully ",
    "isSuccess": true
}

Error Response

View common error responses

Rate limit: 100 requests per minute. Exceeding this limit will block requests for 1 minute

EOL Data Not Available

API EndPoint : eolDataNotAvailable

This API retrieves a list of network devices whose End-of-Life (EOL) data is not available in the system.

HTTP Method

GET

API URL

http://localhost:8060/api/json/ncmdevice/eolDataNotAvailable?apiKey=********

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
jqgrid_id	jqgrid_id = DEEOLNAList,DEEOLNADeviceList 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
IP Address	NCMResource__ADDRESS
Device Type	NCMPersonality__DISPLAYNAME
Series	NCMResource__SERIES
Model	NCMResource__MODEL
Mark EOL	NCMDeviceNotEOL__EOLOPERATIONSTATUS

Sample Response

HTTP Code: 200

{
    "total": 1,
    "records": "13",
    "page": 1,
    "rows": [
        {
            "id": 603,
            "cell": [
                603,
                "10.5.X.X",
                "10.5.X.X",
                "Paloalto device-state Backup",
                "[NA]",
                "[NA]",
                "DATANOTSENT",
                "",
                ""
            ]
        },
        {
            "id": 2,
            "cell": [
                2,
                "10.5.X.X",
                "10.5.X.X",
                "FortiGate Firewall Version6",
                "[NA]",
                "[NA]",
                "DATANOTSENT",
                "",
                ""
            ]
        },
        {
            "id": 3,
            "cell": [
                3,
                "10.5.X.X",
                "10.5.X.X",
                "HPE ArubaOS Switch",
                "[NA]",
                "[NA]",
                "DATANOTSENT",
                "",
                ""
            ]
        },
        {
            "id": 4,
            "cell": [
                4,
                "10.5.X.X",
                "10.5.X.X",
                "Juniper Router",
                "[NA]",
                "[NA]",
                "DATANOTSENT",
                "",
                ""
            ]
        },
        {
            "id": 307,
            "cell": [
                307,
                "10.5.X.X",
                "10.5.X.X",
                "PFSense Firewall 2.x",
                "[NA]",
                "[NA]",
                "DATANOTSENT",
                "",
                ""
            ]
        },
        {
            "id": 310,
            "cell": [
                310,
                "10.5.X.X",
                "10.5.X.X",
                "Arista DCS Switch",
                "[NA]",
                "[NA]",
                "DATANOTSENT",
                "",
                ""
            ]
        },
        {
            "id": 308,
            "cell": [
                308,
                "10.5.X.X",
                "10.5.X.X",
                "HP 5500 Series Switch",
                "[NA]",
                "[NA]",
                "DATANOTSENT",
                "",
                ""
            ]
        },
        {
            "id": 306,
            "cell": [
                306,
                "10.5.X.X",
                "10.5.X.X",
                "PanOS",
                "[NA]",
                "[NA]",
                "DATANOTSENT",
                "",
                ""
            ]
        },
        {
            "id": 605,
            "cell": [
                605,
                "10.5.X.X",
                "10.5.X.X",
                "Force10 Switch",
                "E600",
                "[NA]",
                "DATANOTSENT",
                "",
                ""
            ]
        },
        {
            "id": 302,
            "cell": [
                302,
                "10.5.X.X",
                "10.5.X.X",
                "FortiOS Device",
                "[NA]",
                "[NA]",
                "DATANOTSENT",
                "",
                ""
            ]
        },
        {
            "id": 304,
            "cell": [
                304,
                "10.5.X.X",
                "10.5.X.X",
                "HPE Procurve Switch",
                "[NA]",
                "[NA]",
                "DATANOTSENT",
                "",
                ""
            ]
        }
    ]
}

Error Response

View common error responses

Rate limit: 100 requests per minute. Exceeding this limit will block requests for 1 minute

EOL Devices

API EndPoint : eolDevices

List All EOL Devices

HTTP Method

GET

API URL

 http://localhost:8060/api/json/ncmdevice/eolDevices?apiKey= ********

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
jqgrid_id	jqgrid_id = DEEOLList,DEEOLDevicesList 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
IP Address	NCMResource__ADDRESS
Device Type	NCMPersonality__DISPLAYNAME
Series	NCMResource__SERIES
Model	NCMResource__MODEL
End Of Sale Date	NCMEoldata__EndOfSaleDate
End Of Support Date	NCMEoldata__LastDateOfSupport

Sample Response

HTTP Code: 200

""

Error Response

View common error responses

Rate limit: 100 requests per minute. Exceeding this limit will block requests for 1 minute

EOL Announced Devices

API EndPoint : eolAnnouncedDevices

List All EOL Announced Devices

HTTP Method

GET

API URL

 http://localhost:8060/api/json/ncmdevice/eolAnnouncedDevices?apiKey= ********

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
jqgrid_id	jqgrid_id = DEEOLAnnouncedList 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
IP Address	NCMResource__ADDRESS
Device Type	NCMPersonality__DISPLAYNAME
Series	NCMResource__SERIES
Model	NCMResource__MODEL
End Of Sale Date	NCMEoldata__EndOfSaleDate
End Of Support Date	NCMEoldata__LastDateOfSupport

Sample Response

HTTP Code: 200

""

Error Response

View common error responses

Rate limit: 100 requests per minute. Exceeding this limit will block requests for 1 minute

Device Group Add Prerender

API EndPoint : deviceGroupAddPreRender

This API supplies all the essential information needed to update an existing device group using the addDeviceGroup API for editing purposes. The response includes QUERYID, a required parameter for edit operations, which links the device group to its associated devices in the backend. Specifically, QUERYID references a SQL select query used to fetch the selected devices for the group.

HTTP Method

GET

API URL

http://localhost:8060/api/json/ncmdevice/deviceGroupEditPreRender?apiKey=********

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes

Sample Response

HTTP Code: 200

{
  "LoginId": 1,
  "AllUnselectedHostMap": {
    "1": "10.5.X.X",
    "2": "10.5.X.X",
    "3": "10.5.X.X",
    "4": "10.5.X.X",
    "301": "10.5.X.X",
    "302": "10.5.X.X",
    "303": "10.5.X.X",
    "304": "10.5.X.X",
    "305": "10.5.X.X",
    "306": "10.5.X.X",
    "307": "10.5.X.X",
    "308": "10.5.X.X",
    "310": "10.5.X.X",
    "602": "10.5.X.X",
    "603": "10.5.X.X"
  }
}

Error Response

View common error responses

Rate limit: 100 requests per minute. Exceeding this limit will block requests for 1 minute

Device Group Edit Prerender

API EndPoint : deviceGroupEditPreRender

HTTP Method

GET

API URL

 http://localhost:8060/api/json/ncmdevice/deviceGroupEditPreRender?apiKey= ********&DEVICE_GROUP_ID=101

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
DEVICE_GROUP_ID	The ID of the device group for which details are required to perform an update action using addDeviceGroup API. This value can be obtained from the response of getDeviceGroupsList API.	long	-	yes

Sample Response

HTTP Code: 200

{
  "CREATED_BY": "admin",
  "tagDisplayName": "Chennai",
  "GLOBAL_DEVICE_GROUP": true,
  "LoginId": 1,
  "DG_TYPE": "Static_Group",
  "QUERYID": 611,
  "DG_DESCRIPTION": "Chennai Devices Group",
  "AllUnselectedHostMap": {
    "1": "10.5.X.X",
    "2": "10.5.X.X",
    "3": "10.5.X.X",
    "4": "10.5.X.X",
    "301": "10.5.X.X",
    "302": "10.5.X.X",
    "303": "10.5.X.X",
    "304": "10.5.X.X",
    "305": "10.5.X.X",
    "306": "10.5.X.X",
    "307": "10.5.X.X",
    "308": "10.5.X.X",
    "310": "10.5.X.X",
    "602": "10.5.X.X",
    "603": "10.5.X.X"
  },
  "DEVICE_GROUP_ID": "306",
  "DEVICE_GROUP_NAME": "Chennai Devices Group"
}

Error Response

View common error responses

Rate limit: 100 requests per minute. Exceeding this limit will block requests for 1 minute

Is Private Device Group

API EndPoint : isPrivateDeviceGroup

This API is used to check if the specified device group is a Private Group or not.

HTTP Method

GET

API URL

http://localhost:8060/api/json/ncmdevice/isPrivateDeviceGroup?apiKey=********&DEVICE_GROUP_ID=101

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
DEVICE_GROUP_ID	ID of the device group. This value can be obtained from the response of getDeviceGroupsList API.	String	-	No

Sample Response

HTTP Code: 200

{"isPrivateDeviceGroup":false,"isSuccess":true}

Error Response

View common error responses

Rate limit: 100 requests per minute. Exceeding this limit will block requests for 1 minute

Get Resources For Groups

API EndPoint : getResourcesForGroups

This API is useful for retrieving the RESOURCEIDs of all devices associated with the specified device groups. If a device belongs to multiple groups, its RESOURCEID will appear only once in the response, ensuring there are no duplicates.

HTTP Method

GET

API URL

http://localhost:8060/api/json/ncmdevice/getResourcesForGroups?apiKey=********&DEVICE_GROUP_ID=[201,202,203]

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
DEVICE_GROUP_ID	List of device group IDs. This value can be obtained from the response of getDeviceGroupsList API.	JSONArray	-	No

Sample Response

HTTP Code: 200

{
    "Resources": [
        603,
        1,
        2,
        3,
        4,
        307,
        310,
        308,
        306,
        302,
        304,
        301,
        303,
        602,
        305
    ]
}

Error Response

View common error responses

Rate limit: 100 requests per minute. Exceeding this limit will block requests for 1 minute

Get Cisco Inventory

API EndPoint : getCiscoInventory

This API retrieves details from Cisco inventory data, including fields such as Name, Description, PID, VID, and Serial Number.

Note:

This API is specific to devices added under the Cisco vendor. For devices from other vendors, the response will be an empty list.

HTTP Method

GET

API URL

http://localhost:8060/api/json/ncmdevice/getCiscoInventory?apiKey=********&deviceId=301

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
deviceId	Resource id of the device	long	-	yes

Sample Response

HTTP Code: 200

{
    "total": 1,
    "records": "2",
    "page": 1,
    "rows": [
        {
            "id": 2,
            "cell": [
                2,
                "10.5.X.X",
                "C2921/C2951 AC Power Supply",
                "C2921/C2951 AC Power Supply",
                "PWR-2921-51-AC",
                "V02",
                "QCS1528H2BT"
            ]
        },
        {
            "id": 1,
            "cell": [
                1,
                "10.5.X.X",
                "CISCO2951/K9",
                "CISCO2951/K9 chassis, Hw Serial#: FGL153210AY, Hw Revision: 1.1",
                "CISCO2951/K9",
                "V03",
                "FGL153210AY"
            ]
        }
    ]
}

Error Response

View common error responses

Rate limit: 100 requests per minute. Exceeding this limit will block requests for 1 minute

Upload Configuration Devices Prerender

API EndPoint : uploadConfigDevicesPrerender

This API retrieves preliminary details for the specified devices, such as hostnames and common labels that can be used later when uploading configurations via the uploadConfigDevices API. If only a single device is specified, it also provides any unsupported download operations for that device. By using LabelIDs obtained from the response along with the ResourceIDs, you can fetch details of associated configurations through the labelConfigDetails API.

In summary, this API returns the list of common labels available across the specified devices. If no common label exists, an empty list is returned.

HTTP Method

GET

API URL

http://localhost:8060/api/json/ncmdevice/uploadConfigDevicesPrerender?apiKey=********&RESOURCEIDS=[305,306,307]

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
RESOURCEIDS	Resource ids of the devices	JSONArray	-	No

Sample Response

HTTP Code: 200

{
  "NOT_SUPPORTED_DOWNLOAD_OPERATIONS": [],
  "RESOURCENAME_LIST": [
    "10.5.X.X",
    "10.5.X.X"
  ],
  "DOWNLOADLABELDATA": [
    {
      "LABEL_ID": 1,
      "LABEL_NAME": "BASELINE"
    }
  ]
}

Error Response

View common error responses

Rate limit: 100 requests per minute. Exceeding this limit will block requests for 1 minute

Upload Configuration Devices

API EndPoint : uploadConfigDevices

This API enables bulk configuration uploads to devices based on their label names, making it easier to efficiently manage and update multiple devices at once.

HTTP Method

POST

API URL

http://localhost:8060/api/json/ncmdevice/uploadConfigDevices?apiKey=********&RESOURCE_ID=[305]&LABEL_NAME="BASELINE"&DOWNLOAD_OPTION="DOWNLOAD_LATER"&SCHEDULE_DATE="10/10/2026"&SCHEDULE_HOUR=10&SCHEDULE_MINUTE=10

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
LABEL_NAME	Name of the label - This value can be obtained from the field DOWNLOADLABELDATA in the response of updateConfigDevicesPrerender API.	-	^([p{L}p{N}P{InBasicLatin}.!:#$s-_',])+$	yes
RESOURCE_ID	Resource ids of the devices	JSONArray	-	No
DEVICE_GROUP_ID	ID of the device group	long	-	No
DOWNLOAD_OPTION	Download Option - The value can be either DOWNLOAD_LATER or DOWNLOAD_NOW, indicates that you want to upload Now or Schedule later with the help of SCHEDULE_DATE, SCHEDULE_HOUR and SCHEDULE_MINUTE params. @Deprecated: DOWNLOAD_LATER option is deprecated.	-	^(DOWNLOAD_LATER\|DOWNLOAD_NOW)$	No
SCHEDULE_DATE	Schedule Date - The format of the date must be DD/MM/YYYY.	-	^((0[1-9]\|[1-2][0-9]\|3[0-1])/(0[1-9]\|1[0-2])/[0-9]{4})$	No
SCHEDULE_HOUR	Schedule Hours in HH (24 Hours Format)	-	^([01]?d\|2[0-3])$	No
SCHEDULE_MINUTE	Schedule Minutes in MM	-	^([0-5]?d)$	No

Sample Response

HTTP Code: 200

{"statusMsg":"Label-based upload Triggered successfully","isSuccess":true}

Error Response

View common error responses

Rate limit: 100 requests per minute. Exceeding this limit will block requests for 1 minute

Upload Configuration Prerender By DraftID

API EndPoint : uploadConfigPreRenders

This API provides preliminary information for a specified DRAFT_ID. The response includes whether upload approval is required, the configuration file ID (to be supplied to the exeUploadConfig API), any unsupported operations, the configuration file type like Running/Startup, the type of upload like Draft based and the current status indicating whether the upload is allowed.

HTTP Method

GET

API URL

http://localhost:8060/api/json/ncmdevice/uploadConfigPreRenders?apiKey=********&DRAFT_ID=101

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
DRAFT_ID	Draft Id - This value can be obtained from getDevDrafts API.	long	-	No

Sample Response

HTTP Code: 200

{
  "DOWNLOAD_NEEDS_APPROVAL": false,
  "DOWNLOAD_TYPE": "DRAFT_BASED",
  "NOT_SUPPORTED_DOWNLOAD_OPERATIONS": [],
  "DOWNLOAD_AS": "Running",
  "CONFIG_ID": "302",
  "IS_DOWNLOAD_ALLOWED": true
}

Error Response

View common error responses

Rate limit: 100 requests per minute. Exceeding this limit will block requests for 1 minute

Upload Configuration Prerender By VersionID

API EndPoint : uploadConfigPreRenders

This API provides preliminary information for a specified VERSION_ID. The response includes whether upload approval is required, the configuration file ID (to be supplied to the exeUploadConfig API), any unsupported operations, the configuration file type like Running/Startup, the type of upload like Version based and the current status indicating whether the upload is allowed.

HTTP Method

GET

API URL

 http://localhost:8060/api/json/ncmdevice/uploadConfigPreRenders?apiKey= ********&VERSION_ID=301

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
VERSION_ID	Version Id - This value can be obtained from getDevChanges API.	long	-	No

Sample Response

HTTP Code: 200

{
  "DOWNLOAD_NEEDS_APPROVAL": false,
  "DOWNLOAD_TYPE": "VERSION_BASED",
  "NOT_SUPPORTED_DOWNLOAD_OPERATIONS": [],
  "DOWNLOAD_AS": "Running",
  "CONFIG_ID": "621",
  "IS_DOWNLOAD_ALLOWED": true
}

Error Response

View common error responses

Rate limit: 100 requests per minute. Exceeding this limit will block requests for 1 minute

Execute Upload Configuration

API EndPoint : exeUploadConfig

This API allows you to upload a selected configuration—either a VERSION or DRAFT identified by CONFIG_ID—to a device, with the option to execute immediately or at a scheduled time.

HTTP Method

POST

API URL

http://localhost:8060/api/json/ncmdevice/exeUploadConfig?apiKey=********&CONFIG_ID=20&DOWNLOAD_TYPE="DRAFT_BASED"&DOWNLOAD_AS="Startup"&COMMENT="Upload+scheduled"&DOWNLOAD_OPTION="DOWNLOAD_LATER"&SCHEDULE_DATE="26/11/2025"&SCHEDULE_HOUR=18&SCHEDULE_MINUTE=15&SCHEDULE_TYPE="Once Only"

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
CONFIG_ID	Configuration Id - This value can be obtained from the response of uploadConfigPreRenders API for the given VersionID or DraftID.	long	-	No
DOWNLOAD_TYPE	Download Type - VERSION_BASED or DRAFT_BASED	-	^(VERSION_BASED\|DRAFT_BASED)$	No
DOWNLOAD_AS	Download As - Type of the configuration Startup or Running	-	^(Startup\|Running)$	No
COMMENT	Comment - A text filed that can be used to describe about the config upload operation.	-	^([p{L}p{N}P{InBasicLatin}.!:#$s-_',])+$	No
DOWNLOAD_OPTION	Download Option - The value can be either DOWNLOAD_LATER or DOWNLOAD_NOW, indicates that you want to upload Now or Schedule later with the help of SCHEDULE_DATE, SCHEDULE_HOUR and SCHEDULE_MINUTE params. Note: It is not mandatory to specify if the request is for DOWNLOAD_NOW.	-	^(DOWNLOAD_LATER\|DOWNLOAD_NOW)$	No
SCHEDULE_DATE	Schedule Date - The format of the date must be DD/MM/YYYY.	-	^((0[1-9]\|1[0-2])/(0[1-9]\|[1-2][0-9]\|3[0-1])/[0-9]{4})$	No
SCHEDULE_HOUR	Schedule Hours in HH (24 Hours Format)	-	^([01]?d\|2[0-3])$	No
SCHEDULE_MINUTE	Schedule Minutes in MM	-	^([0-5]?d)$	No
SCHEDULE_TYPE	Schedule Type - The value can be either "Now" or "Only Once", which is similar to Download Option. It is required to specify "Now" for DOWNLOAD_NOW and "Only Once" for DOWNLOAD_LATER".	-	^(Once Only\|Now)$	No

Sample Response

HTTP Code: 200

{
  "statusMsg": "Configuration Upload Operation Triggered Successfully.",
  "isSuccessMsg": true
}

Error Response

View common error responses

Rate limit: 100 requests per minute. Exceeding this limit will block requests for 1 minute

Device Templates

API EndPoint : deviceTemplates

This API retrieves the basic information for all device templates, including template ID, display name, description, category, OS type, vendor name, the ID of associated REST template (if any) and the number of devices linked to each template. Additionally, if the CUSTOM parameter is set to true, the API will return details exclusively for custom device templates.

HTTP Method

GET

API URL

http://localhost:8060/api/json/v2/ncmdevice/deviceTemplates?apiKey=********&restTemplateId=6

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
CUSTOM	If the value of the set to true, then it will return details exclusively for custom device templates. Else it will return details of all device templates.	boolean	-	No
restTemplateId	ID of the REST template - The value can be obtained from the response of getAllRESTTemplates API.	long	-	No
jqgrid_id	jqgrid_id = DEDeviceTemplates,DECustomDeviceTemplates,DEFilteredDeviceTemplates 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 = NCMVendor__DISPLAYNAME 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 = NCMVendor__DISPLAYNAME 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":"NCMVendor__DISPLAYNAME","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
Vendor	NCMVendor__DISPLAYNAME
OS Type	NCMDeviceTemplate__OSTYPE
Category	NCMDeviceCategory__CATEGORY
Devices	RESOURCE_COUNT
Description	NCMDeviceTemplate__DESCRIPTION
Device Type	NCMDeviceTemplate__DISPLAYNAME

Sample Response

HTTP Code: 200

{
    "total": 1,
    "records": "10",
    "page": 1,
    "rows": [
        {
            "DISPLAYNAME": "Cisco IOS Router",
            "IS_DEPRICATED": false,
            "DESCRIPTION": "For all Cisco IOS Routers",
            "CATEGORY": "Router",
            "OSTYPE": "IOS",
            "id": 20,
            "VENDORNAME": "Cisco",
            "RESOURCE_COUNT": 3
        },
        {
            "DISPLAYNAME": "HPE Procurve Switch",
            "IS_DEPRICATED": false,
            "DESCRIPTION": "",
            "CATEGORY": "Switch",
            "REST_DT_ID": 6,
            "OSTYPE": "[NA]",
            "id": 314,
            "VENDORNAME": "HPE",
            "RESOURCE_COUNT": 2
        },
        {
            "DISPLAYNAME": "PaloAlto Firewall",
            "IS_DEPRICATED": false,
            "DESCRIPTION": "Palo alto firewall device template",
            "CATEGORY": "Firewall",
            "REST_DT_ID": 2,
            "OSTYPE": "PAN-OS",
            "id": 213,
            "VENDORNAME": "PaloAlto",
            "RESOURCE_COUNT": 2
        },
        {
            "DISPLAYNAME": "ArubaOS-CX Switch",
            "IS_DEPRICATED": false,
            "DESCRIPTION": "",
            "CATEGORY": "Switch",
            "REST_DT_ID": 10,
            "OSTYPE": "ArubaOS",
            "id": 339,
            "VENDORNAME": "Aruba",
            "RESOURCE_COUNT": 1
        },
        {
            "DISPLAYNAME": "Force10 E-Series Switch",
            "IS_DEPRICATED": false,
            "DESCRIPTION": "For all Force10 E-Series Switches",
            "CATEGORY": "Switch",
            "OSTYPE": "FTOS",
            "id": 68,
            "VENDORNAME": "Dell Force10",
            "RESOURCE_COUNT": 1
        },
        {
            "DISPLAYNAME": "Cisco Integrated Services Router ISR",
            "IS_DEPRICATED": false,
            "DESCRIPTION": "For all Integrated Services Router series",
            "CATEGORY": "Router",
            "OSTYPE": "IOS",
            "id": 40,
            "VENDORNAME": "Cisco",
            "RESOURCE_COUNT": 1
        },
        {
            "DISPLAYNAME": "PaloAlto device-state Backup",
            "IS_DEPRICATED": false,
            "DESCRIPTION": "Palo alto firewall device-state backup device template",
            "CATEGORY": "General",
            "OSTYPE": "PAN-OS",
            "id": 377,
            "VENDORNAME": "PaloAlto",
            "RESOURCE_COUNT": 1
        },
        {
            "DISPLAYNAME": "Arista Data Center Switch",
            "IS_DEPRICATED": false,
            "DESCRIPTION": "",
            "CATEGORY": "Switch",
            "REST_DT_ID": 3,
            "OSTYPE": "EOS",
            "id": 278,
            "VENDORNAME": "Arista",
            "RESOURCE_COUNT": 1
        },
        {
            "DISPLAYNAME": "PFSense",
            "IS_DEPRICATED": false,
            "DESCRIPTION": "",
            "CATEGORY": "General",
            "REST_DT_ID": 5,
            "OSTYPE": "[NA]",
            "id": 344,
            "VENDORNAME": "PFSense",
            "RESOURCE_COUNT": 1
        },
        {
            "DISPLAYNAME": "FortiGate Firewall Version 6",
            "IS_DEPRICATED": false,
            "DESCRIPTION": "FortiGate Firewall",
            "CATEGORY": "Firewall",
            "REST_DT_ID": 1,
            "OSTYPE": "FortiOS",
            "id": 257,
            "VENDORNAME": "Fortinet",
            "RESOURCE_COUNT": 1
        }
    ]
}

Error Response

View common error responses

Rate limit: 100 requests per minute. Exceeding this limit will block requests for 1 minute

Multi Configuration Templates

API EndPoint : multiConfigTemplates

This API retrieves basic information for MultiConfig device templates, including the template ID, display name, category, vendor name, and the number of devices associated with each template.

HTTP Method

GET

API URL

http://localhost:8060/api/json/v2/ncmdevice/multiConfigTemplates?apiKey=********

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
jqgrid_id	jqgrid_id = multiConfigTemplates 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 = NCMDeviceTemplate__DISPLAYNAME 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 = NCMDeviceTemplate__DISPLAYNAME 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":"NCMDeviceTemplate__DISPLAYNAME","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
Name	NCMDeviceTemplate__DISPLAYNAME
Vendor	NCMVendor__DISPLAYNAME
Category	NCMDeviceCategory__CATEGORY
Devices	RESOURCE_COUNT

Sample Response

HTTP Code: 200

{
    "total": 1,
    "records": "5",
    "page": 1,
    "rows": [
        {
            "DISPLAYNAME": "FortiGate Firewall Version 6",
            "CATEGORY": "Firewall",
            "VENDOR": "Fortinet",
            "id": 257,
            "RESOURCE_COUNT": 1
        },
        {
            "DISPLAYNAME": "Cisco ASA MultiContext",
            "CATEGORY": "Firewall",
            "VENDOR": "Cisco",
            "id": 25,
            "RESOURCE_COUNT": 0
        },
        {
            "DISPLAYNAME": "PaloAlto Firewall PA-4000",
            "CATEGORY": "Firewall",
            "VENDOR": "PaloAlto",
            "id": 170,
            "RESOURCE_COUNT": 0
        },
        {
            "DISPLAYNAME": "Cisco Nexus VDC",
            "CATEGORY": "General",
            "VENDOR": "Cisco",
            "id": 252,
            "RESOURCE_COUNT": 0
        },
        {
            "DISPLAYNAME": "Infoblox NIOS",
            "CATEGORY": "General",
            "VENDOR": "Infoblox",
            "id": 346,
            "RESOURCE_COUNT": 0
        }
    ]
}

Error Response

View common error responses

Rate limit: 100 requests per minute. Exceeding this limit will block requests for 1 minute

Shared Device Templates

API EndPoint : sharedDeviceTemplates

This API retrieves basic information for shared device templates. For each shared template, it returns details such as the tested build version, device template name, description, operating system type, vendor name, template XML file, the user or team who shared it, a unique record ID, and the date and time the template was added. The record ID will be used to import/export a particular shared template using importSharedTemplate and exportSharedTemplate APIs.

HTTP Method

GET

API URL

http://localhost:8060/api/json/ncmdevice/sharedDeviceTemplates?apiKey=********

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes

Sample Response

HTTP Code: 200

{
    "gridData": [
        {
            "Tested_Version": "126277",
            "Description1": "For Siemens Scalance Switches",
            "OS_Type": "",
            "Vendor_Name": "Siemens",
            "Device_Template_XML": "Siemens_Scalance_Switch.xml",
            "Shared_By": "NCM",
            "Device_Template_Name": "Siemens Scalance Switch",
            "RECORDID": "189709000041000001",
            "Added_Time": "20-Feb-2023 18:18:18"
        },
        {
            "Tested_Version": "126150",
            "Description1": "Raisecom",
            "OS_Type": "RaiseComOS",
            "Vendor_Name": "Raisecom",
            "Device_Template_XML": "Raisecom_Switch.xml",
            "Shared_By": "NCM",
            "Device_Template_Name": "Raisecom Switch",
            "RECORDID": "189709000041000002",
            "Added_Time": "30-Jan-2023 12:22:12"
        },
        {
            "Tested_Version": "126258",
            "Description1": "For ZyXEL devices",
            "OS_Type": "ZyNOS",
            "Vendor_Name": "ZyXEL",
            "Device_Template_XML": "ZyXEL_Device.xml",
            "Shared_By": "NCM",
            "Device_Template_Name": "ZyXEL Device",
            "RECORDID": "189709000041000003",
            "Added_Time": "16-Dec-2022 15:40:26"
        },
        {
            "Tested_Version": "126258",
            "Description1": "For Transition Network Switch devices",
            "OS_Type": "",
            "Vendor_Name": "TransitionNetworks",
            "Device_Template_XML": "Transition_Networks_Switch.xml",
            "Shared_By": "NCM",
            "Device_Template_Name": "Transition Networks Switch",
            "RECORDID": "189709000041000004",
            "Added_Time": "16-Dec-2022 15:39:14"
        },
        {
            "Tested_Version": "126150",
            "Description1": "",
            "OS_Type": "",
            "Vendor_Name": "Cisco",
            "Device_Template_XML": "Cisco_Firepower_Threat_Defense.xml",
            "Shared_By": "NCM",
            "Device_Template_Name": "Cisco Firepower Threat Defense",
            "RECORDID": "189709000041000005",
            "Added_Time": "12-Dec-2022 11:53:51"
        }
    ]
}

Error Response

View common error responses

Rate limit: 100 requests per minute. Exceeding this limit will block requests for 1 minute

Is IPAddress Available

API EndPoint : isIPAvailable

This API checks if a device exists with the specified IP address.

If a matching device is found, the API returns the resourceId of the device and a success status message.

If no matching device is found, the API returns -1 for resourceId with an appropriate failure status message.

HTTP Method

GET

API URL

http://localhost:8060/api/json/ncmdevice/isIPAvailable?apiKey=********&IPADDRESS="192.168.XX.XX"

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
IPADDRESS	The IP address of the device to be verified.	-	^(?:(?:25[0-5]\|2[0-4][0-9]\|[01]?[0-9][0-9]?).){3}(?:25[0-5]\|2[0-4][0-9]\|[01]?[0-9][0-9]?)$	yes

Sample Response

HTTP Code: 200

{
    "resourceId": 301,
    "statusMsg": "Success",
    "ErrorType": "NoError",
    "isSuccess": true
}

Error Response

View common error responses

Rate limit: 100 requests per minute. Exceeding this limit will block requests for 1 minute

Configuration Conflicts

API EndPoint : configConflicts

Retrieves details of devices within a specified device group (DG_ID) where the startup and running configurations are in conflict.

HTTP Method

GET

API URL

http://localhost:8060/api/json/ncmdevice/configConflicts?apiKey=********&DG_ID=301

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
DG_ID	ID of the device group/ This value can be obtained from the response of getDeviceGroupsList API.	long	-	No
jqgrid_id	jqgrid_id = DEConflictList,DEConflictsList 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
Device Type	NCMPersonality__DISPLAYNAME
Model	NCMResource__MODEL
Last Backup at	NCMBackupStateHolder__TIMESTAMP
Last Operation Status	NCMClientOperationStatus__DISPLAYNAME
Startup-Running Conflict	ShowConfilct

Sample Response

HTTP Code: 200

{
    "total": 1,
    "records": "1",
    "rows": [
        {
            "id": 305,
            "cell": [
                305,
                true,
                "SSH - TFTP",
                "10.5.X.X",
                "Cisco Router",
                "CISCO2951/K9",
                "Nov 07, 2025 13:15 PM",
                "Upload Failed",
                "images/icon_csh_failed.gif",
                "FAILURE",
                "READY",
                "10.5.X.X",
                "",
                ""
            ]
        }
    ]
}

Error Response

View common error responses

Rate limit: 100 requests per minute. Exceeding this limit will block requests for 1 minute

Configuration No Conflicts

API EndPoint : configNoConflicts

Retrieves details of devices within a specified device group (DG_ID) where the startup and running configurations are in sync.

HTTP Method

GET

API URL

http://localhost:8060/api/json/ncmdevice/configNoConflicts?apiKey=********&DG_ID=301

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
DG_ID	ID of the device group. This value can be obtained from the response of getDeviceGroupsList API.	long	-	No
jqgrid_id	jqgrid_id = DENoConflictList,DEConflictsNAList 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
Device Type	NCMPersonality__DISPLAYNAME
Model	NCMResource__MODEL
Last Backup at	NCMBackupStateHolder__TIMESTAMP
Last Operation Status	NCMClientOperationStatus__DISPLAYNAME

Sample Response

HTTP Code: 200

{
    "total": 1,
    "records": "4",
    "rows": [
        {
            "id": 1,
            "cell": [
                1,
                true,
                "SSH",
                "10.5.X.X",
                "Cisco Router",
                "[NA]",
                "Nov 07, 2025 09:00 AM",
                "Compliance Check",
                "images/icon_csh_success.gif",
                "SUCCESS",
                "READY",
                "10.5.X.X",
                "",
                ""
            ]
        },
        {
            "id": 2,
            "cell": [
                2,
                true,
                "TELNET",
                "10.5.X.X",
                "FortiGate Firewall Version6",
                "[NA]",
                "Nov 07, 2025 12:26 PM",
                "Compliance Check",
                "images/icon_csh_success.gif",
                "SUCCESS",
                "READY",
                "10.5.X.X",
                "",
                ""
            ]
        },
        {
            "id": 3,
            "cell": [
                3,
                true,
                "SSH",
                "10.5.X.X",
                "HPE ArubaOS Switch",
                "[NA]",
                "Nov 07, 2025 09:00 AM",
                "Compliance Check",
                "images/icon_csh_success.gif",
                "SUCCESS",
                "READY",
                "10.5.X.X",
                "",
                ""
            ]
        },
        {
            "id": 4,
            "cell": [
                4,
                false,
                "[NA]",
                "10.5.X.X",
                "Juniper Router",
                "[NA]",
                "Nov 04, 2025 14:37 PM",
                "Compliance Check",
                "images/icon_csh_success.gif",
                "SUCCESS",
                "NOTREADY",
                "10.5.X.X",
                "",
                ""
            ]
        }
    ]
}

Error Response

View common error responses

Rate limit: 100 requests per minute. Exceeding this limit will block requests for 1 minute

Configuration Not Backed Up

API EndPoint : configNotBackedUp

Retrieves details of devices within a specified device group (DG_ID) that have not been backed up.

HTTP Method

GET

API URL

http://localhost:8060/api/json/ncmdevice/configNotBackedUp?apiKey=********&DG_ID=301

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
DG_ID	ID of the device group. This value can be obtained from the response of getDeviceGroupsList API.	long	-	yes
jqgrid_id	jqgrid_id = DEConflictNAList 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
Device Type	NCMPersonality__DISPLAYNAME
Model	NCMResource__MODEL
Last Backup at	NCMBackupStateHolder__TIMESTAMP
Last Operation Status	NCMClientOperationStatus__DISPLAYNAME
IP Address	NCMResource__ADDRESS

Sample Response

HTTP Code: 200

{
    "total": 1,
    "records": "12",
    "rows": [
        {
            "id": 301,
            "cell": [
                301,
                true,
                "SSH",
                "10.5.X.X",
                "Cisco Router",
                "CiscoModel",
                "Nov 10, 2025 10:56 AM",
                "Script Execution",
                "images/icon_csh_failed.gif",
                "FAILURE",
                "READY",
                "10.5.X.X",
                "",
                ""
            ]
        },
        {
            "id": 602,
            "cell": [
                602,
                false,
                "[NA]",
                "10.5.X.X",
                "PanOS",
                "[NA]",
                null,
                "Script Execution",
                "images/icon_csh_failed.gif",
                "FAILURE",
                "NOTREADY",
                "10.5.X.X",
                "",
                ""
            ]
        },
        {
            "id": 302,
            "cell": [
                302,
                false,
                "[NA]",
                "10.5.X.X",
                "FortiOS Device",
                "[NA]",
                null,
                "Script Execution",
                "images/icon_csh_failed.gif",
                "FAILURE",
                "NOTREADY",
                "10.5.X.X",
                "",
                ""
            ]
        },
        {
            "id": 310,
            "cell": [
                310,
                false,
                "[NA]",
                "10.5.X.X",
                "Arista DCS Switch",
                "[NA]",
                null,
                "Compliance Check",
                "images/icon_csh_failed.gif",
                "FAILURE",
                "NOTREADY",
                "10.5.X.X",
                "",
                ""
            ]
        },
        {
            "id": 303,
            "cell": [
                303,
                false,
                "[NA]",
                "10.5.X.X",
                "HPE Procurve Switch",
                "[NA]",
                null,
                "Script Execution",
                "images/icon_csh_failed.gif",
                "FAILURE",
                "NOTREADY",
                "10.5.X.X",
                "",
                ""
            ]
        },
        {
            "id": 308,
            "cell": [
                308,
                false,
                "[NA]",
                "10.5.X.X",
                "HP 5500 Series Switch",
                "[NA]",
                null,
                "Compliance Check",
                "images/icon_csh_failed.gif",
                "FAILURE",
                "NOTREADY",
                "10.5.X.X",
                "",
                ""
            ]
        },
        {
            "id": 603,
            "cell": [
                603,
                true,
                "SSH - SCP",
                "10.5.X.X",
                "Paloalto device-state Backup",
                "[NA]",
                "Nov 10, 2025 10:55 AM",
                "Backup Failed",
                "images/icon_csh_failed.gif",
                "FAILURE",
                "READY",
                "10.5.X.X",
                "",
                ""
            ]
        },
        {
            "id": 307,
            "cell": [
                307,
                true,
                "SSH",
                "10.5.X.X",
                "PFSense Firewall 2.x",
                "[NA]",
                "Nov 07, 2025 09:00 AM",
                "Compliance Check",
                "images/icon_csh_failed.gif",
                "FAILURE",
                "READY",
                "10.5.X.X",
                "",
                ""
            ]
        },
        {
            "id": 306,
            "cell": [
                306,
                false,
                "[NA]",
                "10.5.X.X",
                "PanOS",
                "[NA]",
                null,
                "Script Execution",
                "images/icon_csh_failed.gif",
                "INTERRUPTED",
                "NOTREADY",
                "10.5.X.X",
                "",
                ""
            ]
        },
        {
            "id": 304,
            "cell": [
                304,
                false,
                "[NA]",
                "10.5.X.X",
                "HPE Procurve Switch",
                "[NA]",
                null,
                "Script Execution",
                "images/icon_csh_failed.gif",
                "INTERRUPTED",
                "NOTREADY",
                "10.5.X.X",
                "",
                ""
            ]
        },
        {
            "id": 604,
            "cell": [
                604,
                false,
                "[NA]",
                "10.5.X.X",
                "Cisco Router",
                "805",
                null,
                "Credentials not supplied",
                "images/icon_csh_notstarted.gif",
                "NOTSTARTED",
                "NOTREADY",
                "10.5.X.X",
                "",
                ""
            ]
        },
        {
            "id": 605,
            "cell": [
                605,
                false,
                "[NA]",
                "10.5.X.X",
                "Force10 Switch",
                "[NA]",
                null,
                "Credentials not supplied",
                "images/icon_csh_notstarted.gif",
                "NOTSTARTED",
                "NOTREADY",
                "10.5.X.X",
                "",
                ""
            ]
        }
    ]
}

Error Response

View common error responses

Rate limit: 100 requests per minute. Exceeding this limit will block requests for 1 minute

Get Resources

API EndPoint : getResources

This API retrieves a list of hostnames and resource IDs for all devices associated with the user.

HTTP Method

GET

API URL

http://localhost:8060/api/json/ncmdevice/getResources?apiKey=********

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes

Sample Response

HTTP Code: 200

{
    "RESOURCES": [
        {
            "RESOURCENAME": "10.5.X.X",
            "RESOURCEID": 603
        },
        {
            "RESOURCENAME": "10.5.X.X",
            "RESOURCEID": 1
        },
        {
            "RESOURCENAME": "10.5.X.X",
            "RESOURCEID": 2
        },
        {
            "RESOURCENAME": "10.5.X.X",
            "RESOURCEID": 3
        },
        {
            "RESOURCENAME": "10.5.X.X",
            "RESOURCEID": 309
        },
        {
            "RESOURCENAME": "10.5.X.X",
            "RESOURCEID": 4
        },
        {
            "RESOURCENAME": "10.5.X.X",
            "RESOURCEID": 307
        },
        {
            "RESOURCENAME": "10.5.X.X",
            "RESOURCEID": 310
        },
        {
            "RESOURCENAME": "10.5.X.X",
            "RESOURCEID": 308
        },
        {
            "RESOURCENAME": "10.5.X.X",
            "RESOURCEID": 306
        },
        {
            "RESOURCENAME": "10.5.X.X",
            "RESOURCEID": 604
        },
        {
            "RESOURCENAME": "10.5.X.X",
            "RESOURCEID": 605
        },
        {
            "RESOURCENAME": "10.5.X.X",
            "RESOURCEID": 302
        },
        {
            "RESOURCENAME": "10.5.X.X",
            "RESOURCEID": 304
        },
        {
            "RESOURCENAME": "10.5.X.X",
            "RESOURCEID": 301
        },
        {
            "RESOURCENAME": "10.5.X.X",
            "RESOURCEID": 303
        },
        {
            "RESOURCENAME": "10.5.X.X",
            "RESOURCEID": 602
        },
        {
            "RESOURCENAME": "10.5.X.X",
            "RESOURCEID": 305
        }
    ]
}

Error Response

View common error responses

Rate limit: 10 requests per minute. Exceeding this limit will block requests for 1 minute

Get Configuration Contents

API EndPoint : getConfigContents

This API is designed to fetch essential information about configurations that have been backed up on a device. For each configuration, the API provides details such as the configuration version ID, annotation (description of the backup event), timestamp of when the backup occurred, whether the version is a baseline, version number, and the user who made the change.

The API filters results based on the specified configuration file type - such as Draft, Startup, Running, VLAN, or Interface using the FileType parameter. This helps users focus on a particular category of configurations and provides relevant inputs for comparing two configurations and obtaining differences using the getConflictDiffdetails API.

HTTP Method

GET

API URL

http://localhost:8060/api/json/ncmdevice/getConfigContents?apiKey=********&RESOURCEID=305&FileType="Running"

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
RESOURCEID	Resource id of the device	long	-	yes
FileType	File Type - The value can be Draft, Startup, Running, VLAN, Interface, or other supported types.	-	[p{L}p{N}s]+	yes

Sample Response

HTTP Code: 200

{
    "CONFIGS": [
        {
            "VERSION_ID": 4,
            "ANNOTATION": "Configuration stored as a result of manual backup operation.",
            "TIMESTAMP": "Oct 31, 2025 13:04 PM",
            "IS_BASELINE": false,
            "VERSION_NO": "Version 4",
            "CHANGED_BY": "Not Available"
        },
        {
            "VERSION_ID": 3,
            "ANNOTATION": "Configuration stored as a result of manual backup operation.",
            "TIMESTAMP": "Oct 31, 2025 13:03 PM",
            "IS_BASELINE": false,
            "VERSION_NO": "Version 3",
            "CHANGED_BY": "Not Available"
        },
        {
            "VERSION_ID": 2,
            "ANNOTATION": "Configuration stored as a result of manual backup operation.",
            "TIMESTAMP": "Oct 31, 2025 12:58 PM",
            "IS_BASELINE": false,
            "VERSION_NO": "Version 2",
            "CHANGED_BY": "Not Available"
        },
        {
            "VERSION_ID": 1,
            "ANNOTATION": "Configuration stored as a result of manual backup operation.",
            "TIMESTAMP": "Oct 31, 2025 12:43 PM",
            "IS_BASELINE": true,
            "VERSION_NO": "Version 1",
            "CHANGED_BY": "Not Available"
        }
    ]
}

Error Response

View common error responses

Rate limit: 20 requests per minute. Exceeding this limit will block requests for 1 minute

Get Configuration File Types

API EndPoint : getConfigFileTypes

This API is used to retrieve the list of available configuration file types for a specified device. The resulting file types can be utilized as filters when calling the getConfigContents API to view specific configuration categories.

HTTP Method

GET

API URL

http://localhost:8060/api/json/ncmdevice/getConfigFileTypes?apiKey=********&RESOURCEID=301

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
RESOURCEID	Resource id of the device	long	-	yes

Sample Response

HTTP Code: 200

{"CONFIGFILETYPE":["Startup","Running","Vlan"]}

Error Response

View common error responses

Rate limit: 100 requests per minute. Exceeding this limit will block requests for 1 minute

Get NCM Devices List

API EndPoint : getNCMDevicesList

This API retrieves the list of devices and device groups that are available for the default-admin. Access to this API is restricted to the "admin" user only. The returned response includes device group information, device IDs and IP addresses, available tags, and configuration groups.

HTTP Method

GET

API URL

http://localhost:8060/api/json/ncmdevice/getNCMDevicesList?apiKey=********

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes

Sample Response

HTTP Code: 200

{
    "IsDeviceGroupSelected": false,
    "remainingGroup": {
        "1": "All Devices Group",
        "2": "CiscoRouter Group",
        "4": "Backup Failure Group",
        "5": "CIS Cisco IOS Group",
        "6": "CIS Cisco ASA Group",
        "309": "Inactive Devices"
    },
    "ncmseltagIds": {},
    "selectedGroup": {},
    "remainingDevices": {
        "1": "10.5.X.X",
        "2": "10.5.X.X",
        "310": "10.5.X.X",
        "3": "10.5.X.X",
        "4": "10.5.X.X",
        "301": "10.5.X.X",
        "302": "10.5.X.X",
        "303": "10.5.X.X",
        "304": "10.5.X.X",
        "602": "10.5.X.X",
        "305": "10.5.X.X",
        "603": "10.5.X.X",
        "306": "10.5.X.X",
        "307": "10.5.X.X",
        "604": "10.5.X.X",
        "308": "10.5.X.X",
        "605": "10.5.X.X",
        "309": "10.5.X.X"
    },
    "ncmremtagIds": {
        "1": "Chennai",
        "2": "Tenkasi"
    },
    "isSpecificDevice": false,
    "isTagsSelected": false,
    "selectedDevices": {},
    "selectedConfigletGrp": {},
    "remainingConfigletGrp": {}
}

Error Response

View common error responses

Rate limit: 100 requests per minute. Exceeding this limit will block requests for 1 minute

Baseline Running Conflict

API EndPoint : baseRunningConflict

Retrieves details of devices within a specified device group (DG_ID) where the baseline and running configurations are in conflict.

HTTP Method

GET

API URL

http://localhost:8060/api/json/ncmdevice/baseRunningConflict?apiKey=********&DG_ID=301

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
DG_ID	ID of the device group. This value can be obtained from the response of getDeviceGroupsList API.	long	-	No
jqgrid_id	jqgrid_id = DEBaseRunningConflictList 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
Device Type	NCMPersonality__DISPLAYNAME
Model	NCMResource__MODEL
Last Backup at	NCMBackupStateHolder__TIMESTAMP
Last Operation Status	NCMClientOperationStatus__DISPLAYNAME

Sample Response

HTTP Code: 200

{
    "total": 1,
    "records": "4",
    "rows": [
        {
            "id": 1,
            "cell": [
                1,
                true,
                "SSH",
                "10.5.X.X",
                "Cisco Router",
                "[NA]",
                "Nov 07, 2025 09:00 AM",
                "Compliance Check",
                "images/icon_csh_success.gif",
                "SUCCESS",
                "READY",
                "10.5.X.X",
                "",
                ""
            ]
        },
        {
            "id": 2,
            "cell": [
                2,
                true,
                "TELNET",
                "10.5.X.X",
                "FortiGate Firewall Version6",
                "[NA]",
                "Nov 07, 2025 12:26 PM",
                "Compliance Check",
                "images/icon_csh_success.gif",
                "SUCCESS",
                "READY",
                "10.5.X.X",
                "",
                ""
            ]
        },
        {
            "id": 3,
            "cell": [
                3,
                true,
                "SSH",
                "10.5.X.X",
                "HPE ArubaOS Switch",
                "[NA]",
                "Nov 07, 2025 09:00 AM",
                "Compliance Check",
                "images/icon_csh_success.gif",
                "SUCCESS",
                "READY",
                "10.5.X.X",
                "",
                ""
            ]
        },
        {
            "id": 4,
            "cell": [
                4,
                false,
                "[NA]",
                "10.5.X.X",
                "Juniper Router",
                "[NA]",
                "Nov 04, 2025 14:37 PM",
                "Compliance Check",
                "images/icon_csh_success.gif",
                "SUCCESS",
                "NOTREADY",
                "10.5.X.X",
                "",
                ""
            ]
        }
    ]
}

Error Response

View common error responses

Rate limit: 100 requests per minute. Exceeding this limit will block requests for 1 minute

Baseline Running No Conflict

API EndPoint : baseRunningNoConflict

Retrieves details of devices within a specified device group (DG_ID) where the baseline and running configurations are in sync.

HTTP Method

GET

API URL

http://localhost:8060/api/json/ncmdevice/baseRunningNoConflict?apiKey=********&DG_ID=301

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
DG_ID	ID of the device group. This value can be obtained from the response of getDeviceGroupsList API.	long	-	No
jqgrid_id	jqgrid_id = DEBaseRunningConflictNAList 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
Device Type	NCMPersonality__DISPLAYNAME
Model	NCMResource__MODEL
Last Backup at	NCMBackupStateHolder__TIMESTAMP
Last Operation Status	NCMClientOperationStatus__DISPLAYNAME

Sample Response

HTTP Code: 200

{
    "total": 1,
    "records": "1",
    "rows": [
        {
            "id": 305,
            "cell": [
                305,
                true,
                "SSH - TFTP",
                "10.5.X.X",
                "Cisco Router",
                "CISCO2951/K9",
                "Nov 07, 2025 13:15 PM",
                "Upload Failed",
                "images/icon_csh_failed.gif",
                "FAILURE",
                "READY",
                "10.5.X.X",
                "",
                ""
            ]
        }
    ]
}

Error Response

View common error responses

Rate limit: 100 requests per minute. Exceeding this limit will block requests for 1 minute

Sync Hostname From OPM

API EndPoint : syncHostnameFromOPM

This API is available exclusively for OPM and OPMPlus editions where NCM acts as an add-on product. It enables bulk updating of NCM device hostnames using the hostnames from OPM.

HTTP Method

POST

API URL

"http://localhost:8060/api/json/ncmdevice/syncHostnameFromOPM?apiKey=********&ComponentSelection="SpecificDevice"&SELECTEDDEVICES=[301,305,309]

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
ComponentSelection	Component Selection - This value can be either DeviceGroup or SpecificDevice.	-	^(DeviceGroup\|SpecificDevice)$	yes
DEVICEGROUPSELECTION	ID of the device group. This value can be obtained from the response of getDeviceGroupsList API.	long	-	No
SELECTEDDEVICES	Resource ids of the devices - This param is required when ComponentSelection is set to SpecificDevice	JSONArray	-	No

Sample Response

HTTP Code: 200

{"statusMsg":"Host Name sync from OpM initiated successfully.","isSuccess":true}

Error Response

View common error responses

Rate limit: 100 requests per minute. Exceeding this limit will block requests for 1 minute

Update NCM Interface Details

API EndPoint : updateNCMInterfaceDetails

This API initiates an interface update action for the specified device. The interfaces are populated via REST, SNMP, or CLI protocols based on credentials that were associated to the device.

HTTP Method

POST

API URL

http://localhost:8060/api/json/ncmdevice/updateNCMInterfaceDetails?apiKey=********&resourceId=301

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
resourceId	Resource id of the device	long	-	yes

Sample Response

HTTP Code: 200

{
    "statusMsg": "Interface discovery initiated successfully. Please refresh the widget after sometime",
    "isSuccess": true
}

Error Response

View common error responses

Rate limit: 100 requests per minute. Exceeding this limit will block requests for 1 minute

Discover VLAN Details

API EndPoint : discoverVlanDetails

This API initiates an VLAN update action for the specified device using SNMP protocol. Make sure that if right SNMP credentials were provided for the device.

HTTP Method

POST

API URL

http://localhost:8060/api/json/ncmdevice/discoverVlanDetails?apiKey=********&resourceId=301

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
resourceId	Resource id of the device	long	-	yes

Sample Response

HTTP Code: 200

{
    "statusMsg": "VLAN discovery initiated successfully. Please refresh the widget after sometime",
    "isSuccess": true
}

Error Response

View common error responses

Rate limit: 100 requests per minute. Exceeding this limit will block requests for 1 minute

Get Device VLAN Details

API EndPoint : getDevVlanDetails

This API retrieves VLAN information for the specified device, including details such as VLAN ID, name, index, and status.

HTTP Method

GET

API URL

http://localhost:8060/api/json/ncmdevice/getDevVlanDetails?apiKey=********&deviceId=301

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
deviceId	Resource id of the device	long	-	yes

Sample Response

HTTP Code: 200

{
    "total": 1,
    "records": "5",
    "page": 1,
    "rows": [
        {
            "id": 41,
            "cell": [
                41,
                "default",
                1,
                "unknown"
            ]
        },
        {
            "id": 42,
            "cell": [
                42,
                "fddi-default",
                1002,
                "unknown"
            ]
        },
        {
            "id": 43,
            "cell": [
                43,
                "token-ring-default",
                1003,
                "unknown"
            ]
        },
        {
            "id": 44,
            "cell": [
                44,
                "fddinet-default",
                1004,
                "unknown"
            ]
        },
        {
            "id": 45,
            "cell": [
                45,
                "trnet-default",
                1005,
                "unknown"
            ]
        }
    ]
}

Error Response

View common error responses

Rate limit: 100 requests per minute. Exceeding this limit will block requests for 1 minute

Get Interface VLAN Last Change Details

API EndPoint : getIntfVlanLastChangeDetails

This API retrieves the last updated timestamps for both the Interfaces and VLAN data of the specified device.

HTTP Method

GET

API URL

http://localhost:8060/api/json/ncmdevice/getIntfVlanLastChangeDetails?apiKey=********&resourceId=301

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
resourceId	Resource id of the device	long	-	yes

Sample Response

HTTP Code: 200

{
    "vlanLastUpdate": "Nov 11, 2025 04:06 PM",
    "intfLastUpdate": "Nov 11, 2025 03:13 PM"
}

Error Response

View common error responses

Rate limit: 100 requests per minute. Exceeding this limit will block requests for 1 minute

Get Device Interfaces

API EndPoint : getV2DevInterfaces

This API is used the fetch the details of interfaces of a specified device, including Interface Name, IP Address, Type, Admin Status, Operation Status, In Speed, Out Speed, NetMask and MACAddress.

HTTP Method

GET

API URL

http://localhost:8060/api/json/ncmdevice/getV2DevInterfaces?apiKey=********&deviceId=305

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
deviceId	Resource id of the device	long	-	yes

Sample Response

HTTP Code: 200

{
    "total": 1,
    "records": "15",
    "page": 1,
    "rows": [
        {
            "id": 31,
            "cell": [
                31,
                "Backplane-GigabitEthernet0/3",
                "[NA]",
                "ethernet-csmacd",
                "Up",
                "Up",
                "1 Gbps",
                "NA",
                "NA",
                "44 d3 ca 39 42 c3"
            ]
        },
        {
            "id": 35,
            "cell": [
                35,
                "Embedded-Service-Engine0/0",
                "[NA]",
                "ethernet-csmacd",
                "Down",
                "Down",
                "10 Mbps",
                "NA",
                "NA",
                "00 00 00 00 00 00"
            ]
        },
        {
            "id": 32,
            "cell": [
                32,
                "GigabitEthernet0/0",
                "10.5.X.X",
                "ethernet-csmacd",
                "Up",
                "Down",
                "1 Gbps",
                "NA",
                "10.5.X.X",
                "44 d3 ca 39 42 c0"
            ]
        },
        {
            "id": 33,
            "cell": [
                33,
                "GigabitEthernet0/1",
                "10.5.X.X",
                "ethernet-csmacd",
                "Up",
                "Down",
                "999.999 Mbps",
                "NA",
                "10.5.X.X",
                "44 d3 ca 39 42 c1"
            ]
        },
        {
            "id": 38,
            "cell": [
                38,
                "GigabitEthernet0/1.1",
                "[NA]",
                "l2vlan",
                "Up",
                "Down",
                "1 Gbps",
                "NA",
                "NA",
                "44 d3 ca 39 42 c1"
            ]
        },
        {
            "id": 34,
            "cell": [
                34,
                "GigabitEthernet0/2",
                "10.5.X.X",
                "ethernet-csmacd",
                "Up",
                "Up",
                "1 Gbps",
                "NA",
                "10.5.X.X",
                "44 d3 ca 39 42 c2"
            ]
        },
        {
            "id": 37,
            "cell": [
                37,
                "Loopback0",
                "[NA]",
                "softwareLoopback",
                "Up",
                "Up",
                "4.294 Gbps",
                "NA",
                "NA",
                "NA"
            ]
        },
        {
            "id": 39,
            "cell": [
                39,
                "Loopback10",
                "10.5.X.X",
                "softwareLoopback",
                "Down",
                "Down",
                "4.294 Gbps",
                "NA",
                "10.5.X.X",
                "NA"
            ]
        },
        {
            "id": 40,
            "cell": [
                40,
                "Loopback234",
                "[NA]",
                "softwareLoopback",
                "Up",
                "Up",
                "4.294 Gbps",
                "NA",
                "NA",
                "NA"
            ]
        },
        {
            "id": 44,
            "cell": [
                44,
                "Loopback50",
                "[NA]",
                "softwareLoopback",
                "Up",
                "Up",
                "4.294 Gbps",
                "NA",
                "NA",
                "NA"
            ]
        },
        {
            "id": 43,
            "cell": [
                43,
                "Loopback51",
                "[NA]",
                "softwareLoopback",
                "Up",
                "Up",
                "4.294 Gbps",
                "NA",
                "NA",
                "NA"
            ]
        },
        {
            "id": 41,
            "cell": [
                41,
                "Loopback55",
                "[NA]",
                "softwareLoopback",
                "Up",
                "Up",
                "4.294 Gbps",
                "NA",
                "NA",
                "NA"
            ]
        },
        {
            "id": 42,
            "cell": [
                42,
                "Loopback555",
                "[NA]",
                "softwareLoopback",
                "Down",
                "Down",
                "4.294 Gbps",
                "NA",
                "NA",
                "NA"
            ]
        },
        {
            "id": 36,
            "cell": [
                36,
                "Null0",
                "[NA]",
                "Others",
                "Up",
                "Up",
                "4.294 Gbps",
                "NA",
                "NA",
                "NA"
            ]
        },
        {
            "id": 45,
            "cell": [
                45,
                "Port-channel1",
                "[NA]",
                "propVirtual",
                "Up",
                "Down",
                "10 Mbps",
                "NA",
                "NA",
                "00 00 00 00 00 00"
            ]
        }
    ]
}

Error Response

View common error responses

Rate limit: 100 requests per minute. Exceeding this limit will block requests for 1 minute

Get NCM Non Inventory Devices From OPM

API EndPoint : getNcmNonInventoryDevicesFromOpm

This API retrieves details of devices that have been added to OPM but are not yet present in NCM. The response includes devices from the following categories: Switch, Router, Wireless, Firewall, Unknown, and LoadBalancer. For each device, information such as IP address, hostname, category, and device type is returned.

HTTP Method

GET

API URL

http://localhost:8060/api/json/ncmdevice/getNcmNonInventoryDevicesFromOpm?apiKey=********

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes

Sample Response

HTTP Code: 200

[
    {
        "ipaddress": "10.5.X.X",
        "HOSTNAME": "10.5.X.X",
        "CATEGORY": "Unknown",
        "DEVICETYPE": "PaloAlto Firewall"
    },
    {
        "ipaddress": "10.5.X.X",
        "HOSTNAME": "10.5.X.X",
        "CATEGORY": "Unknown",
        "DEVICETYPE": "ArubaOS-CX Switch"
    },
    {
        "ipaddress": "10.5.X.X",
        "HOSTNAME": "10.5.X.X",
        "CATEGORY": "Unknown",
        "DEVICETYPE": "Arista Data Center Switch"
    },
    {
        "ipaddress": "10.5.X.X",
        "HOSTNAME": "10.5.X.X",
        "CATEGORY": "Unknown",
        "DEVICETYPE": "HPE ArubaOS Switch"
    },
    {
        "ipaddress": "10.5.X.X",
        "HOSTNAME": "10.5.X.X",
        "CATEGORY": "Unknown",
        "DEVICETYPE": "PFSense"
    },
    {
        "ipaddress": "10.5.X.X",
        "HOSTNAME": "10.5.X.X",
        "CATEGORY": "Router",
        "DEVICETYPE": "Cisco 2900 IS Series"
    }
]

Error Response

View common error responses

Rate limit: 100 requests per minute. Exceeding this limit will block requests for 1 minute

Handle RMM Shortfall

API EndPoint : handleRMMShortfall

This API is used only when NCM is used as addon in RMM Central. It is used to mark a device deleted, managed or unmanaged. In RMM we do not delete the devices in NCM directly as it doesn't sit well with RMM framework. So we mark them as deleted and then the framework takes care of the actual deletion.

HTTP Method

POST

API URL

http://localhost:8060/api/json/ncmdevice/handleRMMShortfall?apiKey=********&DEVICE_IDS=[301,305,309]&OPERATION_TYPE="UNMANAGE"

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
DEVICE_IDS	Unique identifiers of the resource that needs to be marked	JSONArray	-	No
RESOURCEID	This parameter is deprecated and will be removed in an upcoming release. It is not in use anymore.	JSONArray	-	No
OPERATION_TYPE	Status of the resource that needs to be marked, it can be DELETE, MANAGE or UNMANAGE	-	^(DELETE\|MANAGE\|UNMANAGE)$	No

Sample Response

HTTP Code: 200

{"statusMsg": "The device handle RMM Shortfall process has been initiated successfully","isSuccess": true}

Error Response

View common error responses

Rate limit: 100 requests per minute. Exceeding this limit will block requests for 1 minute

Get Device Count

API EndPoint : getDeviceCount

This API is used to get the total number of Managed Devices available for an user.

HTTP Method

GET

API URL

http://localhost:8060/api/json/ncmdevice/getDeviceCount?apiKey=********

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes

Sample Response

HTTP Code: 200

{
    "count": 15
}

Error Response

View common error responses

Rate limit: 100 requests per minute. Exceeding this limit will block requests for 1 minute

Delete Device

API EndPoint : deleteDevice

This API deletes the specified devices from NCM, removing all associated information such as configurations, drafts, credentials, hardware details, and more. Additionally, devices are deleted one by one in the backend, as removing large amounts of data such as configurations may take some time.

HTTP Method

POST

API URL

http://localhost:8060/api/json/ncmdevice/deleteDevice?apiKey=********&DEVICE_IDS=[301,302]

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
DEVICE_IDS	Resource ids of the devices	JSONArray	-	No

Sample Response

HTTP Code: 200

{
    "statusMsg": "The device deletion process has been initiated successfully",
    "isSuccess": true
}

Error Response

View common error responses

Rate limit: 100 requests per minute. Exceeding this limit will block requests for 1 minute

Thank you for your feedback!

Was this content helpful?

We are sorry. Help us improve this page.

How can we improve this page?

Need more information on this topic

Need better screenshots

Need clear step by step instructions

Others

Do you need assistance with this topic?

YesNo

By clicking "Submit", you agree to processing of personal data according to the Privacy Policy.