Network Configuration Manager REST API | Network Configuration Manager Help

Configure Password Manager

API EndPoint : configure

Configures or updates PAM integration settings in NCM

HTTP Method

POST

API URL

http://localhost:8060/api/json/pam/configure?apiKey=********&protocol=https&server_name=pam-1234&server_port=8282&enabled=true&auth_token=********&app_server_name=NetworkConfigurationManager&service_name=PAM360

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
protocol	Protocol used for PAM connection. Use https for secure communication	-	^(http\|https)$	yes
server_name	Hostname or IP address of the PAM server	-	^([p{L}p{N}P{InBasicLatin}s.:-_])+$	yes
server_port	Port number used to connect to the PAM server	-	^([1-9][0-9]{0,3}\|[1-5][0-9]{4}\|6[0-4][0-9]{3}\|65[0-4][0-9]{2}\|655[0-2][0-9]\|6553[0-5])$	yes
enabled	Indicates whether PAM integration is enabled	boolean	-	yes
auth_token	Authentication token used to authorize requests to the PAM server	-	[p{L}p{N}-_s]+	yes
app_server_name	Unique name used to map NCM with the PAM360 service. Identifies the ITOM application in PAM360.	-	^([A-Za-z0-9._s])+$	yes
service_name	Name of the password manager to be configured	-	^(PMP\|PAM360\|CYBERARK)$	yes

Sample Response

HTTP Code: 200

{"test_connection":true,"statusMsg":"PAM360 settings configured successfully","connection_msg":"Verification success, Now you can proceed further.","isSuccess":true}

Error Response

View common error responses

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

Generate Application Token

API EndPoint : generateAppToken

Generates a token in NCM to be provided to PAM for integration

HTTP Method

POST

API URL

http://localhost:8060/api/json/pam/generateAppToken?apiKey=********

Parameters

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

Sample Response

HTTP Code: 200

{
    "statusMsg": "Successfully generated PAM Auth Token",
    "isSuccess": true
}

Error Response

View common error responses

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

Get Password Manager Settings

API EndPoint : getSettings

Retrieves the current PAM integration settings from NCM

HTTP Method

GET

API URL

http://localhost:8060/api/json/pam/getSettings?apiKey=********

Parameters

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

Sample Response

HTTP Code: 200

{
  "PAM_CONFIGURED_SUCCESS": {
    "server_name": "test-123",
    "service_name": "PAM360",
    "itom_host": "10.5.X.X",
    "itom_port": "8061",
    "protocol": "https",
    "server_port": 8282,
    "pamConfigured": true,
    "enabled": true,
    "app_connection_status": true,
    "last_connection_status": true,
    "last_connection_message": "Verification success, Now you can proceed further.",
    "pamTokenGenerated": true,
    "auth_token": "not_to_display",
    "app_server_name": "TestNew",
    "additional_details": [
      {
        "key": "auth_token",
        "value": "not_to_display",
        "is_secured": true
      },
      {
        "key": "app_server_name",
        "value": "TestNew",
        "is_secured": false
      }
    ],
    "isSuccess": true
  },

  "PAM_CONFIGURED_CONNECTION_FAILED": {
    "server_name": "test-123",
    "service_name": "PAM360",
    "itom_host": "10.5.X.X",
    "itom_port": "8061",
    "protocol": "https",
    "server_port": 8282,
    "pamConfigured": true,
    "enabled": true,
    "app_connection_status": true,
    "last_connection_status": false,
    "last_connection_message": "Sync failed. Please check the provided data are correct.",
    "app_connection_message": "Application server name has been mapped incorrectly, preventing password retrieval.",
    "pamTokenGenerated": true,
    "auth_token": "not_to_display",
    "app_server_name": "TestNCM",
    "additional_details": [
      {
        "key": "auth_token",
        "value": "not_to_display",
        "is_secured": true
      },
      {
        "key": "app_server_name",
        "value": "TestNCM",
        "is_secured": false
      }
    ],
    "isSuccess": true
  }
}

Error Response

View common error responses

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

Sync Device Passwords from PAM

API EndPoint : sync

Syncs passwords of associated device accounts from NCM to PAM

HTTP Method

