Network Configuration Manager REST API

List Configlet Groups

API EndPoint : listConfigletGroup

Retrieves all available configlet groups in NCM

HTTP Method

GET

API URL

http://localhost:8060/api/json/ncmconfiglets/listConfigletGroup?apiKey=********

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
jqgrid_id	Unique identifier for the jqGrid instance. Used to distinguish between multiple grids on the same page or in the same API call.	String	-	No
jqgridLoad	Indicates whether the jqGrid should perform a fresh load or reload its data.	boolean	-	No
_search	Set to true if the current request is for searching/filtering data, and false otherwise.	boolean	-	No
nd	Timestamp value used for cache busting, ensuring fresh data is retrieved from the server rather than from browser cache.	long	-	No
rows	The number of rows to retrieve per page (page size). Controls pagination in jqGrid.	int	-	No
page	The current page number to be retrieved. Enables pagination functionality in jqGrid.	int	-	No
sidx	The column name by which to sort the data. Used for server-side sorting in jqGrid.	String	-	No
sord	The sort order for the data, either asc (ascending) or desc (descending).	String	-	No
filters	JSON-encoded string containing advanced multi-field filter criteria generated by jqGrid's toolbar or multi-search.	String	-	No
searchOper	The search operator for simple search (e.g., eq for equals, ne for not equals, bw for begins with, etc.). Used with single-field search.	String	-	No
searchString	The value to search for in a simple (single-field) search. Used with searchField and searchOper.	String	-	No
searchField	The column name to perform a simple search on. Used with searchString and searchOper to define single-field search criteria.	String	-	No

Sample Response

HTTP Code: 200

{
  "total": 1,
  "records": "1",
  "page": 1,
  "rows": [
    {
      "CONFIGLET_COUNT": 3,
      "NCMConfigletGroup__OWNER_NAME": "admin",
      "NCMConfigletGroup__CONFIGLETGROUP_DESC": "",
      "NCMConfigletGroup__CONFIGLETGROUP_TYPE": "staticgroup",
      "id": 1,
      "NCMConfigletGroup__CONFIGLETGROUP_NAME": "SNMP Configlets"
    }
  ]
}

Error Response

View common error responses

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

Get a Configlet Details

API EndPoint : configletGroupPrereder

Fetches pre-render details of a configlet group before update. Ensures accurate rendering with all linked configlet information.

HTTP Method

GET

API URL

http://localhost:8060/api/json/ncmconfiglets/configletGroupPrereder?apiKey=********&group_id=1

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
group_id	ID of the configlet group	long	-	No

Sample Response

HTTP Code: 200

