Network Configuration Manager REST API | Network Configuration Manager Help

Get All Credential Rules

API EndPoint : getAllCredentialRules

Retrieves a paginated list of Credential Rules available in NCM. This endpoint is typically used to populate a grid or table view in the UI. The response includes both the Credential Rule data and pagination metadata.

HTTP Method

GET

API URL

http://localhost:8060/api/json/ncmtags/getAllCredentialRules?apiKey=********

Parameters

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

Sample Response

HTTP Code: 200

{
    "headers": [
        {
            "hidden": true,
            "displayName": "",
            "name": "id"
        },
        {
            "displayName": "webclient.ncm.credRule.ruleOrder",
            "name": "RULE_ORDER",
            "width": "5"
        },
        {
            "formatter": "cellValueEscapeFormat",
            "displayName": "webclient.admin.alarmesc.RuleName",
            "classes": "pointer",
            "name": "RULENAME",
            "width": "15"
        },
        {
            "formatter": "formatCredRuleCriteria",
            "displayName": "webclient.opm.group.create.step2",
            "classes": "pointer",
            "name": "CRITERIA",
            "width": "50"
        },
        {
            "hidden": true,
            "displayName": "",
            "classes": "pointer",
            "name": "DEVICE_CRI_TYPE"
        },
        {
            "hidden": true,
            "displayName": "",
            "name": "STATUS"
        },
        {
            "displayName": "opu.common.PROTOCOL",
            "classes": "pointer",
            "name": "PROTOCOL_NAME",
            "width": "10"
        },
        {
            "formatter": "cellValueEscapeFormat",
            "displayName": "ncm.acd.Profile_Name",
            "classes": "pointer",
            "name": "PROFILENAME",
            "width": "10"
        },
        {
            "formatter": "formatCredRuleAction",
            "displayName": "webclient.action.actions",
            "classes": "pointer",
            "name": "ACTION",
            "width": "10"
        }
    ],
    "colCount": 6,
    "gridId": "CredentialRules",
    "rows": [
        {
            "CREATED_BY": "admin",
            "CRITERIA": {
                "criteriaDetails": [
                    {
                        "Condition": "LIKE",
                        "Field": "ADDRESS",
                        "Value": "3.4",
                        "Comparator": ""
                    },
                    {
                        "Condition": "STARTS_WITH",
                        "Field": "RESOURCENAME",
                        "Value": "CHEN",
                        "Comparator": "and"
                    }
                ]
            },
            "DEVICE_CRI_TYPE": "CRITERIA",
            "STATUS": true,
            "PROFILENAME": "test",
            "RULENAME": "Cred Rule Test",
            "LAST_MODIFIED_BY": "admin",
            "DESCRIPTION": "This is a new Credential Rule",
            "RULE_ORDER": 1,
            "id": 1,
            "PROTOCOL_NAME": "SSH"
        }
    ],
    "isSuccess": true
}

Error Response

View common error responses

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

Render Credentials Rule

API EndPoint : renderCredentialsRule

Retrieves detailed information for a specific credential rule, including its associated credential profiles and rule criteria.

HTTP Method

GET

API URL

http://localhost:8060/api/json/ncmtags/renderCredentialsRule?apiKey=********&RULEID=101

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
RULEID	Unique identifier of the credential rule whose details are to be retrieved. You can use the getAllCredentialRules API to obtain the corresponding RULEID.	long	-	No

Sample Response

HTTP Code: 200

{
    "IsDeviceGroupSelected": false,
    "UnselectedDGMap": {
        "1": "All Devices Group",
        "2": "CiscoRouter Group",
        "3": "CiscoSwitch Group",
        "4": "Backup Failure Group",
        "5": "CIS Cisco IOS Group",
        "6": "CIS Cisco ASA Group"
    },
    "LoginId": 1,
    "DG_DESCRIPTION": {
        "1": "ncm.default_devicegroup.description",
        "2": "ncm.ciscorouter_group.description",
        "3": "ncm.ciscoswitch_group.description",
        "4": "ncm.bkupfailure_group.description",
        "5": "ncm.devicegroup.cisco.ios.desc",
        "6": "ncm.devicegroup.cisco.asa.desc"
    },
    "DG_INFO": {
        "1": "All Devices Group",
        "2": "CiscoRouter Group",
        "3": "CiscoSwitch Group",
        "4": "Backup Failure Group",
        "5": "CIS Cisco IOS Group",
        "6": "CIS Cisco ASA Group"
    },
    "profiles": [
        {
            "PROFILENAME": "test",
            "PROFILEID": 301
        }
    ],
    "protocols": [
        {
            "COMBINATIONID": 1,
            "DISPLAYNAME": "SSH"
        },
        {
            "COMBINATIONID": 2,
            "DISPLAYNAME": "SSH - SCP"
        },
        {
            "COMBINATIONID": 3,
            "DISPLAYNAME": "SSH - TFTP"
        },
        {
            "COMBINATIONID": 7,
            "DISPLAYNAME": "SSH - SFTP"
        },
        {
            "COMBINATIONID": 4,
            "DISPLAYNAME": "TELNET"
        },
        {
            "COMBINATIONID": 5,
            "DISPLAYNAME": "TELNET - TFTP"
        },
        {
            "COMBINATIONID": 6,
            "DISPLAYNAME": "SNMP - TFTP"
        }
    ],
    "selectedDGMap": {},
    "SHOW_ONLY_PUBLIC_DEVICE_GROUP": true,
    "isSuccess": true
}

