Settings

List Block Exclude Criteria

API EndPoint : listAllBlockExcludeCriteria

Provides the list of all block exclude criteria configured

HTTP Method

GET

API URL

http://localhost:8060/api/json/ncmsettings/listAllBlockExcludeCriteria?apiKey=********

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
jqgrid_id	jqgrid_id = DEBlockExcludeCriteriaList 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 = NCMBlockExcludeCriteria__CRITERIANAME 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 = NCMBlockExcludeCriteria__CRITERIANAME 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":"NCMBlockExcludeCriteria__CRITERIANAME","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
Criteria Name	NCMBlockExcludeCriteria__CRITERIANAME
Template Name	NCMDeviceTemplate__DISPLAYNAME
Config Block Start	NCMBlockExcludeCriteria__BLOCK_START_CRITERIA
Config Block End	NCMBlockExcludeCriteria__BLOCK_END_CRITERIA
Additional Criteria	NCMBlockExcludeCriteria__BLOCK_CONDITION_CRITERIA

Sample Response

HTTP Code: 200

{
  "total": 1,
  "records": "2",
  "page": 1,
  "rows": [
    {
      "id": 4,
      "cell": [
        4,
        "Fortigate Exclude Certificate",
        "FortiGate Firewall",
        ".*BEGIN CERTIFICATE.*",
        ".*END CERTIFICATE.*",
        "NONE",
        ""
      ]
    },
    {
      "id": 5,
      "cell": [
        5,
        "Exclude shutdown interfaces",
        "Cisco ACE Module",
        "interface.*",
        "!",
        "Block Should Contain : shutdown",
        ""
      ]
    }
  ]
}

Error Response

View common error responses

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

Primary Mail Setup Status

API EndPoint : hasPrimaryMailSettings

Checks whether Mail Configuration is set up or not

HTTP Method

GET

API URL

http://localhost:8060/api/json/ncmsettings/hasPrimaryMailSettings?apiKey=********

Parameters

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

Sample Response

HTTP Code: 200

{
  "hasMailServerSettings": false
}

Error Response

View common error responses

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

Execute Schedule

API EndPoint : runSchedule

Execute a particular schedule manually

HTTP Method

POST

API URL

http://localhost:8060/api/json/ncmsettings/runSchedule?apiKey=********&scheduleIds=[101,102,103]

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
scheduleIds	Unique Id of the schedule that needs to executed	JSONArray	-	yes

Sample Response

HTTP Code: 200

{
  "statusMsg": "Selected task will run shortly. Please go to Schedule Audit to check the results",
  "isSuccess": true
}

Error Response

View common error responses

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

Get Syslog Blocked Ips

API EndPoint : getSysLogBlockedHosts

Lists the set of devices whose syslogs are dropped for specific period of time

HTTP Method

GET

API URL

http://localhost:8060/api/json/ncmsettings/getSysLogBlockedHosts?apiKey=********

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
jqgrid_id	jqgrid_id = DESysLogBlockedHostList 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 = SyslogBlockedHosts__HOSTNAME 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 = SyslogBlockedHosts__HOSTNAME 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":"SyslogBlockedHosts__HOSTNAME","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	SyslogBlockedHosts__HOSTNAME
Unblock Time	SyslogBlockedHosts__ALLOWEDTIME

Sample Response

HTTP Code: 200

{
  "total": 1,
  "records": "1",
  "page": 1,
  "rows": [
    {
      "id": 1,
      "cell": [
        1,
        "10.5.x.x",
        "2025-11-03 16:59:27"
      ]
    }
  ]
}

Error Response

View common error responses

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

Unblock Syslog Blocked Ips

API EndPoint : removeSysLogBlocedHosts

Unblocks the devices so that their syslog messages can be processed for information

HTTP Method

POST

API URL

http://localhost:8060/api/json/ncmsettings/removeSysLogBlocedHosts?apiKey=********&HOSTID=[101,102,103]

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
HOSTID	List of device's Ids that needs to be unblocked	JSONArray	-	yes

Sample Response

HTTP Code: 200

{
  "statusMsg": "Selected hosts removed from blocked list successfully.",
  "isSuccess": true
}

Error Response

View common error responses

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

List Configlets

API EndPoint : listAllConfiglets

Provides the list of all configlet scripts available

HTTP Method

GET

API URL

http://localhost:8060/api/json/ncmsettings/listAllConfiglets?apiKey=********&DEVICETEMPLATEID=63&FILTER_TYPE=FLOW&INCLUDE_FLOW_CONFILGETS=true

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
DEVICETEMPLATEID	ID of the device template - Provide device template id if want to see only the configlets associated to that specific device template	long	-	No
FILTER_TYPE	Value is given as 'PROMATE' to get the list of configlets that are associated with any of the device templates. Value is given as 'FLOW' to get the list of flow configlets that are used in NetFlow Analyzer.	-	^(PROMOTE\|FLOW)$	No
INCLUDE_FLOW_CONFILGETS	If wants to get the list of flow configlets that are used in 'Netflow Analyzer' along with NCM configlets set as 'true'	boolean	-	No
jqgrid_id	jqgrid_id = DEConfigletsList,DEFilteredConfigletsList 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 = NCMTemplate__TEMPLATE_NAME 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 = NCMTemplate__TEMPLATE_NAME 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":"NCMTemplate__TEMPLATE_NAME","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
Configlet Name	NCMTemplate__TEMPLATE_NAME
Description	NCMTemplate__DESCRIPTION
Created By	NCMTemplate__OWNER_NAME
Last Modified Time	NCMTemplate__LAST_MODIFIED_TIME
Template Type	NCMTemplate__TEMPLATE_TYPE
Vendor	NCMTemplate__VENDOR_NAME
Tags	NCMTag__DISPLAYNAME

Sample Response

HTTP Code: 200

{
  "total": 1,
  "records": "7",
  "page": 1,
  "rows": [
    {
      "id": 6,
      "cell": [
        6,
        "Alaxala_Enable_Change_detection",
        "Forward syslog messages to syslog server, applicable for Alaxala 5400 devices",
        "system",
        "[NA]",
        "COMMAND_LINE_MODE",
        "Alaxala",
        "",
        "COMMAND_LINE_MODE"
      ]
    },
    {
      "id": 8,
      "cell": [
        8,
        "AlliedTelesis_87XX_Disable_Change_detection",
        "Disable syslog for AlliedTelesis CenterCom 87XX",
        "system",
        "[NA]",
        "COMMAND_LINE_MODE",
        "AlliedTelesis",
        "",
        "COMMAND_LINE_MODE"
      ]
    },
    {
      "id": 7,
      "cell": [
        7,
        "AlliedTelesis_87XX_Enable_Change_detection",
        "Forward syslog messages to syslog server, applicable for AlliedTelesis CenterCom 87XX",
        "system",
        "[NA]",
        "COMMAND_LINE_MODE",
        "Allied Telesis",
        "",
        "COMMAND_LINE_MODE"
      ]
    },
    {
      "id": 41,
      "cell": [
        41,
        "Catalyst_6500_CatOS",
        "Flow Export command for Catalyst 6500 Model CatOS 6504_E,6513,6509,6506",
        "system",
        "[NA]",
        "COMMAND_LINE_MODE",
        "Cisco",
        "",
        "COMMAND_LINE_MODE"
      ]
    },
    {
      "id": 69,
      "cell": [
        69,
        "Cisco_ASA_SendSyslogs",
        "Enable syslogs for Cisco ASA firewalls",
        "system",
        "[NA]",
        "COMMAND_LINE_MODE",
        "Cisco",
        "",
        "COMMAND_LINE_MODE"
      ]
    },
    {
      "id": 3,
      "cell": [
        3,
        "Cisco_Change_Password_Script",
        "Changing Password for Cisco devices",
        "system",
        "[NA]",
        "COMMAND_LINE_MODE",
        "Cisco",
        "",
        "COMMAND_LINE_MODE"
      ]
    },
    {
      "id": 5,
      "cell": [
        5,
        "Cisco_PIX_ASA_7_x_Forward_Syslog_Script",
        "Forward syslog messages to syslog server, applicable for PIX and ASA 7.x devices",
        "system",
        "[NA]",
        "COMMAND_LINE_MODE",
        "Cisco",
        "",
        "COMMAND_LINE_MODE"
      ]
    }
  ]
}

Error Response

View common error responses

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

Add Flow Configlet

API EndPoint : addFlowConfiglets

Adds one or more flow configlets to a specified device template

HTTP Method

POST

API URL

http://localhost:8060/api/json/ncmsettings/addFlowConfiglets?apiKey=********&TEMPLATE_ID=[201,202,203]&DEVICETEMPLATEID=63

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
TEMPLATE_ID	List of unique identifiers of the configlet template to be added.	JSONArray	-	yes
DEVICETEMPLATEID	Unique identifier of the device template to which the configlet will be added.	long	-	yes

Sample Response

HTTP Code: 200

