Network Configuration Manager REST API | Network Configuration Manager Help

List All Configurations

API EndPoint : listAllConfigs

This API retrieves the complete configuration history, filtered according to the parameters provided. It allows you to view past configuration versions based on file ID, search text, or device group selection.

HTTP Method

GET

API URL

http://localhost:8060/api/json/ncmconfig/listAllConfigs?apiKey=********&DG_ID=101&fileId=301

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
fileId	File Id	long	-	No
SEARCH_STRING	Filter all the configurations that contain the search string.	String	-	No
DG_ID	ID of the device group	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": [
    {
      "id": 621,
      "cell": [
        621,
        "Nov 07, 2025 09:00 AM",
        "10.5.X.X",
        "10.5.X.X",
        "5",
        "melab",
        "Running",
        1,
        "276.78 KB",
        0,
        "Not Available",
        602,
        305,
        "[NA]",
        "New configuration obtained from device after scheduled backup execution",
        ""
      ]
    }
  ]
}

Error Response

View common error responses

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

Get Device Changes

API EndPoint : getDevChanges

This API retrieves all configuration change history of all fileType for a specific device.

HTTP Method

GET

API URL

http://localhost:8060/api/json/v2/ncmconfig/getDevChanges?apiKey=********&deviceId=301

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
deviceId	Resource id of the device	long	-	yes
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": [
        {
            "backedupBy": "admin",
            "changedBy": "Not Available",
            "changeType": 1,
            "versionNo": 2,
            "approvedBy": "Not Available",
            "id": 302,
            "configSize": "760.00 Bytes",
            "fileType": "Running",
            "timestamp": "Oct 31, 2025 16:15 PM"
        },
        {
            "backedupBy": "admin",
            "changedBy": "Not Available",
            "changeType": 0,
            "versionNo": 1,
            "approvedBy": "Not Available",
            "id": 301,
            "configSize": "760.00 Bytes",
            "fileType": "Running",
            "timestamp": "Oct 31, 2025 15:47 PM"
        }
    ]
}

Error Response

View common error responses

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

Get Current Configuration Files

API EndPoint : getCurrentConfigFiles

Retrieves only the latest version of configuration files for all devices, across all configuration file types. This API returns the most recently stored configuration for each device.

HTTP Method

GET

API URL

http://localhost:8060/api/json/ncmconfig/getCurrentConfigFiles?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": [
        {
            "id": 621,
            "cell": [
                621,
                "10.5.X.X",
                "10.5.X.X",
                " 5",
                "Nov 07, 2025 09:00 AM",
                "melab",
                "Running",
                1,
                "276.78 KB",
                0,
                "Not Available",
                602,
                305,
                "[NA]",
                "New configuration obtained from device after scheduled backup execution",
                ""
            ]
        },
        {
            "id": 613,
            "cell": [
                613,
                "10.5.X.X",
                "10.5.X.X",
                " 2",
                "Nov 06, 2025 09:00 AM",
                "Not Available",
                "Startup",
                1,
                "275.99 KB",
                0,
                "Not Available",
                601,
                305,
                "[NA]",
                "New configuration obtained from device after scheduled backup execution",
                ""
            ]
        },
        {
            "id": 313,
            "cell": [
                313,
                "10.5.X.X",
                "10.5.X.X",
                11,
                "Oct 31, 2025 16:23 PM",
                "Not Available",
                "Running",
                1,
                "761.00 Bytes",
                0,
                "Not Available",
                302,
                3,
                "[NA]",
                "Configuration stored as a result of manual backup operation.",
                ""
            ]
        }
    ]
}

Error Response

View common error responses

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

Get Conflict Difference Details

API EndPoint : getConflictDiffdetails

Fetches Diff Content in Configuration Conflict. Use LEFT_CONFIG_TYPE, LEFT_CONFIG_ID, RIGHT_CONFIG_TYPE, and RIGHT_CONFIG_ID together to retrieve the actual configuration difference. If deviceId or fileId is used instead, diff content will not be available.

HTTP Method

GET

API URL