{
  "groupName": "SNMP Configlets",
  "groupType": "staticgroup",
  "groupDesc": "",
  "selected_entity_staticgroup": [
    {
      "hostName": "Cisco - SNMP Trap Settings for Access ports",
      "id": 20
    },
    {
      "hostName": "Enable SNMP v1/v2 Cisco",
      "id": 120
    },
    {
      "hostName": "SNMP_Disable",
      "id": 2
    }
  ],
  "groupId": 1,
  "unselected_configletGroups": [],
  "unselected_configlets": [
    {
      "hostName": "AlliedTelesis_87XX_Disable_Change_detection",
      "id": 8
    },
    {
      "hostName": "AlliedTelesis_87XX_Enable_Change_detection",
      "id": 303
    },
    {
      "hostName": "Arista - Copy Cert and Key Files",
      "id": 33
    }
  ],
  "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 Associated with Group

API EndPoint : listConfigletsOfGroup

Lists all configlets associated with a particular group. Used to view configurations grouped under a specific category.

HTTP Method

GET

API URL

http://localhost:8060/api/json/ncmconfiglets/listConfigletsOfGroup?apiKey=********&group_id=101

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
group_id	ID of the configlet group	long	-	yes
jqgrid_id	Unique identifier for the jqGrid instance. Used to distinguish between multiple grids on the same page or in the same API call.	String	-	No
jqgridLoad	Indicates whether the jqGrid should perform a fresh load or reload its data.	boolean	-	No
_search	Set to true if the current request is for searching/filtering data, and false otherwise.	boolean	-	No
nd	Timestamp value used for cache busting, ensuring fresh data is retrieved from the server rather than from browser cache.	long	-	No
rows	The number of rows to retrieve per page (page size). Controls pagination in jqGrid.	int	-	No
page	The current page number to be retrieved. Enables pagination functionality in jqGrid.	int	-	No
sidx	The column name by which to sort the data. Used for server-side sorting in jqGrid.	String	-	No
sord	The sort order for the data, either asc (ascending) or desc (descending).	String	-	No
filters	JSON-encoded string containing advanced multi-field filter criteria generated by jqGrid's toolbar or multi-search.	String	-	No
searchOper	The search operator for simple search (e.g., eq for equals, ne for not equals, bw for begins with, etc.). Used with single-field search.	String	-	No
searchString	The value to search for in a simple (single-field) search. Used with searchField and searchOper.	String	-	No
searchField	The column name to perform a simple search on. Used with searchString and searchOper to define single-field search criteria.	String	-	No

Sample Response

HTTP Code: 200

{
  "total": 1,
  "records": "3",
  "page": 1,
  "rows": [
    {
      "NCMTemplate__TEMPLATE_TYPE": "PROG_CONFIGLET_MODE",
      "id": 20,
      "NCMTemplate__TEMPLATE_NAME": "Cisco - SNMP Trap Settings for Access ports",
      "NCMTemplate__DESCRIPTION": "Configures SNMP Trap Settings for all access ports",
      "NCMTemplate__VENDOR_NAME": "Cisco"
    },
    {
      "NCMTemplate__TEMPLATE_TYPE": "COMMAND_LINE_MODE",
      "id": 120,
      "NCMTemplate__TEMPLATE_NAME": "Enable SNMP v1/v2 Cisco",
      "NCMTemplate__DESCRIPTION": "This configlet is used to enable SNMP v1/v2 in Cisco Routers / Switches on multiple devices simultaneously",
      "NCMTemplate__VENDOR_NAME": "Cisco"
    },
    {
      "NCMTemplate__TEMPLATE_TYPE": "TFTP_FILE_TRANSFER_MODE",
      "id": 2,
      "NCMTemplate__TEMPLATE_NAME": "SNMP_Disable",
      "NCMTemplate__DESCRIPTION": "Disabling SNMP",
      "NCMTemplate__VENDOR_NAME": "Cisco"
    }
  ]
}

Error Response

View common error responses

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

Add Configlet Group

API EndPoint : addConfigletGroup

Adds a new configlet group with name, description, and type. Helps categorize configlets for organized configuration management.

HTTP Method

POST

API URL

http://localhost:8060/api/json/ncmconfiglets/addConfigletGroup?apiKey=********&group_name=Network%20Audit%20Groups&group_desc=Subgroup%20for%20network%20audit%20configlets&group_type=subgroup&selected_entity=[101,102]

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
group_name	Name of the configlet group	-	^([p{L}p{N}P{InBasicLatin}.!:#$s-_',])+$	No
group_desc	Comment on purpose or characteristics of the configlet group	-	^([p{L}p{N}P{InBasicLatin}.!:#$s-_',])+$	No
group_type	Specify the type of Configlet group to be created. 1. staticgroup – Use this option when creating a group consisting of Configlets. 2. subgroup – Use this option when creating a new Configlet group under an existing Configlet group.	-	^(staticgroup\|subgroup)$	yes
selected_entity	Params values can either be list of configlet Ids or list of configlet group Ids based on the group type. If group_type is "staticgroup" then "selected_entity" is list of configlets If group_type is "subgroup" then "selected_entity" is list of configlet group	JSONArray	-	yes

Sample Response

HTTP Code: 200

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

Edit Configlet Group

API EndPoint : editConfigletGroup

Updates details of an existing configlet group

HTTP Method

POST

API URL

http://localhost:8060/api/json/ncmconfiglets/editConfigletGroup?apiKey=********&group_id=1&group_name=Updated%20SNMP%20Configlets&group_desc=Updated%20description%20for%20SNMP%20configlet%20group&group_type=staticgroup&selected_entity=[101,102]

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
group_id	IDs of the configlet group that needs to be updated	long	-	yes
group_name	Updated name of the configlet group.	-	^([p{L}p{N}P{InBasicLatin}.!:#$s-_',])+$	No
group_desc	Updated comment on purpose or characteristics of the configlet group	-	^([p{L}p{N}P{InBasicLatin}.!:#$s-_',])+$	No
group_type	Specify the type of configlet group need to be created 1. staticgroup - If group is created of configlets 2. subgroup - if the newly created configlet group is the group of existing configlet group	-	^(staticgroup\|subgroup)$	yes
selected_entity	Params values can either be list of configlet Ids or list of configlet group Ids based on the group type. If group_type is "staticgroup" then "selected_entity" is list of configlets If group_type is "subgroup" then "selected_entity" is list of configlet group	JSONArray	-	yes

Sample Response

HTTP Code: 200

{
  "statusMsg": "Configlet group is updated successfully.",
  "isSuccess": true
}

Error Response

View common error responses

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

Delete Configlet Group

API EndPoint : deleteConfigletGroup

Deletes the specified configlet group

HTTP Method

POST

API URL

http://localhost:8060/api/json/ncmconfiglets/deleteConfigletGroup?apiKey=********&group_id=101

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
group_id	ID of configlet group that needs to be deleted	long	-	yes

Sample Response

HTTP Code: 200

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

Create Configlet Regex

API EndPoint : addNCMRegex

Add a new NCM regex entry which is used for input validation on programmable configlet's parameters.

HTTP Method

POST

API URL

http://localhost:8060/api/json/ncmconfiglets/addNCMRegex?apiKey=********&displayname=IP%20Address%20Validation&value=^(?:[0-9]{1,3}/ ){3}[0-9]{1,3}$&description=Validates%20IPv4%20address%20inputs

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
displayname	Display name of the regex.	-	^([p{L}p{N}P{InBasicLatin}.!:#$s-_',])+$	yes
value	Regex pattern to be added.	-	[^<>]+	yes
description	Comment on purpose/usage of the regex	-	^([p{L}p{N}P{InBasicLatin}.!:#$s-_',])+$	No

Sample Response

HTTP Code: 200

{
  "statusMsg": "NCM regex added successfully",
  "regexId": 301,
  "isSuccess": true
}

Error Response

View common error responses

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

Update Configlet Regex

API EndPoint : addNCMRegex

Updated the existing regex which is used for input validation on programmable configlet's parameters.

HTTP Method

POST

API URL

http://localhost:8060/api/json/ncmconfiglets/addNCMRegex?regexId=301&apiKey=********&displayname=Port%20Validation&value=^[0-9]{1,5}$&description=Validates%20port%20range%201-65535

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
displayname	Display name of the regex.	-	^([p{L}p{N}P{InBasicLatin}.!:#$s-_',])+$	yes
value	Regex pattern to be added.	-	[^<>]+	yes
description	Comment on purpose/usage of the regex	-	^([p{L}p{N}P{InBasicLatin}.!:#$s-_',])+$	No
regexId	Unique Id of the regex. Mandatory when updated an existing regex	long	-	No

Sample Response

HTTP Code: 200

{
    "statusMsg": "NCM regex updated successfully",
    "regexId": 1,
    "isSuccess": true
  }

Error Response

View common error responses

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

Delete Configlet Regexes

API EndPoint : deleteNCMRegex

Deletes one or more regex entries

HTTP Method

POST

API URL

http://localhost:8060/api/json/ncmconfiglets/deleteNCMRegex?apiKey=********®exIds=[301,302,303]

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
regexIds	List of regex IDs to be deleted	JSONArray	-	yes

Sample Response

HTTP Code: 200

{
  "statusMsg": "Regexes are successfully deleted",
  "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 Regex Details

API EndPoint : ncmRegexPrerender

Fetches pre-render details of a specific regex. Used before editing for preview

HTTP Method

GET

API URL

http://localhost:8060/api/json/ncmconfiglets/ncmRegexPrerender?regexId=301&apiKey=********

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
regexId	ID of the regex entry.	long	-	No

Sample Response

HTTP Code: 200

{
  "displayname": "Checksum",
  "description": "Regex to validate checksum input",
  "value": "^[a-fA-F0-9]{32}$",
  "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 Configlet Regexes

API EndPoint : listAllNCMRegex

Lists all regex patterns configured.Useful for reviewing and managing regex definitions.

HTTP Method

GET

API URL

http://localhost:8060/api/json/ncmconfiglets/listAllNCMRegex?apiKey=********

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
jqgrid_id	Unique identifier for the jqGrid instance. Used to distinguish between multiple grids on the same page or in the same API call.	String	-	No
jqgridLoad	Indicates whether the jqGrid should perform a fresh load or reload its data.	boolean	-	No
_search	Set to true if the current request is for searching/filtering data, and false otherwise.	boolean	-	No
nd	Timestamp value used for cache busting, ensuring fresh data is retrieved from the server rather than from browser cache.	long	-	No
rows	The number of rows to retrieve per page (page size). Controls pagination in jqGrid.	int	-	No
page	The current page number to be retrieved. Enables pagination functionality in jqGrid.	int	-	No
sidx	The column name by which to sort the data. Used for server-side sorting in jqGrid.	String	-	No
sord	The sort order for the data, either asc (ascending) or desc (descending).	String	-	No
filters	JSON-encoded string containing advanced multi-field filter criteria generated by jqGrid's toolbar or multi-search.	String	-	No
searchOper	The search operator for simple search (e.g., eq for equals, ne for not equals, bw for begins with, etc.). Used with single-field search.	String	-	No
searchString	The value to search for in a simple (single-field) search. Used with searchField and searchOper.	String	-	No
searchField	The column name to perform a simple search on. Used with searchString and searchOper to define single-field search criteria.	String	-	No

Sample Response

HTTP Code: 200

{
  "total": 3,
  "records": "3",
  "page": 1,
  "rows": [
    {
      "id": 4,
      "CREATED_BY": "SYSTEM",
      "REGEX": "^[p{L}p{N}]+$",
      "LAST_MODIFIED_BY": "[NA]",
      "DESCRIPTION": "[NA]",
      "REGEX_DISPNAME": "Alpha Numeric"
    },
    {
      "id": 301,
      "CREATED_BY": "admin",
      "REGEX": "^[a-fA-F0-9]{32}$",
      "LAST_MODIFIED_BY": "[NA]",
      "DESCRIPTION": "Regex to validate checksum input",
      "REGEX_DISPNAME": "Checksum"
    },
    {
      "id": 3,
      "CREATED_BY": "SYSTEM",
      "REGEX": "^[1-9]d*$",
      "LAST_MODIFIED_BY": "[NA]",
      "DESCRIPTION": "[NA]",
      "REGEX_DISPNAME": "Positive Integer"
    }
  ]
}

Error Response

View common error responses

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

Add Programmable Configlet

API EndPoint : addProConfiglets

Add a new programmable configlet for automation or device configuration. Allows defining commands, variables, define multiple conditions , loop over data fetched from device, and data-driven scripts for advanced programmatic configuration management.

HTTP Method

POST

API URL

http://localhost:8060/api/json/ncmconfiglets/addProConfiglets?apiKey=********&configlet_name="Show%20Version"&description="show%20command%20execution"&vendor="Cisco"&device_execution_mode="Multiple_Device"&BACKUP_BEFORE_TEMPLATE=true&BACKUP_AFTER_TEMPLATE=true&variables=[]&configlet_content="$device.execute("show version")"

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
variables	List of variables available on the configlet. Each variable is represented as a JSON object within an array, defining how input values are collected when the configlet is executed. [ { "name": "", "displayname": "", "description": "", "type": "", "default_value": "", "is_hidden": "	JSONArray	-	yes
configlet_content	Configuration content or script.	String	-	yes
configlet_name	Name of the configlet.	-	^([p{L}p{N}P{InBasicLatin}.!:#$s-_',])+$	yes
description	Comment on purpose , scope and usage of the configlet	-	^([p{L}p{N}P{InBasicLatin}.!:#$s-_',])+$	No
BACKUP_BEFORE_TEMPLATE	Specifies whether to backup the configuration before applying the template	boolean	-	No
BACKUP_AFTER_TEMPLATE	Specifies whether to backup the configuration after applying the template	boolean	-	No
vendor	Vendor name with which the configlet should be associated	-	^([p{L}p{N}s-()])+$	No
device_execution_mode	Mode for configlet execution on the device. 1. Multiple_Device - Configlet can be executed on multiple devices with same input parameters 2. Single_Device - Configlets can be executed only on 1 device at a time	-	(Multiple_Device\|Single_Device)	No

Sample Response

HTTP Code: 200

{
    "statusMsg": "Programmable configlet Upgrade Cisco Switches is added successfully.",
    "isSuccess": true
  }

Error Response

View common error responses

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

Update Programmable Configlet

API EndPoint : addProConfiglets

Updates a new programmable configlet for automation or device configuration. Allows defining commands, variables, define multiple conditions , loop over data fetched from device, and data-driven scripts for advanced programmatic configuration management.

HTTP Method

POST

API URL

http://localhost:8060/api/json/ncmconfiglets/addProConfiglets?apiKey=********&configlet_id=101&configlet_name="Show%20Version"&description="Revised%20content%20for%20Cisco%20switch"&vendor="Cisco"&device_execution_mode="Single_Device"&BACKUP_BEFORE_TEMPLATE=true&variables=[]&configlet_content="$device.execute("show version")"

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
variables	List of variables available on the configlet.Each variable is represented as a JSON object within an array, defining how input values are collected when the configlet is executed. [ {"name":, "displayname":, "description":, "type":, "default_value":, "is_hidden":	JSONArray	-	yes
configlet_content	Configuration content or script.	String	-	yes
configlet_name	Name of the configlet.	-	^([p{L}p{N}P{InBasicLatin}.!:#$s-_',])+$	yes
configlet_id	Id of the programmable configlet. Mandatory while updating the configlet	long	-	No
description	Comment on purpose , scope and usage of the configlet	-	^([p{L}p{N}P{InBasicLatin}.!:#$s-_',])+$	No
BACKUP_BEFORE_TEMPLATE	Specifies whether to backup the configuration before applying the template	boolean	-	No
BACKUP_AFTER_TEMPLATE	Specifies whether to backup the configuration after applying the template	boolean	-	No
vendor	Vendor name with which the configlet should be associated	-	^([p{L}p{N}s-()])+$	No
device_execution_mode	Mode for configlet execution on the device. 1. Multiple_Device - Configlet can be executed on multiple devices with same input parameters 2. Single_Device - Configlets can be executed only on 1 device at a time	-	(Multiple_Device\|Single_Device)	No

Sample Response

HTTP Code: 200

{
    "statusMsg": "Programmable configlet Upgrade Cisco Switches is updated successfully.",
    "isSuccess": true
  }

Error Response

View common error responses

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

List Programmable Configlet

API EndPoint : listProConfiglets

Lists all programmable configlets available. Used to view and manage advanced automation templates.

HTTP Method

GET

API URL

http://localhost:8060/api/json/ncmconfiglets/listProConfiglets?apiKey=********

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
jqgrid_id	Unique identifier for the jqGrid instance. Used to distinguish between multiple grids on the same page or in the same API call.	String	-	No
jqgridLoad	Indicates whether the jqGrid should perform a fresh load or reload its data.	boolean	-	No
_search	Set to true if the current request is for searching/filtering data, and false otherwise.	boolean	-	No
nd	Timestamp value used for cache busting, ensuring fresh data is retrieved from the server rather than from browser cache.	long	-	No
rows	The number of rows to retrieve per page (page size). Controls pagination in jqGrid.	int	-	No
page	The current page number to be retrieved. Enables pagination functionality in jqGrid.	int	-	No
sidx	The column name by which to sort the data. Used for server-side sorting in jqGrid.	String	-	No
sord	The sort order for the data, either asc (ascending) or desc (descending).	String	-	No
filters	JSON-encoded string containing advanced multi-field filter criteria generated by jqGrid's toolbar or multi-search.	String	-	No
searchOper	The search operator for simple search (e.g., eq for equals, ne for not equals, bw for begins with, etc.). Used with single-field search.	String	-	No
searchString	The value to search for in a simple (single-field) search. Used with searchField and searchOper.	String	-	No
searchField	The column name to perform a simple search on. Used with searchString and searchOper to define single-field search criteria.	String	-	No

Sample Response

HTTP Code: 200

{
  "total": 1,
  "records": "4",
  "page": 1,
  "rows": [
   
    {
      "VENDOR_NAME": "Cisco",
      "TEMPLATE_NAME": "Cisco Stack Switches - Firmware Upgrade",
      "DESCRIPTION": "Upgrades firmware for provided slots in the range.",
      "OWNER_NAME": "system",
      "TEMPLATE_TYPE": "PROG_CONFIGLET_MODE",
      "id": 21
    },
    {
      "VENDOR_NAME": "Cumulus",
      "TEMPLATE_NAME": "Cumulus - VLAN Creation ",
      "DESCRIPTION": "This configlet is used to create VLAN in Cumulus devices.",
      "OWNER_NAME": "system",
      "TEMPLATE_TYPE": "PROG_CONFIGLET_MODE",
      "id": 28
    },
    {
      "VENDOR_NAME": "Cisco",
      "TEMPLATE_NAME": "Device Banner Configuration",
      "DESCRIPTION": "Configuring banner for devices",
      "OWNER_NAME": "system",
      "TEMPLATE_TYPE": "PROG_CONFIGLET_MODE",
      "id": 22
    },
    {
      "VENDOR_NAME": "HPE",
      "TEMPLATE_NAME": "HP Switch - Password change",
      "DESCRIPTION": "Change password for HP Switch",
      "OWNER_NAME": "system",
      "TEMPLATE_TYPE": "PROG_CONFIGLET_MODE",
      "id": 29
    },
    {
      "VENDOR_NAME": "Juniper",
      "TEMPLATE_NAME": "Juniper SRX - Enable Syslogs",
      "DESCRIPTION": " Enable syslogs for Juniper SRX firewalls",
      "OWNER_NAME": "system",
      "TEMPLATE_TYPE": "PROG_CONFIGLET_MODE",
      "id": 31
    }
  ]
}

Error Response

View common error responses

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

Get Configlet Variables

API EndPoint : getConfigletVariables

Retrieves variable/parameter definitions from a configlet template.

HTTP Method

POST

API URL

http://localhost:8060/api/json/ncmconfiglets/getConfigletVariables?apiKey=********&template_content=copy%20${SOURCE_FILE_NAME}%20${DESTINATION_FILE_NAME}&isEdit=true

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
template_content	Content of the configlet which has to be applied over the device	String	-	No
isEdit	Indicates whether it’s in edit mode.or a yet-create configlet	boolean	-	No
template_id	Id of the programmable configlet	long	-	No

Sample Response

HTTP Code: 200

{
  "types": [
    {
      "name": "Dropdown",
      "id": "LIST"
    },
    {
      "name": "Multi-Select",
      "id": "MULTISELECT"
    },
    {
      "name": "Password",
      "id": "PASSWORD"
    },
    {
      "name": "Option",
      "id": "OPTIONS"
    },
    {
      "name": "Boolean",
      "id": "BOOLEAN"
    },
    {
      "name": "Text",
      "id": "TEXT"
    }
  ],
  "custom_variables": [
    {
      "default_values": "",
      "displayname": "Range",
      "name": "range",
      "description": "Slots to be upgraded in the stack",
      "type": "TEXT",
      "userdefined": true,
      "mapped_regex": {
        "name": "Positive Integer",
        "id": 3,
        "value": "^[1-9]d*$"
      },
      "isHidden": false
    },
    {
      "default_values": "",
      "displayname": "Source file name",
      "name": "SOURCE_FILE_NAME",
      "description": "Source firmware file to be upgraded.",
      "type": "TEXT",
      "userdefined": true,
      "mapped_regex": {
        "id": 0
      },
      "isHidden": false
    },
    {
      "default_values": "",
      "displayname": "Destination file name",
      "name": "DESTINATION_FILE_NAME",
      "description": "Destination firmware file in the device.",
      "type": "TEXT",
      "userdefined": true,
      "mapped_regex": {
        "id": 0
      },
      "isHidden": false
    }
  ],
  "predefined": [],
  "regexes": [
    {
      "name": "Positive Integer",
      "id": 3,
      "value": "^[1-9]d*$"
    },
    {
      "name": "Alpha Numeric",
      "id": 4,
      "value": "^[p{L}p{N}]+$"
    },
    {
      "name": "Checksum",
      "id": 301,
      "value": "^[a-fA-F0-9]{32}$"
    }
  ],
  "isSuccess": true
}

Error Response

View common error responses

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

Programmable Configlet Execution Details

API EndPoint : proConfigletsExecutionPrerender

Fetches pre-execution details for a configlet before deployment(i.e before applying them on the device)

HTTP Method

GET

API URL

http://localhost:8060/api/json/ncmconfiglets/proConfigletsExecutionPrerender?apiKey=********&configlet_id=101

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
configlet_id	Id of the programmable configlet. Mandatory while updating the configlet	long	-	yes

Sample Response

HTTP Code: 200

{
  "TEMPLATE_NAMES": [
    "Cisco_Syslog_Configurations",
    "SNMP_Disable",
    "Cisco_Change_Password_Script",
    "Cisco_PIX_ASA_7_x_Forward_Syslog_Script",
    "AlliedTelesis_87XX_Disable_Change_detection",
    "Fortigate_Firewall_V4_Enable_Change_detection",
    "DHCP Snooping Vlan",
    "Cisco_Show_Version_Script",
    "Show Version Script"
  ],
  "VendorName": "Cisco",
  "Description": "Changes the description of the interfaces with the matching string",
  "TemplateType": "PROG_CONFIGLET_MODE",
  "templateId": 19,
  "TemplateContents": "#foreach( $interface in $device.interfaces() )n#set( $desc = $device.execute(""show interfaces $interface description"") )n#if( $desc.toString().contains($match_string) )n$device.execute(""config t"")n$device.execute(""interface $interface"")n$device.execute(""description $new_description"")n$device.execute(""end"")n#endn#end",
  "VENDOR_NAMES": [
    {
      "DisplayName": "All",
      "Name": "All"
    },
    {
      "DisplayName": "HPE (3Com)",
      "Name": "3Com"
    },
    {
      "DisplayName": "Acme Packet",
      "Name": "AcmePacket"
    },
    {
      "DisplayName": "ZTE",
      "Name": "ZTE"
    },
    {
      "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": "Cisco - Change Interface Description",
  "LOGIN_NAME": "system"
}

Error Response

View common error responses

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

Get REST API Credentials

API EndPoint : getRestAPICredentials

(Deprecated)
This API returns REST API credential details for specific devices and retrieves REST API parameters used in REST template configurations. When used to fetch REST Template parameters, the response will exclude REST_PARAM_VALUES entry which are the actual credential values saved for particular devices.

Deprecation Notice:

This endpoint will be replaced by two new APIs:

getRestAPIParameters — to fetch parameters for a specific REST template.

getCredentials — to retrieve credential details.

As part of this change:

The HTTP method will be updated from POST to GET.

The only supported parameter will be restTemplateId.

This endpoint will be limited to returning details for a specific REST template.

Documentation will be updated once the new credential revamp is rolled out.

HTTP Method

POST

API URL

http://localhost:8060/api/json/ncmconfiglets/getRestAPICredentials?apiKey=********&restTemplateId=101&isViewOnly=true

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
resourceIds	The list of resource (device) IDs for which REST API credentials are being fetched.	JSONArray	-	yes
restTemplateId	The unique identifier of the REST template. Required when fetching parameters for a specific REST template. restTemplateId can be retrieved from getAllRESTTemplates API	long	-	No
isViewOnly	UI flag indicating the purpose of the API call: set to true when fetching parameters list for REST template details, and false when fetching credentials.	boolean	-	No

Sample Response

HTTP Code: 200

{
    "CHECK_REST_API": true,
    "REST_API_SUPPORTED": true,
    "PARAMS": [
        {
            "paramOrder": 1,
            "isUserInput": true,
            "default_Value": "1.1.1.1",
            "paramDisplayName": "Host / Domain",
            "dataType": "STRING",
            "paramName": "RemoteHost",
            "type": "LOGIN_PARAM",
            "category": "VALUE"
        },
        {
            "paramOrder": 2,
            "isUserInput": true,
            "default_Value": "HTTPS",
            "paramDisplayName": "Protocol",
            "dataType": "SWITCH",
            "options": [
                {
                    "value": "HTTP",
                    "key": "http"
                },
                {
                    "value": "HTTPS",
                    "key": "https"
                }
            ],
            "paramName": "protocol",
            "type": "LOGIN_PARAM",
            "category": "VALUE"
        },
        {
            "paramOrder": 4,
            "isUserInput": true,
            "default_Value": "",
            "paramDisplayName": "Username",
            "dataType": "STRING",
            "paramName": "username",
            "type": "LOGIN_PARAM",
            "category": "VALUE"
        },
        {
            "paramOrder": 5,
            "isUserInput": true,
            "default_Value": "",
            "paramDisplayName": "Password",
            "dataType": "PASSWORD",
            "paramName": "password",
            "type": "LOGIN_PARAM",
            "category": "VALUE"
        },
        {
            "paramOrder": 6,
            "isUserInput": true,
            "default_Value": "",
            "paramDisplayName": "Enable Password",
            "dataType": "PASSWORD",
            "paramName": "enablepassword",
            "type": "LOGIN_PARAM",
            "category": "VALUE"
        },
        {
            "help": "Disabling REST backup may impact operations like Configlet execution and Upload Configuration. Ensure CLI credentials are working before disabling REST backup.",
            "paramOrder": 100,
            "readonly": "false",
            "isUserInput": "true",
            "defaultValue": "true",
            "paramDisplayName": "Use the REST API to back up the configuration",
            "dataType": "STATUS",
            "data-true": "true",
            "data-false": "false",
            "paramName": "backup_config",
            "category": "VALUE"
        },
        {
            "paramOrder": 102,
            "readonly": "false",
            "isUserInput": "true",
            "defaultValue": "true",
            "paramDisplayName": "Use the REST API to retrieve the interfaces",
            "dataType": "STATUS",
            "data-true": "true",
            "data-false": "false",
            "paramName": "fetch_interfaces",
            "category": "VALUE"
        }
    ],
    "REST_PARAM_VALUES": {
        "enablepassword": "PASSWORD_CANT_BE_SHOWN_FOR_SECURITY_PURPOSE",
        "protocol": "HTTPS",
        "password": "PASSWORD_CANT_BE_SHOWN_FOR_SECURITY_PURPOSE",
        "RemoteHost": "1.1.1.1",
        "fetch_interfaces": "true",
        "backup_config": "true",
        "username": "admin"
    }
}

Error Response

View common error responses

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

Get All REST Templates

API EndPoint : getAllRESTTemplates

This API retrieves a list of all REST device templates available in NCM.

It is primarily used to populate a grid in the UI and therefore includes pagination details in the response.

HTTP Method

GET

API URL

http://localhost:8060/api/json/ncmconfiglets/getAllRESTTemplates?apiKey=********

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
jqgrid_id	Unique identifier for the jqGrid instance. Used to distinguish between multiple grids on the same page or in the same API call.	String	-	No
jqgridLoad	Indicates whether the jqGrid should perform a fresh load or reload its data.	boolean	-	No
_search	Set to true if the current request is for searching/filtering data, and false otherwise.	boolean	-	No
nd	Timestamp value used for cache busting, ensuring fresh data is retrieved from the server rather than from browser cache.	long	-	No
rows	The number of rows to retrieve per page (page size). Controls pagination in jqGrid.	int	-	No
page	The current page number to be retrieved. Enables pagination functionality in jqGrid.	int	-	No
sidx	The column name by which to sort the data. Used for server-side sorting in jqGrid.	String	-	No
sord	The sort order for the data, either asc (ascending) or desc (descending).	String	-	No
filters	JSON-encoded string containing advanced multi-field filter criteria generated by jqGrid's toolbar or multi-search.	String	-	No
searchOper	The search operator for simple search (e.g., eq for equals, ne for not equals, bw for begins with, etc.). Used with single-field search.	String	-	No
searchString	The value to search for in a simple (single-field) search. Used with searchField and searchOper.	String	-	No
searchField	The column name to perform a simple search on. Used with searchString and searchOper to define single-field search criteria.	String	-	No

Sample Response

HTTP Code: 200

{
    "total": 1,
    "records": "-1",
    "page": 1,
    "rows": [
        {
            "DISPLAYNAME": "FortiOS REST API",
            "BASE_URL_FORMAT": "",
            "DESCRIPTION": "This device template is derived from FortiOS REST API version v6.0.4. Few APIs that are added / enhanced in this template may not work in the older versions.",
            "VENDOR": "Fortinet",
            "id": 1,
            "BASE_OS_VERSION": "6.0.4",
            "DT_COUNT": 6,
            "NAME": "FortiOS"
        },
        {
            "DISPLAYNAME": "Checkpoint Firewall REST API",
            "BASE_URL_FORMAT": "",
            "DESCRIPTION": "This device template is derived from Checkpoint R80.30 version. Few APIs that are added / enhanced in this template may not work in the older versions.",
            "VENDOR": "Checkpoint",
            "id": 8,
            "BASE_OS_VERSION": "R80.30",
            "DT_COUNT": 3,
            "NAME": "Checkpoint"
        },
        {
            "DISPLAYNAME": "HPE Aruba OS REST API",
            "BASE_URL_FORMAT": "",
            "DESCRIPTION": "This device template is derived from HPE Aruba OS Release 16.11. Few APIs that are added / enhanced in this template may not work in the older versions.",
            "VENDOR": "HPE",
            "id": 6,
            "BASE_OS_VERSION": "16.11",
            "DT_COUNT": 3,
            "NAME": "HPEArubaOS"
        },
        {
            "DISPLAYNAME": "PAN-OS REST API",
            "BASE_URL_FORMAT": "",
            "DESCRIPTION": "This device template is derived from PAN REST API version v9.0. Few APIs that are added / enhanced in this template may not work in the older versions.",
            "VENDOR": "PaloAlto",
            "id": 2,
            "BASE_OS_VERSION": "9.0",
            "DT_COUNT": 3,
            "NAME": "PanOS"
        }
    ]
}

Error Response

View common error responses

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

Get TEST Template Details

API EndPoint : getRESTTemplateDetails

This API retrieves detailed information for a specific REST template.

The response includes key attributes such as:

Template name and description

Associated vendor and base OS version

To view credential parameters for a specific template, refer to the getRestAPICredentials API.

To view rest configlets for a specific template, refer to the getRESTConfigletDetails API.

HTTP Method

GET

API URL

http://localhost:8060/api/json/ncmconfiglets/getRESTTemplateDetails?apiKey=********&restTemplateId=101

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
restTemplateId	The unique identifier of the REST template for which details are being fetched. restTemplateId can be retrieved from getAllRESTTemplates API	long	-	yes

Sample Response

HTTP Code: 200

{
    "restEnabled": true,
    "restTemplateId": 1,
    "restBaseUrl": "",
    "restVendor": "Fortinet",
    "restDesc": "This device template is derived from FortiOS REST API version v6.0.4. Few APIs that are added / enhanced in this template may not work in the older versions.",
    "restDisplayName": "FortiOS REST API",
    "restBaseVersion": "6.0.4",
    "restName": "FortiOS"
}

Error Response

View common error responses

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

Get All REST Configlets

API EndPoint : getAllRESTOperations

This API retrieves the list of all REST Configlets associated with a specific REST template or all the REST Configlets if no rest template id is provided.

It is primarily used to populate a grid in the UI and therefore includes pagination details in the response.

HTTP Method

GET

API URL

http://localhost:8060/api/json/ncmconfiglets/getAllRESTOperations?apiKey=********&restTemplate=101

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
restTemplate	The unique identifier of the REST Device Template for which the list is being fetched. restTemplate can be retrieved from getAllRESTTemplates API	String	-	No
jqgrid_id	Unique identifier for the jqGrid instance. Used to distinguish between multiple grids on the same page or in the same API call.	String	-	No
jqgridLoad	Indicates whether the jqGrid should perform a fresh load or reload its data.	boolean	-	No
_search	Set to true if the current request is for searching/filtering data, and false otherwise.	boolean	-	No
nd	Timestamp value used for cache busting, ensuring fresh data is retrieved from the server rather than from browser cache.	long	-	No
rows	The number of rows to retrieve per page (page size). Controls pagination in jqGrid.	int	-	No
page	The current page number to be retrieved. Enables pagination functionality in jqGrid.	int	-	No
sidx	The column name by which to sort the data. Used for server-side sorting in jqGrid.	String	-	No
sord	The sort order for the data, either asc (ascending) or desc (descending).	String	-	No
filters	JSON-encoded string containing advanced multi-field filter criteria generated by jqGrid's toolbar or multi-search.	String	-	No
searchOper	The search operator for simple search (e.g., eq for equals, ne for not equals, bw for begins with, etc.). Used with single-field search.	String	-	No
searchString	The value to search for in a simple (single-field) search. Used with searchField and searchOper.	String	-	No
searchField	The column name to perform a simple search on. Used with searchString and searchOper to define single-field search criteria.	String	-	No

Sample Response

HTTP Code: 200

{
  "total": 1,
  "records": "3",
  "page": 1,
  "rows": [
    {
      "API_URL": "/api/v2/cmdb/firewall/address",
      "TEMPLATE_NAME": "FortiOS REST API",
      "FAVOURITE": true,      
      "VENDOR": "Fortinet",
      "REQUEST_TYPE": "POST",
      "id": 1,
      "CREATEDBY": "SYSTEM",
      "BASE_OS_VERSION": "6.0.4",
      "actions": {"json":[{"PLOT_TYPE":"EXECUTE_FORM","REQUEST_TYPE":"POST","PARAMS":"{'mKeySelection':'false','includeAllParams':'true', 'restricted':'true'}","KEY":"Add","URL":"/api/v2/cmdb/firewall/address","ACTIONID":13,"NAME":"Add"},{"PLOT_TYPE":"EXECUTE_FORM","REQUEST_TYPE":"PUT","PARAMS":"{'prepopulation':'true','includeAllParams':'true','readOnlyParams':['type'], 'restricted':'true'}","KEY":"Edit","URL":"/api/v2/cmdb/firewall/address/$name","ACTIONID":14,"NAME":"Edit"},{"PLOT_TYPE":"GRID","REQUEST_TYPE":"GET","PARAMS":"{'mKeySelection':'false'}","subActions":"{'header':['Add'],'row':['View','Edit','Rename','Delete'],'grid_id':'fortios_address','readOnlyOperations':['View']}","KEY":"List","URL":"/api/v2/cmdb/firewall/address","ACTIONID":15,"NAME":"View All"},{"PLOT_TYPE":"VIEW_FORM","REQUEST_TYPE":"GET","PARAMS":"{'includeAllParams':'true','prepopulation':'true'}","subActions":"{'header':['Edit','Rename','Delete']}","KEY":"View","URL":"/api/v2/cmdb/firewall/address/$name","ACTIONID":16,"NAME":"View Object"},{"PLOT_TYPE":"EXECUTE_FORM","REQUEST_TYPE":"PUT","PARAMS":"{'includedParams':['name'], 'restricted':'true'}","KEY":"Rename","URL":"/api/v2/cmdb/firewall/address/$name","ACTIONID":17,"NAME":"Rename"},{"PLOT_TYPE":"DELETE_FORM","REQUEST_TYPE":"DELETE","PARAMS":"{'includeAllParams':'true','prepopulation':'true', 'restricted':'true'}","KEY":"Delete","URL":"/api/v2/cmdb/firewall/address/$name","ACTIONID":18,"NAME":"Delete"}]},
      "NAME": "Address"
    },
    {
      "API_URL": "/Objects/Addresses",
      "TEMPLATE_NAME": "PAN-OS REST API",
      "FAVOURITE": true,
      "VENDOR": "PaloAlto",
      "REQUEST_TYPE": "POST",
      "id": 2,
      "CREATEDBY": "SYSTEM",
      "BASE_OS_VERSION": "9.0",
      "actions": {"json":[{"PLOT_TYPE":"EXECUTE_FORM","REQUEST_TYPE":"POST","PARAMS":"{'mKeySelection':'false','includeAllParams':'true', 'restricted':'true'}","KEY":"Add","URL":"/Objects/Addresses","ACTIONID":115,"NAME":"Add"},{"PLOT_TYPE":"EXECUTE_FORM","REQUEST_TYPE":"PUT","PARAMS":"{'prepopulation':'true','includeAllParams':'true', 'restricted':'true'}","KEY":"Edit","URL":"/Objects/Addresses","ACTIONID":116,"NAME":"Edit"},{"PLOT_TYPE":"GRID","REQUEST_TYPE":"GET","PARAMS":"{'mKeySelection':'false','includedParams':[]}","subActions":"{'header':['Add'],'row':['View','Edit','Rename','Delete'],'grid_id':'panos_address','readOnlyOperations':['View']}","KEY":"List","URL":"/Objects/Addresses","ACTIONID":117,"NAME":"View All"},{"PLOT_TYPE":"VIEW_FORM","REQUEST_TYPE":"GET","PARAMS":"{'prepopulation':'true','includeAllParams':'true'}","subActions":"{'header':['Edit','Rename','Delete']}","KEY":"View","URL":"/Objects/Addresses","ACTIONID":118,"NAME":"View Object"},{"PLOT_TYPE":"DELETE_FORM","REQUEST_TYPE":"DELETE","PARAMS":"{'prepopulation':'true','includeAllParams':'true', 'paramsToSendDevice':['name'], 'restricted':'true'}","KEY":"Delete","URL":"/Objects/Addresses","ACTIONID":119,"NAME":"Delete"},{"PLOT_TYPE":"EXECUTE_FORM","REQUEST_TYPE":"POST","PARAMS":"{'prepopulation':'true','includedParams':['name'], 'extraParams':[{'name':'action', 'default-value':'rename', 'userinput':'false', 'paramType':'POST_PARAM', 'paramOrder':'2'}, {'name':'newname', 'displayName':'New Name', 'userinput':'true', 'mandatory':'true', 'paramType':'POST_PARAM', 'additionalDetails':{'size':'63'}, 'paramOrder':'3'}], 'restricted':'true'}","KEY":"Rename","URL":"/Objects/Addresses","ACTIONID":120,"NAME":"Rename"}]},
      "NAME": "Address"
    },
    {
      "API_URL": "/api/v2/cmdb/firewall/addrgrp",
      "TEMPLATE_NAME": "FortiOS REST API",
      "FAVOURITE": true,
      "VENDOR": "Fortinet",
      "REQUEST_TYPE": "POST",
      "id": 3,
      "CREATEDBY": "SYSTEM",
      "BASE_OS_VERSION": "6.0.4",
      "actions": {"json":[{"PLOT_TYPE":"EXECUTE_FORM","REQUEST_TYPE":"POST","PARAMS":"{'mKeySelection':'false','prepopulation':'true','includeAllParams':'true', 'restricted':'true'}","KEY":"Add","URL":"/api/v2/cmdb/firewall/addrgrp","ACTIONID":25,"NAME":"Add"},{"PLOT_TYPE":"EXECUTE_FORM","REQUEST_TYPE":"PUT","PARAMS":"{'includeAllParams':'true','prepopulation':'true', 'restricted':'true'}","KEY":"Edit","URL":"/api/v2/cmdb/firewall/addrgrp/$name","ACTIONID":26,"NAME":"Edit"},{"PLOT_TYPE":"GRID","REQUEST_TYPE":"GET","PARAMS":"{'mKeySelection':'false'}","subActions":"{'header':['Add'],'row':['View','Edit','Rename','Delete'],'grid_id':'fortios_addrgrp','readOnlyOperations':['View']}","KEY":"List","URL":"/api/v2/cmdb/firewall/addrgrp","ACTIONID":27,"NAME":"View All"},{"PLOT_TYPE":"VIEW_FORM","REQUEST_TYPE":"GET","PARAMS":"{'includeAllParams':'true','prepopulation':'true'}","subActions":"{'header':['Edit','Rename','Delete']}","KEY":"View","URL":"/api/v2/cmdb/firewall/addrgrp/$name","ACTIONID":28,"NAME":"View Object"},{"PLOT_TYPE":"EXECUTE_FORM","REQUEST_TYPE":"PUT","PARAMS":"{'includedParams':['name'], 'restricted':'true'}","KEY":"Rename","URL":"/api/v2/cmdb/firewall/addrgrp/$name","ACTIONID":29,"NAME":"Rename"},{"PLOT_TYPE":"DELETE_FORM","REQUEST_TYPE":"DELETE","PARAMS":"{'includeAllParams':'true','prepopulation':'true', 'restricted':'true'}","KEY":"Delete","URL":"/api/v2/cmdb/firewall/addrgrp/$name","ACTIONID":30,"NAME":"Delete"}]},
      "NAME": "Address Group"
    }
  ]
}

Error Response

View common error responses

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

Get REST Configlet Details

API EndPoint : getRESTConfigletDetails

This API retrieves the list of all REST Configlets associated with a specific REST template.

List of all REST Configlets will be returned if no template id is provided.

The response includes the IDs of the Configlets and the corresponding APIs used by each.

For detailed information on individual Configlets and their operations, refer to the getAllRESTOperations API.

HTTP Method

GET

API URL

http://localhost:8060/api/json/ncmconfiglets/getRESTConfigletDetails?apiKey=********&restTemplateId=101

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
restTemplateId	The unique identifier of the REST Device Template for which the list is being fetched. restTemplateId can be retrieved from getAllRESTTemplates API	long	-	No
jqgrid_id	Unique identifier for the jqGrid instance. Used to distinguish between multiple grids on the same page or in the same API call.	String	-	No
jqgridLoad	Indicates whether the jqGrid should perform a fresh load or reload its data.	boolean	-	No
_search	Set to true if the current request is for searching/filtering data, and false otherwise.	boolean	-	No
nd	Timestamp value used for cache busting, ensuring fresh data is retrieved from the server rather than from browser cache.	long	-	No
rows	The number of rows to retrieve per page (page size). Controls pagination in jqGrid.	int	-	No
page	The current page number to be retrieved. Enables pagination functionality in jqGrid.	int	-	No
sidx	The column name by which to sort the data. Used for server-side sorting in jqGrid.	String	-	No
sord	The sort order for the data, either asc (ascending) or desc (descending).	String	-	No
filters	JSON-encoded string containing advanced multi-field filter criteria generated by jqGrid's toolbar or multi-search.	String	-	No
searchOper	The search operator for simple search (e.g., eq for equals, ne for not equals, bw for begins with, etc.). Used with single-field search.	String	-	No
searchString	The value to search for in a simple (single-field) search. Used with searchField and searchOper.	String	-	No
searchField	The column name to perform a simple search on. Used with searchString and searchOper to define single-field search criteria.	String	-	No

Sample Response

HTTP Code: 200

{
    "rows": [
        {
            "API_URL": "/api/v2/cmdb/firewall/policy",
            "NAME": "Policy"
        },
        {
            "API_URL": "/api/v2/cmdb/firewall/policy6",
            "NAME": "IPv6 Policy"
        },
        {
            "API_URL": "/api/v2/cmdb/firewall/address",
            "NAME": "Address"
        },
        {
            "API_URL": "/api/v2/cmdb/firewall/address6",
            "NAME": "IPv6 Address"
        }
    ]
}

Error Response

View common error responses

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

Execute REST API

API EndPoint : execAPI

This API executes a specified REST Configlet on a target device within NCM.

It is typically used to trigger REST-based configurations or operations defined in the Configlet as actions.

HTTP Method

POST

API URL

http://localhost:8060/api/json/ncmconfiglets/execAPI?apiKey=********&resourceId=305&operationId=1&action=Add&apiURLParams={extraParam:value}&postJSONData={name:test_address,subnet:192.168.1.0/24}&annotation=Add%20new%20address%20object

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
resourceId	The identifier of the device on which the operation should be performed. Use this when executing on a single device. Although marked as optional, either resourceId or resourceIds must be provided for the API to function.	long	-	No
operationId	The unique identifier of the REST Configlet being executed. operationId can be retrieved from getAllRESTOperations API	long	-	yes
action	Specifies which action should be performed for the selected Configlet. Each Configlet defines its own set of actions — for example: viewAll, add, delete, edit, etc. List of actions can be checked in getAllRESTOperations API	String	-	yes
resourceIds	Used when executing the operation on multiple devices. Either resourceId or resourceIds is required, even though both are marked as optional. Note: Not all actions support multi-device execution. Please review the Configlet details before invoking the API with this parameter.	JSONArray	-	No
apiURLParams	A stringified JSON object containing additional query parameters required by the API URL for the specified Configlet.	String	-	No
mKey	The unique identifier (Managed Key) of the object on the device on which the operation is being performed. MKeys differ between vendors. Refer to the vendor’s API documentation, as well as the Configlet and action details, to determine the correct value. renderExecuteRESTAPI contains the details abour mKey for each action	String	-	No
postJSONData	The JSON body that will be sent in the API request to the device. Use the renderExecuteRESTAPI API to fetch details about the required body parameters.	String	-	No
postData	The data payload forwarded with the API call to the device. Use the renderExecuteRESTAPI API to fetch details about the required post parameters.	String	-	No
initialData	Stores the current configuration of the object before executing the Configlet. This enables comparison between the pre-execution and post-execution configurations. Use the getMKeyObjectDetails API to retrieve the current configuration.	String	-	No
annotation	Used to include additional context or notes for this particular execution. Helps identify or trace executions in the REST execution history grid. It can also assist administrators in tracking requests that require approval before execution.	String	^([p{L}p{N}P{InBasicLatin}.!:#$s-_',])+$	No

Sample Response

HTTP Code: 200

{
 "isSuccess":true,
"NEED_APPROVAL": false,
"statusMsg":"Operation executed Successfully"
}

Error Response

View common error responses

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

Execute REST Api and Get Result

API EndPoint : execAPIAndGetResult

This API functions similarly to the execAPI API but is designed specifically for Configlets where the device response is returned in CLI format.

In NCM, it is primarily used for Arista-related Configlets.

For all other Configlets, use the execAPI API instead.

HTTP Method

POST

API URL

http://localhost:8060/api/json/ncmconfiglets/execAPIAndGetResult?apiKey=********&resourceId=305&operationId=15&action=Add&postJSONDataname:test_address,subnet:192.168.1.0/24}

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
resourceId	The identifier of the device on which the operation should be performed.	long	-	No
operationId	The unique identifier of the REST Configlet being executed. operationId can be retrieved from getAllRESTOperations API	long	-	yes
action	Specifies which action should be performed for the selected Configlet. Each Configlet defines its own set of actions. List of actions can be checked in getAllRESTOperations API	String	-	yes
postJSONData	The JSON body that will be sent in the API request to the device. Use the renderExecuteRESTAPI API to fetch details about the required body parameters.	String	-	No

Sample Response

HTTP Code: 200

{
    "devResponse": {
        "statusMsg": "",
        "response": "Actual device response redacted due to security reasons",
        "isSuccess": true
    },
    "isSuccess": true
}

Error Response

View common error responses

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

Get REST Object List from a device

API EndPoint : getMKeyObjectList

This API functions similarly to the execAPI API but is designed specifically for Configlet actions where the device response returns a list of objects.

It is equivalent to performing the “View All” operation from the UI and is always used to retrieve object lists from the device.

This API should be used only for actions categorized as LIST.

In NCM, each such action has a predefined grid ID, and the returned data is formatted accordingly.

The response also includes grid column details to support proper rendering in the UI.

HTTP Method

POST

API URL

http://localhost:8060/api/json/ncmconfiglets/getMKeyObjectList?apiKey=********&resourceId=305&operationId=15&action=List&postJSONData={extraParam:value}

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
resourceId	The identifier of the device on which the operation should be performed.	long	-	yes
operationId	The unique identifier of the REST Configlet being executed. operationId can be retrieved from getAllRESTOperations API	long	-	yes
action	Specifies which action should be performed for the selected Configlet. Each Configlet defines its own set of actions. List of actions can be checked in getAllRESTOperations API	String	-	yes
postJSONData	The JSON body that will be sent in the API request to the device. Use the renderExecuteRESTAPI API to fetch details about the required body parameters.	String	-	No

Sample Response

HTTP Code: 200

{
    "grid_id": "arista_ip_prefix_list",
    "colModelList": [
        {
            "formatter": "",
            "search": "",
            "hidden": false,
            "displayName": "ncm.columnname.prefixListName",
            "classes": "pointer",
            "searchtype": "",
            "hidedlg": false,
            "name": "ip_prefix_list",
            "index": "ip_prefix_list",
            "sortable": ""
        },
        {
            "formatter": "",
            "search": "",
            "hidden": false,
            "displayName": "ncm.columnname.sequenceNo",
            "classes": "pointer",
            "searchtype": "",
            "hidedlg": true,
            "name": "seqno",
            "index": "seqno",
            "sortable": ""
        },
        {
            "formatter": "formatFortiOSPolicyAction",
            "search": "",
            "hidden": false,
            "displayName": "reportfilter.filtertype",
            "classes": "pointer",
            "searchtype": "",
            "name": "filterType",
            "index": "filterType",
            "sortable": ""
        },
        {
            "formatter": "",
            "search": "",
            "hidden": false,
            "displayName": "ncm.columnname.ipAddressPrefix",
            "classes": "pointer",
            "searchtype": "",
            "name": "prefix",
            "index": "prefix",
            "sortable": ""
        },
        {
            "formatter": "formatCheckUndefinedHiphen",
            "search": "",
            "hidden": false,
            "displayName": "ncm.columnname.minPrefixLength",
            "classes": "pointer",
            "searchtype": "",
            "name": "ge",
            "index": "ge",
            "sortable": ""
        },
        {
            "formatter": "formatCheckUndefinedHiphen",
            "search": "",
            "hidden": false,
            "displayName": "ncm.columnname.maxPrefixLength",
            "classes": "pointer",
            "searchtype": "",
            "name": "le",
            "index": "le",
            "sortable": ""
        },
        {
            "formatter": "formatCheckUndefinedHiphen",
            "search": "",
            "hidden": false,
            "displayName": "ncm.columnname.exactPrefixLength",
            "classes": "pointer",
            "searchtype": "",
            "name": "eq",
            "index": "eq",
            "sortable": ""
        }
    ],
    "colNameList": [
        "Prefix List Name",
        "Seq.#",
        "Filter Type",
        "IP Address Prefix",
        "Min Prefix Length",
        "Max Prefix Length",
        "Exact Prefix Length"
    ],
    "groupsList": [],
    "isv2Grid": false,
    "gridData": [
        {
            "ip_prefix_list": "LIST 1",
            "seqno": "10",
            "prefix": "0.0.0.0/0",
            "le": "32",
            "filterType": "permit",
            "ge": "0"
        },
        {
            "ip_prefix_list": "LIST 2",
            "seqno": "10",
            "prefix": "1.1.1.1/22",
            "filterType": "permit",
            "eq": "32"
        }
    ],
    "grouping": false,
    "isSuccess": true
}

Error Response

View common error responses

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

Retrieve REST Object Details

API EndPoint : getMKeyObjectDetails

This API retrieves the configuration details of a specified object on the device.

For example, it can be used to fetch details of an address or similar configuration entity on the device.

HTTP Method

GET

API URL

http://localhost:8060/api/json/ncmconfiglets/getMKeyObjectDetails?apiKey=********&resourceId=305&operationId=101&actionStr=View&apiURLParams={extraParam:value}

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
resourceId	The identifier of the device on which the operation should be performed.	long	-	yes
operationId	The unique identifier of the REST Configlet being executed. operationId can be retrieved from getAllRESTOperations API	long	-	yes
actionStr	Specifies which action should be performed for the selected Configlet. Each Configlet defines its own set of actions. List of actions can be checked in getAllRESTOperations API	String	-	yes
mKey	The unique identifier (Managed Key) of the object on the device on which the operation is being performed. MKeys differ between vendors. Refer to the vendor’s API documentation, as well as the Configlet and action details, to determine the correct value. renderExecuteRESTAPI can be used to see the details about mKey for each action	String	-	No
apiURLParams	A stringified JSON object containing additional query parameters required by the API URL for the specified Configlet. renderExecuteRESTAPI contains the details about apiURLParams for each action.	String	-	No

Sample Response

HTTP Code: 200

{
  "statusMsg": "",
  "response": {
    "is_jumbo_enabled": false,
    "vlan_id": 2,
    "is_primary_vlan": false,
    "is_dhcp_server_enabled": false,
    "name": "test",
    "type": "VT_STATIC",
    "is_dsnoop_enabled": false,
    "uri": "/vlans/2",
    "is_voice_enabled": false,
    "status": "VS_PORT_BASED"
  },
  "isSuccess": true
}

Error Response

View common error responses

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

Get Associated REST Configlets

API EndPoint : getRESTListActions

This API retrieves the list of REST Configlets associated with a specific device.

It returns only those Configlets that are marked as favorites and are categorized as LIST, which are visible under the Object Explorer section of the Device Snapshot page.

To retrieve the complete list of available Configlets, use the getAllRESTOperations API.

HTTP Method

GET

API URL

http://localhost:8060/api/json/ncmconfiglets/getRESTListActions?apiKey=********&resourceId=305

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
resourceId	The identifier of the device on which the operation should be performed.	long	-	yes

Sample Response

HTTP Code: 200

{
    "operations": [
        {
            "mkey": "octets",
            "subAction": {
                "grid_id": "HPEAruba_authorized_server",
                "rowActions": [
                    {
                        "mkey": "octets",
                        "KEY": "Delete",
                        "NAME": "Delete"
                    }
                ],
                "headerActions": [
                    {
                        "mkey": "octets",
                        "KEY": "Add",
                        "NAME": "Add"
                    }
                ]
            },
            "operationId": 1,
            "operationName": "Authorized Server",
            "fav": true
        },
        {
            "mkey": "id",
            "subAction": {
                "grid_id": "HPEAruba_ports",
                "rowActions": [
                    {
                        "mkey": "id",
                        "KEY": "Edit",
                        "NAME": "Edit"
                    }
                ],
                "headerActions": []
            },
            "operationId": 2,
            "operationName": "Port Properties",
            "fav": true
        }
    ],
    "isSuccess": true
}

Error Response

View common error responses

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

Get REST Configlets History

API EndPoint : getRESTConfigletHistory

This API retrieves the execution history of Configlets.

It is primarily used to populate a grid in the UI and therefore includes pagination details in the response.

HTTP Method

GET

API URL

http://localhost:8060/api/json/ncmconfiglets/getRESTConfigletHistory?apiKey=********

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
jqgrid_id	Unique identifier for the jqGrid instance. Used to distinguish between multiple grids on the same page or in the same API call.	String	-	No
jqgridLoad	Indicates whether the jqGrid should perform a fresh load or reload its data.	boolean	-	No
_search	Set to true if the current request is for searching/filtering data, and false otherwise.	boolean	-	No
nd	Timestamp value used for cache busting, ensuring fresh data is retrieved from the server rather than from browser cache.	long	-	No
rows	The number of rows to retrieve per page (page size). Controls pagination in jqGrid.	int	-	No
page	The current page number to be retrieved. Enables pagination functionality in jqGrid.	int	-	No
sidx	The column name by which to sort the data. Used for server-side sorting in jqGrid.	String	-	No
sord	The sort order for the data, either asc (ascending) or desc (descending).	String	-	No
filters	JSON-encoded string containing advanced multi-field filter criteria generated by jqGrid's toolbar or multi-search.	String	-	No
searchOper	The search operator for simple search (e.g., eq for equals, ne for not equals, bw for begins with, etc.). Used with single-field search.	String	-	No
searchString	The value to search for in a simple (single-field) search. Used with searchField and searchOper.	String	-	No
searchField	The column name to perform a simple search on. Used with searchString and searchOper to define single-field search criteria.	String	-	No

Sample Response

HTTP Code: 200

{
    "total": 1,
    "records": "3",
    "page": 1,
    "rows": [
        {
            "STATUS": "INPROGRESS",
            "START_TIME": "Nov 11, 2025 14:14 PM",
            "API_URL": "/rest/v4/vlans/2",
            "ACTION": "Edit",
            "OPERATION_NAME": "VLAN",
            "REQUEST_TYPE": "PUT",
            "id": 301,
            "LOGIN_NAME": "admin"
        },
        {
            "STATUS": "COMPLETED",
            "START_TIME": "Oct 10, 2025 10:24 AM",
            "API_URL": "/command-api",
            "ACTION": "Execute",
            "OPERATION_NAME": "Command Executor",
            "REQUEST_TYPE": "POST",
            "id": 2,
            "LOGIN_NAME": "admin"
        },
        {
            "STATUS": "COMPLETED",
            "START_TIME": "Oct 10, 2025 09:54 AM",
            "API_URL": "/command-api",
            "ACTION": "Execute",
            "OPERATION_NAME": "Command Executor",
            "REQUEST_TYPE": "POST",
            "id": 1,
            "LOGIN_NAME": "admin"
        }
    ]
}

Error Response

View common error responses

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