POST

API URL

http://localhost:8060/api/json/pam/sync?apiKey=********

Parameters

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

Sample Response

HTTP Code: 200

{"statusMsg":"Sync initiated with PAM360. Please navigate to Action > View Sync Report for details.","isSuccess":true}

Error Response

View common error responses

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

Delete PAM Integration

API EndPoint : delete

Deletes the PAM integration from NCM and removes it from PAM if the connection exists

HTTP Method

POST

API URL

http://localhost:8060/api/json/pam/delete?apiKey=********

Parameters

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

Sample Response

HTTP Code: 200

{
  "PAM_REMOVED_FROM_NCM_AND_PAM": {
    "statusMsg": "Successfully removed PAM360 configuration",
    "isSuccess": true
  },
  "PAM_REMOVED_FROM_NCM_ONLY": {
    "statusMsg": "Successfully removed PAM360 configuration from Network Configuration Manager. Unable to reach PAM360 service. Kindly remove the configuration in PAM360",
    "isSuccess": true
  }
}

Error Response

View common error responses

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

Test PAM Connectivity

API EndPoint : test

Tests the connectivity between NCM and PAM to verify integration settings.

HTTP Method

POST

API URL

http://localhost:8060/api/json/pam/test?apiKey=********&test_existing=false&service_name=PAM360&server_name=pam-1234&server_port=8282

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
test_existing	Tests existing PAM configuration if true; otherwise tests new/modified configurations	boolean	-	No
service_name	Name of the password manager configured	-	^(PMP\|PAM360\|CYBERARK)$	No
server_name	Hostname or IP address of the PAM server	-	^([p{L}p{N}P{InBasicLatin}s.:-_])+$	No
server_port	Port number used to connect to the PAM server	-	^([1-9][0-9]{0,3}\|[1-5][0-9]{4}\|6[0-4][0-9]{3}\|65[0-4][0-9]{2}\|655[0-2][0-9]\|6553[0-5])$	No
auth_token	Authentication token used to authorize requests to the PAM server	-	[p{L}p{N}-_s]+	No

Sample Response

HTTP Code: 200

{"statusMsg":"Verification success, Now you can proceed further.","isSuccess":true}

Error Response

View common error responses

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

Update PAM Integration Status

API EndPoint : updatePAMStatus

Enables or disables PAM integration in NCM

HTTP Method

POST

API URL

http://localhost:8060/api/json/pam/updatePAMStatus?apiKey=********&enabled=true

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
enabled	Indicates whether PAM integration is enabled	boolean	-	yes

Sample Response

HTTP Code: 200

{
  "PAM360_DISABLED": {
    "statusMsg": "PAM360 has been disabled successfully",
    "isSuccess": true
  },
  "PAM360_ENABLED": {
    "statusMsg": "PAM360 has been enabled successfully",
    "isSuccess": true
  }
}

Error Response

View common error responses

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

Retrieve PAM Users

API EndPoint : getUsers

Retrieves users associated with device accounts from the PAM system

HTTP Method

GET

API URL

http://localhost:8060/api/json/pam/getUsers?apiKey=********&moid=101

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
moid	The unique identifier of the resource for which user accounts need to be fetched	long	-	No
dns_name	Hostname of the resource for which user accounts need to be fetched	-	^([p{L}p{N}P{InBasicLatin}s.:-_])+$	No

Sample Response

HTTP Code: 200

{"user_names":["test", "test2"],"isSuccess":true}

Error Response

View common error responses

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

Schedule PAM Tasks

API EndPoint : schedule

Schedules PAM tasks with configurable status, frequency, day, and time.

HTTP Method

POST

API URL