http://localhost:8060/api/json/ncmconfig/getConflictDiffdetails?apiKey=********&fileId=601

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
deviceId	Resource id of the device	long	-	No
fileId	Id of the configuration file type.ie Id of running configuration file or startup configuration file or any custom configuration file	long	-	No
LEFT_CONFIG_TYPE	Indicates the type of the left-hand configuration. Set to VERSION if the configuration ID refers to a version, or DRAFT if it refers to a draft.	-	^(DRAFT\|VERSION)$	No
LEFT_CONFIG_ID	The left-hand configuration ID. Based on the config type, this will be either a Version ID or Draft ID.	long	-	No
RIGHT_CONFIG_TYPE	Indicates the type of the right-hand configuration. Set to VERSION if the configuration ID refers to a version, or DRAFT if it refers to a draft.	-	^(DRAFT\|VERSION)$	No
RIGHT_CONFIG_ID	The right-hand configuration ID. Based on the config type, this will be either a Version ID or Draft ID.	long	-	No

Sample Response

HTTP Code: 200

{
  "showDiff": true,
  "LEFT_RESOURCE_NAME": "10.5.X.X",
  "RIGHT_RESOURCE_NAME": "10.5.X.X",
  "LEFT_VERSION_NO": "Version 1",
  "RIGHT_VERSION_NO": "Version 11",
  "modifiedCount": "6",
  "addedCount": "0",
  "deletedCount": "0",

  "diffLeft": [
    {
      "rowData": "version 11.3(c)",
      "styleClass": "diffModifiedLine"
    },
    {
      "rowData": " mtu 15001",
      "styleClass": "diffModifiedLine"
    }
  ],

  "diffRight": [
    {
      "rowData": "version 11.6(c)",
      "styleClass": "diffModifiedLine"
    },
    {
      "rowData": " mtu 15002",
      "styleClass": "diffModifiedLine"
    }
  ]
}

Error Response

View common error responses

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

Get Latest StartupRunning Version

API EndPoint : getStartupRunningVersion

This API retrieves the latest Startup and Running configuration version IDs for a specific device.

It indicates whether both configuration types are present in the repository, and returns the respective version numbers if available.

HTTP Method

GET

API URL

http://localhost:8060/api/json/ncmconfig/getStartupRunningVersion?apiKey=********&RESOURCEID=333

Parameters

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

Sample Response

HTTP Code: 200

{
    "Running": 621,
    "Vlan": 623,
    "Startup": 613,
    "isSuccess": true
}

Error Response

View common error responses

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

Get Configuration File Summary

API EndPoint : getConfigFileSummary

This API retrieves detailed information about a specific configuration file, including the version number, file type (Running or Startup), configuration size, when it was captured, and who performed the backup. It provides a complete summary to help understand the context, source, and revision of the configuration.

HTTP Method

GET

API URL

http://localhost:8060/api/json/ncmconfig/getConfigFileSummary?apiKey=********&fileId=302&snapType=ConfigFile

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
fileId	Id of the configuration file type.ie Id of running configuration file or startup configuration file or any custom configuration file	long	-	yes
snapType	Determines whether snapshot details are included in the response. If snapType is set to `ConfigFile`, the response includes snapDetails, which contain widget and layout metadata used to display configuration summaries in the UI. If snapType is left empty, snapDetails are excluded, and only the core configuration summary data is returned.	-	^(ConfigFile)$	no

Sample Response

HTTP Code: 200