{
  "statusMsg": "Flow Configlets 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

Get List of Flow Configlets

API EndPoint : addFlowConfigletsPreRender

Provides pre-rendered conifglet details for a specified device template. The API lists all available configlets and identifies which flow configlets are currently associated with the selected device template, allowing users to preview configlets before applying them.

HTTP Method

GET

API URL

http://localhost:8060/api/json/ncmsettings/addFlowConfigletsPreRender?apiKey=********&DEVICETEMPLATEID=101

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
DEVICETEMPLATEID	Unique identifier of the device template for which pre-rendered flow configlet information needs to be fetched.	long	-	yes

Sample Response

HTTP Code: 200

{
  "customTemplateMap": {
    "38": "Cisco_4000_4500_FlowExport",
    "39": "Catalyst_4500_FlowExport",
    "40": "Catalyst_6500_FlowExport",
    "41": "Catalyst_6500_CatOS",
    "42": "Cisco_3850_FlowExport",
    "43": "Cisco_CommonFlexible_FlowExport",
    "44": "CiscoASR1000_FlowExport",
    "45": "CiscoASR_12K_9K_FlowExport",
    "46": "Cisco3750_3560_FlowExport",
    "47": "CiscoASA_FlowExport"
  },
  "customTemplateSelMap": {
    "48": "Fortigate_FireWall_FlowExport",
    "49": "Juniper_ESeries_sFlowExport",
    "50": "Huawei_NetStream_FlowExport",
    "51": "FoundarySwitch_FlowExport"
  }
}

Error Response

View common error responses

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

Get Flow Configlet Details

API EndPoint : getExportConfiglet

Retrieves the flow export configlets for a specific device. The API fetches all flow configlets associated with the device template to which the device belongs, along with their content, providing a preview before they are uploaded to the device.

HTTP Method

GET

API URL

"http://localhost:8060/api/json/ncmsettings/getExportConfiglet?apiKey=********&deviceId=1001&IF_NAMES=["GigabitEthernet0/1","GigabitEthernet0/2"]

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
deviceId	Resource id of the device to which the flow configlet needs to applied	long	-	yes
IF_NAMES	Interface Names for Flow Export	JSONArray	-	No

Sample Response

HTTP Code: 200

{
  "configlets": [
    {
      "Description": "Flow Export command for All Cisco IOS Router",
      "TemplateName": "CiscoRouter_FlowExport",
      "Id": 35,
      "TemplateType": "COMMAND_LINE_MODE",
      "TemplateContents": "Config tnip flow-export destination 10.5.X.X 8080nnip flow-export source 10.5.X.Xnip flow-export version 5nip flow-export version 5 origin-asnip flow-cache timeout active 1nip flow-cache timeout inactive 15nSnmp-server ifindex persistnexit"
    },
    {
      "Description": "Flow Export command for Cisco",
      "TemplateName": "Cisco_CommonFlexible_FlowExport",
      "Id": 43,
      "TemplateType": "COMMAND_LINE_MODE",
      "TemplateContents": "config tnflow exporter NFAexporterndestination 10.5.X.Xnsource 10.5.X.Xnexport-protocol version-9ntransport udp 8080ntemplate data timeout 60nexitnnflow monitor NFAmonitornrecord netflow-originalnexporter NFAexporterncache timeout active 60ncache timeout inactive 15nexit"
    }
  ]
}

Error Response

View common error responses

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

Get Configlet Execution History

API EndPoint : listExecutionHistory

Provides a summary of past configlet executions, helping track when and where each configlet was applied and its execution status.

HTTP Method

GET

API URL

http://localhost:8060/api/json/ncmsettings/listExecutionHistory?apiKey=********

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
jqgrid_id	jqgrid_id = DEHistoryList 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 = NCMScriptExecution__TEMPLATE_NAME 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 = NCMScriptExecution__TEMPLATE_NAME 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":"NCMScriptExecution__TEMPLATE_NAME","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
Configlet Name	NCMScriptExecution__TEMPLATE_NAME
Execution Status	NCMBulkExecution__STATUS
Invoked On	NCMBulkExecution__START_TIME
Invoked By	NCMBulkExecution__LOGIN_NAME

Sample Response

HTTP Code: 200

{
  "total": 6,
  "records": "6",
  "page": 1,
  "rows": [
    {
      "id": 58211,
      "cell": [
        58211,
        "Test Script",
        "COMPLETED",
        "Oct 31, 2025 00:01 AM",
        "userxxx",
        "&CUSTOMIZE_DATA_VIEWNAME=CustomTemplateResultView&EXECUTION_ID=58211"
      ]
    },
    {
      "id": 58210,
      "cell": [
        58210,
        "Test Script",
        "COMPLETED",
        "Oct 31, 2025 00:00 AM",
        "userxxx",
        "&CUSTOMIZE_DATA_VIEWNAME=CustomTemplateResultView&EXECUTION_ID=58210"
      ]
    },
    {
      "id": 58209,
      "cell": [
        58209,
        "Cisco_Show_Version_Script",
        "COMPLETED",
        "Oct 30, 2025 17:13 PM",
        "operator",
        "&CUSTOMIZE_DATA_VIEWNAME=CustomTemplateResultView&EXECUTION_ID=58209"
      ]
    },
    {
      "id": 58208,
      "cell": [
        58208,
        "Cisco_Show_Version_Script",
        "COMPLETED",
        "Oct 30, 2025 13:30 PM",
        "operator",
        "&CUSTOMIZE_DATA_VIEWNAME=CustomTemplateResultView&EXECUTION_ID=58208"
      ]
    },
    {
      "id": 58207,
      "cell": [
        58207,
        "Upgrade Cisco Stack Switch",
        "COMPLETED",
        "Oct 28, 2025 10:50 AM",
        "admin",
        "&CUSTOMIZE_DATA_VIEWNAME=CustomTemplateResultView&EXECUTION_ID=58207"
      ]
    },
    {
      "id": 58206,
      "cell": [
        58206,
        "Upgrade HP Switches",
        "COMPLETED",
        "Oct 28, 2025 10:50 AM",
        "admin",
        "&CUSTOMIZE_DATA_VIEWNAME=CustomTemplateResultView&EXECUTION_ID=58206"
      ]
    }
  ]
}

Error Response

View common error responses

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

List All Schedules

API EndPoint : allSchedules

Provides a list of all schedules that have been configured for automated or timed operations.

HTTP Method

GET

API URL

http://localhost:8060/api/json/ncmsettings/allSchedules?apiKey=********&taskType=Configuration%20Backup

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
taskType	Specifies the task name to filter and return only the schedules configured to perform that task.	-	^(Configuration Backup\|Compliance Check\|Sync Configuration\|Report Generation\|Custom Template\|PCI Review\|Device Discovery)$	No
jqgrid_id	jqgrid_id = DEAllSchedulesList 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 = Schedule__SCHEDULE_NAME 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 = Schedule__SCHEDULE_NAME 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":"Schedule__SCHEDULE_NAME","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	Schedule__SCHEDULE_NAME
Task Type	NCMSchedule__TASK_TYPE
Status	Scheduled_Task__ADMIN_STATUS
Next Run	Task_Input__SCHEDULE_TIME
Recurrence	NCMSchedule__RECURRENCE_TYPE
Created By	AaaLogin__NAME
Last Modified By	NCMSchedule__LAST_MODIFIED_BY
Actions	Actions

Sample Response

HTTP Code: 200

{
  "total": 1,
  "records": "6",
  "page": 1,
  "rows": [
    {
      "Status": "",
      "Description": "",
      "ProductType": "NCM",
      "Time": "Nov 05, 2025 09:00 AM",
      "typeid": "Configuration Backup",
      "id": 49,
      "cell": [
        49,
        "Example Daily Config Backup",
        "Configuration Backup",
        3,
        "Nov 05, 2025 09:00 AM",
        "Daily",
        "admin",
        "[NA]",
        "",
        false
      ],
      "ScheduleName": "Example Daily Config Backup"
    },
    {
      "Status": "",
      "Description": "",
      "ProductType": "NCM",
      "Time": "Nov 02, 2025 09:00 AM",
      "typeid": "Configuration Backup",
      "id": 50,
      "cell": [
        50,
        "Example Weekly Config Backup",
        "Configuration Backup",
        4,
        "Nov 02, 2025 09:00 AM",
        "Weekly",
        "admin",
        "[NA]",
        "",
        false
      ],
      "ScheduleName": "Example Weekly Config Backup"
    },
    {
      "Status": "",
      "Description": "",
      "ProductType": "NCM",
      "Time": "Nov 01, 2025 09:00 AM",
      "typeid": "Report Generation",
      "id": 73,
      "cell": [
        73,
        "Example Startup-Running Conflict report",
        "Report Generation",
        4,
        "Nov 01, 2025 09:00 AM",
        "Monthly",
        "admin",
        "[NA]",
        "",
        false
      ],
      "ScheduleName": "Example Startup-Running Conflict report"
    },
    {
      "Status": "",
      "Description": "",
      "ProductType": "NCM",
      "Time": "Nov 01, 2025 02:00 AM",
      "typeid": "Report Generation",
      "id": 74,
      "cell": [
        74,
        "Example Configuration Change report",
        "Report Generation",
        4,
        "Nov 01, 2025 02:00 AM",
        "Daily",
        "admin",
        "[NA]",
        "",
        false
      ],
      "ScheduleName": "Example Configuration Change report"
    },
    {
      "Status": "",
      "Description": "",
      "ProductType": "NCM",
      "Time": "Oct 31, 2025 13:00 PM",
      "typeid": "Configuration Backup",
      "id": 48,
      "cell": [
        48,
        "Example Hourly Config Backup",
        "Configuration Backup",
        4,
        "Oct 31, 2025 13:00 PM",
        "Hourly",
        "admin",
        "[NA]",
        "",
        false
      ],
      "ScheduleName": "Example Hourly Config Backup"
    },
    {
      "Status": "",
      "Description": "",
      "ProductType": "NCM",
      "Time": "Oct 31, 2025 12:12 PM",
      "typeid": "Custom Template",
      "id": 47,
      "cell": [
        47,
        "Example execute command script",
        "Custom Template",
        4,
        "Oct 31, 2025 12:12 PM",
        "Once Only",
        "admin",
        "[NA]",
        "",
        false
      ],
      "ScheduleName": "Example execute command script"
    }
  ]
}

Error Response

View common error responses

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

List All Show Commands

API EndPoint : allshowCommands

Provides a complete list of all show commands that can be executed on supported devices.

HTTP Method

GET

API URL

http://localhost:8060/api/json/ncmsettings/allshowCommands?apiKey=********

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
jqgrid_id	jqgrid_id = DEShowCommandsList 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 = NCMShowCommands__COMMAND_ALIAS 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 = NCMShowCommands__COMMAND_ALIAS 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":"NCMShowCommands__COMMAND_ALIAS","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
Command Alias	NCMShowCommands__COMMAND_ALIAS
Show Command	NCMShowCommands__SHOW_COMMAND
Associated Vendor	NCMVendor__DISPLAYNAME

Sample Response

HTTP Code: 200

{
  "total": 3,
  "records": "3",
  "page": 1,
  "rows": [
    {
      "id": 73,
      "cell": [
        73,
        "show version",
        "/system resource print",
        "Mikrotik",
        ""
      ]
    },
    {
      "id": 63,
      "cell": [
        63,
        "ati5",
        "ati5",
        "Digi",
        ""
      ]
    },
    {
      "id": 51,
      "cell": [
        51,
        "bigpipe platform",
        "bigpipe platform",
        "F5",
        ""
      ]
    }
  ]
}

Error Response

View common error responses

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

List Export Configuration Execution History

API EndPoint : exportConfigs

Provides a record of past Export Configuration operations, including execution details and status

HTTP Method

GET

API URL

http://localhost:8060/api/json/ncmsettings/exportConfigs?apiKey=********

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
jqgrid_id	jqgrid_id = DEExportConfigList 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 = NCMDisasterExecAudit__START_TIME 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 = NCMDisasterExecAudit__START_TIME 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":"NCMDisasterExecAudit__START_TIME","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
Started On	NCMDisasterExecAudit__START_TIME
Finished On	NCMDisasterExecAudit__END_TIME
Execution Type	NCMDisasterExecAudit__EXECUTION_TYPE
Status	NCMDisasterExecAudit__STATUS

Sample Response

HTTP Code: 200

{
  "total": 1,
  "records": "1",
  "page": 1,
  "rows": [
    {
      "id": 1,
      "cell": [
        1,
        "Nov 03, 2025 17:34 PM",
        "Nov 03, 2025 17:34 PM",
        "MANUAL",
        "SUCCESS"
      ]
    }
  ]
}

Error Response

View common error responses

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

List All Pending Requests

API EndPoint : pendingRequests

Provides the list of pending device configuration change requests available for approval from administrator

HTTP Method

GET

API URL

http://localhost:8060/api/json/ncmsettings/pendingRequests?apiKey=********

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
jqgrid_id	jqgrid_id = DEPendingRequestList 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 = NCMApprovalRequest__REQUEST_TYPE 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 = NCMApprovalRequest__REQUEST_TYPE 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":"NCMApprovalRequest__REQUEST_TYPE","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
Requested Operation	NCMApprovalRequest__REQUEST_TYPE
Requested By	AaaLogin__NAME
Annotation	NCMApprovalRequest__ANNOTATION
Requested On	NCMApprovalRequest__CREATED_TIME

Sample Response

HTTP Code: 200

{
  "total": 1,
  "records": "2",
  "page": 1,
  "rows": [
    {
      "id": 23101,
      "cell": [
        23101,
        "Label Upload",
        "Operator_XXXX",
        "No Comment Available",
        "Oct 30, 2025 12:45 PM"
      ]
    },
    {
      "id": 22801,
      "cell": [
        22801,
        "Version Upload",
        "operator",
        "No Comment Available",
        "Oct 14, 2025 13:59 PM"
      ]
    }
  ]
}

Error Response

View common error responses

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

List All Approved Requests

API EndPoint : approvedRequests

Provides the list of device configuration change requests approved by administrator and got executed

HTTP Method

GET

API URL

http://localhost:8060/api/json/ncmsettings/approvedRequests?apiKey=********

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
jqgrid_id	jqgrid_id = DEApprovedRequestList 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 = NCMAPPROVALREQUESTAUDIT__REQUEST_TYPE 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 = NCMAPPROVALREQUESTAUDIT__REQUEST_TYPE 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":"NCMAPPROVALREQUESTAUDIT__REQUEST_TYPE","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
Requested Operation	NCMAPPROVALREQUESTAUDIT__REQUEST_TYPE
Requested By	NCMApprovalRequestAudit__REQUESTED_USER
Approved By	NCMApprovalRequestAudit__APPROVED_USER
Requested On	NCMApprovalRequestAudit__CREATED_TIME
Approved On	NCMApprovalRequestAudit__APPROVED_TIME
Comments	NCMApprovalRequestAudit__APPROVAL_ANNOTATION

Sample Response

HTTP Code: 200

{
  "total": 1,
  "records": "4",
  "page": 1,
  "rows": [
    {
      "id": 3602,
      "cell": [
        3602,
        "Custom Template Upload",
        "test@test.com",
        "admin@test.com",
        "Mar 20, 2019 18:49 PM",
        "Jun 18, 2019 14:26 PM",
        " Request Run At 06/18/2019, 17 : 30"
      ]
    },
	{
      "id": 5705,
      "cell": [
        5705,
        "Scheduled Custom Template Upload",
        "operator-xxx",
        "admin",
        "Mar 03, 2020 17:47 PM",
        "Mar 03, 2020 17:47 PM",
        "No Comment Available"
      ]
    },
    {
      "id": 1503,
      "cell": [
        1503,
        "Draft Upload",
        "operator-yyy",
        "admin",
        "Oct 12, 2018 11:18 AM",
        "Oct 12, 2018 11:19 AM",
        "No Comment Available"
      ]
    },
    {
      "id": 301,
      "cell": [
        301,
        "Draft Upload",
        "operator-xxx",
        "admin",
        "Jun 12, 2018 21:24 PM",
        "Jun 12, 2018 21:25 PM",
        "approve"
      ]
    }
  ]
}

Error Response

View common error responses

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

List All Rejected Requests

API EndPoint : rejectedRequests

Provides the list of device configuration change requests rejected by the administrator

HTTP Method

GET

API URL

http://localhost:8060/api/json/ncmsettings/rejectedRequests?apiKey=********

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
jqgrid_id	jqgrid_id = DERejectedRequestList 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 = NCMAPPROVALREQUESTAUDIT__REQUEST_TYPE 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 = NCMAPPROVALREQUESTAUDIT__REQUEST_TYPE 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":"NCMAPPROVALREQUESTAUDIT__REQUEST_TYPE","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
Requested Operation	NCMAPPROVALREQUESTAUDIT__REQUEST_TYPE
Requested By	NCMApprovalRequestAudit__REQUESTED_USER
Rejected By	NCMApprovalRequestAudit__APPROVED_USER
Requested On	NCMApprovalRequestAudit__CREATED_TIME
Rejected On	NCMApprovalRequestAudit__APPROVED_TIME
Comments	NCMApprovalRequestAudit__APPROVAL_ANNOTATION

Sample Response

HTTP Code: 200

{
  "total": 1,
  "records": "5",
  "page": 1,
  "rows": [
    {
      "id": 17701,
      "cell": [
        17701,
        "Version Upload",
        "operator",
        "admin",
        "Oct 14, 2025 15:46 PM",
        "Oct 28, 2025 16:20 PM",
        "No Comment Available"
      ]
    },
    {
      "id": 16810,
      "cell": [
        16810,
        "Draft Upload",
        "user-operator",
        "admin",
        "Nov 19, 2024 03:40 AM",
        "Nov 26, 2024 10:23 AM",
        "No Comment Available"
      ]
    },
    {
      "id": 16806,
      "cell": [
        16806,
        "Custom Template Upload",
        "operator",
        "admin",
        "Sep 23, 2024 11:25 AM",
        "Nov 26, 2024 10:23 AM",
        "No Comment Available"
      ]
    },
    {
      "id": 16805,
      "cell": [
        16805,
        "REST API Configlet Upload",
        "operator-Rest",
        "admin",
        "Oct 23, 2024 11:08 AM",
        "Nov 26, 2024 10:23 AM",
        "No Comment Available"
      ]
    },
    {
      "id": 16804,
      "cell": [
        16804,
        "Draft Upload",
        "operator",
        "admin",
        "Nov 19, 2024 11:56 AM",
        "Nov 26, 2024 10:23 AM",
        "No Comment Available"
      ]
    }
  ]
}

Error Response

View common error responses

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

List Executable Approved Requests

API EndPoint : getApprovedList

Provides the list of device configuration change requests that are approved and available for execution

HTTP Method

GET

API URL

http://localhost:8060/api/json/ncmsettings/getApprovedList?apiKey=********

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
jqgrid_id	jqgrid_id = DEExecutableRequestList 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 = NCMApprovalRequestAudit__REQUEST_TYPE 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 = NCMApprovalRequestAudit__REQUEST_TYPE 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":"NCMApprovalRequestAudit__REQUEST_TYPE","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
Requested Operation	NCMApprovalRequestAudit__REQUEST_TYPE
Requested By	NCMApprovalRequestAudit__REQUESTED_USER
Approved By	NCMApprovalRequestAudit__APPROVED_USER
Requested On	NCMApprovalRequestAudit__CREATED_TIME
Approved On	NCMApprovalRequestAudit__APPROVED_TIME
Comments	NCMApprovalRequestAudit__APPROVAL_ANNOTATION
Actions	Actions

Sample Response

HTTP Code: 200

{
  "total": 1,
  "records": "1",
  "page": 1,
  "rows": [
    {
      "created_time": "Oct 14, 2025 14:00 PM",
      "approved_user": "user-xxx",
      "req_oper": "Version Upload",
      "login_name": "operator",
      "approval_comments": "No Comment Available",
      "approved_time": "Oct 30, 2025 12:49 PM",
      "id": 2702,
      "reqId": 22802
    }
  ]
}

Error Response

View common error responses

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

Get Schedule Execution History

API EndPoint : getscheduleAudit

Provides a list of previously executed schedules along with their execution details and status

HTTP Method

GET

API URL

http://localhost:8060/api/json/ncmsettings/getscheduleAudit?apiKey=********

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
jqgrid_id	jqgrid_id = DEScheduleAudit 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 = Schedule_Audit__SCHEDULE_NAME 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 = Schedule_Audit__SCHEDULE_NAME 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":"Schedule_Audit__SCHEDULE_NAME","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
Schedule Name	Schedule_Audit__SCHEDULE_NAME
Created By	NCMScheduleResultAudit__LOGIN_NAME
Task Type	NCMSchedule__TASK_TYPE
Start Time	Schedule_Audit__SCHEDULE_START_TIME
End Time	NCMScheduleResultAudit__SCHEDULE_END_TIME
Status	NCMScheduleResultAudit__SCHEDULE_RUNNING_STATUS

Sample Response

HTTP Code: 200

{
  "total": 1,
  "records": "1",
  "page": 1,
  "rows": [
    {
      "id": 1,
      "cell": [
        1,
        "Example Daily Config Backup",
        "admin",
        "Configuration Backup",
        "Nov 03, 2025 13:32 PM",
        "Nov 03, 2025 13:33 PM",
        4,
        4,
        49,
        "COMPLETED",
        "https://192.80.xx.xx:8066/schedule_results/backup/Result_44_Nov_3_13_32_04.html",
        "COMPLETED",
        false
      ]
    }
  ]
}

Error Response

View common error responses

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

List All Credential Profiles

API EndPoint : credProfList

Provides the list of credential profiles configured

HTTP Method

GET

API URL

http://localhost:8060/api/json/ncmsettings/credProfList?apiKey=********

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
jqgrid_id	jqgrid_id = DECredProfList 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 = NCMSharedProfile__PROFILENAME 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 = NCMSharedProfile__PROFILENAME 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":"NCMSharedProfile__PROFILENAME","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
Profile Name	NCMSharedProfile__PROFILENAME
Description	NCMSharedProfile__DESCRIPTION
Tags	NCMTag__DISPLAYNAME

Sample Response

HTTP Code: 200

{
  "total": 1,
  "records": "1",
  "page": 1,
  "rows": [
    {
      "id": 301,
      "cell": [
        301,
        "Cisco140",
        "For Cisco 140 Device",
        "images/icon_refresources.gif",
        "",
        ""
      ]
    }
  ]
}

Error Response

View common error responses

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

Device CLI Configlet Result

API EndPoint : detailedResult

Provides the execution results of a configlet on a specified device, including status, output, and any errors encountered during execution.

HTTP Method

GET

API URL

http://localhost:8060/api/json/ncmsettings/detailedResult?apiKey=********&resourceId=305&executionId=6

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
resourceId	Unique identifier of the device for which the configlet execution result needs to be retrieved.	long	-	yes
executionId	Unique identifier of the execution whose result needs to be retrieved.	long	-	yes

Sample Response

HTTP Code: 200

{
  "Status": "SUCCESS",
  "pdfUrl": "&CUSTOMIZE_DATA_VIEWNAME=CustomTemplateResultView&EXECUTION_ID=6&RESOURCE_ID=305",
  "ResourceName": "10.5.X.X",
  "TemplateName": "Show Version Script",
  "ExecutionMode": "Script Execution Mode",
  "InvokedOn": "Nov 4, 2025 11:47 AM",
  "COMMAND_RESPONSE": [
    {
      "DEVICE_RESPOSE": [""],
      "commandClassCode": "green_Code",
      "COMMAND": "terminal length 0",
      "responseClassCode": "grey_Code"
    },
    {
      "DEVICE_RESPOSE": ["CiscoRouter140#"],
      "commandClassCode": "green_Code",
      "COMMAND": "show version",
      "responseClassCode": "grey_Code"
    },
    {
      "DEVICE_RESPOSE": [
        "Cisco IOS Software, C2951 Software (C2951-UNIVERSALK9-M), Version 15.4(3)M5, RELEASE SOFTWARE (fc1)",
        "Technical Support: http://www.cisco.com/techsupport",
        "Copyright (c) 1986-2016 by Cisco Systems, Inc.",
        "Compiled Tue 09-Feb-16 05:48 by prod_rel_team",
        "ROM: System Bootstrap, Version 15.0(1r)M6, RELEASE SOFTWARE (fc1)",
        "CiscoRouter140 uptime is 2 weeks, 3 days, 20 hours, 16 minutes",
        "System returned to ROM by reload at 11:52:08 UTC Fri Oct 17 2025",
        "System image file is flash0:c2951-universalk9-mz.SPA.154-3.M5.bin",
        "Last reload type: Normal Reload",
        "Last reload reason: Reload Command",
        "This product contains cryptographic features and is subject to United",
        "States and local country laws governing import, export, transfer and",
        "use. Delivery of Cisco cryptographic products does not imply",
        "third-party authority to import, export, distribute or use encryption.",
        "Importers, exporters, distributors and users are responsible for",
        "compliance with U.S. and local country laws. By using this product you",
        "agree to comply with applicable laws and regulations. If you are unable",
        "to comply with U.S. and local laws, return this product immediately.",
        "A summary of U.S. laws governing Cisco cryptographic products may be found at:",
        "http://www.cisco.com/wwl/export/crypto/tool/stqrg.html",
        "If you require further assistance please contact us by sending email to",
        "export@cisco.com.",
        "Cisco CISCO2951/K9 (revision 1.1) with 487424K/36864K bytes of memory.",
        "Processor board ID FGL153210AY",
        "3 Gigabit Ethernet interfaces",
        "1 terminal line",
        "DRAM configuration is 72 bits wide with parity enabled.",
        "255K bytes of non-volatile configuration memory.",
        "250880K bytes of ATA System CompactFlash 0 (Read/Write)",
        "License Info:",
        "License UDI:",
        "-------------------------------------------------",
        "Device#t PIDtttSN",
        "-------------------------------------------------",
        "*1 t CISCO2951/K9 FGL153210AY",
        "Technology Package License Information for Module:'c2951'",
        "------------------------------------------------------------------------",
        "Technology Technology-package Technology-package",
        " Current Type Next reboot ",
        "------------------------------------------------------------------------",
        "ipbase ipbasek9 Permanent ipbasek9",
        "security None None None",
        "uc None None None",
        "data datak9 RightToUse datak9",
        "NtwkEss None None None",
        "CollabPro None None None",
        "Configuration register is 0x2102",
        "CiscoRouter140#"
      ],
      "commandClassCode": "green_Code",
      "COMMAND": "",
      "responseClassCode": "grey_Code"
    }
  ]
}

Error Response

View common error responses

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

Device REST Configlet Result

API EndPoint : NCMPopulateRestConfigletExecDetails

This API is used to fetch the detailed result of any rest configlet that has been executed

HTTP Method

GET

API URL

http://localhost:8060/api/json/ncmsettings/NCMPopulateRestConfigletExecDetails?apiKey=********&resourceId=1&executionId=1

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
resourceId	Unique identifier of the device for which the configlet execution result needs to be retrieved.	long	-	yes
executionId	Unique identifier of the execution whose result needs to be retrieved. Please use the ncmconfiglets/getRESTConfigletHistory API to get the list of execution id.	long	-	yes

Sample Response

HTTP Code: 200

{
  "Status": "SUCCESS",
  "Action": "Add",
  "OperationName": "IP Prefix List",
  "ResourceName": "2.2.2.2",
  "postJSONData": {
    "ip_prefix_list": "test",
    "seqno": "1.1.1.1",
    "prefix": "1.1.1.1",
    "filterType": "deny"
  },
  "InvokedOn": "Nov 20, 2025 12:46 PM",
  "OPERATIONID": 36,
  "BackupEnabled": true,
  "ApiUrl": "command-api",
  "RequestType": "POST",
  "pdfUrl": "&CUSTOMIZE_DATA_VIEWNAME=RestApiCustomTemplateResultView&EXECUTION_ID=1&RESOURCE_ID=1",
  "restConfigletDetails": {
    "executionDetails": {
      "parameterGroups": [
        {
          "groupName": "Basic",
          "paramGroupId": 91,
          "showHeader": false,
          "paramGroupOrder": 1,
          "paramList": [
            {
              "paramOrder": 1,
              "dataType": "STRING",
              "paramLevel": 1,
              "paramName": "ip_prefix_list",
              "required": true,
              "loadui": true,
              "paramType": "JSON_PARAM",
              "help": "Prefix list name.",
              "isUserInput": true,
              "readonly": false,
              "paramDisplayName": "Prefix List Name",
              "paramId": 614,
              "category": "VALUE"
            },
            {
              "paramOrder": 2,
              "dataType": "STRING",
              "paramLevel": 1,
              "paramName": "seqno",
              "required": true,
              "loadui": true,
              "paramType": "JSON_PARAM",
              "help": "Unique sequence number",
              "isUserInput": true,
              "readonly": false,
              "paramDisplayName": "Sequence",
              "paramId": 615,
              "category": "VALUE"
            },
            {
              "paramOrder": 3,
              "defaultValue": "permit",
              "dataType": "SWITCH",
              "paramLevel": 1,
              "paramName": "filterType",
              "required": false,
              "loadui": true,
              "paramType": "JSON_PARAM",
              "help": "Select filter type Permit or Deny",
              "isUserInput": true,
              "readonly": false,
              "paramDisplayName": "Filter Type",
              "options": [
                { "displayName": "Permit", "name": "permit" },
                { "displayName": "Deny", "name": "deny" }
              ],
              "paramId": 616,
              "category": "VALUE"
            },
            {
              "paramOrder": 5,
              "dataType": "STRING",
              "paramLevel": 1,
              "paramName": "prefix",
              "required": true,
              "loadui": true,
              "paramType": "JSON_PARAM",
              "help": "Subnet upon which command filters routes.",
              "isUserInput": true,
              "readonly": false,
              "paramDisplayName": "IP Prefix",
              "paramId": 618,
              "category": "VALUE"
            }
          ]
        }
      ]
    },
    "operation": {
      "API_URL": "command-api",
      "OPERATION_TYPE": "CLI",
      "BASE_OS_VERSION": "4.24.3M",
      "NAME": "IP Prefix List",
      "VENDOR": "Arista",
      "REQUEST_TYPE": "POST",
      "allowMultipleDevices": false,
      "TEMPLATE_NAME": "Arista DCS REST API",
      "mKeyName": "ip_prefix_list",
      "mKeySelection": false,
      "mKeyDispName": "Prefix List Name",
      "clicontents": {
        "TEMPLATE_CONTENTS": "enablenconfigurenip prefix-list $ip_prefix_listnseq $seqno $filterType $prefix"
      }
    }
  },
  "COMMAND_RESPONSE": [
    {
      "DEVICE_RESPOSE": [""],
      "commandClassCode": "green_Code",
      "COMMAND": {
        "code": 1002,
        "data": {
          "result": [
            { "output": "" },
            { "output": "" },
            { "output": "" },
            {
              "output": "% Invalid input (at token 1: '1.1.1.1')",
              "errors": ["Invalid input (at token 1: '1.1.1.1')"]
            }
          ],
          "errorDetail": [
            {
              "code": 1002,
              "index": 3,
              "cmd": "seq 1.1.1.1 deny 1.1.1.1",
              "message": "invalid command"
            }
          ]
        },
        "message": "CLI command 4 of 4 'seq 1.1.1.1 deny 1.1.1.1' failed: invalid command"
      },
      "responseClassCode": "grey_Code"
    }
  ]
}

Error Response

View common error responses

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

List All SSH Key Profiles

API EndPoint : listNCMSSHKeys

Retrieves all SSH private key profiles used for connecting to network devices.

HTTP Method

GET

API URL

http://localhost:8060/api/json/ncmsettings/listNCMSSHKeys?apiKey=********

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
jqgrid_id	jqgrid_id = DENCMSSHKeyList 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 = NCMSSHPrivPubKeys__KEYNAME 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 = NCMSSHPrivPubKeys__KEYNAME 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":"NCMSSHPrivPubKeys__KEYNAME","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
SSH Key Name	NCMSSHPrivPubKeys__KEYNAME
FingerPrint	NCMSSHPrivPubKeys__FINGERPRINT
Comment	NCMSSHPrivPubKeys__COMMENTS
Invoked By	NCMSSHPrivPubKeys__LOGIN_ID
Tags	NCMTag__DISPLAYNAME
Invoked On	NCMSSHPrivPubKeys__CREATED_TIME

Sample Response

HTTP Code: 200

{
  "total": 1,
  "records": "1",
  "page": 1,
  "rows": [
    {
      "id": 1,
      "cell": [
        1,
        "DSA Profile",
        "SHA256:9GSYT+9/G53iEdtmuEvfxBRHwNgcpRyu/RaAHS93CC0",
        "secret",
        "admin",
        "",
        "images/icon_refresources.gif",
        "Nov 04, 2025 11:26 AM"
      ]
    }
  ]
}

Error Response

View common error responses

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

Associate Credentials

API EndPoint : assocCredential

Associates the network devices with their respective credentials. We use two modes of authentication.

1. SSH Key-Based Authentication

2. Password Based Authentication

You can also associate profiles created instead of providing complete credentials directly.

Password Based Authentication works with both SSH & Telnet connections.

In addition SNMP Connections and Rest API based connections are also supported. You can associate SNMP Profiles to enable SNMP communication with the network device or provide Rest API credentials to perform api based operations.

HTTP Method

POST

API URL

http://localhost:8060/api/json/ncmsettings/assocCredential?apiKey=aa969becbd20e6bd8a2d4cca602aab42&protocolCombinationList=SSH&SSH_LOGINNAME=ncm&SSH_PASSWORD=use7*r&SSH_PROMPT=>&SSH_ENABLEPASSWORD=pass@w0rd&SSH_ENABLEPROMPT=%23&authMode=password&BACKUP_STATUS=true&RESOURCEID_LIST=6008

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
authMode	Type of authentication to access the device . It can be either "SSH Key-Based" or "Password Based"	-	^(sshKey\|password)$	No
SSH_PRIVATEKEYID	SSH Key Name of SSH Key Profile	-	[p{L}p{N}-_s]+	No
UPDATE_TYPE	@Depcricated : Ignore this param	-	^(UPDATE)$	No
BACKUP_STATUS	Set as 'true', if wants to trigger Backup operation automatically once credential is applied	boolean	-	No
TEST_CRED	Set as 'true', if wants to test the provided credential's validity before triggering backup	boolean	-	No
RESOURCEID_LIST	List of Resource Ids - List of device's unique id for which the credential needs to be applied	-	((d+)(,d+)*)	yes
SNMP_PROFILELIST	SNMP Profile Name that needs to be associated with device. If profile name is provided ignore other credential parameters	-	^([p{L}p{N}P{InBasicLatin}.!:@#$s-_\/',])+$	No
SNMP_VERSION	SNMP Version - Provide value as 3 for SNMP V3,1 for SNMP V1&V2C	-	^(0\|1\|3)$	No
SNMP_PORT	Port over which we need to communicate with SNMP	-	^([1-9][0-9]{0,3}\|[1-5][0-9]{4}\|6[0-4][0-9]{3}\|65[0-4][0-9]{2}\|655[0-2][0-9]\|6553[0-5])$	No
SNMP_READCOMMUNITY	Similar to password. Provides only read access using SNMP	String	-	No
SNMP_WRITECOMMUNITY	Similar to password. Provides read-write access using SNMP	String	-	No
SNMP_USERNAME	Username to enable secure communication with device. Mandatory if going to associate SNMP V3 Profile	String	-	No
SNMP_CONTEXTNAME	Name of the context which you want to read or write using SNMP	String	-	No
SNMP_AUTHPROTOCOL	Authentication algorithm used to verify identity (20=None, 21=MD5 and 22=SHA)	-	^(20\|21\|22)$	No
SNMP_AUTHPASSWORD	Password used with Auth Protocol to authenticate snmp user	String	-	No
SNMP_PRIVPROTOCOL	Encryption alogorithm to be used on SNMP data (49=AES 128, 50=DES and 51=None)	-	^(49\|50\|51)$	No
SNMP_PRIVPASSWORD	Password used for encryption. Mandatory if SNMP Priv Protocol is provided with a value	String	-	No
SNMP_NATIP	@Depcricated : Ignore this param	-	^(?:(?: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]?)$	No
TELNET_PROFILELIST	Telnet Profile Name that needs to be associated with device. If profile name is provided ignore other credential parameters	-	^([p{L}p{N}P{InBasicLatin}.!:@#$s-_\/',])+$	No
TELNET_LOGINNAME	Username of the network device for Telnet Connection	String	-	No
TELNET_PASSWORD	Password of the network device for Telnet Connection	String	-	No
TELNET_PROMPT	Prompt received from network device after successfull authentication (eg: if hostname# is received then prompt is #)	String	-	No
TELNET_ENABLEUSERNAME	Username of privilege command(eg: enable,clish,etc) if applicable for the network device	String	-	No
TELNET_ENABLEPASSWORD	Password of privilege command(eg: enable,clish,etc) if applicable for the network device	String	-	No
TELNET_ENABLEPROMPT	Prompt received from network device after successfull authentication of privilege command	String	-	No
TELNET_NATIP	@Depcricated : Ignore this param	-	^(?:(?: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]?)$	No
TELNET_PORT	Port to which we need to establish Telnet Connection	-	^([1-9][0-9]{0,3}\|[1-5][0-9]{4}\|6[0-4][0-9]{3}\|65[0-4][0-9]{2}\|655[0-2][0-9]\|6553[0-5])$	No
TELNET_LOGINPROMPT	Provide what the device prompts when it requests for username (eg : login: or :)	String	-	No
TELNET_PASSWORDPROMPT	Provide what the device prompts when it requests for password(eg : password: or :)	String	-	No
TELNET_ENABLEUSERNAMEPROMPT	Provide what the device prompts when it requests for "Enable Username" (eg : username: or :)	String	-	No
TELNET_ENABLEPASSWORDPROMPT	Provide what the device prompts when it requests for "Enable Password" (eg : password: or :)	String	-	No
TELNET_ENABLEPASSWORDTYPE	Type of Enable Password the device expects. There are 3 types 1. enablePassword - Usual format where once enable command is entered devices asks for enable username and password 2. noEnablePassword - We directly enter into privilege mode once enable command is entered. Device won't prompt for any credentials 3. emptyEnablePassword - Once enable command is send device prompts for password. But password need not be provided. You get privilege access just with an enter	-	^(enablePassword\|noEnablePassword\|emptyEnablePassword)$	No
SSH_PROFILELIST	SSH Profile Name that needs to be associated with device. If profile name is provided ignore other credential parameters	-	^([p{L}p{N}P{InBasicLatin}.!:@#$s-_\/',])+$	No
SSH_LOGINNAME	Username of the network device for SSH Connection	String	-	No
SSH_PASSWORD	Password of the network device for SSH Connection	String	-	No
SSH_PROMPT	Prompt received from network device after successfull authentication (eg: if hostname# is received then prompt is #)	String	-	No
SSH_ENABLEUSERNAME	Username of privilege command(eg: enable,clish,etc) if applicable for the network device	String	-	No
SSH_ENABLEPASSWORD	Password of privilege command(eg: enable,clish,etc) if applicable for the network device	String	-	No
SSH_ENABLEPROMPT	Prompt received from network device after successfull authentication of privilege command	String	-	No
SSH_NATIP	@Depcricated : Ignore this param	-	^(?:(?: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]?)$	No
SSH_PORT	Port to which we need to establish SSH Connection	-	^([1-9][0-9]{0,3}\|[1-5][0-9]{4}\|6[0-4][0-9]{3}\|65[0-4][0-9]{2}\|655[0-2][0-9]\|6553[0-5])$	No
SSH_LOGINPROMPT	Provide what the device prompts when it requests for username (eg : login: or :)	String	-	No
SSH_PASSWORDPROMPT	Provide what the device prompts when it requests for password(eg : password: or :)	String	-	No
SSH_ENABLEUSERNAMEPROMPT	Provide what the device prompts when it requests for "Enable Username" (eg : username: or :)	String	-	No
SSH_ENABLEPASSWORDPROMPT	Provide what the device prompts when it requests for "Enable Password" (eg : password: or :)	String	-	No
SSH_ENABLEPASSWORDTYPE	Type of Enable Password the device expects. There are 3 types 1. enablePassword - Usual format where once enable command is entered devices asks for enable username and password 2. noEnablePassword - We directly enter into privilege mode once enable command is entered. Device won't prompt for any credentials 3. emptyEnablePassword - Once enable command is send device prompts for password. But password need not be provided. You get privilege access just with an enter	-	^(enablePassword\|noEnablePassword\|emptyEnablePassword)$	No
protocolCombinationList	Connection Type - SSH or Telnet or SNMP or Rest API. Value can also be the combination with transfer protocols like Telnet-Tftp or SSH - SCP or SSH - Sftp or SNMP - Tfrp	-	^(TELNET\|TELNET - TFTP\|SSH\|SSH - TFTP\|SSH - SCP\|SSH - SFTP\|SNMP - TFTP\|REST API)$	No
REST_API_PARAMS	This is an optional JSONArray to save the REST Credentials of the device into DB. It is a JSONArray of Objects where each object contains three keys as follows: name: String value: String isPassword: boolean	JSONArray	-	No

Sample Response

HTTP Code: 200

{
    "statusMsg": "Credential values have been 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

Test Credentials

API EndPoint : saveandTestResult

Saves the Credential and Validates. Once connection with network device is established we execute configuration backup for either startup or running to verify execution

HTTP Method

GET

API URL

http://localhost:8060/api/json/ncmsettings/saveandTestResult?apiKey=********&RESOURCEID=101&BACKUP_STATUS=true

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
RESOURCEID	Resource id - Unique Id of the device for which we need to validate credentials	long	-	yes
BACKUP_STATUS	If set as 'true', backup will be triggered automatically if validation is successfull	boolean	-	No

Sample Response

HTTP Code: 200

{
  "CREDENTIAL_VALUES": {
    "Login Prompt": ":",
    "Password Prompt": ":",
    "Enable Password": "",
    "Port": "22",
    "Enable Prompt": "",
    "Enable Password Prompt": ":",
    "Prompt": ">|#",
    "Login Name": "sriv",
    "Password": "**********"
  },

  "RESPONSE_MAP": {
    "2": "nCiscoRouter140#",
    "4": "nUsing 55403 out of 262136 bytes, uncompressed size=277529 bytesnUncompressed configuration from 55403 bytes to 277529 bytesn!n! Last configuration change at 10:14:10 UTC Mon Nov 3 2025 by srivn!nversion 15.4nno service padnservice tcp-keepalives-innservice timestamps debug datetime localtime show-timezonen...ntransport input nonen!nscheduler allocate 20000 1000n!nendnnCiscoRouter140#"
  },

  "EXECUTION_STATUS": true,
  "BACKUP_OPERATION_AVAILABLE": true,
  "CREDENTIAL_UPDATED": true,
  "PING_AVAILABILITY": true,
  "TESTING_SUPPORTED": true,
  "PROTOCOL_USED": "SSH",
  "EXECUTION_RESULT": false,
  "RESOURCENAME": "10.5.X.X",
  "OPERATION_STATUS": true,

  "exeResultMap": {
    "USERINPUT_MAP": {
      "{UserInput:scp_password}": "SCPDeviceExpert",
      "{UserInput:ABSOLUTE_FILE_NAME}": "/home/test/hari/NCM_ESS_RESTAPIDOCUMENTATION/OpManager/tftp_files/305_ConfigFile.txt",
      "{UserInput:fileFormat}": "Text",
      "{UserInput:syslog_server_detail}": "allip",
      "{UserInput:scp_server_status}": "startscp",
      "{UserInput:EnablePrompt}": ">|#",
      "{UserInput:RndNo}": "758827516",
      "{UserInput:LogLevel}": "INFO",
      "{UserInput:file_name}": "305_ConfigFile.txt",
      "{UserInput:scp_username}": "deviceexpert",
      "{UserInput:syslog_server_status}": "startsyslog",
      "{UserInput:PMP_ServerPort}": "80",
      "{UserInput:tftp_server_address}": "10.5.X.X",
      "{UserInput:PMP_ServerName}": "",
      "{UserInput:tftp_server_detail}": "allip",
      "{UserInput:EnablePasswordPrompt}": ":",
      "{UserInput:PMP_AuthToken}": "",
      "{UserInput:scp_server_address}": "10.5.X.X",
      "{UserInput:PMP_EnableSync}": "off",
      "{UserInput:syslog_server_address}": "10.5.X.X",
      "{UserInput:Prompt}": ">|#",
      "{UserInput:ftp_server_address}": "10.5.X.X",
      "{UserInput:UploadAudit}": "true",
      "{UserInput:scp_server_detail}": "allip",
      "{UserInput:tftp_server_status}": "starttftp",
      "{UserInput:EnablePassword}": ""
    },

    "TASK_HANDLING": true,
    "IS_ITERATIVE": false,
    "ENABLE_CONNECTION_FETCHED": true,
    "EXECUTION_RESULT": "CONNECTION_FETCHED",
    "LOGIN_SEQUENCE": []
  },

  "PARAMETER_MAP": [
    { "PARAM": "Port", "VALUE": "true" },
    { "PARAM": "Login Prompt", "VALUE": "true" },
    { "PARAM": "Login Name", "VALUE": "true" },
    { "PARAM": "Password Prompt", "VALUE": "true" },
    { "PARAM": "Password", "VALUE": "true" },
    { "PARAM": "Prompt", "VALUE": "true" },
    { "PARAM": "Enable Username Prompt", "VALUE": "true" },
    { "PARAM": "Enable Username", "VALUE": "true" },
    { "PARAM": "Enable Password Prompt", "VALUE": "true" },
    { "PARAM": "Enable Password", "VALUE": "true" },
    { "PARAM": "Enable Prompt", "VALUE": "true" }
  ],

  "TEST_RESULT": [
    "",
    "terminal length 0",
    "nCiscoRouter140#",
    "show startup-confign...nscheduler allocate 20000 1000n!nendnCiscoRouter140#n"
  ],

  "GIVEN_VALUES": [
    ">|#",
    ">|#"
  ]
}

Error Response

View common error responses

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

Edit Configlet

API EndPoint : updateConfiglet

Updates the existing configlet template with changes if any

HTTP Method

POST

API URL

http://localhost:8060/api/json/ncmsettings/updateConfiglet?apiKey=********&TEMPLATE_ID=6&DESCRIPTION=Enable%20Change%20Detection&CONTENTS=enable%20change%20detection&TEMPLATE_TYPE=COMMAND_LINE_MODE&NAME=Alaxala_Enable_Change_Detection&DEVICETEMPLATEID=63&VENDOR_NAME=Alaxala&TAG_ID=10&BACKUP_BEFORE_TEMPLATE=false&BACKUP_AFTER_TEMPLATE=true

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
DESCRIPTION	Purpose of configlet	-	^([p{L}p{N}P{InBasicLatin}.!:@#$s-_\/',])+$	No
CONTENTS	Configlet script which needs to applied on network devices	String	-	No
TEMPLATE_TYPE	Type of configlet script. It can be one of the following: 1. COMMAND_LINE_MODE - It is a simple "Script Execution Mode" configlet. Provide content the same way it is applied on a network device. 2. ADVANCED_COMMAND_LINE_MODE - In this mode, you can set timeout, delay, command prompts, and also configure conditional configlet execution. 3. TFTP_FILE_TRANSFER_MODE - As the name suggests, the content is uploaded as a file to the target network device.	-	^(COMMAND_LINE_MODE\|TFTP_FILE_TRANSFER_MODE\|ADVANCED_COMMAND_LINE_MODE)$	yes
TEMPLATE_ID	Unique Id of the configlet which you need to edit. It is mandatory for updating an existing configlet	long	-	No
BACKUP_BEFORE_TEMPLATE	Since Configlet is used to make changes on network device, If this param is set as 'true', we backup the configurations before applying the configlet on device.	boolean	-	No
BACKUP_AFTER_TEMPLATE	Since Configlet is used to make changes on network device, If this param is set as 'true', we backup the configurations after applying the configlet on device	boolean	-	No
NAME	Name of the Configlet	-	^([p{L}p{N}P{InBasicLatin}.!:@#$s-_\/',])+$	No
DEVICETEMPLATEID	ID of the device template to which the configlet needs to be associated, so that the configlet will be available in device snapshot page	long	-	No
VENDOR_NAME	Name of the vendor to which this configlet is applicable	-	^([p{L}p{N}+_s()-])+$	No
TAG_ID	ID of the tag to which this configlet is associated	long	-	No

Sample Response

HTTP Code: 200

{
  "statusMsg": "Custom template Upload Image to Switch created successfully",
  "isSuccess": true
}

Error Response

View common error responses

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

Add Configlet

API EndPoint : updateConfiglet

Adds the new configlet template that needs to be applied to devices

HTTP Method

POST

API URL

http://localhost:8060/api/json/ncmsettings/updateConfiglet?apiKey=********&DESCRIPTION=Enable%20Change%20Detection&CONTENTS=enable%20change%20detection&TEMPLATE_TYPE=COMMAND_LINE_MODE&NAME=Alaxala_Enable_Change_Detection&DEVICETEMPLATEID=63&VENDOR_NAME=Alaxala&TAG_ID=10&BACKUP_BEFORE_TEMPLATE=false&BACKUP_AFTER_TEMPLATE=true

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
DESCRIPTION	Purpose of configlet	-	^([p{L}p{N}P{InBasicLatin}.!:@#$s-_\/',])+$	No
CONTENTS	Configlet script which needs to applied on network devices	String	-	No
TEMPLATE_TYPE	Type of configlet script. It can be one of the following: 1. COMMAND_LINE_MODE - It is a simple "Script Execution Mode" configlet. Provide content the same way it is applied on a network device. 2. ADVANCED_COMMAND_LINE_MODE - In this mode, you can set timeout, delay, prompts for commands to be executed, and also configure conditional configlet execution. 3. TFTP_FILE_TRANSFER_MODE - As the name suggests, the content is uploaded as a file to the target network device.	-	^(COMMAND_LINE_MODE\|TFTP_FILE_TRANSFER_MODE\|ADVANCED_COMMAND_LINE_MODE)$	yes
BACKUP_BEFORE_TEMPLATE	Since Configlet is used to make changes on network device, If this param is set as 'true', we backup the configurations before applying the configlet on device.	boolean	-	No
BACKUP_AFTER_TEMPLATE	Since Configlet is used to make changes on network device, If this param is set as 'true', we backup the configurations after applying the configlet on device	boolean	-	No
NAME	Name of the Configlet	-	^([p{L}p{N}P{InBasicLatin}.!:@#$s-_\/',])+$	No
DEVICETEMPLATEID	ID of the device template to which the configlet needs to be associated, so that the configlet will be available in device snapshot page	long	-	No
VENDOR_NAME	Name of the vendor to which this configlet is applicable	-	^([p{L}p{N}+_s()-])+$	No
TAG_ID	ID of the tag to which this configlet is associated	long	-	No

Sample Response

HTTP Code: 200

{
  "statusMsg": "Custom template Alaxala_Enable_Change_detection 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 SNMP Profile List

API EndPoint : getSNMPProfiles

Provides the list of snmp profiles and their unique IDs available

HTTP Method

GET

API URL

 http://localhost:8060/api/json/ncmsettings/getSNMPProfiles?apiKey= ********

Parameters

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

Sample Response

HTTP Code: 200

{
 "profiles": [
 {
 "profileName": "Snmp_Public",
 "profileID": "1"
 },
 {
 "profileName": "Snmp_Test",
 "profileID": "601"
 }
 ]
}

Error Response

View common error responses

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

List Supported Vendors

API EndPoint : vendorList

List All Vendors Supported by NCM

HTTP Method

GET

API URL

 http://localhost:8060/api/json/ncmsettings/vendorList?apiKey= ********&IS_PRERENDER=true

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
IS_PRERENDER	If set as 'true', deviceType of first vendor on list and custom column names will be provided If set as 'false' or not provided , only vendor list will be fetched	boolean	-	No

Sample Response

HTTP Code: 200

{
 "COLUMN_NAME2": "Custom Column 2",
 "COLUMN_NAME3": "Custom Column 3",
 "deviceTypes": [
 "3Com 4200G Series Switch",
 "3Com 4500 Series Switch",
 "3Com 5500 Series Switch",
 "3Com Menu Based Switches"
 ],
 "COLUMN_NAME1": "Custom Column 1",
 "Vendor": [
 {
 "DisplayName": "HPE (3Com)",
 "Name": "3Com"
 },
 {
 "DisplayName": "A10Networks",
 "Name": "A10Networks"
 },
 {
 "DisplayName": "Acme Packet",
 "Name": "AcmePacket"
 },
 {
 "DisplayName": "Adtran",
 "Name": "Adtran"
 },
 {
 "DisplayName": "ADVA",
 "Name": "ADVA"
 },
 {
 "DisplayName": "Alaxala",
 "Name": "Alaxala"
 },
 {
 "DisplayName": "Alcatel",
 "Name": "Alcatel"
 },
 {
 "DisplayName": "Allied Telesis",
 "Name": "AlliedTelesis"
 },
 {
 "DisplayName": "Anritsu",
 "Name": "Anritsu"
 },
 {
 "DisplayName": "Antaira",
 "Name": "Antaira"
 },
 {
 "DisplayName": "NetScout (Arbornetworks)",
 "Name": "Arbornetworks"
 },
 {
 "DisplayName": "Arista",
 "Name": "Arista"
 },
 {
 "DisplayName": "Array",
 "Name": "Array"
 },
 {
 "DisplayName": "Aruba",
 "Name": "Aruba"
 },
 {
 "DisplayName": "ATMedia",
 "Name": "ATMedia"
 },
 {
 "DisplayName": "AudioCodes",
 "Name": "AudioCodes"
 },
 {
 "DisplayName": "Avaya",
 "Name": "Avaya"
 },
 {
 "DisplayName": "Emerson (Avocent)",
 "Name": "Avocent"
 },
 {
 "DisplayName": "Symantec (Blue Coat)",
 "Name": "BlueCoat"
 },
 {
 "DisplayName": "Brocade",
 "Name": "Brocade"
 },
 {
 "DisplayName": "Calix",
 "Name": "Calix"
 },
 {
 "DisplayName": "Cambium",
 "Name": "Cambium"
 },
 {
 "DisplayName": "CambiumNetworks",
 "Name": "CambiumNetworks"
 },
 {
 "DisplayName": "Canoga Perkins",
 "Name": "Canoga Perkins"
 },
 {
 "DisplayName": "Century Systems",
 "Name": "CenturySystems"
 },
 {
 "DisplayName": "CheckPoint",
 "Name": "CheckPoint"
 },
 {
 "DisplayName": "Ciena",
 "Name": "Ciena"
 },
 {
 "DisplayName": "Cisco",
 "Name": "Cisco"
 },
 {
 "DisplayName": "Citrix",
 "Name": "Citrix"
 },
 {
 "DisplayName": "Comnet",
 "Name": "Comnet"
 },
 {
 "DisplayName": "Coriant",
 "Name": "Coriant"
 },
 {
 "DisplayName": "Cumulus",
 "Name": "Cumulus"
 },
 {
 "DisplayName": "Dax",
 "Name": "Dax"
 },
 {
 "DisplayName": "DCNetworks",
 "Name": "DCNetworks"
 },
 {
 "DisplayName": "Dell",
 "Name": "Dell"
 },
 {
 "DisplayName": "Digi",
 "Name": "Digi"
 },
 {
 "DisplayName": "DLink",
 "Name": "DLink"
 },
 {
 "DisplayName": "DPtech",
 "Name": "DPtech"
 },
 {
 "DisplayName": "Edge-Core",
 "Name": "EdgeCore"
 },
 {
 "DisplayName": "Extreme (Enterasys)",
 "Name": "Enterasys"
 },
 {
 "DisplayName": "Ericsson",
 "Name": "Ericsson"
 },
 {
 "DisplayName": "EricssonRedback",
 "Name": "EricssonRedback"
 },
 {
 "DisplayName": "EtherWAN",
 "Name": "EtherWAN"
 },
 {
 "DisplayName": "Exinda",
 "Name": "Exinda"
 },
 {
 "DisplayName": "Extreme",
 "Name": "Extreme"
 },
 {
 "DisplayName": "F5",
 "Name": "F5"
 },
 {
 "DisplayName": "FiberHome",
 "Name": "FiberHome"
 },
 {
 "DisplayName": "Fibrolan",
 "Name": "Fibrolan"
 },
 {
 "DisplayName": "FireEye",
 "Name": "FireEye"
 },
 {
 "DisplayName": "Dell Force10",
 "Name": "Force10"
 },
 {
 "DisplayName": "Fortinet",
 "Name": "Fortinet"
 },
 {
 "DisplayName": "Foundry",
 "Name": "Foundry"
 },
 {
 "DisplayName": "FS",
 "Name": "FS"
 },
 {
 "DisplayName": "Fujitsu",
 "Name": "Fujitsu"
 },
 {
 "DisplayName": "Siemens (Garderos)",
 "Name": "Garderos"
 },
 {
 "DisplayName": "Gigamon",
 "Name": "Gigamon"
 },
 {
 "DisplayName": "H3C",
 "Name": "H3C"
 },
 {
 "DisplayName": "Hillstone",
 "Name": "Hillstone"
 },
 {
 "DisplayName": "Hirschmann",
 "Name": "Hirschmann"
 },
 {
 "DisplayName": "Hitachi Cable",
 "Name": "Hitachi Cable"
 },
 {
 "DisplayName": "Hitachi Energy",
 "Name": "HitachiEnergy"
 },
 {
 "DisplayName": "HPE",
 "Name": "HP"
 },
 {
 "DisplayName": "Huawei",
 "Name": "Huawei"
 },
 {
 "DisplayName": "IBM",
 "Name": "IBM"
 },
 {
 "DisplayName": "Infinity",
 "Name": "Infinity"
 },
 {
 "DisplayName": "Infoblox",
 "Name": "Infoblox"
 },
 {
 "DisplayName": "INSYS",
 "Name": "INSYS"
 },
 {
 "DisplayName": "Juniper",
 "Name": "Juniper"
 },
 {
 "DisplayName": "LANCOM",
 "Name": "LANCOM"
 },
 {
 "DisplayName": "Lenovo",
 "Name": "Lenovo"
 },
 {
 "DisplayName": "Maipu",
 "Name": "Maipu"
 },
 {
 "DisplayName": "McAfee",
 "Name": "McAfee"
 },
 {
 "DisplayName": "Mellanox",
 "Name": "Mellanox"
 },
 {
 "DisplayName": "MELNET",
 "Name": "MELNET"
 },
 {
 "DisplayName": "Fortinet (Meru)",
 "Name": "Meru"
 },
 {
 "DisplayName": "Microsens",
 "Name": "Microsens"
 },
 {
 "DisplayName": "Mikrotik",
 "Name": "Mikrotik"
 },
 {
 "DisplayName": "MimoMax",
 "Name": "MimoMax"
 },
 {
 "DisplayName": "Mistletoe",
 "Name": "Mistletoe"
 },
 {
 "DisplayName": "MobileIron",
 "Name": "MobileIron"
 },
 {
 "DisplayName": "Motorola",
 "Name": "Motorola"
 },
 {
 "DisplayName": "ADVA (MRV)",
 "Name": "MRV"
 },
 {
 "DisplayName": "NEC",
 "Name": "NEC"
 },
 {
 "DisplayName": "Netgear",
 "Name": "Netgear"
 },
 {
 "DisplayName": "Netonix",
 "Name": "Netonix"
 },
 {
 "DisplayName": "Juniper (NetScreen)",
 "Name": "Netscreen"
 },
 {
 "DisplayName": "Nokia",
 "Name": "Nokia"
 },
 {
 "DisplayName": "Nortel",
 "Name": "Nortel"
 },
 {
 "DisplayName": "Opengear",
 "Name": "Opengear"
 },
 {
 "DisplayName": "OPNSense",
 "Name": "OPNSense"
 },
 {
 "DisplayName": "PacketLight",
 "Name": "PacketLight"
 },
 {
 "DisplayName": "PaloAlto",
 "Name": "PaloAlto"
 },
 {
 "DisplayName": "PFSense",
 "Name": "PFSense"
 },
 {
 "DisplayName": "Proxim",
 "Name": "Proxim"
 },
 {
 "DisplayName": "Radware",
 "Name": "Radware"
 },
 {
 "DisplayName": "Raisecom",
 "Name": "Raisecom"
 },
 {
 "DisplayName": "Riverbed",
 "Name": "Riverbed"
 },
 {
 "DisplayName": "Ruckus",
 "Name": "Ruckus"
 },
 {
 "DisplayName": "Siemens (RuggedCom)",
 "Name": "RuggedCom"
 },
 {
 "DisplayName": "Ruijie",
 "Name": "Ruijie"
 },
 {
 "DisplayName": "Sangfor",
 "Name": "Sangfor"
 },
 {
 "DisplayName": "Siemens",
 "Name": "Siemens"
 },
 {
 "DisplayName": "Sphereon",
 "Name": "Sphereon"
 },
 {
 "DisplayName": "Tejas",
 "Name": "Tejas"
 },
 {
 "DisplayName": "Telco",
 "Name": "Telco"
 },
 {
 "DisplayName": "Trend Micro (TippingPoint)",
 "Name": "Tippingpoint"
 },
 {
 "DisplayName": "TOPS",
 "Name": "TOPS"
 },
 {
 "DisplayName": "TPLink",
 "Name": "TPLink"
 },
 {
 "DisplayName": "TransitionNetworks",
 "Name": "TransitionNetworks"
 },
 {
 "DisplayName": "Belden (Trapeze)",
 "Name": "Trapeze"
 },
 {
 "DisplayName": "Ubiquiti",
 "Name": "Ubiquiti"
 },
 {
 "DisplayName": "Vanguard",
 "Name": "Vanguard"
 },
 {
 "DisplayName": "Vubiq",
 "Name": "Vubiq"
 },
 {
 "DisplayName": "Vyatta",
 "Name": "Vyatta"
 },
 {
 "DisplayName": "WatchGuard",
 "Name": "WatchGuard"
 },
 {
 "DisplayName": "Welotec",
 "Name": "Welotec"
 },
 {
 "DisplayName": "XASJ",
 "Name": "XASJ"
 },
 {
 "DisplayName": "Yamaha",
 "Name": "Yamaha"
 },
 {
 "DisplayName": "ZTE",
 "Name": "ZTE"
 },
 {
 "DisplayName": "ZyXEL",
 "Name": "ZyXEL"
 }
 ]
}

Error Response

View common error responses

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

Get Device Type for Vendor

API EndPoint : deviceType

List All Device Type Supported for Particular Vendor

HTTP Method

GET

API URL

 http://localhost:8060/api/json/ncmsettings/deviceType?apiKey= ********&VENDOR_NAME=Adtran

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
VENDOR_NAME	Name of the vendor	-	^([p{L}p{N}+_s()-])+$	yes

Sample Response

HTTP Code: 200

{
 "deviceTypes": [
 "Adtran 800 Series Netvanta Router",
 "Adtran LAN Switch",
 "Adtran Netvanta Router"
 ]
}

Error Response

View common error responses

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

Check DNS Resolution Status

API EndPoint : checkDNSName

Checks whether DNS is Resolved or Not for the device

HTTP Method

POST

API URL

 http://localhost:8060/api/json/ncmsettings/checkDNSName?apiKey= ********&IPADDRESS=xxx.xxx.xx.x

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
IPADDRESS	IPAddress of the device	-	^([p{L}p{N}P{InBasicLatin}s.:-_])+$	yes

Sample Response

HTTP Code: 200

{
 "resolved": true
}

Error Response

View common error responses

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

Ping Device

API EndPoint : pingCheck

Ping the particular device to check its reachability

HTTP Method

POST

API URL

http://localhost:8060/api/json/ncmsettings/pingCheck?apiKey=********&IPADDRESS=xxx.xxx.xx.x

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
IPADDRESS	IPAddress of the device which needs to be verified for its reachability	-	^([p{L}p{N}P{InBasicLatin}s.:-_])+$	yes
fromAddDevice	@Only for UI rendering : Set as 'true', if the request is from "Add Device" page	boolean	-	No

Sample Response

HTTP Code: 200

{
  "PING_STATUS": true
}

Error Response

View common error responses

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

Get Associated Credential

API EndPoint : getCredentials

Provides the details on credentials that are applied manually to the devices and if credentials were applied via profile check "/ncmsettings/credentialPreRenders" api

HTTP Method

POST

API URL

http://localhost:8060/api/json/ncmsettings/getCredentials?apiKey=********&resourceIds=[101,102,103]

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
resourceIds	Unique identifier of the device.	JSONArray	-	yes

Sample Response

HTTP Code: 200

{
  "telnet_enableUserNamePrompt": ":",
  "snmp_writeCommunity": "",
  "snmp_contextName": "",
  "profile_telnet_loginName": true,
  "profile_snmp_userName": true,
  "profile_ssh_enablePasswordType": true,
  "ssh_loginPrompt": ":",
  "sshProfileName": "",
  "DOMINANT_PERS": "FortiGateFirewallVersion6",
  "telnet_enableUserName": "",
  "profile_telnet_enableUserName": true,
  "telnet_enableUserName_loaded_from_pam": false,
  "RESOURCEID_LIST": [
    2
  ],
  "telnet_port": "23",
  "ssh_enableUserName": "",
  "ssh_enablePasswordPrompt": ":",
  "ProtocolList": [
    "SSH",
    "SSH - TFTP",
    "TELNET",
    "TELNET - TFTP",
    "REST API"
  ],
  "SelectedProtocolList": "SSH",
  "profile_telnet_password": true,
  "snmp_authPassword": "",
  "profile_snmp_privProtocol": true,
  "ssh_enablePrompt": "",
  "profileDisplayList": [
    "Cisco140",
    "dsa",
    "Snmp_Public",
    "Snmp_Test",
    "Test"
  ],
  "snmp_version": "",
  "profile_telnet_enablePasswordType": true,
  "profile_ssh_enableUserName": true,
  "snmp_authProtocol": "",
  "profile_snmp_privPassword": true,
  "telnet_enablePasswordType": "",
  "ssh_loginName_loaded_from_pam": false,
  "profile_ssh_enablePassword": true,
  "ssh_enableUserName_loaded_from_pam": false,
  "telnet_loginName_loaded_from_pam": false,
  "ssh_port": "22",
  "profile_telnet_prompt": true,
  "telnet_enablePassword": "",
  "authMode": "password",
  "telnet_prompt": "",
  "telnet_loginName": "",
  "profile_snmp_writeCommunity": true,
  "ssh_passwordPrompt": ":",
  "profile_ssh_password": true,
  "telnet_enablePrompt": "",
  "sshKeyList": [
    "DSA Profile"
  ],
  "RESOURCENAME_LIST": [
    "10.5.X.X"
  ],
  "ssh_password": "not_to_display",
  "CREDENTIALVALIDITY": true,
  "profile_snmp_version": true,
  "telnetProfileName": "",
  "ssh_enablePasswordType": "enablePassword",
  "ssh_prompt": ">|#",
  "profile_ssh_prompt": true,
  "testResourceId": "2",
  "ssh_loginName": "root",
  "profile_snmp_port": true,
  "profile_snmp_contextName": true,
  "ssh_enableUserNamePrompt": ":",
  "isPasswordAuth": true,
  "telnet_loginPrompt": ":",
  "telnet_enablePasswordPrompt": ":",
  "profile_telnet_enablePassword": true,
  "profile_telnet_enablePrompt": true,
  "ssh_enablePassword": "",
  "snmp_readCommunity": "",
  "testNotSupportedText": "Test option is not supported for multiple device selection.",
  "profile_ssh_loginName": true,
  "telnet_passwordPrompt": ":",
  "telnet_password": "",
  "profile_ssh_enablePrompt": true,
  "snmp_userName": "",
  "snmp_privPassword": "",
  "snmp_privProtocol": "NO_PRIV",
  "snmpProfileName": "",
  "profile_snmp_readCommunity": true,
  "profile_snmp_authProtocol": true,
  "snmp_port": "161",
  "profile_snmp_authPassword": true,
  "enableTestOption": true
}

Error Response

View common error responses

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

Add Credential Profile

API EndPoint : addSharedProfile

Add the credential profile. Credentials can be either for SNMP or Telnet or SSH Connections

HTTP Method

POST

API URL

http://localhost:8060/api/json/ncmsettings/addSharedProfile?apiKey=********&IS_SNMP_PROFILE=true&PROFILENAME=Cisco_SNMP_Profile&snmp_port=161&snmp_version=3&snmp_username=admin&snmp_contextname=default&snmp_authprotocol=22&snmp_privprotocol=49&snmp_authpassword=password123&snmp_privpassword=secret456&snmp_readcommunity=public&snmp_writecommunity=writeonly&PROFILEDESCRIPTION=SNMP%20Profile%20for%20Cisco

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
IS_SNMP_PROFILE	Set of 'true' if it is an SNMP profile	boolean	-	No
PROFILENAME	Name of the profile	-	^([p{L}p{N}P{InBasicLatin}.!:@#$s-_\/',])+$	No
snmp_port	Port over which we need to communicate with SNMP	int	-	No
snmp_version	SNMP Version - Provide value as 3 for SNMP V3,1 for SNMP V1&V2C	int	-	No
snmp_username	Username to enable secure communication with device. Mandatory if going to associate SNMP V3 Profile	String	-	No
snmp_contextname	Name of the context which you want to read or write using SNMP	String	-	No
snmp_authprotocol	Authentication algorithm used to verify identity (20=None, 21=MD5 and 22=SHA)	-	^(20\|21\|22)$	No
snmp_privprotocol	Encryption alogorithm to be used on SNMP data (49=AES 128, 50=DES and 51=None)	-	^(49\|50\|51)$	No
snmp_authpassword	Password used with Auth Protocol to authenticate snmp user	String	-	No
snmp_privpassword	Password used for encryption. Mandatory if SNMP Priv Protocol is provided with a value	String	-	No
snmp_readcommunity	Similar to password. Provides only read access using SNMP	String	-	No
snmp_writecommunity	Similar to password. Provides read-write access using SNMP	String	-	No
telnet_loginname	Username of the network device for Telnet Connection	String	-	No
telnet_password	Password of the network device for Telnet Connection	String	-	No
telnet_prompt	Prompt received from network device after successfull authentication (eg: if hostname# is received then prompt is #)	String	-	No
telnet_enableUserName	Username of privilege command(eg: enable,clish,etc) if applicable for the network device	String	-	No
telnet_enablepassword	Password of privilege command(eg: enable,clish,etc) if applicable for the network device	String	-	No
telnet_enablepasswordType	Type of Enable Password the device expects. There are 3 types: 1. enablePassword - Usual format where, once the enable command is entered, the device asks for enable username and password. 2. noEnablePassword - Directly enters privilege mode once the enable command is entered. The device will not prompt for any credentials. 3. emptyEnablePassword - Once the enable command is sent, the device prompts for a password, but no password needs to be provided. Privilege access is granted by simply pressing Enter.	-	^(enablePassword\|noEnablePassword\|emptyEnablePassword)$	No
telnet_enableprompt	Prompt received from network device after successfull authentication of privilege command	String	-	No
ssh_loginname	Username of the network device for SSH Connection	String	-	No
ssh_password	Password of the network device for SSH Connection	String	-	No
ssh_prompt	Prompt received from network device after successfull authentication (eg: if hostname# is received then prompt is #)	String	-	No
ssh_enableUserName	Username of privilege command(eg: enable,clish,etc) if applicable for the network device	String	-	No
ssh_enablepassword	Password of privilege command(eg: enable,clish,etc) if applicable for the network device	String	-	No
ssh_enablepasswordType	Type of Enable Password the device expects. There are 3 types: 1. enablePassword - Usual format where once the enable command is entered, the device asks for enable username and password. 2. noEnablePassword - We directly enter into privilege mode once the enable command is entered. The device will not prompt for any credentials. 3. emptyEnablePassword - Once the enable command is sent, the device prompts for a password, but no password needs to be provided. Privilege access is obtained by simply pressing Enter.	-	^(enablePassword\|noEnablePassword\|emptyEnablePassword)$	No
ssh_enableprompt	Prompt received from network device after successfull authentication of privilege command	String	-	No
PROFILEDESCRIPTION	Description on credential profile	-	^([p{L}p{N}P{InBasicLatin}.!:#$s-_',])+$	No

Sample Response

HTTP Code: 200

{
  "statusMsg": "Credential profile Cisco140 has been 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

Get Credetial Profile Info

API EndPoint : credentialPreRenders

Provides the details of specific credential profile. We can fetch the details with either 'Profile Id' or 'Profile Name'

HTTP Method

GET

API URL

http://localhost:8060/api/json/ncmsettings/credentialPreRenders?apiKey=********&PROFILENAME=Cisco_SSH_Profile

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
PROFILEID	ID of the credential profile	long	-	No
PROFILENAME	Name of the profile	-	^([p{L}p{N}.!:@#$s-_\/',])+$	No

Sample Response

HTTP Code: 200

{
  "PROFILENAME": "Cisco SSH",
  "PROFILEDESCRIPTION": "",
  "PROFILEPROPERTIESMAP": {
    "SnmpPort": "161",
    "SSH_LoginName": "userTest",
    "PROFILENAME": "Cisco SSH",
    "TELNET_EnablePassword": "",
    "SSH_EnableUserName": "",
    "TELNET_EnablePrompt": "",
    "TELNET_Prompt": "",
    "TELNET_Password": "",
    "TELNET_EnablePasswordType": "enablePassword",
    "WriteCommunity": "",
    "ReadCommunity": "",
    "SSH_EnablePasswordType": "enablePassword",
    "TELNET_LoginName": "",
    "SnmpVersion": "0",
    "SSH_EnablePrompt": "#",
    "SSH_EnablePassword": "",
    "SSH_Prompt": ">|#",
    "TELNET_EnableUserName": "",
    "SSH_Password": "not_to_display"
  }
}

Error Response

View common error responses

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

Edit Credential Profile

API EndPoint : updateSharedProfile

Update the particular credential profile

HTTP Method

POST

API URL

http://localhost:8060/api/json/ncmsettings/updateSharedProfile?apiKey=********&PROFILEID=101&IS_SNMP_PROFILE=true&PROFILENAME=Cisco_SNMP_Profile&snmp_port=161&snmp_version=3&snmp_username=admin&snmp_contextname=default&snmp_authprotocol=22&snmp_privprotocol=49&snmp_authpassword=password123&snmp_privpassword=secret456&snmp_readcommunity=public&snmp_writecommunity=writeonly&PROFILEDESCRIPTION=Updated%20SNMP%20Profile%20for%20Cisco

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
PROFILEID	ID of the credential profile	long	-	yes
IS_SNMP_PROFILE	Set of 'true' if it is an SNMP profile	boolean	-	No
PROFILENAME	Name of the profile	-	^([p{L}p{N}P{InBasicLatin}.!:@#$s-_\/',])+$	No
snmp_port	Port over which we need to communicate with SNMP	int	-	No
snmp_version	SNMP Version - Provide value as 3 for SNMP V3,1 for SNMP V1&V2C	int	-	No
snmp_username	Username to enable secure communication with device. Mandatory if going to associate SNMP V3 Profile	String	-	No
snmp_contextname	Name of the context which you want to read or write using SNMP	String	-	No
snmp_authprotocol	Authentication algorithm used to verify identity (20=None, 21=MD5 and 22=SHA)	-	^(20\|21\|22)$	No
snmp_privprotocol	Encryption alogorithm to be used on SNMP data (49=AES 128, 50=DES and 51=None)	-	^(49\|50\|51)$	No
snmp_authpassword	Password used with Auth Protocol to authenticate snmp user	String	-	No
snmp_privpassword	Password used for encryption. Mandatory if SNMP Priv Protocol is provided with a value	String	-	No
snmp_readcommunity	Similar to password. Provides only read access using SNMP	String	-	No
snmp_writecommunity	Similar to password. Provides read-write access using SNMP	String	-	No
telnet_loginname	Username of the network device for Telnet Connection	String	-	No
telnet_password	Password of the network device for Telnet Connection	String	-	No
telnet_prompt	Prompt received from network device after successfull authentication (eg: if hostname# is received then prompt is #)	String	-	No
telnet_enableUserName	Username of privilege command(eg: enable,clish,etc) if applicable for the network device	String	-	No
telnet_enablepassword	Password of privilege command(eg: enable,clish,etc) if applicable for the network device	String	-	No
telnet_enablepasswordType	Type of Enable Password the device expects. There are 3 types 1. enablePassword - Usual format where once enable command is entered devices asks for enable username and password 2. noEnablePassword - We directly enter into privilege mode once enable command is entered. Device won't prompt for any credentials 3. emptyEnablePassword - Once enable command is send device prompts for password. But password need not be provided. You get privilege access just with an enter	-	^(enablePassword\|noEnablePassword\|emptyEnablePassword)$	No
telnet_enableprompt	Prompt received from network device after successfull authentication of privilege command	String	-	No
ssh_loginname	Username of the network device for SSH Connection	String	-	No
ssh_password	Password of the network device for SSH Connection	String	-	No
ssh_prompt	Prompt received from network device after successfull authentication (eg: if hostname# is received then prompt is #)	String	-	No
ssh_enableUserName	Username of privilege command(eg: enable,clish,etc) if applicable for the network device	String	-	No
ssh_enablepassword	Password of privilege command(eg: enable,clish,etc) if applicable for the network device	String	-	No
ssh_enablepasswordType	Type of Enable Password the device expects. There are 3 types 1. enablePassword - Usual format where once enable command is entered devices asks for enable username and password 2. noEnablePassword - We directly enter into privilege mode once enable command is entered. Device won't prompt for any credentials 3. emptyEnablePassword - Once enable command is send device prompts for password. But password need not be provided. You get privilege access just with an enter	-	^(enablePassword\|noEnablePassword\|emptyEnablePassword)$	No
ssh_enableprompt	Prompt received from network device after successfull authentication of privilege command	String	-	No
PROFILEDESCRIPTION	Description of the credential profile	-	^([p{L}p{N}P{InBasicLatin}.!:#$s-_',])+$	No

Sample Response

HTTP Code: 200

{
  "statusMsg": "Credential profile Cisco140 has been updated and the credential update process for the associated devices 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 Configlet Pre Execution Details

API EndPoint : exeTemplatePreRenders

Provides the necessary details needed to execute a specified configlet, allowing validation before actual execution.

HTTP Method

GET

API URL

http://localhost:8060/api/json/ncmsettings/exeTemplatePreRenders?apiKey=********&TEMPLATE_ID=12

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
TEMPLATE_ID	ID of the configlet	long	-	No
TEMPLATE_NAME	Specify the name of the template to be referenced.	-	^([p{L}p{N}.!:@#$s-_\/',])+$	No
IS_REMEDIATION	Indicates whether the template is used for remediation purposes. Set to true if the template performs corrective actions when a compliance rule fails on a device. This flag is used to render remediation configlets in the UI.	boolean	-	No
comprule_id	Identifier of the compliance rule associated with the remediation template. Used to render the remediation configlet linked to the corresponding rule in the UI.	long	-	No
policy_id	Specify the compliance policy id to which the rule with remediation template is associated. It is used to render remediation configlet associated with them in UI	long	-	No

Sample Response

HTTP Code: 200

{
  "templateType": "COMMAND_LINE_MODE",
  "IsDeviceGroupSelected": false,
  "LoginId": 1,
  "UnselectedHostMap": {
    "1": "10.5.x.x",
    "2": "10.5.x.x",
    "3": "10.5.x.x",
    "4": "10.5.x.x"
  },
  "TEMPLATE_VAR_LIST": [],
  "defaultParams": {
    "NETFLOW_IP": "10.5.x.x",
    "SERVER_IP": "10.5.x.x",
    "OPM_SERVER_IP": "10.5.x.x",
    "FWA_SYSLOG_PORT": 1514,
    "NCM_SERVER_IP": "10.5.x.x",
    "NCM_SYSLOG_PORT": 514,
    "NETFLOW_PORT": "9996"
  },
  "DeviceGroupMap": {
    "1": "All Devices Group",
    "2": "CiscoRouter Group",
    "3": "CiscoSwitch Group",
    "4": "Backup Failure Group"
  },
  "DeviceGroupDescriptionMap": {
    "1": "ncm.default_devicegroup.description",
    "2": "This device group contains all the cisco routers present in the inventory",
    "3": "This device group contains all the cisco switches present in the inventory",
    "4": "This device group contains all the cisco routers present in the inventory"
  },
  "templateId": 12,
  "vendorName": "All",
  "tagName": "Los Angeles",
  "SHOW_ADD_DEVICEGROUP_LINK": true,
  "TEMPLATE_CONTENTS": "show version",
  "BACKUP_BEFORE_TEMPLATE": true,
  "templateName": "Testing Script",
  "ConfigletTypes": {
    "ADVANCED_COMMAND_LINE_MODE": "Advanced Script Execution Mode",
    "COMMAND_LINE_MODE": "Script Execution Mode",
    "TFTP_FILE_TRANSFER_MODE": "File Transfer Mode"
  },
  "SelectedHostSortedMap": [],
  "commandLineMode": true,
  "BACKUP_AFTER_TEMPLATE": true,
  "TEMPLATE_TYPE": "Execute",
  "SelectedHostMap": {}
}

Error Response

View common error responses

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

Get Configlet Details

API EndPoint : configletPreRenders

This API fetches all necessary details and dependencies required to preview or validate the configlet content prior adding or editing it

HTTP Method

GET

API URL

http://localhost:8060/api/json/ncmsettings/configletPreRenders?apiKey=********&TEMPLATE_ID=8

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
TEMPLATE_ID	Unique identifier of the configlet to be pre-rendered before editing.	long	-	No
DEVICETEMPLATEID	Unique identifier of the device template to which the configlet is associated	long	-	No

Sample Response

HTTP Code: 200

{
  "TEMPLATE_NAMES": [
    "Cisco_Syslog_Configurations",
    "SNMP_Disable",
    "Cisco_Change_Password_Script",
    "Cisco_PIX_ASA_7_x_Forward_Syslog_Script",
    "Cumulus VLAN Creation"
  ],
  "VendorName": "AlliedTelesis",
  "Description": "Disable syslog for AlliedTelesis CenterCom 87XX",
  "TemplateType": "COMMAND_LINE_MODE",
  "templateId": "8",
  "TemplateContents": "destroy log output=$logout_no",
  "VENDOR_NAMES": [
    {
      "DisplayName": "All",
      "Name": "All"
    },
    {
      "DisplayName": "HPE (3Com)",
      "Name": "3Com"
    },
    {
      "DisplayName": "A10Networks",
      "Name": "A10Networks"
    },
    {
      "DisplayName": "ZyXEL",
      "Name": "ZyXEL"
    }
  ],
  "BACKUP_BEFORE_TEMPLATE": true,
  "ConfigletTypes": {
    "ADVANCED_COMMAND_LINE_MODE": "Advanced Script Execution Mode",
    "COMMAND_LINE_MODE": "Script Execution Mode",
    "TFTP_FILE_TRANSFER_MODE": "File Transfer Mode",
    "PROG_CONFIGLET_MODE": "Programmable Configlets Mode"
  },
  "executionContext": "Multiple_Device",
  "BACKUP_AFTER_TEMPLATE": true,
  "TemplateName": "AlliedTelesis_87XX_Disable_Change_detection",
  "LOGIN_NAME": "system"
}

Error Response

View common error responses

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

Delete Schedule Audit

API EndPoint : deleteScheduleAudit

Deletes a specific schedule audit entry

HTTP Method

POST

API URL

http://localhost:8060/api/json/ncmsettings/deleteScheduleAudit?apiKey=********&AUDIT_ID=[101,102,103]

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
AUDIT_ID	Unique identifier of the schedule audit to be deleted.	JSONArray	-	No

Sample Response

HTTP Code: 200

{
  "statusMsg": "The selected schedule audit records have been deleted successfully",
  "isSuccess": true
}

Error Response

View common error responses

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

Delete Credential Profile

API EndPoint : deleteCredentials

Deletes a specific credential profile

HTTP Method

POST

API URL

http://localhost:8060/api/json/ncmsettings/deleteCredentials?apiKey=********&PROFILEID=[101,102,103]

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
PROFILEID	Unique identifier of the credential profile to be deleted.	JSONArray	-	yes

Sample Response

HTTP Code: 200

{
  "statusMsg": "Credential profile(s) have been removed 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 Command Details

API EndPoint : commandPreRender

Pre-renders the details of a show command before adding or updating it, allowing validation and preview

HTTP Method

GET

API URL

http://localhost:8060/api/json/ncmsettings/commandPreRender?apiKey=********&commandId=101

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
commandId	Unique identifier of the show command to be pre-rendered.	long	-	No

Sample Response

HTTP Code: 200

{
  "Command": "show version",
  "id": 5,
  "Vendor": 57,
  "vendors": [
    {
      "DisplayName": "HPE (3Com)",
      "id": 3
    },
	{
      "DisplayName": "Cisco",
      "id": 5
    },
    {
      "DisplayName": "XASJ",
      "id": 120
    },
    {
      "DisplayName": "Yamaha",
      "id": 31
    },
    {
      "DisplayName": "ZTE",
      "id": 54
    },
    {
      "DisplayName": "ZyXEL",
      "id": 99
    }
  ],
  "CommandAlias": "show version"
}

Error Response

View common error responses

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

List All Sysoids

API EndPoint : allSysOID

Retrieves a list of all standard SYSOID (System Object Identifiers)

HTTP Method

GET

API URL

http://localhost:8060/api/json/ncmsettings/allSysOID?apiKey=********&DEVICETEMPLATEID=101

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
DEVICETEMPLATEID	ID of the device template whose SYSOID list is to be fetched.	long	-	No
jqgrid_id	jqgrid_id = DESysObjectIdList 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
DeviceTemplateName	NCMDeviceTemplate__DISPLAYNAME
Model	NCMDeviceSysOID__MODEL
Series	NCMDeviceSysOID__SERIES
SysObjectID	NCMDeviceSysOID__SYSOID

Sample Response

HTTP Code: 200

{
  "total": 1,
  "records": "9",
  "page": 1,
  "rows": [
    {
      "id": ".10.5.X.X.4.1.1010.5.X.X",
      "cell": [
        ".10.5.X.X.4.1.1010.5.X.X",
        "Avocent ACS",
        "acs8008",
        "ACS 8000",
        ".10.5.X.X.4.1.1010.5.X.X"
      ]
    },
    {
      "id": ".10.5.X.X.4.1.10418.16.2",
      "cell": [
        ".10.5.X.X.4.1.10418.16.2",
        "Avocent ACS",
        "6048",
        "ACS 6000",
        ".10.5.X.X.4.1.10418.16.2"
      ]
    },
    {
      "id": ".10.5.X.X.4.1.1010.5.X.X",
      "cell": [
        ".10.5.X.X.4.1.1010.5.X.X",
        "Avocent ACS",
        "6016",
        "ACS 6000",
        ".10.5.X.X.4.1.1010.5.X.X"
      ]
    },
    {
      "id": ".10.5.X.X.4.1.1010.5.X.X",
      "cell": [
        ".10.5.X.X.4.1.1010.5.X.X",
        "Avocent ACS",
        "6032",
        "ACS 6000",
        ".10.5.X.X.4.1.1010.5.X.X"
      ]
    },
    {
      "id": ".10.5.X.X.4.1.1010.5.X.X",
      "cell": [
        ".10.5.X.X.4.1.1010.5.X.X",
        "Avocent ACS",
        "6048",
        "ACS 6000",
        ".10.5.X.X.4.1.1010.5.X.X"
      ]
    },
    {
      "id": ".10.5.X.X.4.1.1010.5.X.X",
      "cell": [
        ".10.5.X.X.4.1.1010.5.X.X",
        "Avocent ACS",
        "6004",
        "ACS 6000",
        ".10.5.X.X.4.1.1010.5.X.X"
      ]
    },
    {
      "id": ".10.5.X.X.4.1.1010.5.X.X",
      "cell": [
        ".10.5.X.X.4.1.1010.5.X.X",
        "Avocent ACS",
        "6008",
        "ACS 6000",
        ".10.5.X.X.4.1.1010.5.X.X"
      ]
    },
    {
      "id": ".10.5.X.X.4.1.2010.5.X.X",
      "cell": [
        ".10.5.X.X.4.1.2010.5.X.X",
        "Century Systems NXR Series",
        "NXR-G100S",
        "",
        ".10.5.X.X.4.1.2010.5.X.X"
      ]
    },
    {
      "id": ".10.5.X.X.4.1.6141.1.104",
      "cell": [
        ".10.5.X.X.4.1.6141.1.104",
        "Ciena Switch",
        "3928",
        "Ciena 3900",
        ".10.5.X.X.4.1.6141.1.104"
      ]
    }
  ]
}

Error Response

View common error responses

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

Execute Configlet

API EndPoint : execConfiglet

Executes a specific configlet on the selected devices or device groups. The API allows setting pre/post backup preferences and defining script variables during execution.

HTTP Method

POST

API URL

http://localhost:8060/api/json/ncmsettings/execConfiglet?apiKey=********&ComponentSelection=DeviceGroup&DEVICEGROUPSELECTION=14&TEMPLATE_ID=87&BACKUP_BEFORE_TEMPLATE=true&BACKUP_AFTER_TEMPLATE=true

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
DEVICEGROUPSELECTION	Identifier of the selected device group on which the configlet should be executed.Applicable if "DeviceGroup" is provided	long	-	No
EXEC_TYPE	Use this parameter and set its value to "REMEDIATION" only when executing the configlet to resolve violations triggered by failed compliance rules.	-	^(REMEDIATION_d+)	No
TEMPLATE_ID	Unique identifier of the configlet to be executed.	long	-	No
ComponentSelection	Mode of device selection. Choose either of the following Device Group - If wants to execute configlet on a specific group of devices SpecificDevice - If wants to execute configlet on specific set of devices	-	^(DeviceGroup\|SpecificDevice)$	No
SELECTEDDEVICES	List of resource Ids on the which configlet wants be executed. Applicable if "SpecificDevice" is provided	JSONArray	-	No
BACKUP_BEFORE_TEMPLATE	Indicates whether to perform a backup before executing the configlet	boolean	-	No
BACKUP_AFTER_TEMPLATE	Indicates whether to perform a backup after executing the configlet	boolean	-	No
VARIABLES	Defines variable names and their corresponding values used in the configlet script. Format: {"variable1":"val1","variable2":"val2"} Eg : {"logout_no","5"}	JSONObject	-	No
VAR_NAME	@Depricated param	JSONArray	-	No

Sample Response

HTTP Code: 200

{
  "EXECUTION_ID": 8,
  "statusMsg": "Upload of template Cisco_Show_Version_Script to the selected device group is in progress",
  "downloadNeedsApproval": false,
  "isSuccess": true
}

Error Response

View common error responses

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

Execute Flow Configlet

API EndPoint : exportFlowConfig

Executes the Flow Export Configlet, which is used to export configuration flows for the specified devices.

HTTP Method

POST

API URL

http://localhost:8060/api/json/ncmsettings/exportFlowConfig?apiKey=********&RESOURCE_IDS=[101,102,103]

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
RESOURCE_IDS	Resource ids of the devices	JSONArray	-	No
Configlets	Details of configlets that needs to be applied to the device. Json array should be in below format [{"Id":"{{Configlet Id}}","TemplateContents": "{{Actual configlet script that needs to be applied}}","TemplateName":"{{Configlet Name}},"TemplateType":"{{Type of configlet . It can be COMMAND_LINE_MODE or ADVANCED_COMMAND_LINE_MODE or TFTP_FILE_TRANSFER_MODE}}","Description":"{{Description of the template}}"}]	JSONArray	-	No

Sample Response

HTTP Code: 200

{
  "statusMsg": "Upload of template CiscoRouter_FlowExport to the selected device(s) is in progress",
  "isSuccess": true
}

Error Response

View common error responses

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

CLI Configlet Execution Summary

API EndPoint : detailedExecResult

Retrieves detailed results of a specific configlet execution

HTTP Method

GET

API URL

http://localhost:8060/api/json/ncmsettings/detailedExecResult?apiKey=********&EXECUTION_ID=101

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
EXECUTION_ID	Unique identifier of the configlet execution whose details are to be retrieved.	long	-	yes
jqgrid_id	jqgrid_id = DEDetailedExecList 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 = NCMBulkExecutionStatus__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 = NCMBulkExecutionStatus__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":"NCMBulkExecutionStatus__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	NCMBulkExecutionStatus__RESOURCENAME
IP Address	NCMResource__ADDRESS
Execution Status	NCMOperationAudit__OPERATIONSTATUS
Description	NCMOperationAudit__MESSAGE
Executed At	NCMOperationAudit__EXECUTEDON

Sample Response

HTTP Code: 200

{
  "total": 1,
  "records": "2",
  "page": 1,
  "rows": [
    {
      "id": 9006,
      "cell": [
        9006,
        "192.168.50.131",
        "192.168.50.131",
        "SUCCESS",
        "Script executed successfully",
        "Nov 10, 2025 10:35 AM",
        "[RESPONSE_START][RESPONSE_END][COMMAND_START]enable[COMMAND_END][RESPONSE_START]nPassword: [RESPONSE_END][COMMAND_START]**********[COMMAND_END][RESPONSE_START]nCISCO131#[RESPONSE_END][COMMAND_START]show version[COMMAND_END][RESPONSE_START]nCisco IOS Software, 2801 Software (C2801-ADVENTERPRISEK9-M), Version 15.1(3)T1, RELEASE SOFTWARE (fc2)nTechnical Support: http://www.cisco.com/techsupportnCopyright (c) 1986-2011 by Cisco Systems, Inc.nCompiled Sun 27-Mar-11 07:15 by prod_rel_teamnnROM: System Bootstrap, Version 12.4(13r)T, RELEASE SOFTWARE (fc1)nnCISCO131 uptime is 17 weeks, 6 days, 23 hours, 53 minutesnSystem returned to ROM by reload at 05:06:21 UTC Mon Jul 7 2025nSystem image file is flash:c2801-adventerprisek9-mz.151-3.T4.bin nLast reload type: Normal ReloadnnThis product contains cryptographic features and is subject to UnitednStates and local country laws governing import, export, transfer andnuse. Delivery of Cisco cryptographic products does not implynthird-party authority to import, export, distribute or use encryption.nImporters, exporters, distributors and users are responsible forncompliance with U.S. and local country laws. By using this product younagree to comply with applicable laws and regulations. If you are unablento comply with U.S. and local laws, return this product immediately.nnA summary of U.S. laws governing Cisco cryptographic products may be found at:nhttp://www.cisco.com/wwl/export/crypto/tool/stqrg.htmlnnIf you require further assistance please contact us by sending email tonexport@cisco.com.nnCisco 2801 (revision 6.0) with 241664K/20480K bytes of memory.nProcessor board ID FHK1112F402n2 FastEthernet interfacesn1 Virtual Private Network (VPN) Modulen3 DSPs, 40 Voice resourcesnDRAM configuration is 64 bits wide with parity disabled.n191K bytes of NVRAM.n62720K bytes of ATA CompactFlash (Read/Write)nnLicense Info:nnLicense UDI:n-------------------------------------------------nDevice#tPIDttSNn-------------------------------------------------n*0tCISCO2801tFHK1112F402nnConfiguration register is 0x2142nnCISCO131#[RESPONSE_END]",
        "&CUSTOMIZE_DATA_VIEWNAME=CustomTemplateResultView&EXECUTION_ID=58215&RESOURCE_ID=9006",
        ""
      ]
    },
    {
      "id": 60304,
      "cell": [
        60304,
        "192.126.50.140",
        "192.126.50.140",
        "FAILURE",
        "Failure occured during the operation execution",
        "Nov 10, 2025 10:35 AM",
        "[RESPONSE_START][RESPONSE_END][COMMAND_START]Device response not available.[COMMAND_END]",
        "&CUSTOMIZE_DATA_VIEWNAME=CustomTemplateResultView&EXECUTION_ID=58215&RESOURCE_ID=60304",
        ""
      ]
    }
  ]
}

Error Response

View common error responses

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

Get Server Settings

API EndPoint : serverSettings

Fetches pre-rendered details of current server settings such as TFTP, SCP, and SYSLOG configurations

HTTP Method

GET

API URL

http://localhost:8060/api/json/ncmsettings/serverSettings?apiKey=********

Parameters

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

Sample Response

HTTP Code: 200

{
  "THREAD_COUNT": "20",
  "syslogServerDetail": "allip",
  "SCP_ADDRESS": "172.24.138.26",
  "SYSLOG_SERVER_STATUS": "startsyslog",
  "TFTP_ADDRESS": "172.24.138.26",
  "SCP_SERVER_STATUS": "startscp",
  "TFTP_SERVER_STATUS": "starttftp",
  "SYSLOG_PORT": [
    "519",
    "514"
  ],
  "SYSLOG_ADDRESS": "172.24.138.26",
  "SCP_RUNNING": true,
  "scpServerDetail": "allip",
  "SYSLOG_RUNNING": true,
  "isScpPwdChanged": true,
  "tftpServerDetail": "allip",
  "TFTP_RUNNING": true,
  "LOCALHOST": "localhost (172.24.138.26)",
  "SERVER_ADDR": [
    "192.168.217.1",
    "192.168.114.1"
  ]
}

Error Response

View common error responses

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

Edit Server Settings

API EndPoint : updateServerSettings

Updates the existing server configuration settings including TFTP, SCP, and SYSLOG servers

HTTP Method

POST

API URL

http://localhost:8060/api/json/ncmsettings/updateServerSettings?apiKey=********&TFTP_COMBO_IP=allip&TFTP_BOX_VISIBLE=192.168.1.10&TFTP_BOX_HIDDEN=192.168.1.11&TFTP_OPERATIONS=starttftp&SCP_COMBO_IP=localhost&SCP_BOX_VISIBLE=192.168.1.12&SCP_BOX_HIDDEN=192.168.1.13&SCP_OPERATIONS=startscp&SYSLOG_COMBO_IP=192.168.1.14&SYSLOG_BOX_VISIBLE=192.168.1.15&SYSLOG_BOX_HIDDEN=192.168.1.16&SYSLOG_OPERATIONS=startsyslog&SYSLOG_PORT=514,515&THREAD_COUNT=10

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
TFTP_COMBO_IP	IP address for TFTP operations (supports allip, localhost, or specific IP).	-	^((allip\|localhost)\|(?:(?: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
TFTP_BOX_VISIBLE	IP address of the visible TFTP interface.	-	^(?:(?: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
TFTP_BOX_HIDDEN	IP address of the hidden TFTP interface.	-	^(?:(?: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
TFTP_OPERATIONS	Specifies the operation to perform on the TFTP server. Valid values are: * starttftp — to start the TFTP server * stoptftp — to stop the TFTP server	-	^(starttftp\|stoptftp)$	yes
SCP_COMBO_IP	IP address for SCP operations (supports allip, localhost, or specific IP).	-	^((allip\|localhost)\|(?:(?: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
SCP_BOX_VISIBLE	IP address of the visible SCP interface.	-	^(?:(?: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
SCP_BOX_HIDDEN	IP address of the hidden SCP interface.	-	^(?:(?: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
SCP_OPERATIONS	Specifies the operation to perform on the SCP server. Valid values are: * startscp — to start the SCP server * stopscp — to stop the SCP server	-	^(startscp\|stopscp)$	yes
SYSLOG_COMBO_IP	IP address for SYSLOG operations (supports allip, localhost, or specific IP).	-	^((allip\|localhost)\|(?:(?: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
SYSLOG_BOX_VISIBLE	IP address of the visible SYSLOG interface.	-	^(?:(?: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
SYSLOG_BOX_HIDDEN	IP address of the hidden SYSLOG interface.	-	^(?:(?: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
SYSLOG_OPERATIONS	Specifies the operation to perform on the Syslog server. Valid values are: * startsyslog — to start the Syslog server * stopsyslog — to stop the Syslog server	-	^(startsyslog\|stopsyslog)$	yes
SYSLOG_PORT	Port(s) to be used for SYSLOG communication. Supports comma-separated values.	-	^(6553[0-5]\|655[0-2][0-9]\|65[0-4][0-9]{2}\|6[0-4][0-9]{3}\|[1-5][0-9]{4}\|[1-9][0-9]{1,3}\|[0-9])(,(6553[0-5]\|655[0-2][0-9]\|65[0-4][0-9]{2}\|6[0-4][0-9]{3}\|[1-5][0-9]{4}\|[1-9][0-9]{1,3}\|[0-9]))*$	yes
THREAD_COUNT	Number of threads to be used for ncm server operations.	int	-	yes

Sample Response

HTTP Code: 200

{
  "statusMsg": "Configuration changes 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

List Line Exclude Criteria

API EndPoint : excludeCriteria

Retrieves a list of all custom exclusion criteria configured

HTTP Method

GET

API URL

http://localhost:8060/api/json/ncmsettings/excludeCriteria?apiKey=********

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
jqgrid_id	jqgrid_id = DEExcludeCriteriaList 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 = NCMPersonality__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 = NCMPersonality__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":"NCMPersonality__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
Device Type	NCMPersonality__DISPLAYNAME
Criteria	CustExcludeCriteria__CRITERIA

Sample Response

HTTP Code: 200

{
  "total": 1,
  "records": "1",
  "page": 1,
  "rows": [
    {
      "id": 1,
      "cell": [
        1,
        "FortiOS Device",
        ".*set ENC pass.*",
        ""
      ]
    }
  ]
}

Error Response

View common error responses

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

Get Device Template Details

API EndPoint : getDeviceTemplateDetails

Retrieves detailed information about a specific device template allowing preview before actual changes

HTTP Method

GET

API URL

http://localhost:8060/api/json/ncmsettings/getDeviceTemplateDetails?apiKey=********&DEVICETEMPLATEID=101

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
DEVICETEMPLATEID	Unique identifier of the device template.	long	-	yes
IS_CLONE	Flag indicating whether the device template is a cloned one or not	boolean	-	No

Sample Response

HTTP Code: 200

{
  "template": [
    {
      "isMultiConfigTemplate": false,
      "operations": [
        "Startup",
        "Running",
        "Vlan",
        "Interface",
        "Inventory",
        "Vtp",
        "Flash",
        "Ip route",
        "Ip bgp summary",
        "Ip ospf neighbor"
      ],
      "DESCRIPTION": "",
      "displayName": "Cisco Catalyst Switch",
      "OSTYPE": "[NA]",
      "TEMPLATENAME": "Cisco_Catalyst_Switch",
      "DEVICETEMPLATEID": 906
    }
  ],
  "isMultiConfigTemplate": false,
  "displayName": "Cisco Catalyst Switch",
  "sysOid": [],
  "PERSONALITYNAME": "CiscoSwitch",
  "VENDORNAME": "Cisco",
  "DEVICETEMPLATEID": 906,
  "LOGGING_LEVEL": "notifications,informational,debugging",
  "operations": [
    "Startup",
    "Running",
    "Vlan",
    "Interface",
    "Inventory",
    "Vtp",
    "Flash",
    "Ip route",
    "Ip bgp summary",
    "Ip ospf neighbor"
  ],
  "VENDORID": 1,
  "protocolCombination": [
    {
      "protocol": "SSH/TELNET",
      "devProtId": [1517, 1518],
      "protocolIds": "ssh_telnet"
    }
  ],
  "BASETEMPLATEID": 21,
  "personality": [
    {
      "PERSONALITYNAME": "CiscoSwitch",
      "PERSONALITYID": 1
    }
  ],
  "vendor": [
    {
      "VENDORID": 1,
      "VENDORNAME": "Cisco",
      "LOGGING_LEVEL": "notifications,informational,debugging"
    }
  ],
  "baseTemplates": [
    {
      "personalityMap": {
        "personalityName": "CiscoRouter",
        "personalityId": "2"
      },
      "templateName": "Cisco IOS Router",
      "baseTemplateId": 20
    },
    {
      "personalityMap": {
        "personalityName": "CiscoSwitch",
        "personalityId": "1"
      },
      "templateName": "Cisco IOS Switch",
      "baseTemplateId": 21,
      "selected": true
    },
    {
      "personalityMap": {
        "personalityName": "CiscoAccessPoint",
        "personalityId": "5"
      },
      "templateName": "Cisco Aironet AccessPoint",
      "baseTemplateId": 22
    },
    {
      "personalityMap": {
        "personalityName": "CiscoAccessServer",
        "personalityId": "7"
      },
      "templateName": "Cisco Access Server",
      "baseTemplateId": 23
    },
    {
      "personalityMap": {
        "personalityName": "CiscoASA",
        "personalityId": "9"
      },
      "templateName": "Cisco ASA",
      "baseTemplateId": 24
    },
    {
      "personalityMap": {
        "personalityName": "CiscoNexusSwitch",
        "personalityId": "18"
      },
      "templateName": "Cisco Nexus Switch",
      "baseTemplateId": 42
    },
    {
      "personalityMap": {
        "personalityName": "CiscoCatalyst9200",
        "personalityId": "280"
      },
      "templateName": "Cisco Catalyst 9200 Switch",
      "baseTemplateId": 374
    },
    {
      "personalityMap": {
        "personalityName": "CiscoSwitch",
        "personalityId": "1"
      },
      "templateName": "Cisco Catalyst Switch",
      "baseTemplateId": 906
    }
  ],
  "OSTYPE": "[NA]",
  "PERSONALITYID": 1,
  "TEMPLATENAME": "Cisco_Catalyst_Switch",
  "categories": [
    "Load Balancer",
    "Switch",
    "Server",
    "Access Point",
    "Router",
    "General",
    "Controller",
    "Firewall"
  ],
  "category": "Switch",
  "BASETEMPLATENAME": "Cisco IOS Switch"
}

Error Response

View common error responses

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

Get SNMP Trap Settings

API EndPoint : snmpTrapSettingsPreRender

Pre-renders the SNMP Trap settings, allowing a preview of current configuration before updating

HTTP Method

GET

API URL

http://localhost:8060/api/json/ncmsettings/snmpTrapSettingsPreRender?apiKey=********

Parameters

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

Sample Response

HTTP Code: 200

{
  "TRAP_COMMUNITY": "not_to_display",
  "TRAP_MGR_PORT": "162",
  "TRAP_MGR_HOST": "",
  "isSuccess": true
}

Error Response

View common error responses

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

Get Custom Column

API EndPoint : getCustColumns

Retrieves all user-defined custom column configurations.

HTTP Method

GET

API URL

http://localhost:8060/api/json/ncmsettings/getCustColumns?apiKey=********

Parameters

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

Sample Response

HTTP Code: 200

{
  "COLUMN_NAME1": "Location",
  "COLUMN_NAME2": "Customer",
  "COLUMN_NAME3": "Group",
  "COLUMN_VALUE1": "TamilNadu",
  "COLUMN_VALUE2": "xyz",
  "COLUMN_VALUE3": "Group A"
}

Error Response

View common error responses

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

Get NCM Diff Limit

API EndPoint : getNCMDiffLimit

Fetches the current diff content limit configuration for NCM.Get Diff Content Limit

HTTP Method

GET

API URL

http://localhost:8060/api/json/ncmsettings/getNCMDiffLimit?apiKey=********

Parameters

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

Sample Response

HTTP Code: 200

{
    "NCM_DIFF_LIMIT": "5000"
}

Error Response

View common error responses

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

Delete Device Template

API EndPoint : deleteDeviceTemplate

Deletes a specific device template

HTTP Method

POST

API URL

http://localhost:8060/api/json/ncmsettings/deleteDeviceTemplate?apiKey=********&DEVICETEMPLATEID=101

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
DEVICETEMPLATEID	Unique ID of the device template to delete.	long	-	yes

Sample Response

HTTP Code: 200

{
  "statusMsg": "Device template Transition Networks Switch is deleted 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 SSH Settings

API EndPoint : getSSHSettings

Fetches SSH configuration details like supported ciphers, key exchange, and hmacs

HTTP Method

GET

API URL

http://localhost:8060/api/json/ncmsettings/getSSHSettings?apiKey=********

Parameters

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

Sample Response

HTTP Code: 200

{
  "ncm.ssh.blockCipherSuites": [],
  "supportedCipherSuits": [
    "aes256-gcm@openssh.com",
    "aes128-gcm@openssh.com",
    "chacha20-poly1305@openssh.com",
    "aes256-ctr",
    "aes192-ctr",
    "aes128-ctr",
    "arcfour256",
    "aes256-cbc",
    "3des-cbc",
    "3des-ctr",
    "aes192-cbc",
    "aes128-cbc",
    "blowfish-cbc",
    "arcfour128",
    "arcfour"
  ],
  "supportedKeyExchanges": [
    "curve25519-sha256",
    "curve25519-sha256@libssh.org",
    "diffie-hellman-group18-sha512",
    "diffie-hellman-group17-sha512",
    "diffie-hellman-group16-sha512",
    "diffie-hellman-group15-sha512",
    "diffie-hellman-group14-sha256",
    "diffie-hellman-group-exchange-sha256",
    "rsa2048-sha256",
    "ecdh-sha2-nistp521",
    "ecdh-sha2-nistp384",
    "ecdh-sha2-nistp256",
    "rsa1024-sha1",
    "diffie-hellman-group14-sha1",
    "diffie-hellman-group-exchange-sha1",
    "diffie-hellman-group1-sha1"
  ],
  "supportedHMacs": [
    "hmac-sha2-512-etm@openssh.com",
    "hmac-sha2-512-96",
    "hmac-sha2-512",
    "hmac-sha2-256-etm@openssh.com",
    "hmac-sha2-256",
    "hmac-sha2-256-96",
    "hmac-sha1-etm@openssh.com",
    "hmac-sha1",
    "hmac-sha1-96",
    "hmac-md5",
    "hmac-md5-etm@openssh.com",
    "hmac-md5-96"
  ],
  "ncm.ssh.allowKeyExchanges": [],
  "ncm.ssh.blockHmacs": [],
  "SCP_RUNNING": 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 SCP Server Settings

API EndPoint : getSCPDetails

Retrieves current SCP server configuration such as username, bind IP, and status.

HTTP Method

GET

API URL

http://localhost:8060/api/json/ncmsettings/getSCPDetails?apiKey=********&serverDetails=true

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
serverDetails	Indicates whether to fetch detailed SCP server information	boolean	-	No

Sample Response

HTTP Code: 200

{
  "SCP_ADDRESS": "10.5.X.X",
  "scpServerDetail": "allip",
  "SCP_SERVER_STATUS": true,
  "scpDefaultPwdChanged": false,
  "scp_password": "not_to_display",
  "isSCPPWDChangeNeed": false,
  "LOCALHOST": "localhost (10.5.X.X)",
  "scp_username": "deviceexpert",
  "SERVER_ADDR": [
    {
      "name": "All IP (10.5.X.X)",
      "value": "allip",
      "selected": true
    },
    {
      "name": "localhost (10.5.X.X)",
      "value": "localhost"
    }
  ],
  "SCP_RUNNING": false,
  "isSuccess": true
}

Error Response

View common error responses

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

Edit SCP Server Settings

API EndPoint : updateSCPDetails

Updates SCP configuration details like credentials, bind IP and service state

HTTP Method

POST

API URL

http://localhost:8060/api/json/ncmsettings/updateSCPDetails?apiKey=********&scp_username=deviceexpert&scp_currentPwd=oldpass123&scp_password=newsecurepass&SCP_BINDTO_IP=allip&SCP_SERVER_IP=10.5.x.x&SCP_START_SERVICE=true

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
scp_username	Username used for SCP authentication.	-	^([p{L}p{N}P{InBasicLatin}.!:@#$s-_\/',])+$	No
scp_currentPwd	Current password to validate before updating.	String	-	No
scp_password	New password to set for SCP access.	String	-	No
SCP_BINDTO_IP	IP address to which SCP service binds.	-	^((allip\|localhost)\|(?:(?: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]?))$	No
SCP_SERVER_IP	SCP server IP for connectivity.	-	^(?:(?: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]?)$	No
SCP_START_SERVICE	Indicates whether to start or stop the scp service	boolean	-	No

Sample Response

HTTP Code: 200

{
  "statusMsg": "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

Edit SSH Settings

API EndPoint : updateSSHSettings

Updates SSH configuration such as supported chipers, keyexchanges and hmacs

HTTP Method

POST

API URL

http://localhost:8060/api/json/ncmsettings/updateSSHSettings?apiKey=********&configurations=%7B%22ncm.ssh.blockCipherSuites%22%3A%22%22%2C%22ncm.ssh.allowKeyExchanges%22%3A%22diffie-hellman-group1-sha1%22%2C%22ncm.ssh.blockHmacs%22%3A%22%22%7D

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
configurations	JSON object specifying new SSH configuration parameters to update. Below are the available keys: 1. ncm.ssh.blockCipherSuites 2. ncm.ssh.allowKeyExchanges 3. ncm.ssh.blockHmacs Sample json: {"ncm.ssh.blockCipherSuites":"aes128-cbc,blowfish-cbc,arcfour128,arcfour","ncm.ssh.allowKeyExchanges":"diffie-hellman-group18-sha512,diffie-hellman-group14-sha1","ncm.ssh.blockHmacs":"hmac-md5,hmac-md5-etm@openssh.com,hmac-md5-96"}	JSONObject	-	yes

Sample Response

HTTP Code: 200

{
  "statusMsg": "Configuration changes 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 Nipper Execution Result

API EndPoint : getNipperDetailedExecResult

Get Nipper Execution Result

HTTP Method

GET

API URL

http://localhost:8060/api/json/ncmsettings/getNipperDetailedExecResult?apiKey=********&EXECUTION_ID=101

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
EXECUTION_ID	Id of the executed schedule nipper report. This can be fetched from getscheduleAudit API response	String	-	No
jqgrid_id	jqgrid_id = DENipperDetailedExecList 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 = NCMNipperBulkExecutionStatus__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 = NCMNipperBulkExecutionStatus__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":"NCMNipperBulkExecutionStatus__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	NCMNipperBulkExecutionStatus__RESOURCENAME
Execution Status	NCMNipperBulkExecutionStatus__STATUS

Sample Response

HTTP Code: 200

{
  "total":110,
  "records":"54749",
  "page":1,
  "rows":
  [
    {
      "id":609,	  "cell":[609,"Test10.5.X.X","SUCCESS","http://10.5.X.X:8888/schedule_results/report/Security_Audit_Report_Nov_20_10_55_00/SecurityAuditReport_For_609_Test10.5.X.X.html","SUCCESS",""]
    },
    {
	"id":7205,
	"cell":[7205,"test123","SUCCESS","http://10.5.X.X:8888/schedule_results/report/Security_Audit_Report_Nov_20_10_55_00/SecurityAuditReport_For_7205_test123.html","SUCCESS",""]
    }
  ]
}

Error Response

View common error responses

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

Add Discovered Devices

API EndPoint : addDiscoveredResources

Adds devices discovered through discovery reports into the NCM device inventory.

HTTP Method

POST

API URL

http://localhost:8060/api/json/ncmsettings/addDiscoveredResources?apiKey=********&REPORTIDS=[101,102]&PROFILEID=301

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
REPORTIDS	List of discovery report IDs from which devices should be imported.	JSONArray	-	No
PROFILEID	Credential profile ID that needs to associated with the devices added	long	-	No

Sample Response

HTTP Code: 200

{
  "deviceCount": 1,
  "isSuccess": true
}

Error Response

View common error responses

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

Get Discovery Status

API EndPoint : getDiscoveryStatus

Retrieves the discovery status to determine progress or completion for ongoing discovery operations.

HTTP Method

GET

API URL

http://localhost:8060/api/json/ncmsettings/getDiscoveryStatus?apiKey=********&isServiceNow=true

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
isServiceNow	Indicates whether to fetch the discovery status for ServiceNow or regular discovery	boolean	-	No
jqgrid_id	jqgrid_id = DEDiscoveryStat 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 = DiscoveryProfile__PROFILENAME 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 = DiscoveryProfile__PROFILENAME 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":"DiscoveryProfile__PROFILENAME","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
Profile Name	DiscoveryProfile__PROFILENAME
Type	DiscoveryRangeDetails__DISCOVERYTYPE

Sample Response

HTTP Code: 200

{
  "total": 1,
  "records": "3",
  "page": 1,
  "rows": [
    {
      "cell": [
        3,
        "Profile_2025_11_04_12_09_42",
        "SingleDevice",
        "10.5.X.X",
        1,
        1,
        0,
        1
      ]
    },
    {
      "cell": [
        2,
        "Profile_2025_11_04_12_07_42",
        "SingleDevice",
        "10.5.X.X",
        1,
        1,
        1,
        0
      ]
    },
    {
      "cell": [
        1,
        "Profile_2025_11_03_17_13_16",
        "SingleDevice",
        "10.5.X.X",
        1,
        1,
        1,
        0
      ]
    }
  ]
}

Error Response

View common error responses

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

Get Discovery Detailed Report

API EndPoint : getDiscoveryDetails

Fetches detailed discovery information for a specific discovery profile.

HTTP Method

GET

API URL

http://localhost:8060/api/json/ncmsettings/getDiscoveryDetails?apiKey=********&profileId=101

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
profileId	Unique ID of the discovery profile whose report details are required	long	-	yes
jqgrid_id	jqgrid_id = DEDiscoveryReport 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 = NCMDiscoveryReport__IPADDRESS 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 = NCMDiscoveryReport__IPADDRESS 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":"NCMDiscoveryReport__IPADDRESS","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
IP Address	NCMDiscoveryReport__IPADDRESS
SysObjectID	NCMDiscoveryReport__SYSOID
Device Type	NCMDiscoveryReport__TEMPLATENAME
Series	NCMDiscoveryReport__SERIES
Model	NCMDiscoveryReport__MODEL
Status	NCMDiscoveryReport__STATUS

Sample Response

HTTP Code: 200

{
  "total": 1,
  "records": "1",
  "page": 1,
  "rows": [
    {
      "id": 3,
      "cell": [
        3,
        "10.5.X.X",
        "[NA]",
        "[NA]",
        "[NA]",
        "[NA]",
        "4_FAILURE"
      ]
    }
  ]
}

Error Response

View common error responses

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

Get ResourceIds for IPAddresses

API EndPoint : getResourceIdsForIps

Retrieves the resource IDs corresponding to the given device IP addresses.

HTTP Method

GET

API URL

http://localhost:8060/api/json/ncmsettings/getResourceIdsForIps?apiKey=********&IPADDRESS=[10.5.x.x,10.5.x.x]

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
IPADDRESS	List of one or more IP addresses for which the NCM resource IDs are to be fetched.	JSONArray	-	yes

Sample Response

HTTP Code: 200

{
  "resourceIds": [
    609
  ]
}

Error Response

View common error responses

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

Get Discovery Summary

API EndPoint : getDiscoverySummary

Provides a summary of the discovery results

HTTP Method

GET

API URL

http://localhost:8060/api/json/ncmsettings/getDiscoverySummary?apiKey=********&profileId=101

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
profileId	Unique ID of the discovery profile for which the summary data is to be fetched	long	-	yes

Sample Response

HTTP Code: 200

{
  "profileName": "Profile_2025_11_04_12_07_42",
  "processed": 1,
  "total": 1,
  "success": 1,
  "failure": 0,
  "yetToAdd": 0
}

Error Response

View common error responses

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

Get Non Inventoried Devices

API EndPoint : getNCMNonInventoriedDevices

Retrieves a list of devices detected by NCM that are not yet added to the inventory

HTTP Method

GET

API URL

http://localhost:8060/api/json/ncmsettings/getNCMNonInventoriedDevices?apiKey=********

Parameters

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

Sample Response

HTTP Code: 200

[
  {
    "HOSTNAME": "10.5.X.X",
    "CATEGORY": "Unknown",
    "DEVICETYPE": "Unknown",
    "IPADDRESS": "10.5.X.X",
    "ID": "2",
    "MONAME": "10.5.X.X"
  },
  {
    "HOSTNAME": "10.5.X.X",
    "CATEGORY": "Unknown",
    "DEVICETYPE": "Unknown",
    "IPADDRESS": "10.5.X.X",
    "ID": "301",
    "MONAME": "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 Probe Status

API EndPoint : ncmeeGetProbeStatus

Retrieves the status of a specified probe

HTTP Method

GET

API URL

http://localhost:8060/api/json/ncmsettings/ncmeeGetProbeStatus?apiKey=********&selectedProbe=probe1

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
selectedProbe	Probe name to be checked	String	-	yes

Sample Response

HTTP Code: 200

{
  "SERVERSTATUS": 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 Probes

API EndPoint : ncmeeListProbes

Fetches the list of all probes configured including their names and basic connection details.

HTTP Method

GET

API URL

http://localhost:8060/api/json/ncmsettings/ncmeeListProbes?apiKey=********

Parameters

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

Sample Response

HTTP Code: 200

{"probeList":{"TestProbe":{"displayName":"TestProbe","status":true}}}

Error Response

View common error responses

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

Get ProbeId For Device

API EndPoint : ncmeeGetProbeForDevice

Retrieves the ID of the probe server associated with a specific device

HTTP Method

GET

API URL

http://localhost:8060/api/json/ncmsettings/ncmeeGetProbeForDevice?apiKey=********&DEVICE_ID=101

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
DEVICE_ID	Resource ID of the device for which probe ID should be fetched	long	-	yes

Sample Response

HTTP Code: 200

{
  "ProbeName": "10000000001"
}

Error Response

View common error responses

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

Get Probe Details for Device

API EndPoint : ncmeeGetProbeDetailsForDevice

Retrieves detailed information about the probe server assigned to a specific device

HTTP Method

GET

API URL

http://localhost:8060/api/json/ncmsettings/ncmeeGetProbeDetailsForDevice?apiKey=********&DEVICE_ID=101

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
DEVICE_ID	Resource ID of the device for which probe details should be fetched	long	-	yes

Sample Response

HTTP Code: 200

{"PROBEID":10000000001,"CUSTOMERID":1,"SERVERSTATUS":true,"PROBENAME":"TestProbe","isSuccess":true}

Error Response

View common error responses

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

Get Personality Vendor List

API EndPoint : getNewDeviceTemplate

Get personality and vendor details for creating new device template

HTTP Method

GET

API URL

http://localhost:8060/api/json/ncmsettings/getNewDeviceTemplate?apiKey=********

Parameters

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

Sample Response

HTTP Code: 200

{
  "promptActionIds": [
    {
      "PROMPTACTIONID": "yesActionId"
    },
    {
      "PROMPTACTIONID": "TransPortWirelessRouterId"
    },
    {
      "PROMPTACTIONID": "nortelPPActionId"
    },
    {
      "PROMPTACTIONID": "necActionId"
    },
    {
      "PROMPTACTIONID": "netscreenActionId"
    }  ],
  "operations": [
    "Startup",
    "Running",
    "Vlan",
    "Interface",
    "Inventory",
    "Vtp",
    "Flash",
    "Ip route",
    "Ip bgp summary",
    "Ip ospf neighbor"
  ],
  "baseTemplates": [
    {
      "displayName": "MiMOMax-T",
      "id": 1
    },
    {
      "displayName": "MiMOMax-P",
      "id": 2
    },
    {
      "displayName": "BlueCoatProxy SGOS Version 6.x",
      "id": 19
    },
    {
      "displayName": "Cisco IOS Router",
      "id": 20
    },
    {
      "displayName": "Cisco IOS Switch",
      "id": 21
    }
  ],
  "categories": [
    "Load Balancer",
    "Switch",
    "Server",
    "Access Point",
    "Router",
    "General",
    "Controller",
    "Firewall"
  ],
  "vendors": [
    {
      "DisplayName": "HPE (3Com)",
      "id": 5
    },
    {
      "DisplayName": "A10Networks",
      "id": 53
    },
    {
      "DisplayName": "Ciena",
      "id": 43
    },
    {
      "DisplayName": "Cisco",
      "id": 1
    },
    {
      "DisplayName": "Citrix",
      "id": 35
    }
  ],
  "personalities": [
    {
      "PERSONALITYNAME": "3Com5500Switch",
      "PERSONALITYID": 128
    },
    {
      "PERSONALITYNAME": "3ComSwitch",
      "PERSONALITYID": 12
    },
    {
      "PERSONALITYNAME": "AdtranLANSwitch",
      "PERSONALITYID": 17
    },
    {
      "PERSONALITYNAME": "AdtranNetvantaRouter",
      "PERSONALITYID": 19
    },
    {
      "PERSONALITYNAME": "ZyXELDevice",
      "PERSONALITYID": 221
    }
  ]
}

Error Response

View common error responses

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

Get Device Template Name

API EndPoint : getDeviceTemplateName

Get device template name of the given device template ID, used when viewing the device template for adding snapshot configlets

HTTP Method

GET

API URL

http://localhost:8060/api/json/ncmsettings/getDeviceTemplateName?apiKey=********&DEVICETEMPLATEID=101

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
DEVICETEMPLATEID	ID of the device template, the value can be obtained from "getDeviceTemplateDetails" api	long	-	yes

Sample Response

HTTP Code: 200

{"TemplateName":"Cisco IOS Router","isSuccess":true}

Error Response

View common error responses

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

Sync Service Now Devices

API EndPoint : syncServiceNowDevicesWithNCM

Sync service now devices with NCM

HTTP Method

POST

API URL

http://localhost:8060/api/json/ncmsettings/syncServiceNowDevicesWithNCM?apiKey=********

Parameters

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

Sample Response

HTTP Code: 200

""

Error Response

View common error responses

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

List All Vendors

API EndPoint : vendorMap

Lists all the vendors and its display name, it is used to get vendor list in Sysoid Add/Edit page, Add Device page,etc

HTTP Method

GET

API URL

http://localhost:8060/api/json/ncmsettings/vendorMap?apiKey=********

Parameters

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

Sample Response

HTTP Code: 200

{
    "vendors": [
        {
            "DisplayName": "HPE (3Com)",
            "Name": "3Com"
        },
       {
            "DisplayName": "XASJ",
            "Name": "XASJ"
        },
        {
            "DisplayName": "Yamaha",
            "Name": "Yamaha"
        },
        {
            "DisplayName": "ZTE",
            "Name": "ZTE"
        },
        {
            "DisplayName": "ZyXEL",
            "Name": "ZyXEL"
        }
    ]
}

Error Response

View common error responses

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

Vendorwise Configlets

API EndPoint : getConfiglet

To list all configlets associated to a specific vendor, when executing configlet on a specific device this API is used to show all configlets matching the device vendor

HTTP Method

GET

API URL

http://localhost:8060/api/json/ncmsettings/getConfiglet?apiKey=********&VENDOR_NAME=Fortinet

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
VENDOR_NAME	Specify the vendor name, it provides the list of configlets associated with the vendor(Ex: Cisco, Dell)	-	^([p{L}p{N}s-()])+$	yes

Sample Response

HTTP Code: 200

{
    "CONFIGLET": {
        "9": "Fortigate_Firewall_V4_Enable_Change_detection",
        "71": "Fortigate_SendSyslogs"
    }
}

Error Response

View common error responses

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

Vendorwise Devices

API EndPoint : getDevicesforVendor

To list devices belonging to a specific vendor, it can be used in selecting devices for Device Group, Schedule, Credential Rule, Configlet, like wherever NCM has requirement to select devices for an operation.

HTTP Method

GET

API URL

http://localhost:8060/api/json/ncmsettings/getDevicesforVendor?apiKey=********&VENDOR_NAME=Fortinet

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
VENDOR_NAME	Specify the vendor name, it provides the list of devices belonging to the vendor(Ex: Cisco, Dell)	-	^([p{L}p{N}s-()])+$	yes

Sample Response

HTTP Code: 200

{
    "vendorHostMap": [
        {
            "hostName": "10.5.X.X",
            "id": 1
        },
        {
            "hostName": "10.5.X.X",
            "id": 301
        },
        {
            "hostName": "10.5.X.X",
            "id": 305
        }
    ]
}

Error Response

View common error responses

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

Add Device

API EndPoint : addDevice

This API is used to add non-snmp devices which cannot be or not discovered automatically to the NCM manually.

We can add

- devices one by one with IPADDRESS param

- multiple devices with BULKIPADDRESSES param

- devices failed to get discovered using DISCOVERY_PROFILE_ID & ARE_FAILED_DISCOVERY_DEVICES param

HTTP Method

POST

API URL

http://localhost:8060/api/json/ncmsettings/addDevice?apiKey=********&IPADDRESS=10.5.x.x&DEVICE_BEHAVIOUR=Cisco IOS Switch&VENDOR_NAME=Cisco&SERIES=2900&MODEL=WS-C2960X-48TS-L&ISMANUALADDITION=true

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
DEVICE_BEHAVIOUR	Name the device template to which the device needs to be associated	-	[p{L}p{N}P{InBasicLatin}-_s./]+	No
ISMANUALADDITION	Set as true if device is added manually by the user. Set as false if it is the done by NCM automatically.	boolean	-	No
SERIES	Series of the device that is to be added	-	^([p{L}p{N}P{InBasicLatin}.!:@#$s-_+\/',[]()])+$	No
MODEL	Model of the device that is to be added	-	^([p{L}p{N}P{InBasicLatin}.!:@#$s-_+\/',[]()])+$	No
COLUMNNAME1	Value of custom column if any	-	^([p{L}p{N}P{InBasicLatin}.!:@#$s-_\/'[],])+$	No
COLUMNNAME2	Value of custom column if any	-	^([p{L}p{N}P{InBasicLatin}.!:@#$s-_\/'[],])+$	No
COLUMNNAME3	Value of custom column if any	-	^([p{L}p{N}P{InBasicLatin}.!:@#$s-_\/'[],])+$	No
BULKIPADDRESSES	Array of ipaddresses that needs to be added in case you wish to add the multiple devices at once.	JSONArray	-	No
IPADDRESS	IPAddress of the single device that needs to added.	-	^([p{L}p{N}P{InBasicLatin}s.:-_])+$	No
VENDOR_NAME	Name of the vendor to which the device belongs	-	^([p{L}p{N}+_s()-])+$	No
DISCOVERY_PROFILE_ID	Profile Id of the Discovery profile whose failed devices needs to added	long	-	No
ARE_FAILED_DISCOVERY_DEVICES	Set as true to add the set of devices that failed to get discovered using snmp. DISCOVERY_PROFILE_ID is mandatory to use this param	boolean	-	No
TAG_ID	ID of the tag to which the device needs to categorized	long	-	No

Sample Response

HTTP Code: 200

{
  "resourceId": 607,
  "credRuleUpdate": true,
  "statusMsg": "Success",
  "Message": "Device has been added successfully. Specify credentials now.",
  "ipAddress": "10.5.X.X",
  "bulkResourceIds": [
    607
  ],
  "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.