Error Response

View common error responses

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

Get Credential Rule Audit

API EndPoint : getCrRuleAudit

Retrieves a paginated list of audit records for a specified credential rule. These audits help identify which credential rules have been applied to which devices. The response includes pagination metadata as well.

HTTP Method

GET

API URL

http://localhost:8060/api/json/ncmtags/getCrRuleAudit?apiKey=********&ruleId=101

Parameters

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

Sample Response

HTTP Code: 200

{
    "total": 1,
    "records": "-1",
    "page": 1,
    "rows": [
        {
            "PROFILENAME": "test",
            "RULENAME": "Cred Rule Test",
            "TIMESTAMP": "Nov 11, 2025 15:54 PM",
            "RESOURCENAME": "172.21.0.251",
            "RULEID": 1,
            "id": 1,
            "INVOKED_BY": "admin"
        },
        {
            "PROFILENAME": "test",
            "RULENAME": "Cred Rule Test",
            "TIMESTAMP": "Nov 11, 2025 15:54 PM",
            "RESOURCENAME": "172.21.0.241",
            "RULEID": 1,
            "id": 2,
            "INVOKED_BY": "admin"
        }
    ]
}

Error Response

View common error responses

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

Delete Credential Rule Audit

API EndPoint : deleteCrRuleAudit

This API is used to delete the specified credential rule audit records.

HTTP Method

POST

API URL

http://localhost:8060/api/json/ncmtags/deleteCrRuleAudit?apiKey=********&AUDIT_IDS=[101,102,103]

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
AUDIT_IDS	Array of unique identifiers of the credential rule audit records that are being deleted. You can use the getCrRuleAudit API to obtain the AUDIT ID.	JSONArray	-	yes

Sample Response

HTTP Code: 200