{
  "ConfigSize": "276.78 KB",
  "ChangedBy": "melab",
  "BackedupBy": "admin",
  "CapturedOn": "Nov 07, 2025 09:00 AM",
  "VersionNo": 5,
  "LabelName": "BASELINE",
  "FileFormat": "Text",
  "deviceId": 305,
  "yaxis": "Count",
  "Annotation": "New configuration obtained from device after scheduled backup execution",
  "BASE_LINE_VERSION": 621,
  "FileType": "Running",
  "ChangeType": 1,
  "dataset": [
    {
      "seriesname": "Authorized",
      "data": [
        [
          1762353473637,
          0
        ],
        [
          1762439873637,
          0
        ],
        [
          1762526273637,
          0
        ],
        [
          1762612673637,
          0
        ],
        [
          1762699073637,
          0
        ],
        [
          1762785473637,
          0
        ],
        [
          1762871873637,
          0
        ]
      ],
      "yaxiscolumnorder": [
        0
      ]
    },
    {
      "seriesname": "Unauthorized",
      "data": [
        [
          1762353473637,
          0
        ],
        [
          1762439873637,
          2
        ],
        [
          1762526273637,
          1
        ],
        [
          1762612673637,
          0
        ],
        [
          1762699073637,
          0
        ],
        [
          1762785473637,
          0
        ],
        [
          1762871873637,
          0
        ]
      ],
      "yaxiscolumnorder": [
        0
      ]
    }
  ],
  "HostName": "CiscoRouter140.com",
  "fileId": 602
}

Error Response

View common error responses

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

Get Configuration File Details

API EndPoint : getConfigFileDetails

This API retrieves the complete details of a specific configuration version. It returns metadata such as who backed up the configuration, when it was captured, the configuration size, version number, and any associated baseline comparison details. It can also return the full configuration content, making it useful for audits, compliance reviews, or manual inspection.

If a snapType value is provided, the response will additionally include snapDetails, which contains UI snapshot layout information used for rendering configuration details in the web interface. If snapType is left empty, the response will exclude snapDetails, providing only core configuration data.

HTTP Method

GET

API URL

http://localhost:8060/api/json/ncmconfig/getConfigFileDetails?apiKey=********&snapType=ConfigChange&versionId=619

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
versionId	ID of the configuration version	long	-	yes
NODIFF	Optional flag. Set to true to skip diff comparison results in response.	boolean	-	No
snapType	Determines whether snapDetails is included. Set to ConfigFile to include UI snapshot layout data. Leave empty to exclude it.	-	^(ConfigChange)$	No

Sample Response

HTTP Code: 200

{
  "VersionNo": 4,
  "VersionId": 619,
  "FileType": "Running",
  "FileFormat": "Text",
  "ConfigSize": "275.93 KB",
  "CapturedOn": "Nov 06, 2025 16:16 PM",
  "BackedupBy": "admin",
  "ChangedBy": "nfa",
  "Annotation": "Configuration backup taken before script execution",
  "LabelName": "No labels associated with this version",
  "HostName": "CiscoRouter140.manageengine.com",
  "fileId": 602,
  "ChangeType": 1,
  "BASE_LINE_VERSION": 621,
  "baselineDiff": {
    "LEFT_VERSION_NO": "Version 4",
    "RIGHT_VERSION_NO": "Version 5",
    "modifiedCount": "13",
    "addedCount": "12",
    "deletedCount": "0"
  },
  "prevDiff": {
    "LEFT_VERSION_NO": "Version 3",
    "RIGHT_VERSION_NO": "Version 4",
    "modifiedCount": "12",
    "addedCount": "0",
    "deletedCount": "0"
  },
  "Running": 621,
  "Startup": 613,
  "Content": "file content here"
}

Error Response

View common error responses

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

Execute Configuration Sync Action

API EndPoint : exeConfigSyncAction

Copies the device’s current running configuration to the startup configuration, ensuring changes are saved and preventing configuration loss after a reboot or unexpected failure.

HTTP Method

POST

API URL

http://localhost:8060/api/json/ncmconfig/exeConfigSyncAction?apiKey=********&DEVICE_IDS=[305,45001]

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
DEVICE_IDS	Resource IDs of the devices whose running configuration needs to be copied to the startup configuration.	JSONArray	-	No
DEVICE_GROUP_ID	ID of the device group containing the devices to perform this operation on.	long	-	No

Sample Response

HTTP Code: 200

{
  "SUPPORTED_RESOURCEID_LIST": [
    305
  ],
  "statusMsg": "Configuration synchronization operation has been scheduled successfully",
  "Success for device:": 305,
  "NOT_SUPPORTED_DEVICES_LIST": [],
  "NOT_SUPPORTED_RESOURCEID_LIST": [],
  "FAILED_RESOURCEID_LIST": [],
  "FAILED_DEVICES_LIST": [],
  "isSuccess": true
}