http://localhost:8060/api/json/pam/schedule?apiKey=********&admin_status=true&repeat_frequency=daily&day_of_week=0&day_of_month=0&time_hrs=10&time_mins=30&connection_mail_address=test@test.com

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
admin_status	Defines whether the task is enabled (true) or disabled (false)	-	^(enabled\|disabled)$	yes
repeat_frequency	Specifies the repeat frequency (e.g., daily, weekly, monthly)	-	^(daily\|weekly\|monthly)$	No
day_of_week	Day of the week for weekly tasks	int	-	No
day_of_month	Day of the month for monthly tasks (1-31)	int	-	No
time_hrs	Hour of the day (0-23) when the task should occur.	int	-	No
time_mins	Minute of the hour (0-59) when the task should occur.	int	-	No
connection_mail_address	Email address to notify if the scheduled sync fails	-	^[%_+a-zA-Z0-9]([a-zA-Z0-9%_-.'])@([a-zA-Z0-9_-.])(.[a-zA-Z]+)$	No

Sample Response

HTTP Code: 200

{"isSuccess":"true"}

Error Response

View common error responses

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

Get PAM Task Details

API EndPoint : getSchedule

Retrieves the configured PAM task schedule with status, frequency, day, and time details

HTTP Method

GET

API URL

http://localhost:8060/api/json/pam/getSchedule?apiKey=********

Parameters

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

Sample Response

HTTP Code: 200

{"connectionFailureMailAddress":"test@test.com","time_hrs":10,"admin_status":"enabled","repeat_frequency":"daily","schedule_name":"CPSyncSchedule","time_mins":0,"isSuccess":true}

Error Response

View common error responses

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

PAM Configuration Status

API EndPoint : isPAMConfigured

Checks whether PAM integration is configured in NCM or not

HTTP Method

GET

API URL

http://localhost:8060/api/json/pam/isPAMConfigured?apiKey=********

Parameters

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

Sample Response

HTTP Code: 200

{"redirectURL":"https://PAMServer:8282","isAddOnConfigured":true,"service_name":"PAM360","pamConfigured":true,"pamTokenGenerated":true,"server_url":"https://PAMServer:8282","enabled":true,"isSuccess":true}

Error Response

View common error responses

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

Retrieve Sync Operations

API EndPoint : getSyncTasks

Retrieves the list of manual and scheduled sync operations performed

HTTP Method

GET

API URL

http://localhost:8060/api/json/pam/getSyncTasks?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":"2","page":1,"rows":[{"start_time":"Nov 07, 2025 13:05 PM","end_time":"Nov 07, 2025 13:05 PM","description":"Sync operation initiated from application settings.","id":2,"triggered_by":"admin","status":"COMPLETED"},{"start_time":"Nov 07, 2025 12:44 PM","end_time":"Nov 07, 2025 12:44 PM","description":"Sync operation initiated from application settings.","id":1,"triggered_by":"admin","status":"COMPLETED"}]}

Error Response

View common error responses

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

Retrieve Sync Operation Accounts

API EndPoint : getSyncAccounts

Retrieves the list of accounts synchronized in a specific sync operation.

HTTP Method

GET

API URL

http://localhost:8060/api/json/pam/getSyncAccounts?apiKey=********&task_id=101

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
task_id	The unique identifier of the sync task to retrieve accounts	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":[{"updated_time":"Nov 07, 2025 13:05 PM","account_name":"test","task_id":2,"id":1,"op_type":"ADD","resource_name":"10.5.X.X"}]}

Error Response

View common error responses

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

Retrieve Synced Resources

API EndPoint : getSharedResources

Retrieves all resources synchronized with PAM, including the number of accounts per resource

HTTP Method

GET

API URL

http://localhost:8060/api/json/pam/getSharedResources?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":[{"last_updated_time":"Nov 07, 2025 13:05 PM","resource_type":"Cisco IOS","number_of_accounts":1,"id":1,"resource_name":"10.5.X.X"}]}

Error Response

View common error responses

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

Retrieve Shared Accounts for Resource

API EndPoint : getSharedAccounts

Retrieves the list of accounts shared from PAM for a specific resource

HTTP Method

GET

API URL

http://localhost:8060/api/json/pam/getSharedAccounts?apiKey=********&resource_id=101

Parameters

Param Name	Description	Data Type	Regex	Is Mandatory
apiKey	API Key to access your server.	-	-	Yes
resource_id	The unique identifier of the resource for which shared accounts are retrieved	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":[{"updated_time":"Nov 07, 2025 13:05 PM","account_id":"1","account_name":"test","module":"NCM","resource_id":1,"id":1,"favourite":false}]}

Error Response

View common error responses

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