{"statusMsg":"Audit record(s) 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 Tag Details

API EndPoint : tagPreRenders

Retrieves detailed information of a tag, including their names, display names, tagID, descriptions, and associated custom column values.

HTTP Method

GET

API URL

http://localhost:8060/api/json/ncmtags/tagPreRenders?apiKey=********&TAG_ID=501

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
TAG_ID	Unique identifier for the tag for which details need to be fetched	long	-	No

Sample Response

HTTP Code: 200

{"tagDisplayName":"Chennai","customColName1":"Custom Column 1","TAG_NAMES":["Chennai"],"Description":"Chennai specific objects","tagId":"1","availableProbeList":[],"tagName":"TestTag","TAG_DISPLAYNAMES":["Chennai"],"customColVal1":"","customColName3":"Custom Column 3","customColName2":"Custom Column 2","customColVal3":"","customColVal2":""}

Error Response

View common error responses

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

Retrieve Tags Details

API EndPoint : tagsList

Retrieves detailed information of all tags, including their names, tagID, display names and associated custom column values.

HTTP Method

GET

API URL

http://localhost:8060/api/json/ncmtags/tagsList?apiKey=********

Parameters

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

Sample Response

HTTP Code: 200

{"customColName1":"Country","customColName3":"City","tags":[{"TagName":"Chennai","TagId":2701,"DisplayName":"Chennai"}],"customColName2":"Location"}

Error Response

View common error responses

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

List All Tags

API EndPoint : listAllTags

Retrieves a list of all tags configured, including their names, display names and associated custom column details

HTTP Method

GET

API URL

http://localhost:8060/api/json/ncmtags/listAllTags?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":"Chennai","TAGNAME":"Chennai","COLUMNVALUE1":"","COLUMNVALUE2":"","COLUMNVALUE3":"","id":1}]}

Error Response

View common error responses

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

Update Tag Custom Columns

API EndPoint : updateTagCustomColumnDetails

Updates the default custom column details of a tag

HTTP Method

POST

API URL

http://localhost:8060/api/json/ncmtags/updateTagCustomColumnDetails?apiKey=********&customColName1=Location&customColName2=Contact%20Person&customColName3=Address

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
customColName1	Custom column value1	-	^([p{L}p{N}P{InBasicLatin}.!:@#$s-_\/'[],])+$	No
customColName2	Custom column value2	-	^([p{L}p{N}P{InBasicLatin}.!:@#$s-_\/'[],])+$	No
customColName3	Custom column value3	-	^([p{L}p{N}P{InBasicLatin}.!:@#$s-_\/'[],])+$	No

Sample Response

HTTP Code: 200

{"statusMsg":"Custom column names are updated for tags 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 Tag Devices

API EndPoint : listTagDevices

Retrieves a list of devices associated with a specific tag, allowing administrators to see which devices are categorized under that tag

HTTP Method

GET

API URL

http://localhost:8060/api/json/ncmtags/listTagDevices?apiKey=********&TAG_ID=101

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
TAG_ID	The unique identifier of the tag whose associated devices need to be fetched.	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":"1","page":1,"rows":[{"DEVICE_TYPE":"Cisco Router","SERIES":"C2951","STARTUP_CONFLICT":true,"BASELINE_CONFLICT":true,"OPERATIONSTATUS":"SUCCESS","COMPLIANCE_STATUS":"Violation","RESOURCENAME":"10.5.X.X","OPERATIONTYPE":"Backup","IP_ADDRESS":"10.5.X.X","id":901,"MODEL":"CISCO2951/K9"}]}

Error Response

View common error responses

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

List Tag Configlets

API EndPoint : listTagConfiglets

Retrieves a list of configuration templates (configlets) associated with a specific tag, allowing administrators see which configlets are categorized under that tag

HTTP Method

GET

API URL

http://localhost:8060/api/json/ncmtags/listTagConfiglets?apiKey=********&TAG_ID=101

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
TAG_ID	The unique identifier of the tag whose associated configlets need to be fetched	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":"2","page":1,"rows":[{"TEMPLATE_NAME":".TagAdmin123","LAST_MODIFIED_TIME":"Nov 11, 2025 15:15 PM","OWNER_NAME":"TagAdmin","TEMPLATE_TYPE":"COMMAND_LINE_MODE","id":31501}]}

Error Response

View common error responses

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

List Tag Schedules

API EndPoint : listTagSchedules

Retrieves a list of schedules associated with a specific tag, showing which scheduled tasks or jobs are under that tag

HTTP Method

GET

API URL

http://localhost:8060/api/json/ncmtags/listTagSchedules?apiKey=********&TAG_ID=101

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
TAG_ID	The unique identifier of the tag whose associated schedules need to be fetched	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":"1","page":1,"rows":[{"LoginNAME":"TagAdmin","ADMIN_STATUS":3,"TASK_TYPE":"Configuration Backup","id":39304,"SCHEDULE_NAME":"TestSchedule"}]}

Error Response

View common error responses

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

List Tag Policies

API EndPoint : listTagPolicies

Retrieves a list of compliance policies associated with a specific tag, allowing administrators to see which compliance policies are categorized under that tag

HTTP Method

GET

API URL

http://localhost:8060/api/json/ncmtags/listTagPolicies?apiKey=********&TAG_ID=101

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
TAG_ID	The unique identifier of the tag whose associated compliance policies need to be fetched	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":"1","page":1,"rows":[{"POLICY_NAME":"TagPolicy","CREATED_BY":"TagAdmin","LAST_MODIFIED_BY":"TagAdmin","DESCRIPTION":"","CONFIG_TYPE":"Running","id":19801}]}

Error Response

View common error responses

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

List Tag Device Groups

API EndPoint : listTagDGs

Retrieves a list of device groups (DGs) associated with a specific tag, showing which device groups include under that tag

HTTP Method

GET

API URL

http://localhost:8060/api/json/ncmtags/listTagDGs?apiKey=********&TAG_ID=101

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
TAG_ID	The unique identifier of the tag whose associated device groups need to be fetched	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":"1","page":1,"rows":[{"ComplianceStatus2":0,"ComplianceStatus1":0,"ConflictStatus":1,"ConflictStatus2":0,"DESCRIPTION":"","ComplianceStatus":1,"ConflictStatus1":0,"id":16804,"DEVICE_GROUP_NAME":"TagPublicGroup","IsGlobal":false}]}

Error Response

View common error responses

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

List Tag Notifications

API EndPoint : listTagNotifications

Retrieves a list of change notifications associated with a specific tag, showing which change notifications are categorized under that tag

HTTP Method

GET

API URL

http://localhost:8060/api/json/ncmtags/listTagNotifications?apiKey=********&TAG_ID=101

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
TAG_ID	The unique identifier of the tag whose associated notifications need to be fetched	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":"1","page":1,"rows":[{"CREATED_BY":"TagAdmin","ACTIONS_DISPLAY_NAME":"Rollback Config","LAST_MODIFIED_BY":"TagAdmin","DESCRIPTION":"","RULE_NAME":"TagNotification","id":10801,"CHANGETYPE_DISPLAY_NAME":"Authorized or Unauthorized change","CONDITION_DISPLAY_NAME":"Any configuration changed"}]}

Error Response

View common error responses

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

List Tag Credentials

API EndPoint : listTagCredentials

Retrieves a list of credentials associated with a specific tag, showing which device credentials are categorized under that tag

HTTP Method

GET

API URL

http://localhost:8060/api/json/ncmtags/listTagCredentials?apiKey=********&TAG_ID=101

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
TAG_ID	The unique identifier of the tag whose associated credentials need to be fetched	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":"1","page":1,"rows":[{"id":12,"PROFILENAME":"TagSSHCredential","DESCRIPTION":"Test Backup Credentials"}]}

Error Response

View common error responses

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

List Tag SSH Keys

API EndPoint : listTagSSHKeys

Retrieves a list of SSH keys associated with a specific tag, showing which SSH keys are categorized under that tag

HTTP Method

GET

API URL

http://localhost:8060/api/json/ncmtags/listTagSSHKeys?apiKey=********&TAG_ID=101

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
TAG_ID	The unique identifier of the tag whose associated SSH keys need to be fetched	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":"1","page":1,"rows":[{"id":12,"KEYNAME":"TagSSHKey","COMMENTS":"New SSH Key"}]}

Error Response

View common error responses

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

List Tag Users

API EndPoint : listTagUsers

Retrieves a list of users associated with a specific tag, showing which users have categorized under that tag

HTTP Method

GET

API URL

http://localhost:8060/api/json/ncmtags/listTagUsers?apiKey=********&TAG_ID=101

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
TAG_ID	The unique identifier of the tag whose associated users need to be fetched	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

{"page":1,"rows":[{"AUTHENTICATION":"Local Authentication","CURRENT_LOGIN":"13 Nov 2025 03:09:54 PM IST","PREVIOUS_LOGIN":"11 Nov 2025 03:26:27 PM IST","DESCRIPTION":"Administrator","id":405,"FIRST_NAME":"TagAdmin"}]}

Error Response

View common error responses

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

Get Tag Custom Columns

API EndPoint : getTagCustomColumnDetails

Retrieves the default details of the custom columns

HTTP Method

GET

API URL

http://localhost:8060/api/json/ncmtags/getTagCustomColumnDetails?apiKey=********

Parameters

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

Sample Response

HTTP Code: 200

{"customColName1":"Country","customColName3":"City","customColName2":"Location"}

Error Response

View common error responses

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

Associate Tag to Resource

API EndPoint : associateTagtoResource

Associates a specific tag with a single resource

HTTP Method

POST

API URL

http://localhost:8060/api/json/ncmtags/associateTagtoResource?apiKey=********&TAG_ID=501&RESOURCEID=1001

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
TAG_ID	The unique identifier of the tag to be associated with the selected resource	long	-	No
RESOURCEID	The unique identifier of the resource to which the tag will be applied	long	-	No

Sample Response

HTTP Code: 200

{"statusMsg":"Device Associated with Tag successfully.","isSuccess":true}

Error Response

View common error responses

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

Retrieve Tag Name

API EndPoint : getTagName

Retrieves the name of a specific tag based on its unique identifier

HTTP Method

GET

API URL

http://localhost:8060/api/json/ncmtags/getTagName?apiKey=********&TAG_ID=101

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
TAG_ID	The unique identifier of the tag whose name needs to be fetched	long	-	yes

Sample Response

HTTP Code: 200

{"tagDisplayName":"Chennai","tagName":"Chennai","isSuccess":true}

Error Response

View common error responses

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