Error Response

View common error responses

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

Add New Draft

API EndPoint : exeNewDraft

Adds a new configuration draft or updates an existing one for a specific device. Drafts allow users to make, review, and test configuration changes before applying them to the live device configuration, helping maintain controlled network updates.

HTTP Method

POST

API URL

http://localhost:8060/api/json/ncmconfig/exeNewDraft?apiKey=********&ANNOTATION=Update%20NTP%20configuration%20for%20device%20security&FILE_CONTENTS=ntp%20server%2010.20.30.40%20prefer&DRAFT_NAME=NTPUpdateDraft&RESOURCEID=305

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
DRAFT_ID	Unique identifier of the draft. Required when updating an existing draft.	long	-	No
ANNOTATION	Description or remarks explaining the purpose or details of the draft configuration.	-	^([p{L}p{N}P{InBasicLatin}.!:@#$s-_\/',])+$	yes
FILE_CONTENTS	The actual configuration content or commands included in the draft.	String	-	yes
DRAFT_NAME	Name assigned to the draft.	-	^([p{L}p{N}P{InBasicLatin}.!:@#$s-_\/',])+$	No
RESOURCEID	Resource ID of the device for which the draft configuration is being created or updated.	long	-	No
VERSION_ID	ID of the specific configuration version on which the draft is based.	long	-	No

Sample Response

HTTP Code: 200

{
  "DRAFT_ID": "302",
  "statusMsg": "Draft Running Version 8 Draft 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 Draft

API EndPoint : deleteDraft

Deletes one or more draft configurations

HTTP Method

POST

API URL

http://localhost:8060/api/json/ncmconfig/deleteDraft?apiKey=********&DRAFT_ID=[302,303]

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
DRAFT_ID	List of unique IDs of the drafts to be deleted.	JSONArray	-	No

Sample Response

HTTP Code: 200

{
  "statusMsg": "Draft has been removed successfully",
  "isSuccess": true
}

Error Response

View common error responses

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

Get Version Details

API EndPoint : getVersionDetails

Retrieves detailed information about one or more configuration versions of a device. Each version includes metadata such as annotation, timestamp, change type and the user who made the changes, helping track and manage device configuration history

HTTP Method

GET

API URL

http://localhost:8060/api/json/ncmconfig/getVersionDetails?apiKey=********&VERSIONS=[622,616]

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
VERSION	Single version number to fetch details for a specific configuration version.	long	-	No
VERSIONS	Array of version numbers to fetch details for multiple configuration versions at once.	JSONArray	-	No

Sample Response

HTTP Code: 200

{
  "versions": [
    {
      "CHANGE_TYPE": 1,
      "versionId": 622,
      "ANNOTATION": "New configuration obtained from device after scheduled backup execution",
      "TIMESTAMP": "Nov 07, 2025 09:00 AM",
      "RESOURCENAME": "10.5.x.x",
      "IS_BASELINE": true,
      "VERSION_NO": 15,
      "FILE_TYPE": "Vlan",
      "RESOURCEID": 305,
      "CHANGED_BY": "Not Available"
    },
    {
      "CHANGE_TYPE": 1,
      "versionId": 616,
      "ANNOTATION": "Configuration stored as a result of manual backup operation.",
      "TIMESTAMP": "Nov 06, 2025 11:45 AM",
      "RESOURCENAME": "10.5.x.x",
      "IS_BASELINE": false,
      "VERSION_NO": 11,
      "FILE_TYPE": "Vlan",
      "RESOURCEID": 305,
      "CHANGED_BY": "Not Available"
    }
  ]
}

Error Response

View common error responses

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

Authorize Unauthorize a Configuration Version

API EndPoint : exeAuthorize

Authorizes or unauthorizes a specific configuration version for a device. This API helps validate changes by marking a configuration as approved (authorized) or rejected (unauthorized), supporting controlled network configuration management.

HTTP Method

POST

API URL

http://localhost:8060/api/json/ncmconfig/exeAuthorize?apiKey=********&VERSION_ID=[616]&AUTHORIZE_CHANGES=false&MESSAGE_BOX=Unauthorized%20change%20detected

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
VERSION_ID	List of configuration version IDs to be authorized or unauthorized.	JSONArray	-	No
AUTHORIZE_CHANGES	Specify whether to authorize (true) or unauthorize (false) the changes.	boolean	-	No
MESSAGE_BOX	Message or note to include while authorizing or unauthorizing the configuration	String	-	No

Sample Response

HTTP Code: 200

{
  "noLabel": true,
  "ConfigSize": "809.00 Bytes",
  "ChangedBy": "Not Available",
  "BackedupBy": "admin",
  "CapturedOn": "Nov 06, 2025 11:45 AM",
  "VersionNo": 11,
  "LabelName": "No labels associated with this version",
  "Vlan": 623,
  "FileFormat": "Text",
  "Annotation": "Configuration stored as a result of manual backup operation.",
  "BASE_LINE_VERSION": 622,
  "versionId": 616,
  "statusMsg": "Authorized",
  "FileType": "Vlan",
  "ChangeType": 0,
  "Content": "nnVirtual LAN ID:  1 (IEEE 802.1Q Encapsulation)nn   vLAN Trunk Interface:   GigabitEthernet0/1nn   Protocols Configured: Transmitted:nnGigabitEthernet0/1.1 (10)nn   0 packets, 0 bytes inputn   0 packets, 0 bytes outputn",
  "Running": 621,
  "Startup": 613,
  "HostName": "10.5.x.x",
  "isSuccess": true,
  "fileId": 603
}

Error Response

View common error responses

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

Set a Config Version as Baseline

API EndPoint : exeSetasBaseLine

Marks a specific configuration version as the baseline version for a device. Baseline versions serve as reference points for future comparisons, helping track changes and maintain network consistency.

HTTP Method

POST

API URL

http://localhost:8060/api/json/ncmconfig/exeSetasBaseLine?apiKey=********&VERSION_ID=616&SET_AS_BASELINE=true

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
VERSION_ID	ID of the configuration version to set as baseline.	long	-	yes
SET_AS_BASELINE	Specify whether this version should be set as baseline. It should be provided as 'true' mandatorily	boolean	-	No

Sample Response

HTTP Code: 200

{
  "ConfigSize": "809.00 Bytes",
  "ChangedBy": "Not Available",
  "BackedupBy": "admin",
  "CapturedOn": "Nov 06, 2025 11:45 AM",
  "VersionNo": 11,
  "LabelName": "BASELINE",
  "Vlan": 623,
  "FileFormat": "Text",
  "Annotation": "Configuration stored as a result of manual backup operation.",
  "BASE_LINE_VERSION": 616,
  "versionId": 616,
  "statusMsg": "BASELINE label has been associated successfully with the selected version no: 11",
  "FileType": "Vlan",
  "ChangeType": 0,
  "Content": "nnVirtual LAN ID:  1 (IEEE 802.1Q Encapsulation)nn   vLAN Trunk Interface:   GigabitEthernet0/1nn   Protocols Configured: Transmitted:nnGigabitEthernet0/1.1 (10)nn   0 packets, 0 bytes inputn   0 packets, 0 bytes outputn",
  "Running": 621,
  "Startup": 613,
  "HostName": "10.5.x.x",
  "isSuccess": true,
  "fileId": 603,
  "BaseLine": 1
}

Error Response

View common error responses

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

Get Device Drafts

API EndPoint : getDevDrafts

Retrieves all draft configurations associated with a specific device. Drafts allow users to make, review, and test configuration changes before applying them to the live device configuration.

HTTP Method

GET

API URL

http://localhost:8060/api/json/ncmconfig/getDevDrafts?apiKey=********&RESOURCEID=101

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
RESOURCEID	Unique ID of the device for which drafts are 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": 302,
      "cell": [
        302,
        "CiscoRouter.xx.com",
        "10.5.X.X",
        "Running Version 8 Draft",
        "admin",
        "Nov 13, 2025 11:57 AM",
        "Version 2",
        "Running",
        ""
      ]
    }
  ]
}

Error Response

View common error responses

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

Get All Drafts

API EndPoint : getAllDrafts

Provides the list of all drafts available

HTTP Method

GET

API URL

http://localhost:8060/api/json/ncmconfig/getAllDrafts?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": [
    {
      "id": 1,
      "cell": [
        1,
        "10.5.X.X",
        "10.5.X.X",
        "Draft001",
        "admin",
        "Oct 31, 2025 16:24 PM",
        "Version 6",
        "Running",
        ""
      ]
    },
    {
      "id": 2,
      "cell": [
        2,
        "10.5.X.X",
        "10.5.X.X",
        "Draft002",
        "admin",
        "Oct 31, 2025 16:24 PM",
        "Version 3",
        "Running",
        ""
      ]
    }
  ]
}

Error Response

View common error responses

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

Get Draft Details

API EndPoint : getDraftDetails

Fetches detailed information about a specific draft configuration, including its differences from the base version, associated device, file contents, and snapshot metadata. Useful for reviewing, validating, or comparing draft changes before applying them.

HTTP Method

GET

API URL

http://localhost:8060/api/json/ncmconfig/getDraftDetails?apiKey=********&DRAFT_ID=2&snapType=ConfigDraft

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
DRAFT_ID	Unique ID of the draft whose details are to be fetched.	long	-	yes
snapType	Provide the snapshot as "ConfigDraft" to get snapshot metadata	-	^(ConfigDraft)$	No

Sample Response

HTTP Code: 200

{
  "draftId": 2,
  "baseVersionDiff": {
    "modifiedCount": "0",
    "RIGHT_RESOURCE_NAME": "10.5.X.X",
    "RIGHT_VERSION_NO": "Draft002",
    "LEFT_FILE_TYPE": "Running",
    "addedCount": "0",
    "LEFT_RESOURCE_NAME": "10.5.X.X",
    "LEFT_CONFIG_ID": "305",
    "RIGHT_CONFIG_ID": "2",
    "deltedCount": "0",
    "LEFT_VERSION_NO": "Version 3",
    "LEFT_CONFIG_TYPE": "VERSION",
    "RIGHT_CONFIG_TYPE": "DRAFT",
    "RIGHT_FILE_TYPE": "Draft"
  },
  "isDwdAllowed": false,
  "FILETYPE": "Running",
  "Annotation": "Running Version 3",
  "modifiedOn": "Oct 31, 2025 04:24 PM",
  "versionId": 305,
  "ownerName": "admin",
  "snapDetails": {
    "snapList": [
      {
        "indexCount": 0,
        "ondemandWidget": false,
        "refresh": false,
        "type": "DraftSummary",
        "sizex": 10,
        "expand": false,
        "apiurl": "/client/api/json/ncmconfig/getDraftDetails",
        "rowNum": 1,
        "parameter": "DRAFT_ID",
        "isEnabled": true,
        "colNum": 1,
        "name": "ncm.configdraft.summary",
        "header": false,
        "id": 401,
        "snapid": 401,
        "expandtime": false,
        "parameters": [],
        "sizey": 12,
        "timeSelection": false,
        "desc": "webclient.snapshot.name.Draft.Summary"
      }
    ],
    "snapshotID": "31",
    "snapshotDesc": "snapshot.desc.configdraft",
    "snapshotName": "ConfigDraft",
    "tabs": {
      "tabs": [],
      "tabWidgets": {}
    },
    "timeSelectionNeeded": false,
    "yScale": 25,
    "maxColumns": 10
  },
  "RESOURCENAME": "10.5.X.X",
  "VERSION": "Version 3",
  "FILE_CONTENTS": "!nversion 11.6(c)nservice confignservice password-encryptionn!hostname Cisco36002588n!enable password 7 testn!username user password 7 passwordrmon event 1 description Low Value owner testUsernrmon alarm 1 10 absolute  rising-threshold 10 rising-threshold Index  1 falling-threshold 1  falling-threshold Index2 owner testUsernn!nendn$TIME_MODIFIED_1761825608834",
  "fileformat": "Text",
  "RESOURCEID": 3,
  "draftName": "Draft002"
}

Error Response

View common error responses

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