REST API Documentation

Note:

Enterprise edition user sync: The Rest API access will not be synced for users from Central to Probe servers. The synced users in Probes will not have permanent Rest API access. Whereas, for the users created in the Probe server, the Rest API access can be updated as required.

TFA: If Two-Factor Authentication has been configured, TFA OTP validation is mandatory to enable Rest API access.

  • Module Wise Api List
  • Json Templates
  • Regex Templates
  • admin
    Title
    API Name
    Method
    Execution in Standalone/Probe
    Execution in Central
    Execution in Probe from Central
    Sample URL
    Get approval users
    getNCMApprovalUsers
    GET
    Allowed
    Restricted
    Restricted
    http://server-url:8060/api/json/admin/getNCMApprovalUsers?apiKey=XXXXXXXXXXYYY
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    ncmProbeId
    probeNameRegex
    No
    Get NFA group names
    getNFAGroupNames
    GET
    Allowed
    Allowed
    Restricted
    http://server-url:8060/api/json/admin/getNFAGroupNames?apiKey=XXXXXXXXXXYYY
    Get pagerDuty configuration settings
    getPagerDutySettings
    GET
    Allowed
    Restricted
    Restricted
    http://server-url:8060/api/json/admin/getPagerDutySettings?apiKey=XXXXXXXXXXYYY
    Modify API global conditions
    modifyAPIGlobalConditions
    POST
    Allowed
    Restricted
    Restricted
    http://server-url:8060/api/json/admin/modifyAPIGlobalConditions?apiKey=XXXXXXXXXXYYY
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    criteria
    Criteria
    stringWithComma
    Yes
    ncmProbeId
    probeNameRegex
    No
    Remove the pager duty configuration
    removePagerDutyConfiguration
    POST
    Allowed
    Restricted
    Restricted
    http://server-url:8060/api/json/admin/removePagerDutyConfiguration?apiKey=XXXXXXXXXXYYY
    Update PagerDuty configuration details
    updatePagerDutySettings
    POST
    Allowed
    Restricted
    Restricted
    http://server-url:8060/api/json/admin/updatePagerDutySettings?apiKey=XXXXXXXXXXYYY
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    routingKey
    key to integrate
    String
    No
    ncm_upload_request
    Raise upload request
    boolean
    No
    ncm_backup_alert
    Raise backup alert
    boolean
    No
    consentStatus
    consent details
    ^(true)$
    Yes
  • device
    Title
    API Name
    Method
    Execution in Standalone/Probe
    Execution in Central
    Execution in Probe from Central
    Sample URL
    Get device list for filter
    getDeviceListForFilter
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/device/getDeviceListForFilter?apiKey=XXXXXXXXXXYYY
    Get NCM devices details
    getNCMDeviceDetails
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/device/getNCMDeviceDetails?apiKey=XXXXXXXXXXYYY
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    ncmProbeId
    probeNameRegex
    No
    unManageFireWalls
    POST
    Allowed
    Restricted
    Restricted
    http://server-url:8060/api/json/device/unManageFireWalls?apiKey=XXXXXXXXXXYYY
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    deviceList
    numberWithComma
    No
    cid
    long
    No
  • discovery
    Title
    API Name
    Method
    Execution in Standalone/Probe
    Execution in Central
    Execution in Probe from Central
    Sample URL
    Discover devices into NCM
    addDiscoveryProfile
    POST
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/v2/discovery/addDiscoveryProfile?apiKey=XXXXXXXXXXYYY&profileName=Profile_2024_06_20_13_31_42&discoveryType=IPRange&ipVersion=4&rangeDetails=FromIP=1.1.1.1, ToIP=1.1.1.30&interfaceDiscovery=false&sheduleDiscovery=true&credentialNames=Public&rediscoveryRule=true&ignoreRule=false&addRule=false&deviceAddAction=ADD&deviceRemoveAction=SKIP&intfAddAction=ADD&intfRemoveAction=SKIP&executeNow=true&existingDevices=true&rediscoverExistingDevices=false&emailId=test@test.com&netmask=255.255.255.0&schedType=1&onceDate=2024-06-20&onceHour=13&onceMin=31&dailyHour=1&dailyMin=1&weeklyHour=1&weeklyMin=1&monthlyHour=1&monthlyMin=1&monthlyDate=1&monthlyWeekNum=1&yearlyHour=1&yearlyMin=1&yearlyDate=1&ipIndex=1&displayIndex=1&typeIndex=1&toIP=1.1.1.30&isSingleIPDiscovery=false
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    wsId
    ID of the PNS Session
    alphanumeric
    Yes
    profileName
    Name of the discovery profile
    layer2mapName
    Yes
    Profile_2024_06_20_13_31_42
    discoveryType
    Type of the discovery
    discoveryProfileType
    Yes
    IPRange
    ipVersion
    Version of the IPAddress
    ^(4|6)$
    Yes
    4
    rangeDetails
    Range of the discovery
    string_with_IPRegex
    No
    FromIP=1.1.1.1, ToIP=1.1.1.30
    interfaceDiscovery
    Interface discovery or not
    boolean
    Yes
    false
    sheduleDiscovery
    Schedule discovery or not
    boolean
    Yes
    true
    credentialNames
    SNMP credential names
    String
    No
    Public
    rediscoveryRule
    Re-discovery or not
    boolean
    No
    true
    ignoreRule
    Ignore discovery rules
    boolean
    No
    false
    addRule
    Add discovery rules
    boolean
    No
    false
    description
    Description of the profile
    text_no_special_char
    No
    ruleIds
    Rule Ids
    positiveNumWithComma
    No
    deviceAddAction
    Add/Skip/Delete interfaces
    deviceOrInterfaceAction
    No
    ADD
    deviceRemoveAction
    Add/Skip/Delete interfaces
    deviceOrInterfaceAction
    No
    SKIP
    intfAddAction
    Add/Skip/Delete interfaces
    deviceOrInterfaceAction
    No
    ADD
    intfRemoveAction
    Add/Skip/Delete interfaces
    deviceOrInterfaceAction
    No
    SKIP
    intfTypeIds
    Interface type ids
    positiveNumWithComma
    No
    intfAdminStatus
    Admin status of the interface
    severityWithComma
    No
    intfOperStatus
    Operator status of the interface
    severityWithComma
    No
    executeNow
    Execute on demand
    boolean
    No
    true
    existingDevices
    Existing devices or not
    boolean
    No
    true
    rediscoverExistingDevices
    Re-discover existing devices
    boolean
    No
    false
    type
    Existing device type
    existingDevicesType
    No
    members
    Members
    String
    No
    emailId
    Mail-ID
    emailid
    No
    test@test.com
    addFilter
    Add discovery filter
    JSONArray
    discoveryFilter
    No
    ignoreFilter
    Ignore discovery filter
    JSONArray
    discoveryFilter
    No
    netmask
    Netmask
    String_With_Extra_Symbols
    No
    255.255.255.0
    subject
    Subject
    alphanumeric_with_basic
    No
    message
    Message of the schedule
    alphanumeric_with_basic
    No
    schedType
    Schedule type
    int
    No
    1
    onceDate
    Date of the schedule
    date
    No
    2024-06-20
    onceHour
    Hour of the schedule
    int
    No
    13
    onceMin
    Minutes of the schedule
    int
    No
    31
    dailyStartDate
    Start Date of the schedule
    date
    No
    dailyHour
    Daily hour of the schedule
    int
    No
    1
    dailyMin
    Daily minutes of the schedule
    int
    No
    1
    weeklyDay
    Day in a week
    positiveNumWithComma
    No
    weeklyHour
    Weekly hour of the schedule
    int
    No
    1
    weeklyMin
    Weekly minutes of the schedule
    int
    No
    1
    monthlyHour
    Monthly hour of the schedule
    int
    No
    1
    monthlyMin
    Monthly minutes of the schedule
    int
    No
    1
    monthlyDate
    Monthly date of the schedule
    int
    No
    1
    monthlyDay
    Monthly day of the schedule
    positiveNumWithComma
    No
    monthlyWeekNum
    Week in a month
    int
    No
    1
    yearlyHour
    Yearly hour of the schedule
    int
    No
    1
    yearlyMin
    Yearly minutes of the schedule
    int
    No
    1
    yearlyMonth
    Yearly month of the schedule
    positiveNumWithComma
    No
    yearlyDate
    Yearly date of the schedule
    int
    No
    1
    ipIndex
    IP Index
    int
    No
    1
    displayIndex
    Display index
    int
    No
    1
    typeIndex
    Type index
    int
    No
    1
    toIP
    To IPAddress
    ipAddress
    No
    1.1.1.30
    isSingleIPDiscovery
    Is Single Discovery
    boolean
    No
    false
    ncmProbeId
    probeNameRegex
    No
  • ncmbackup
    Title
    API Name
    Method
    Execution in Standalone/Probe
    Execution in Central
    Execution in Probe from Central
    Sample URL
    Add a schedule
    addScheduleforConfig
    POST
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmbackup/addScheduleforConfig?apiKey=XXXXXXXXXXYYY&SCHEDULE_NAME=Hourly Backup&REPORT_ID=1&IS_ADVANCED_REPORT=true
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    SCHEDULE_NAME
    Name of the schedule
    text_basic_symbols_two_byte_support
    Yes
    Hourly Backup
    TASK_TYPE
    Task type
    ^(Configuration Backup|Compliance Check|Sync Configuration|Report Generation|Custom Template|PCI Review|Device Discovery)$
    No
    EMAIL_RECIPIENTS
    Email address
    (^[\w]([\w\-\.\+\'\/]*)@([\w\-\.]*)(\.[a-zA-Z]{2,22}(\.[a-zA-Z]{2}){0,2})(,[\w]([\w\-\.\+\'\/]*)@([\w\-\.]*)(\.[a-zA-Z]{2,22}(\.[a-zA-Z]{2}){0,2}))*)
    No
    IP_RANGE
    Range of IPAddress
    ncmIPRangeAllowedChar
    No
    SNMP_PROFILELIST
    Profile names
    String
    No
    ComponentSelection
    Device or device group selection
    ^(SpecificDevice|DeviceGroup)$
    No
    DEVICEGROUPSELECTION
    ID of the device group
    long
    No
    SELECTEDDEVICES
    Resource ids of the devices
    JSONArray
    longJson
    No
    BKPNOTIF_CONDITION
    Notify if there is a failure in backing up a device
    boolean
    No
    BKPNOTIF_CONDITION_CONFIG_CHANGE
    Notify if there is a change in configuration
    boolean
    No
    EXCLUDE_CONFIG_CHANGE_IN_MAIL
    Exclude configuration difference from notification
    boolean
    No
    COMPNOTIF_CONDITION
    Notify only if there is a policy violation
    boolean
    No
    REPORT_FILE_TYPE
    Type of the report
    ^(PDF|CSV|TXT|XLSX)$
    No
    COMPLIANCE_SHOW_RESULT
    Compliance report rule condition
    ^(VIOLATED_RULES_ONLY|COMPLIANT_RULES_ONLY|ALL_RULES)$
    No
    REPORT_TEMPLATE_NAME
    Name of the report
    ncmSchedReportTemplate
    No
    REPORT_DURATION
    Duration of the report
    ^(today|yesterday|last_30_days|last_7_days|last_week|last_month|this_week|this_month)$
    No
    REVIEWER_ID
    ID of the PCI reviewer
    long
    No
    SYNCNOTIF_CONDITION
    Notify only if there is a failure in sync configuration operation
    boolean
    No
    IS_ADD
    Add report or not
    boolean
    No
    QUERYID
    Query ID
    long
    No
    TAG_ID
    ID of the tag to be associated
    long
    No
    ScheduleMailSubject
    Mail subject
    text_basic_symbols_two_byte_support
    No
    SKIP_MAIL
    Skip mail notification
    boolean
    Yes
    IS_PUBLIC
    Public or private schedule
    boolean
    Yes
    REPORT_ID
    long
    No
    1
    IS_ADVANCED_REPORT
    boolean
    No
    true
    SCHEDULE_TYPE
    Schedule type
    ^(Hourly|Daily|Weekly|Monthly|Once Only)$
    Yes
    HOURLY_START_DATE
    Hourly start date
    schStart_date
    No
    HOURLY_START_TIME_HOUR
    Hourly start hour
    hours
    No
    HOURLY_START_TIME_MIN
    Hourly start minutes
    minutes
    No
    HOURLY_INTERVAL
    Hourly interval
    long
    No
    DAILY_START_DATE
    Daily start date
    schStart_date
    No
    DAILY_START_TIME_HOUR
    Daily start hour
    hours
    No
    DAILY_START_TIME_MIN
    Daily start minutes
    minutes
    No
    WEEKLY_START_TIME_HOUR
    Weekly start hour
    hours
    No
    WEEKLY_START_TIME_MIN
    Weekly start minutes
    minutes
    No
    WEEKLY_DAYS
    Days on the week
    JSONArray
    day_dateJson
    No
    MONTHLY_START_TIME_HOUR
    Monthly start hour
    hours
    No
    MONTHLY_START_TIME_MIN
    Monthly start minutes
    minutes
    No
    MONTHLY_MONTHS
    Months on the year
    JSONArray
    day_dateJson
    No
    MONTHLY_DATE_OF_MONTH
    Date on the month
    int
    No
    ONCEONLY_START_TIME_HOUR
    Once only start hour
    hours
    No
    ONCEONLY_START_TIME_MIN
    Once only start minutes
    minutes
    No
    ONCEONLY_START_DATE
    Once only start date
    schStart_date
    No
    WEEKLY_START_DATE
    Weekly start date
    schStart_date
    No
    MONTHLY_START_DATE
    Monthly start date
    schStart_date
    No
    CUSTOM_TEMPLATE_ID
    ID of the configlet
    long
    No
    BACKUP_ENABLED
    Execute backup before and after configlet execution
    boolean
    No
    FILEUPLOADCONFIGLET
    Is configlet value uploaded via file
    boolean
    No
    VARIABLES
    Name of the configlet script variables
    String
    No
    FILENAME
    Name of the configlet value file
    ncmFileNameChars
    No
    VAR_NAME
    Configlet value variable name
    String
    No
    Enable/Disable/Delete a schedule
    enableSceduleConfig
    POST
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmbackup/enableSceduleConfig?apiKey=XXXXXXXXXXYYY&ACTION_TYPE=DISABLE&SCHEDULE_ID=327
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    ACTION_TYPE
    Action Type
    ^(DISABLE|ENABLE|REMOVE)$
    Yes
    DISABLE
    SCHEDULE_ID
    ID of the schedule
    JSONArray
    longJson
    Yes
    327
    Execute backup
    exeBackup
    POST
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmbackup/exeBackup?apiKey=XXXXXXXXXXYYY&DEVICE_IDS=["2"]&IPADDRESS=2.3.2.1&DEVICE_GROUP_ID=1
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    DEVICE_IDS
    Resource ids of the devices
    JSONArray
    longJson
    No
    ["2"]
    IPADDRESS
    IPAddress of the device
    JSONArray
    ipJson
    No
    2.3.2.1
    DEVICE_GROUP_ID
    ID of the device group
    long
    No
    1
    Get all backups
    getBackupsList
    GET
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmbackup/getBackupsList?apiKey=XXXXXXXXXXYYY&RESOURCEID=2
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    RESOURCEID
    Resource id of the device
    long
    No
    2
    Get last backups
    getLastBackupsList
    GET
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmbackup/getLastBackupsList?apiKey=XXXXXXXXXXYYY
    Get last week backups
    getLastWeekBackupSummary
    GET
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmbackup/getLastWeekBackupSummary?apiKey=XXXXXXXXXXYYY&RESOURCEID=2
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    RESOURCEID
    Resource id of the device
    long
    Yes
    2
  • ncmcompliance
    Title
    API Name
    Method
    Execution in Standalone/Probe
    Execution in Central
    Execution in Probe from Central
    Sample URL
    Add a policy
    addCompPolicy
    POST
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmcompliance/addCompPolicy?apiKey=XXXXXXXXXXYYY&COMPRULEGROUP_ID=["5","2","6","1"]&ASSOCIATE=true&COMPPOLICY_NAME=TestPolicy&COMPPOLICY_DESCR=Policy for testing&CONFIG_TYPE=Running&COMP_CRITERIA=ANY_FAILURE&COMPPOLICY_ID=1&ASSIGNED_RESOURCES=["2"]&ASSIGNED_DEVICEGROUP=["1"]&RUNCOMPCHECK_STATUS=true&TAG_ID=1
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    COMPRULEGROUP_ID
    IDs of the rule groups
    JSONArray
    longJson
    No
    ["5","2","6","1"]
    ASSOCIATE
    Associate
    boolean
    No
    true
    COMPPOLICY_NAME
    Name of the policy
    text_basic_symbols_two_byte_support
    No
    TestPolicy
    COMPPOLICY_DESCR
    Description of the policy
    text_basic_symbols_two_byte_support
    No
    Policy for testing
    CONFIG_TYPE
    Configuration type
    ^(Running|Startup)$
    Yes
    Running
    COMP_CRITERIA
    Compliance criteria
    ^(ANY_FAILURE|CRITICAL_MAJOR_FAILURE)$
    Yes
    ANY_FAILURE
    COMPPOLICY_ID
    ID of the policy
    long
    No
    1
    ASSIGNED_RESOURCES
    Resource ids of the devices
    JSONArray
    longJson
    No
    ["2"]
    ASSIGNED_DEVICEGROUP
    Ids of the device group
    JSONArray
    longJson
    No
    ["1"]
    RUNCOMPCHECK_STATUS
    Run compliance check
    boolean
    No
    true
    TAG_ID
    ID of the tag to be associated
    long
    No
    1
    Add a rule with advanced custom criteria
    addRule
    POST
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmcompliance/addRule?apiKey=XXXXXXXXXXYYY&SIMPLE_CONDITION=10&SIMPLE_ALLOWED_COUNT=\d
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    SIMPLE_CONDITION
    ^(10|20|30|40)$
    Yes
    10
    SIMPLE_PATTERN
    String
    Yes
    SIMPLE_ALLOWED_COUNT
    ^(\d|[1-4]\d|50)$
    Yes
    \d
    COMPRULE_ID
    ID of the rule
    long
    No
    COMPRULE_NAME
    Name of the rule
    text_basic_symbols_two_byte_support
    No
    COMPRULE_DESCR
    Description of the rule
    text_basic_symbols_two_byte_support
    No
    VIOLATION_SEVERITY
    Severity of the rule
    ^(Critical|Major|Warning)$
    No
    REMEDIATION_DESCR
    Remediation description of the rule
    text_basic_symbols_two_byte_support
    No
    REMEDIATION_TEMPLATE
    ID of the remediation configlet
    long
    No
    TAG_ID
    ID of the tag to be associated
    long
    No
    Add a rule with advanced custom criteria
    addRule
    POST
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmcompliance/addRule?apiKey=XXXXXXXXXXYYY
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    CRITERIA_LIST
    Criteria List
    JSONArray
    criteriaListJson
    No
    COMPRULE_ID
    ID of the rule
    long
    No
    COMPRULE_NAME
    Name of the rule
    text_basic_symbols_two_byte_support
    No
    COMPRULE_DESCR
    Description of the rule
    text_basic_symbols_two_byte_support
    No
    VIOLATION_SEVERITY
    Severity of the rule
    ^(Critical|Major|Warning)$
    No
    REMEDIATION_DESCR
    Remediation description of the rule
    text_basic_symbols_two_byte_support
    No
    REMEDIATION_TEMPLATE
    ID of the remediation configlet
    long
    No
    TAG_ID
    ID of the tag to be associated
    long
    No
    Add a rule with advanced custom criteria
    addRule
    POST
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmcompliance/addRule?apiKey=XXXXXXXXXXYYY&BLOCK_CONDITION=NONE&IS_SINGLE_LINE=true
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    CRITERIA_LIST
    Criteria List
    JSONArray
    criteriaListJson
    No
    BLOCK_CRITERIA_LIST
    Block criteria list
    JSONArray
    blockCriteriaListJson
    No
    START_BLOCK_CONFIG
    Start Block Config
    String
    Yes
    END_BLOCK_CONFIG
    End Block Config
    String
    No
    BLOCK_CONDITION
    Block Condition
    ^(NONE|CONTAINS|NOT_CONTAINS)$
    No
    NONE
    BLOCK_CONDITION_VALUE
    Block Condition Value
    String
    No
    IS_SINGLE_LINE
    Single line or multi line
    boolean
    Yes
    true
    COMPRULE_ID
    ID of the rule
    long
    No
    COMPRULE_NAME
    Name of the rule
    text_basic_symbols_two_byte_support
    No
    COMPRULE_DESCR
    Description of the rule
    text_basic_symbols_two_byte_support
    No
    VIOLATION_SEVERITY
    Severity of the rule
    ^(Critical|Major|Warning)$
    No
    REMEDIATION_DESCR
    Remediation description of the rule
    text_basic_symbols_two_byte_support
    No
    REMEDIATION_TEMPLATE
    ID of the remediation configlet
    long
    No
    TAG_ID
    ID of the tag to be associated
    long
    No
    Add a rule group
    addRuleGroup
    POST
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmcompliance/addRuleGroup?apiKey=XXXXXXXXXXYYY&COMPRULE_ID=["10","11"]&RULEGROUP_NAME=CiscoSecurityGroup&RULEGROUP_DESCR=This group contains all security related compliance rules&COMPRULEGROUP_ID=2&TAG_ID=1
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    COMPRULE_ID
    ID of the rule
    JSONArray
    longJson
    No
    ["10","11"]
    RULEGROUP_NAME
    Name of the rulegroup
    text_basic_symbols_two_byte_support
    No
    CiscoSecurityGroup
    RULEGROUP_DESCR
    Description of the rulegroup
    text_basic_symbols_two_byte_support
    No
    This group contains all security related compliance rules
    COMPRULEGROUP_ID
    ID of the rulegroup
    long
    No
    2
    TAG_ID
    ID of the tag to be associated
    long
    No
    1
    Associate rulegroup to rule
    associateRuleGroup
    POST
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmcompliance/associateRuleGroup?apiKey=XXXXXXXXXXYYY&COMPRULE_ID=["302"]&CREATE_NEW=false&forceUpdate=true&COMPRULEGROUP_IDS=["1"]
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    COMPRULE_ID
    ID of the rule
    JSONArray
    longJson
    No
    ["302"]
    CREATE_NEW
    Create new group
    boolean
    No
    false
    RULEGROUP_NAME
    Name of the rulegroup
    text_basic_symbols
    No
    RULEGROUP_DESCR
    Description of the rulegroup
    text_basic_symbols
    No
    forceUpdate
    Force Update
    boolean
    No
    true
    COMPRULEGROUP_IDS
    IDs of the rulegroup
    JSONArray
    longJson
    No
    ["1"]
    Associate rulegroup to policy
    associateToPolicy
    POST
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmcompliance/associateToPolicy?apiKey=XXXXXXXXXXYYY&COMPRULEGROUP_IDS=["5"]&CREATE_NEW=false&forceUpdate=true&CONFIG_TYPE=Running&COMP_CRITERIA=ANY_FAILURE&COMPPOLICY_ID=["2"]
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    COMPRULEGROUP_IDS
    IDs of the rule group
    JSONArray
    longJson
    No
    ["5"]
    COMPPOLICY_IDS
    IDs of the policy
    JSONArray
    longJson
    No
    CREATE_NEW
    Create New
    boolean
    No
    false
    forceUpdate
    Force Update
    boolean
    No
    true
    COMPPOLICY_NAME
    Name of the policy
    text_basic_symbols
    No
    COMPPOLICY_DESCR
    Description of the policy
    text_basic_symbols
    No
    CONFIG_TYPE
    Configuration type
    ^(Running|Startup)$
    No
    Running
    COMP_CRITERIA
    Compliance criteria
    ^(ANY_FAILURE|CRITICAL_MAJOR_FAILURE)$
    No
    ANY_FAILURE
    COMPPOLICY_ID
    ID of the policy
    JSONArray
    longJson
    No
    ["2"]
    COMPRULEGROUP_ID
    ID of the rule group
    JSONArray
    longJson
    No
    Clone a rule
    copyRule
    POST
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmcompliance/copyRule?apiKey=XXXXXXXXXXYYY&COMP_CLONE_RULES=[{"id":"13","newName":"Cloned Rule"},{"id":"14","newName":"10"}]
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    COMP_CLONE_RULES
    Compliance Clone Rules
    JSONArray
    cloneRuleJson
    No
    [{"id":"13","newName":"Cloned Rule"},{"id":"14","newName":"10"}]
    Delete policies
    deleteCompPolicy
    POST
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmcompliance/deleteCompPolicy?apiKey=XXXXXXXXXXYYY&COMP_POLICYIDS=[301]
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    COMP_POLICYIDS
    IDs of the policies
    JSONArray
    longJson
    No
    [301]
    Delete rule(s)
    deleteRule
    POST
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmcompliance/deleteRule?apiKey=XXXXXXXXXXYYY&COMPRULE_ID=["301"]
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    COMPRULE_ID
    IDs of the rules
    JSONArray
    longJson
    Yes
    ["301"]
    Delete rulegroup(s)
    deleteRuleGroup
    POST
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmcompliance/deleteRuleGroup?apiKey=XXXXXXXXXXYYY&COMP_RGIDS=["3","1"]
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    COMP_POLICYIDS
    IDs of the policy
    JSONArray
    longJson
    No
    COMP_RGIDS
    IDs of the rule groups
    JSONArray
    longJson
    No
    ["3","1"]
    Associate policies with resources
    exeAssociatePolicies
    POST
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmcompliance/exeAssociatePolicies?apiKey=XXXXXXXXXXYYY&ASSIGNED_POLICIES=[301]&RESOURCEID=2&DG_ID=1&RUNCOMPCHECK_STATUS=true
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    ASSIGNED_POLICIES
    IDs of the policies
    JSONArray
    longJson
    No
    [301]
    RESOURCEID
    Resource id of the device
    long
    No
    2
    DG_ID
    ID of the device group
    long
    No
    1
    RUNCOMPCHECK_STATUS
    Run Compliance Check
    boolean
    No
    true
    Run a compliance check
    exeComplianceCheck
    POST
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmcompliance/exeComplianceCheck?apiKey=XXXXXXXXXXYYY&COMPPOLICY_IDS=[301]&RESOURCEID=2&DEVICE_GROUP_ID=1
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    COMPPOLICY_IDS
    IDs of the policies
    JSONArray
    longJson
    No
    [301]
    RESOURCEID
    Resource id of the device
    JSONArray
    longJson
    No
    2
    DEVICE_GROUP_ID
    ID of the device group
    long
    No
    1
    Get associated devices for rule or policy
    exeDevAssocwithRules
    GET
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmcompliance/exeDevAssocwithRules?apiKey=XXXXXXXXXXYYY&COMPPOLICY_ID=1&COMPRULE_ID=1&complianceType=VIOLATED_RULES_ONLY
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    COMPPOLICY_ID
    ID of the policy
    long
    No
    1
    COMPRULE_ID
    ID of the rule
    long
    No
    1
    complianceType
    Compliance Type
    ^(VIOLATED_RULES_ONLY|COMPLIANT_RULES_ONLY|DATA_NOT_AVAIL)$
    No
    VIOLATED_RULES_ONLY
    Get compliance details of policy
    exeRulesInPolicy
    GET
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmcompliance/exeRulesInPolicy?apiKey=XXXXXXXXXXYYY&COMPPOLICY_ID=1&complianceType=ALL
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    COMPPOLICY_ID
    ID of the policy
    long
    No
    1
    complianceType
    Compliance Type
    ^(ALL|VIOLATED_RULES_ONLY|COMPLIANT_RULES_ONLY|DATA_NOT_AVAIL)$
    No
    ALL
    Validate a rule
    exeValidateRule
    POST
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmcompliance/exeValidateRule?apiKey=XXXXXXXXXXYYY&VALIDATECRITERIA=true&CRITERIATYPE=Advanced&BLOCK_CONDITION=NONE&CRITERIA_LIST=[{"operator":"and","condition":"80","pattern":"timeout","allowedCount":"0"}]&CONTENT=exec-timeout (([1-9][\d]* ?[\d]*)|([\d]* [1-9][\d]*))&COMPRULE_ID=1&RESOURCEID=2&IS_SINGLE_LINE=true&RESPOLICY_ID=1
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    VALIDATECRITERIA
    Criteria to be validated
    boolean
    No
    true
    CRITERIATYPE
    Criteria Type
    ^(Advanced|AdvancedBlockCriteria)$
    No
    Advanced
    STARTBLOCKCONFIG
    Start Block Configuration
    String
    No
    ENDBLOCKCONFIG
    End Block Configuration
    String
    No
    BLOCK_CONDITION
    Block Configuration
    ^(NONE|CONTAINS|NOT_CONTAINS)$
    No
    NONE
    BLOCK_CONDITION_VALUE
    Block Condition Value
    String
    No
    CRITERIA_LIST
    Criteria List
    JSONArray
    criteriaListJson
    No
    [{"operator":"and","condition":"80","pattern":"timeout","allowedCount":"0"}]
    BLOCK_CRITERIA_LIST
    Block critieria list
    JSONArray
    blockCriteriaListJson
    No
    CONTENT
    Content to be validated
    String
    No
    exec-timeout (([1-9][\d]* ?[\d]*)|([\d]* [1-9][\d]*))
    COMPRULE_ID
    ID of the rule
    long
    No
    1
    RESOURCEID
    Resource id of the device
    long
    No
    2
    CONFIG_TYPE
    Configuration Type
    ^(Running)$
    No
    IS_SINGLE_LINE
    Single line or multi line
    boolean
    No
    true
    RESPOLICY_ID
    ID of the resource and policy mapping
    long
    No
    1
    Get adhoc test rendering details
    getAdhocTestPreRenders
    GET
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmcompliance/getAdhocTestPreRenders?apiKey=XXXXXXXXXXYYY
    Get PCI reviews
    getAllReviews
    GET
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmcompliance/getAllReviews?apiKey=XXXXXXXXXXYYY&REVIEWER_ID=1
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    REVIEWER_ID
    ID of the PCI reviewer
    long
    No
    1
    STATUS
    Compliance Status
    ^(PENDING|REVIEWED)$
    No
    Get associated policy for rulegroup
    getAssocaitedPolicy
    GET
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmcompliance/getAssocaitedPolicy?apiKey=XXXXXXXXXXYYY&RULEGROUP_ID=5
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    RULEGROUP_ID
    ID of the rule group
    long
    No
    5
    Get associated rulegroup for rule
    getAssocaitedRuleGroup
    GET
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmcompliance/getAssocaitedRuleGroup?apiKey=XXXXXXXXXXYYY&RULE_ID=302
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    RULE_ID
    ID of the rule
    long
    No
    302
    Get the compliance list in central
    getCentralComplianceList
    GET
    Restricted
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmcompliance/getCentralComplianceList?apiKey=XXXXXXXXXXYYY
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    Status
    Status
    String
    No
    DG_ID
    ID of the device group
    long
    No
    Get compliance rules
    getCmpRules
    GET
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmcompliance/getCmpRules?apiKey=XXXXXXXXXXYYY&hideStandard=true
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    hideStandard
    boolean
    No
    true
    Get compliance details
    getComplianceDetails
    GET
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmcompliance/getComplianceDetails?apiKey=XXXXXXXXXXYYY&compolicyId=1&resourceId=1&status=Compliant&hideStandard=true
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    compolicyId
    ID of the compliance policy
    long
    No
    1
    resourceId
    Resource id of the device
    long
    No
    1
    status
    Compliance status
    ^(Compliant|Violation|notavailable)$
    No
    Compliant
    hideStandard
    boolean
    No
    true
    Get compliance rulegroup
    getComplianceGroups
    GET
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmcompliance/getComplianceGroups?apiKey=XXXXXXXXXXYYY&hideStandard=true
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    hideStandard
    boolean
    No
    true
    Get compliance policies
    getComplianceList
    GET
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmcompliance/getComplianceList?apiKey=XXXXXXXXXXYYY&ASSOCIATION=true&RESOURCEID=2&DG_ID=1&hideStandard=true
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    ASSOCIATION
    Device and Policy Association
    boolean
    No
    true
    RESOURCEID
    Resource id of the device
    long
    No
    2
    DG_ID
    ID of the device group
    long
    No
    1
    hideStandard
    boolean
    No
    true
    Get policy violations
    getCompliancePolicyViolations
    GET
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmcompliance/getCompliancePolicyViolations?apiKey=XXXXXXXXXXYYY&ResourceId=2
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    ResourceId
    Resource id of the device
    long
    No
    2
    Get compliance status of device group
    getCompliancePopupTable
    GET
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmcompliance/getCompliancePopupTable?apiKey=XXXXXXXXXXYYY&Status=Compliant&DG_ID=1
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    Status
    Compliance Status
    ^(Compliant|Violation|NA)$
    No
    Compliant
    DG_ID
    ID of the device group
    long
    No
    1
    Get compliance tab data
    getComplianceTabData
    GET
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmcompliance/getComplianceTabData?apiKey=XXXXXXXXXXYYY
    Get devices affected for CVE
    getCveAffectedDeviceDetails
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmcompliance/getCveAffectedDeviceDetails?apiKey=XXXXXXXXXXYYY
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    CVEID
    ID of the CVE
    String
    No
    Get CVE details
    getCveDetailsForFirmwareVulnerability
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmcompliance/getCveDetailsForFirmwareVulnerability?apiKey=XXXXXXXXXXYYY
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    CVEID
    ID of the CVE
    String
    No
    Get CVE details
    getCveDetailsForFirmwareVulnerabilityCveSearchTool
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmcompliance/getCveDetailsForFirmwareVulnerabilityCveSearchTool?apiKey=XXXXXXXXXXYYY&resourceId=1
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    CVE_ID
    ID of the CVE
    String
    No
    resourceId
    Resource id of the device
    long
    No
    1
    Search a content in firmware vulnerability
    getCveGridDetailsForSearchTool
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmcompliance/getCveGridDetailsForSearchTool?apiKey=XXXXXXXXXXYYY
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    searchStr
    String to be searched
    String
    No
    List Severity status for vulnerability report
    getFirmVulCveSeverityStatus
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmcompliance/getFirmVulCveSeverityStatus?apiKey=XXXXXXXXXXYYY
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    CUSTOMIZE_DATA_VIEWNAME
    View name of the report
    String
    No
    List dashboard count of vulnerabilities info
    getFirmVulDashDataCount
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmcompliance/getFirmVulDashDataCount?apiKey=XXXXXXXXXXYYY
    List device vulnerability information
    getFirmVulDeviceCveSubTable
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmcompliance/getFirmVulDeviceCveSubTable?apiKey=XXXXXXXXXXYYY&EXPLOIT=true&resourceId=1
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    EXPLOIT
    Is Exploitable Vulnerabilities
    boolean
    No
    true
    resourceId
    Resource id of the device
    long
    No
    1
    List vulnerability severity count for exposed devices
    getFirmVulDeviceReportTable
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmcompliance/getFirmVulDeviceReportTable?apiKey=XXXXXXXXXXYYY&EXPLOIT=true&DG_ID=1
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    EXPLOIT
    Is Exploitable Vulnerabilities
    boolean
    No
    true
    DG_ID
    ID of the device group
    long
    No
    1
    List Severity status for device based vulnerability report
    getFirmVulDeviceSeverityStatus
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmcompliance/getFirmVulDeviceSeverityStatus?apiKey=XXXXXXXXXXYYY&DG_ID=1
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    DG_ID
    ID of the device group
    long
    Yes
    1
    CUSTOMIZE_DATA_VIEWNAME
    View name of the report
    String
    No
    List dashboard count based on vulnerabilities discovered
    getFirmVulDiscoverDashWidgetCount
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmcompliance/getFirmVulDiscoverDashWidgetCount?apiKey=XXXXXXXXXXYYY
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    TIME_DURATION
    Time Duration
    String
    No
    List device vulnerabilities
    getFirmVulExposedDeviceVul
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmcompliance/getFirmVulExposedDeviceVul?apiKey=XXXXXXXXXXYYY&rsId=1&EXPLOIT=true&DG_ID=1
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    rsId
    Resource id of the device
    long
    No
    1
    SEVERITY
    Severity of vulnerability
    String
    No
    EXPLOIT
    Is Exploitable Vulnerabilities
    boolean
    No
    true
    DG_ID
    ID of the device group
    long
    No
    1
    List all high severity vulnerabilities based on device
    getFirmVulHighVulDeviceDashTable
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmcompliance/getFirmVulHighVulDeviceDashTable?apiKey=XXXXXXXXXXYYY
    Get firmware vulnerability details
    getFirmVulnDetails
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmcompliance/getFirmVulnDetails?apiKey=XXXXXXXXXXYYY&EXPLOIT=true&pageNo=1&viewsPerPage=1
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    SEVERITY
    (((critical|important|moderate|low)+)(,(critical|important|moderate|low)+)*)|(all)
    No
    EXPLOIT
    boolean
    No
    true
    pageNo
    int
    No
    1
    viewsPerPage
    int
    No
    1
    searchkey
    ^[\p{L}\p{N}-]+$
    No
    List dashboard count for device based vulnerability report
    getFirmVulnExposedDeviceDashCount
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmcompliance/getFirmVulnExposedDeviceDashCount?apiKey=XXXXXXXXXXYYY
    List all vulnerabilities
    getFirmVulnExposedDevicesList
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmcompliance/getFirmVulnExposedDevicesList?apiKey=XXXXXXXXXXYYY&EXPLOIT=true&DG_ID=1
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    SEVERITY
    Severity of vulnerability
    String
    No
    EXPLOIT
    Is Exploitable Vulnerabilities
    boolean
    No
    true
    DG_ID
    ID of the device group
    long
    No
    1
    Get firmware vulnerability grid data
    getFirmVulnGrid
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmcompliance/getFirmVulnGrid?apiKey=XXXXXXXXXXYYY&EXPLOIT=true
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    SEVERITY
    Severity
    String
    No
    EXPLOIT
    Exploit
    boolean
    No
    true
    List dashboard count for version based vulnerability report
    getFirmVulnVersionDistDashCount
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmcompliance/getFirmVulnVersionDistDashCount?apiKey=XXXXXXXXXXYYY
    List meta information for version based vulnerability report
    getFirmVulVersionDashTable
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmcompliance/getFirmVulVersionDashTable?apiKey=XXXXXXXXXXYYY&EXPLOIT=true&DG_ID=1
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    SEVERITY
    Severity of vulnerability
    String
    No
    EXPLOIT
    Is Exploitable Vulnerabilities
    boolean
    No
    true
    DG_ID
    ID of the device group
    long
    No
    1
    List Severity status for version based vulnerability report
    getFirmVulVersionSeverityStatus
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmcompliance/getFirmVulVersionSeverityStatus?apiKey=XXXXXXXXXXYYY&DG_ID=1
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    DG_ID
    ID of the device group
    long
    Yes
    1
    CUSTOMIZE_DATA_VIEWNAME
    View name of the report
    String
    No
    List vulnerabilities and device details for version based vulnerability report
    getFirmVulVersionSubTable
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmcompliance/getFirmVulVersionSubTable?apiKey=XXXXXXXXXXYYY&EXPLOIT=true&DG_ID=1
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    osVer
    OS Version
    String
    No
    vendor
    Device Vendor Name
    String
    No
    SEVERITY
    Severity of vulnerability
    String
    No
    EXPLOIT
    Is Exploitable Vulnerabilities
    boolean
    No
    true
    DG_ID
    ID of the device group
    long
    No
    1
    Get firmware vulnerability dashboard data
    getFirmwareVulnerabilityDashBoardTable
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmcompliance/getFirmwareVulnerabilityDashBoardTable?apiKey=XXXXXXXXXXYYY
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    SEVERITY
    Severity
    String
    No
    Get firmware vulnerability severity count
    getFirmwareVulnerabilityGridSeverityCount
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmcompliance/getFirmwareVulnerabilityGridSeverityCount?apiKey=XXXXXXXXXXYYY
    Get last updated time of firmware vulnerability
    getFVLastUpdatedDetails
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmcompliance/getFVLastUpdatedDetails?apiKey=XXXXXXXXXXYYY
    Get PCI reviews for a user
    getMyReviews
    GET
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmcompliance/getMyReviews?apiKey=XXXXXXXXXXYYY
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    STATUS
    Compliance Status
    ^(PENDING|REVIEWED)$
    No
    Get firmware vulnerability details for a vulnerability
    getNCMFirmwareVulListAllSubGrid
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmcompliance/getNCMFirmwareVulListAllSubGrid?apiKey=XXXXXXXXXXYYY&vulId=1
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    vulId
    Vulnerability id for which details needs to be fetched
    long
    No
    1
    Get the details of PCI review
    getPCIReviewDetails
    GET
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmcompliance/getPCIReviewDetails?apiKey=XXXXXXXXXXYYY
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    Status
    Compliance Status
    ^(NOTASSIGNED|PENDING|REVIEWED)$
    No
    Get policy adhoc result
    getPolicyAdhocResult
    POST
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmcompliance/getPolicyAdhocResult?apiKey=XXXXXXXXXXYYY&ComponentSelection=SpecificDevice&DEVICEGROUPSELECTION=1&SELECTEDDEVICES=["2"]&CONFIG_TYPE=Running&COMPPOLICY_ID=["301"]
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    ComponentSelection
    Component Selection
    ^(SpecificDevice|DeviceGroup)$
    No
    SpecificDevice
    DEVICEGROUPSELECTION
    ID of the device group
    long
    No
    1
    SELECTEDDEVICES
    Resource ids of the devices
    JSONArray
    longJson
    No
    ["2"]
    CONFIG_TYPE
    Configuration Type
    ^(Running|Startup)$
    No
    Running
    COMPPOLICY_ID
    IDs of the policies
    JSONArray
    longJson
    No
    ["301"]
    Get summary of compliance policy
    getPolicyDistribution
    GET
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmcompliance/getPolicyDistribution?apiKey=XXXXXXXXXXYYY&policyId=1
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    policyId
    ID of the compliance policy
    long
    Yes
    1
    Get policy rendering details
    getPolicyPreRenders
    GET
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmcompliance/getPolicyPreRenders?apiKey=XXXXXXXXXXYYY&COMPPOLICY_ID=301
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    snapType
    Snapshot Name
    ^(ConfigPolicy)$
    No
    COMPPOLICY_ID
    ID of the policy
    long
    No
    301
    Get resource policy details
    getResPolicyInfo
    GET
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmcompliance/getResPolicyInfo?apiKey=XXXXXXXXXXYYY&resPolicyId=301
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    snapType
    Snapshot Name
    ^(ConfigResCompliance)$
    No
    resPolicyId
    ID of the resource and policy mapping
    long
    No
    301
    Get reviewed details
    getReviewDetails
    GET
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmcompliance/getReviewDetails?apiKey=XXXXXXXXXXYYY&REVIEW_ID=1
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    REVIEW_ID
    ID of the PCI review
    long
    Yes
    1
    Get render details of PCI review
    getReviewPrerender
    GET
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmcompliance/getReviewPrerender?apiKey=XXXXXXXXXXYYY&REVIEW_ID=1&DEVICE_ID=2
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    REVIEW_ID
    ID of the PCI review
    long
    Yes
    1
    DEVICE_ID
    Resource id of the device
    long
    Yes
    2
    Get rule adhoc result
    getRuleAdhocTestResult
    POST
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmcompliance/getRuleAdhocTestResult?apiKey=XXXXXXXXXXYYY&ComponentSelection=SpecificDevice&DEVICEGROUPSELECTION=1&SELECTEDDEVICES=["2"]&CONFIG_TYPE=Running&COMPRULEGROUP_ID=["5"]
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    ComponentSelection
    Component Selection
    ^(SpecificDevice|DeviceGroup)$
    No
    SpecificDevice
    DEVICEGROUPSELECTION
    ID of the device group
    long
    No
    1
    SELECTEDDEVICES
    Resource ids of the devices
    JSONArray
    longJson
    No
    ["2"]
    CONFIG_TYPE
    Configuration Type
    ^(Running|Startup)$
    No
    Running
    COMPRULE_ID
    ID of the rule
    JSONArray
    longJson
    No
    COMPRULEGROUP_ID
    Compliance Rule Group Id
    JSONArray
    longJson
    No
    ["5"]
    Get rule details
    getRuleCompliances
    GET
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmcompliance/getRuleCompliances?apiKey=XXXXXXXXXXYYY&resPolicyId=1&compliant=true&details=true
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    resPolicyId
    ID of the resource and policy mapping
    long
    Yes
    1
    severity
    Severity
    ^(All)$
    No
    compliant
    Compliant
    boolean
    No
    true
    details
    Details
    boolean
    No
    true
    Get rulegroup rendering details
    getRuleGroupPreRenders
    GET
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmcompliance/getRuleGroupPreRenders?apiKey=XXXXXXXXXXYYY&COMPRULEGROUP_ID=302
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    COMPRULEGROUP_ID
    Compliance Rule Group Id
    long
    No
    302
    Get rule rendering details
    getRulePreRenders
    GET
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmcompliance/getRulePreRenders?apiKey=XXXXXXXXXXYYY&COMPRULE_ID=302
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    COMPRULE_ID
    ID of the rule
    ^(New|new|\d+)$
    No
    302
    Get firmware vulnerability details for device
    getSnapshotFirmwareVulnerabilityDetails
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmcompliance/getSnapshotFirmwareVulnerabilityDetails?apiKey=XXXXXXXXXXYYY&resourceId=1
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    resourceId
    Resource id of the device
    long
    No
    1
    Request vulnerability data
    requestFirmVulDataUpdate
    POST
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmcompliance/requestFirmVulDataUpdate?apiKey=XXXXXXXXXXYYY
    Review a PCI rule
    reviewPCI
    POST
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmcompliance/reviewPCI?apiKey=XXXXXXXXXXYYY&REVIEW_ID=1&REVIEW_COMMENTS=Review Pending&ISMULTIPLE=true&RESOURCEID=2
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    REVIEW_ID
    ID of the PCI review
    long
    Yes
    1
    REVIEW_COMMENTS
    Comments of review
    ncmBasicTextChars
    No
    Review Pending
    ISMULTIPLE
    Is Multiple
    boolean
    No
    true
    RESOURCEID
    Resource id of the device
    String
    Yes
    2
    Update comment for CVE-ID
    saveCommentValCveDetails
    POST
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmcompliance/saveCommentValCveDetails?apiKey=XXXXXXXXXXYYY
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    cveId
    ID of the CVE
    String
    Yes
    comment
    Comment to be updated
    String
    Yes
    Update firmware vulnerability state
    saveFirmwareVulnerabilityCveStateValues
    POST
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmcompliance/saveFirmwareVulnerabilityCveStateValues?apiKey=XXXXXXXXXXYYY
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    STATEDETAILS
    A JSON Array with Vulnerability State
    JSONArray
    firmwareVulStateJson
    No
    Update firmware vulnerability sync time
    setFirmwareVulnerabilityPeriodicUpdateTime
    POST
    Allowed
    Allowed
    Restricted
    http://server-url:8060/api/json/ncmcompliance/setFirmwareVulnerabilityPeriodicUpdateTime?apiKey=XXXXXXXXXXYYY
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    newTime
    Schedule time
    HrsMinSec
    Yes
    Update firmware vulnerability data
    startFirmwareVulDataSyncProcess
    POST
    Allowed
    Allowed
    Restricted
    http://server-url:8060/api/json/ncmcompliance/startFirmwareVulDataSyncProcess?apiKey=XXXXXXXXXXYYY
    Stop a CVE search
    stopCveSearchTool
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmcompliance/stopCveSearchTool?apiKey=XXXXXXXXXXYYY
  • ncmconfig
    Title
    API Name
    Method
    Execution in Standalone/Probe
    Execution in Central
    Execution in Probe from Central
    Sample URL
    Add a change rule
    addChangeRule
    POST
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmconfig/addChangeRule?apiKey=XXXXXXXXXXYYY&RULE_NAME=change1&DEVICE_GROUP_ID=1&RESOURCEID=2&RULE_DESCR=change management rule&RULE_ID=1&SEND_EMAIL=true&SEND_TRAP=true&GENERATE_TICKET=true&ROLLBACK_CONFIG=true&SEND_SYSLOGMSG=true&CONDITION=3&CHANGETYPECONDITION=1&APPEND_DIFF=true&EMAIL_FORMAT=HTML&EMAIL_SUBJECT=Change Detected $DEVICENAME&EMAIL_MESSAGE=The following rules are violated: $RULENAME&TO_ADDRESS=user1@testing.com&SYSLOG_PORT=1&TICKET_APPEND_DIFF=true&TICKET_EMAIL_FORMAT=HTML&ROLLBACK_CONFIG_TYPE=BASELINE&PORT=1&ASSIGNED_RESOURCES=[]&ASSIGNED_DEVICEGROUP=["1"]&TAG_ID=1
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    RULE_NAME
    Name of the change rule
    text_basic_symbols_two_byte_support
    No
    change1
    DEVICE_GROUP_ID
    ID of the device group
    long
    No
    1
    RESOURCEID
    Resource id of the device
    long
    No
    2
    RULE_DESCR
    Description of the change rule
    text_basic_symbols_two_byte_support
    No
    change management rule
    RULE_ID
    ID of the change rule
    long
    No
    1
    SEND_EMAIL
    Send Email
    boolean
    No
    true
    SEND_TRAP
    Send Trap
    boolean
    No
    true
    GENERATE_TICKET
    Generate Ticket
    boolean
    No
    true
    ROLLBACK_CONFIG
    Roll Back Configuration
    boolean
    No
    true
    SEND_SYSLOGMSG
    Send Syslog Messages
    boolean
    No
    true
    CONDITION
    Condition
    long
    No
    3
    CHANGETYPECONDITION
    Change Type Condition
    int
    No
    1
    APPEND_DIFF
    Append Diff
    boolean
    No
    true
    EMAIL_FORMAT
    Email Format
    ^(HTML|TEXT)$
    No
    HTML
    EMAIL_SUBJECT
    Email Subject
    text_basic_symbols_two_byte_support
    No
    Change Detected $DEVICENAME
    EMAIL_MESSAGE
    Email Message
    text_basic_symbols_two_byte_support
    No
    The following rules are violated: $RULENAME
    TO_ADDRESS
    To Address
    (^[\w]([\w\-\.\+\'\/]*)@([\w\-\.]*)(\.[a-zA-Z]{2,22}(\.[a-zA-Z]{2}){0,2})(,[\w]([\w\-\.\+\'\/]*)@([\w\-\.]*)(\.[a-zA-Z]{2,22}(\.[a-zA-Z]{2}){0,2}))*)
    No
    user1@testing.com
    SYSLOG_HOST
    SYSLOG Host
    ncmHostOrIPAllowedChar
    No
    SYSLOG_PORT
    SYSLOG Port
    int
    No
    1
    TICKET_APPEND_DIFF
    Ticket Append Diff
    boolean
    No
    true
    TICKET_EMAIL_FORMAT
    Ticket Email Format
    ^(HTML|TEXT)$
    No
    HTML
    TICKET_SUBJECT
    Ticket Subject
    text_basic_symbols_two_byte_support
    No
    TICKET_MESSAGE
    Ticket Message
    text_basic_symbols_two_byte_support
    No
    TICKET_TO_ADDRESS
    Ticket To Address
    (^[\w]([\w\-\.\+\'\/]*)@([\w\-\.]*)(\.[a-zA-Z]{2,22}(\.[a-zA-Z]{2}){0,2})(,[\w]([\w\-\.\+\'\/]*)@([\w\-\.]*)(\.[a-zA-Z]{2,22}(\.[a-zA-Z]{2}){0,2}))*)
    No
    ROLLBACK_CONFIG_TYPE
    Roll Back Configuration
    ^(BASELINE|PREVIOUS)$
    No
    BASELINE
    HOST
    Host
    ncmHostOrIPAllowedChar
    No
    PORT
    Port
    int
    No
    1
    COMMUNITY
    Community
    String
    No
    ASSIGNED_RESOURCES
    Resource ids of the devices
    JSONArray
    longJson
    No
    []
    ASSIGNED_DEVICEGROUP
    Ids of the device group
    JSONArray
    longJson
    No
    ["1"]
    TAG_ID
    ID of the tag to be associated
    long
    No
    1
    Associate label to configuration
    assocLabel
    POST
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmconfig/assocLabel?apiKey=XXXXXXXXXXYYY&VERSION_ID=14468&LABEL_NAME=BASELINE&DESCRIPTION=This label marks the stable configuration of a device
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    VERSION_ID
    ID of the configuration version
    long
    Yes
    14468
    LABEL_NAME
    Name of the label
    ncmBasicTextChars
    No
    BASELINE
    DESCRIPTION
    Description of the label
    ncmBasicTextChars
    No
    This label marks the stable configuration of a device
    NEW_LABEL_NAME
    Name of the new label
    ncmBasicTextChars
    No
    Update associated resources for a change rule
    changeAssocDev
    POST
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmconfig/changeAssocDev?apiKey=XXXXXXXXXXYYY&RULE_ID=2&ASSIGNED_RESOURCES=[]&ASSIGNED_DEVICEGROUP=["1","3"]
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    RULE_ID
    ID of the change rule
    long
    Yes
    2
    ASSIGNED_RESOURCES
    Resource ids of the devices
    JSONArray
    longJson
    No
    []
    ASSIGNED_DEVICEGROUP
    Ids of the device group
    JSONArray
    longJson
    No
    ["1","3"]
    Delete draft(s)
    deleteDraft
    POST
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmconfig/deleteDraft?apiKey=XXXXXXXXXXYYY&DRAFT_ID=["1"]
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    DRAFT_ID
    IDs of the draft
    JSONArray
    longJson
    No
    ["1"]
    Update configuration file properties
    editConfigFileProp
    POST
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmconfig/editConfigFileProp?apiKey=XXXXXXXXXXYYY&VERSION_ID=["26404"]&AUTHCOMMENT_ID=false&AUTHORIZE_CHANGES=true&ANNOTATION=New configuration obtained from device after scheduled backup execution&CHANGEDBY=NCM
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    VERSION_ID
    ID of the configuration version
    JSONArray
    longJson
    No
    ["26404"]
    AUTHCOMMENT_ID
    Authorized Comment Id
    boolean
    No
    false
    AUTHORIZE_CHANGES
    Authorize Changes
    boolean
    No
    true
    MESSAGE_BOX
    Message Box
    text_basic_symbols_two_byte_support
    No
    ANNOTATION
    Annotation
    text_basic_symbols_two_byte_support
    No
    New configuration obtained from device after scheduled backup execution
    CHANGEDBY
    Changed By
    ncmSeriesModel
    No
    NCM
    Associate change rule to resources
    exeAssocRulefromDevSnap
    POST
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmconfig/exeAssocRulefromDevSnap?apiKey=XXXXXXXXXXYYY&RESOURCEID=2&RULE_ID=["1501"]
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    RESOURCEID
    Resource id of the device
    long
    No
    2
    RULE_ID
    IDs of the change rules
    JSONArray
    longJson
    No
    ["1501"]
    Authorize or unauthorize the changes
    exeAuthorize
    POST
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmconfig/exeAuthorize?apiKey=XXXXXXXXXXYYY&VERSION_ID=["14468"]&AUTHORIZE_CHANGES=true&MESSAGE_BOX=authorised
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    VERSION_ID
    ID of the configuration version
    JSONArray
    longJson
    No
    ["14468"]
    AUTHORIZE_CHANGES
    Authorize or Unauthorize
    boolean
    No
    true
    MESSAGE_BOX
    Sample message
    String
    No
    authorised
    Check compliance
    exeComplianceCheck
    POST
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmconfig/exeComplianceCheck?apiKey=XXXXXXXXXXYYY&VERSION_ID=14468&DRAFT_ID=1&SELECTION_TYPE=ASSIGNED
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    VERSION_ID
    ID of the configuration version
    long
    No
    14468
    DRAFT_ID
    ID of the draft
    long
    No
    1
    SELECTION_TYPE
    Selection Type
    ^(ASSIGNED|SELECTED)$
    Yes
    ASSIGNED
    POLICY_ID
    ID of the policy
    JSONArray
    longJson
    No
    Get render details of compliance check
    exeComplianceCheckPreRender
    GET
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmconfig/exeComplianceCheckPreRender?apiKey=XXXXXXXXXXYYY&VERSION_ID=14468&DRAFT_ID=1
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    VERSION_ID
    ID of the configuration version
    long
    No
    14468
    DRAFT_ID
    ID of the draft
    long
    No
    1
    Sync configurations
    exeConfigSyncAction
    POST
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmconfig/exeConfigSyncAction?apiKey=XXXXXXXXXXYYY&DEVICE_GROUP_ID=1
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    DEVICE_IDS
    Resource ids of the devices
    JSONArray
    longJson
    No
    DEVICE_GROUP_ID
    ID of the device group
    long
    No
    1
    Add or update a draft
    exeNewDraft
    POST
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmconfig/exeNewDraft?apiKey=XXXXXXXXXXYYY&DRAFT_ID=1&ANNOTATION=changed&FILE_CONTENTS=Building configuration...Current configuration : 2626 bytes&DRAFT_NAME=draft2&RESOURCEID=2&VERSION_ID=26404
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    DRAFT_ID
    ID of the draft
    long
    No
    1
    ANNOTATION
    Annotation
    text_basic_symbols_two_byte_support
    Yes
    changed
    FILE_CONTENTS
    File contents
    String
    Yes
    Building configuration...Current configuration : 2626 bytes
    DRAFT_NAME
    Name of the draft
    text_basic_symbols_two_byte_support
    No
    draft2
    RESOURCEID
    Resource id of the device
    long
    No
    2
    VERSION_ID
    ID of the configuration version
    long
    No
    26404
    Set configuration version as baseline
    exeSetasBaseLine
    POST
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmconfig/exeSetasBaseLine?apiKey=XXXXXXXXXXYYY&VERSION_ID=14468&SET_AS_BASELINE=true
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    VERSION_ID
    ID of the configuration version
    long
    Yes
    14468
    SET_AS_BASELINE
    Set as baseline configuration
    boolean
    No
    true
    Schedule configuration exports
    exportConfig
    POST
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmconfig/exportConfig?apiKey=XXXXXXXXXXYYY&SCHEDULE_TYPE=DAILY&DAILY_TIMER_HOURS=8&DAILY_TIMER_MINUTES=30&STORAGE=C:\ManageEngine\OpManager\config_backup&DG_GROUP_EXPORT=["All Devices Group"]&EMAIL_ONLY_ON_FAILURE=false&WEEKLY_TIMER_HOURS=[01]?\d&WEEKLY_TIMER_MINUTES=0&MONTHLY_SCHEDULE=1&MONTHLY_TIMER_MINUTES=0&TO_ADDRESS=user1@testing.com&isDeviceGroup=true&IS_ALLCONFIG_SAME_FOLDER=false&MODIFY_EXPORT_FILE_NAME=true&FOLDER_NAME_FORMAT=dd-MMM-yyyy
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    SCHEDULE_TYPE
    Schedule Type
    ^(NEVER|DAILY|WEEKLY|MONTHLY)$
    Yes
    DAILY
    DAILY_TIMER_HOURS
    Daily Time Hours
    ^([01]?\d|2[0-3])$
    No
    8
    DAILY_TIMER_MINUTES
    Daily Time Minutes
    ^([0-5]?\d)$
    No
    30
    STORAGE
    Storage Location
    String
    Yes
    C:\ManageEngine\OpManager\config_backup
    DG_GROUP_EXPORT
    Device Group
    JSONArray
    longJson
    No
    ["All Devices Group"]
    EMAIL_ONLY_ON_FAILURE
    Email Only on Failure
    boolean
    No
    false
    WEEKLY_SCHEDULE
    Weekly Schedule
    ^([0-7])$
    No
    WEEKLY_TIMER_HOURS
    Weekly Time Hours
    ^([01]?\d|2[0-3])$
    No
    [01]?\d
    WEEKLY_TIMER_MINUTES
    Weekly Time Minutes
    ^(0|15|30|45)$
    No
    0
    MONTHLY_SCHEDULE
    Monthly Schedule
    int
    No
    1
    MONTHLY_TIMER_HOURS
    Monthly Time Hours
    ^([0-5]?\d)$
    No
    MONTHLY_TIMER_MINUTES
    Monthly Time Minutes
    ^(0|15|30|45)$
    No
    0
    TO_ADDRESS
    Tp Address
    (^[\w]([\w\-\.\+\'\/]*)@([\w\-\.]*)(\.[a-zA-Z]{2,22}(\.[a-zA-Z]{2}){0,2})(,[\w]([\w\-\.\+\'\/]*)@([\w\-\.]*)(\.[a-zA-Z]{2,22}(\.[a-zA-Z]{2}){0,2}))*)
    No
    user1@testing.com
    isDeviceGroup
    Is Device Group
    boolean
    No
    true
    ASSOCIATED_DEVICES
    Associated Devices
    JSONArray
    longJson
    No
    IS_ALLCONFIG_SAME_FOLDER
    Is All Configuration Exported under same Folder
    boolean
    No
    false
    MODIFY_EXPORT_FILE_NAME
    boolean
    No
    true
    FOLDER_NAME_FORMAT
    Folder Name Format
    ^(dd-MMM-yyyy|dd-MM-yyyy|MM-dd-yyyy|yyyy-MM-dd|MMM-dd-yyyy)$
    Yes
    dd-MMM-yyyy
    Export scheduled configurations
    exportConfigNow
    POST
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmconfig/exportConfigNow?apiKey=XXXXXXXXXXYYY
    Export a configuration version
    exportConfigVersion
    GET
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmconfig/exportConfigVersion?apiKey=XXXXXXXXXXYYY&VERSION_ID=14468
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    VERSION_ID
    ID of the configuration version
    long
    Yes
    14468
    Get all drafts
    getAllDrafts
    GET
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmconfig/getAllDrafts?apiKey=XXXXXXXXXXYYY
    Get associated resources of change rule
    getAssocDevPreRenders
    GET
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmconfig/getAssocDevPreRenders?apiKey=XXXXXXXXXXYYY&RULE_ID=2
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    RULE_ID
    ID of the change rule
    long
    No
    2
    Get change rule render details
    getChangeMgntRulePreRenders
    GET
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmconfig/getChangeMgntRulePreRenders?apiKey=XXXXXXXXXXYYY&RULE_ID=1
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    RULE_ID
    ID of the change rule
    long
    No
    1
    Get all change rules
    getChangeRules
    GET
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmconfig/getChangeRules?apiKey=XXXXXXXXXXYYY&RESOURCEID=2&DG_ID=1&TOASSOCIATE=true
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    RESOURCEID
    Resource id of the device
    long
    No
    2
    DG_ID
    ID of the device group
    long
    No
    1
    TOASSOCIATE
    To Associate
    boolean
    No
    true
    Get configuration content from search
    getConfigAsSearchResult
    POST
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmconfig/getConfigAsSearchResult?apiKey=XXXXXXXXXXYYY&versionId=1
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    versionId
    ID of the configuration version
    long
    Yes
    1
    CONFIG_SEARCH_CRITERIA
    Configuration Search Criteria
    JSONObject
    searchStringJSON
    No
    Get configuration file details
    getConfigFileDetails
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmconfig/getConfigFileDetails?apiKey=XXXXXXXXXXYYY&versionId=1&NODIFF=true
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    versionId
    ID of the configuration version
    long
    Yes
    1
    NODIFF
    No Diff
    boolean
    No
    true
    snapType
    Snapshot Name
    ^(ConfigChange)$
    No
    Get configuration summary
    getConfigFileSummary
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmconfig/getConfigFileSummary?apiKey=XXXXXXXXXXYYY&fileId=1
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    fileId
    File Id
    long
    Yes
    1
    snapType
    Snapshot Name
    ^(ConfigFile)$
    No
    Get configuration diff details
    getConflictDiffdetails
    get
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmconfig/getConflictDiffdetails?apiKey=XXXXXXXXXXYYY&deviceId=1&fileId=1&LEFT_CONFIG_TYPE=VERSION&LEFT_CONFIG_ID=23792&RIGHT_CONFIG_TYPE=VERSION&RIGHT_CONFIG_ID=26404
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    deviceId
    Resource id of the device
    long
    No
    1
    fileId
    File Id
    long
    No
    1
    LEFT_CONFIG_TYPE
    Left Hand Side Configuration Type
    ^(DRAFT|VERSION)$
    No
    VERSION
    LEFT_CONFIG_ID
    Left Hand Side Configuration Id
    long
    No
    23792
    RIGHT_CONFIG_TYPE
    Right Hand Side Configuration Type
    ^(DRAFT|VERSION)$
    No
    VERSION
    RIGHT_CONFIG_ID
    Right Hand Side Configuration Id
    long
    No
    26404
    Get latest configurations of devices
    getCurrentConfigFiles
    GET
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmconfig/getCurrentConfigFiles?apiKey=XXXXXXXXXXYYY
    Get changes list for a device
    getDevChanges
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmconfig/getDevChanges?apiKey=XXXXXXXXXXYYY&deviceId=5&showAllVersions=true
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    deviceId
    Resource id of the device
    long
    Yes
    5
    showAllVersions
    Show all versions
    boolean
    No
    true
    Get changes list for a device
    getDevChanges
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/v2/ncmconfig/getDevChanges?apiKey=XXXXXXXXXXYYY
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    deviceId
    Resource id of the device
    long
    Yes
    Get drafts associated with devices
    getDevDrafts
    GET
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmconfig/getDevDrafts?apiKey=XXXXXXXXXXYYY&RESOURCEID=2
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    RESOURCEID
    Resource id of the device
    long
    Yes
    2
    Get draft details
    getDraftDetails
    GET
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmconfig/getDraftDetails?apiKey=XXXXXXXXXXYYY&DRAFT_ID=4511
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    DRAFT_ID
    ID of the draft
    long
    Yes
    4511
    snapType
    Snapshot name
    ^(ConfigDraft)$
    No
    Get label details
    getLabelDetails
    GET
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmconfig/getLabelDetails?apiKey=XXXXXXXXXXYYY
    Get latest configuration versions for a device
    getStartupRunningVersion
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmconfig/getStartupRunningVersion?apiKey=XXXXXXXXXXYYY&RESOURCEID=2
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    RESOURCEID
    Resource id of the device
    long
    Yes
    2
    Get version details
    getVersionDetails
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmconfig/getVersionDetails?apiKey=XXXXXXXXXXYYY&VERSION=1&VERSIONS=["20474","4508"]
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    VERSION
    Single version number
    long
    No
    1
    VERSIONS
    Multiple Version numbers
    JSONArray
    longJson
    No
    ["20474","4508"]
    Get all configurations
    listAllConfigs
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmconfig/listAllConfigs?apiKey=XXXXXXXXXXYYY&fileId=1&DG_ID=1
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    fileId
    File Id
    long
    No
    1
    SEARCH_STRING
    Search String
    String
    No
    DG_ID
    ID of the device group
    long
    No
    1
    Update a change rule
    updateChangeRule
    POST
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmconfig/updateChangeRule?apiKey=XXXXXXXXXXYYY&ACTION_TYPE=DELETE&RULE_ID=["2"]&CONTEXT=DEVICEPROP&RESOURCEID=1&DEVICE_GROUP_ID=1
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    ACTION_TYPE
    Action Type
    ^(DISABLE|ENABLE|DELETE|DISASSOCIATE)$
    Yes
    DELETE
    RULE_ID
    ID of the change rule
    JSONArray
    longJson
    No
    ["2"]
    CONTEXT
    Context
    ^(DEVICEPROP|DEVICEGROUP)$
    No
    DEVICEPROP
    RESOURCEID
    Resource id of the device
    long
    No
    1
    DEVICE_GROUP_ID
    ID of the device group
    long
    No
    1
  • ncmconfiglets
    Title
    API Name
    Method
    Execution in Standalone/Probe
    Execution in Central
    Execution in Probe from Central
    Sample URL
    Add a configlet group
    addConfigletGroup
    POST
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmconfiglets/addConfigletGroup?apiKey=XXXXXXXXXXYYY
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    group_name
    Name of the configlet group
    ncmBasicTextChars
    No
    group_desc
    Description of the configlet group
    ncmBasicTextChars
    No
    group_type
    Static group or sub group
    ^(staticgroup|subgroup)$
    Yes
    selected_entity
    Selected configlets or configlet groups
    JSONArray
    longJson
    Yes
    Add a syslog state regex
    addSyslogStateRegex
    POST
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmconfiglets/addSyslogStateRegex?apiKey=XXXXXXXXXXYYY
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    PERSONALITYID
    ID of the personality
    long
    Yes
    REGEX
    Regex pattern
    syslogStateRegex
    Yes
    Get render details of configlet group
    configletGroupPrereder
    GET
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmconfiglets/configletGroupPrereder?apiKey=XXXXXXXXXXYYY
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    group_id
    ID of the configlet group
    long
    No
    Delete configlet group(s)
    deleteConfigletGroup
    POST
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmconfiglets/deleteConfigletGroup?apiKey=XXXXXXXXXXYYY
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    group_id
    IDs of the configlet group
    long
    Yes
    Delete a syslog state regex
    deleteSyslogStateRegex
    POST
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmconfiglets/deleteSyslogStateRegex?apiKey=XXXXXXXXXXYYY
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    REGEXID
    ID of the syslog state regex
    long
    Yes
    Edit a configlet group
    editConfigletGroup
    POST
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmconfiglets/editConfigletGroup?apiKey=XXXXXXXXXXYYY
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    group_id
    ID of the configlet group
    long
    Yes
    group_name
    Name of the configlet group
    ncmBasicTextChars
    No
    group_desc
    Description of the configlet group
    ncmBasicTextChars
    No
    group_type
    Static group or sub group
    ^(staticgroup|subgroup)$
    Yes
    selected_entity
    Selected configlets or configlet groups
    JSONArray
    longJson
    Yes
    Execute REST configlet
    execAPI
    POST
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmconfiglets/execAPI?apiKey=XXXXXXXXXXYYY&resourceId=1&operationId=1&action=Add&mKey=tempAddress
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    resourceId
    Resource ID of the device on which the configlet needs to be executed
    long
    No
    1
    operationId
    Operation ID of the configlet
    long
    Yes
    1
    action
    Action that needs to be performed. Each configlets have different set of operations.
    String
    Yes
    Add
    resourceIds
    List of resource IDs, if operation needs to be performed on multiple devices. This param is not in use right now and is kept for future use. PLEASE DO NOT USE IT
    JSONArray
    longJson
    No
    apiURLParams
    This parameter is used to pass any special parameter to the API url. This param is not in use right now and is kept for future use. PLEASE DO NOT USE IT
    String
    No
    mKey
    mKey is the unique id of the object on which the operation is to be performed. Ex. if an address called tempAddress is being edited then same must be passed as mKey. Which field must be used as mKey can be checked in the response of renderExecuteRESTAPI API under operation data.
    String
    No
    tempAddress
    postJSONData
    postJSONData that needs to be sent to device. Value must be a JSON Object. Details of which params must be sent in postJSONData can be checked in response of renderExecuteRESTAPI.
    String
    No
    postData
    postData that needs to be sent to device. Details of which params must be sent in postData can be checked in response of renderExecuteRESTAPI.
    String
    No
    initialData
    String
    No
    Execute REST configlet
    execAPIAndGetResult
    POST
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmconfiglets/execAPIAndGetResult?apiKey=XXXXXXXXXXYYY
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    resourceId
    Resource id of the device
    long
    No
    operationId
    Operation ID
    long
    Yes
    action
    Action
    String
    Yes
    postJSONData
    JSON data
    String
    No
    Get REST operations/configlets
    getAllRESTOperations
    GET
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmconfiglets/getAllRESTOperations?apiKey=XXXXXXXXXXYYY&restTemplate=1
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    restTemplate
    ID of Rest device template for which list of configlets needs to be fetched. If empty, all available configlets will be fetched.
    String
    No
    1
    Get all REST templates
    getAllRESTTemplates
    GET
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmconfiglets/getAllRESTTemplates?apiKey=XXXXXXXXXXYYY
    Get all syslog state regex
    getAllSyslogStateRegex
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmconfiglets/getAllSyslogStateRegex?apiKey=XXXXXXXXXXYYY
    Get object details for REST configlet
    getMKeyObjectDetails
    GET
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmconfiglets/getMKeyObjectDetails?apiKey=XXXXXXXXXXYYY&resourceId=1&operationId=1&actionStr=Edit&mKey=tempAddress
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    resourceId
    Resource Id of the device from which the details needs to be fetched
    long
    Yes
    1
    operationId
    Operation Id of the Configlet for which the details needs to be fetched
    long
    Yes
    1
    actionStr
    Action for which the details needs to be fetched. Works for all actions except Add
    String
    Yes
    Edit
    mKey
    mKey is the unique id of the object whose details are being fetched. Ex. if details are needed for an address called tempAddress then same must be passed as mKey. Which field must be used as mKey can be checked in the response of renderExecuteRESTAPI API under operation data.
    String
    No
    tempAddress
    apiURLParams
    String
    No
    Get objects for REST configlet
    getMKeyObjectList
    POST
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmconfiglets/getMKeyObjectList?apiKey=XXXXXXXXXXYYY&resourceId=1&operationId=1&action=Edit
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    resourceId
    Resource Id of the device from which the object list needs to be fetched
    long
    Yes
    1
    operationId
    Operation Id of the configlet for which the object list needs to be fetched
    long
    Yes
    1
    action
    Action for which the list of objects needs to be fetched. Works for all actions except Add
    String
    Yes
    Edit
    postJSONData
    String
    No
    Get all personalities
    getPersonalities
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmconfiglets/getPersonalities?apiKey=XXXXXXXXXXYYY
    Get associated REST credentials for devices
    getRestAPICredentials
    POST
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmconfiglets/getRestAPICredentials?apiKey=XXXXXXXXXXYYY&resourceIds=["1","25","28"]&restTemplateId=1&isViewOnly=true
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    resourceIds
    Resource ids of the devices
    JSONArray
    longJson
    Yes
    ["1","25","28"]
    restTemplateId
    ID of the rest template
    long
    No
    1
    isViewOnly
    View only
    boolean
    No
    true
    Get REST configlet details
    getRESTConfigletDetails
    GET
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmconfiglets/getRESTConfigletDetails?apiKey=XXXXXXXXXXYYY
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    restTemplateId
    ID of the rest template
    long
    No
    Get REST configlets history
    getRESTConfigletHistory
    GET
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmconfiglets/getRESTConfigletHistory?apiKey=XXXXXXXXXXYYY
    Get REST configlets for device
    getRESTListActions
    GET
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmconfiglets/getRESTListActions?apiKey=XXXXXXXXXXYYY&resourceId=1
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    resourceId
    Resource Id of the device for which the list of configlets needs to be fetched
    long
    Yes
    1
    Get REST template details
    getRESTTemplateDetails
    GET
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmconfiglets/getRESTTemplateDetails?apiKey=XXXXXXXXXXYYY
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    restTemplateId
    ID of the rest template
    long
    Yes
    Get all configlet groups
    listConfigletGroup
    GET
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmconfiglets/listConfigletGroup?apiKey=XXXXXXXXXXYYY
    Get configlets associated with group
    listConfigletsOfGroup
    GET
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmconfiglets/listConfigletsOfGroup?apiKey=XXXXXXXXXXYYY
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    group_id
    ID of the configlet group
    long
    Yes
    Get render details for executing REST configlets
    renderExecuteRESTAPI
    GET
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmconfiglets/renderExecuteRESTAPI?apiKey=XXXXXXXXXXYYY&resourceId=1&operationId=1&action=Add
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    resourceId
    Resource Id of the device for which the details needs to be fetched
    long
    No
    1
    operationId
    Operation Id of the configlet for which the details needs to be fetched
    long
    Yes
    1
    action
    Action for which the details needs to be fetched.
    String
    Yes
    Add
    Update a syslog state regex
    updateSyslogStateRegex
    POST
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmconfiglets/updateSyslogStateRegex?apiKey=XXXXXXXXXXYYY
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    REGEXID
    ID of the regex
    long
    Yes
    PERSONALITYID
    ID of the personality
    long
    Yes
    REGEX
    Regex pattern
    syslogStateRegex
    Yes
  • ncmdashboard
    Title
    API Name
    Method
    Execution in Standalone/Probe
    Execution in Central
    Execution in Probe from Central
    Sample URL
    Get compliance status for devicegroup
    getComplianceStatus
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmdashboard/getComplianceStatus?apiKey=XXXXXXXXXXYYY&DG_ID=1
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    DG_ID
    ID of the device group
    long
    Yes
    1
    CUSTOMIZE_DATA_VIEWNAME
    View name of the report
    String
    No
    Get configuration conflict status
    getConfigConflictStatus
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmdashboard/getConfigConflictStatus?apiKey=XXXXXXXXXXYYY&DG_ID=1
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    DG_ID
    ID of the device group
    long
    Yes
    1
    CUSTOMIZE_DATA_VIEWNAME
    View name of the report
    String
    No
  • ncmdevice
    Title
    API Name
    Method
    Execution in Standalone/Probe
    Execution in Central
    Execution in Probe from Central
    Sample URL
    Add a device group
    addDeviceGroup
    POST
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmdevice/addDeviceGroup?apiKey=XXXXXXXXXXYYY&SELECTEDDEVICES=["2","304"]&DEVICE_GROUP_NAME=Sample Device Group&DG_DESCRIPTION=Sample&GLOBAL_DEVICE_GROUP=false&IS_EDIT_VIEW=false&DEVICE_GROUP_ID=1&ComponentSelection=SpecificDeviceCriteria&QUERYID=1&TAG_ID=1&isDistribute=true
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    SELECTEDDEVICES
    Resource ids of the devices
    JSONArray
    longJson
    No
    ["2","304"]
    SELECTEDDEVICEGROUPS
    IDs of the device groups
    JSONArray
    longJson
    No
    DEVICE_GROUP_NAME
    Name of the device group
    ncmAllowedNameChars
    No
    Sample Device Group
    DG_DESCRIPTION
    Device Group Description
    ncmBasicTextChars
    No
    Sample
    GLOBAL_DEVICE_GROUP
    Is Global Device Group
    boolean
    No
    false
    IS_EDIT_VIEW
    Is Edit View
    boolean
    No
    false
    DEVICE_GROUP_ID
    ID of the device group
    long
    No
    1
    ComponentSelection
    Component Selection
    ^(DeviceByCriteria|SubGroup|SpecificDeviceCriteria)$
    Yes
    SpecificDeviceCriteria
    QUERYID
    Query Id
    long
    No
    1
    TAG_ID
    ID of the tag to be associated
    long
    No
    1
    CRITERIA_LIST
    Criteria List
    JSONArray
    DGCriteriaJSON
    No
    isDistribute
    Distribute device group
    boolean
    No
    true
    Get backup status
    backupStatus
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmdevice/backupStatus?apiKey=XXXXXXXXXXYYY&DEVICE_GROUP_ID=1
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    DEVICE_GROUP_ID
    ID of the device group
    long
    Yes
    1
    status
    Backup Status
    ^(success|failure|not_backed_up)$
    No
    Get devices with baseline running conflict
    baseRunningConflict
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmdevice/baseRunningConflict?apiKey=XXXXXXXXXXYYY&DG_ID=1
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    DG_ID
    ID of the device group
    long
    No
    1
    Get devices with no baseline running conflict
    baseRunningNoConflict
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmdevice/baseRunningNoConflict?apiKey=XXXXXXXXXXYYY&DG_ID=1
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    DG_ID
    ID of the device group
    long
    No
    1
    Modify device template
    changeDeviceTemplate
    POST
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmdevice/changeDeviceTemplate?apiKey=XXXXXXXXXXYYY
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    NEW_TEMPLATE_NAME
    Name of the new template
    ncmAllowedNameChars
    Yes
    RESOURCE_IDS
    Resource ids of the device
    JSONArray
    longJson
    Yes
    Check CLI connection
    checkCLIConnectionForCredentials
    GET
    Allowed
    Restricted
    Restricted
    http://server-url:8060/api/json/ncmdevice/checkCLIConnectionForCredentials?apiKey=XXXXXXXXXXYYY
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    port
    Port number
    int
    No
    protocol
    Protocol details
    ^(TELNET|SSH|Telnet)$
    No
    resourceId
    Resource id of the device
    long
    No
    deviceType
    Device type
    ^(Custom|Inventoried)$
    No
    Get startup running conflicts device list
    configConflicts
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmdevice/configConflicts?apiKey=XXXXXXXXXXYYY&DG_ID=1
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    DG_ID
    ID of the device group
    long
    No
    1
    Get list of devices without startup running conflicts
    configNoConflicts
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmdevice/configNoConflicts?apiKey=XXXXXXXXXXYYY&DG_ID=1
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    DG_ID
    ID of the device group
    long
    No
    1
    Get not backedup devices
    configNotBackedUp
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmdevice/configNotBackedUp?apiKey=XXXXXXXXXXYYY&DG_ID=1
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    DG_ID
    ID of the device group
    long
    Yes
    1
    Delete device(s)
    deleteDevice
    POST
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmdevice/deleteDevice?apiKey=XXXXXXXXXXYYY&DEVICE_IDS=["2"]
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    DEVICE_IDS
    Resource ids of the devices
    JSONArray
    longJson
    No
    ["2"]
    Delete device group(s)
    deleteDeviceGroup
    POST
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmdevice/deleteDeviceGroup?apiKey=XXXXXXXXXXYYY&DEVICE_GROUP_ID=["4","2"]
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    DEVICE_GROUP_ID
    IDs of the device groups
    JSONArray
    longJson
    No
    ["4","2"]
    Get render details for device group
    deviceGroupEditPreRender
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmdevice/deviceGroupEditPreRender?apiKey=XXXXXXXXXXYYY&DEVICE_GROUP_ID=1
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    DEVICE_GROUP_ID
    ID of the device group
    long
    No
    1
    Get devices associated for device group
    deviceGroupResources
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmdevice/deviceGroupResources?apiKey=XXXXXXXXXXYYY&DEVICE_GROUP_ID=1&PROFILEID=1&TABLE_DATA=DeviceByCriteria
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    DEVICE_GROUP_ID
    ID of the device group
    long
    No
    1
    snapType
    Snapshot Name
    String
    No
    PROFILEID
    Profile Id
    long
    No
    1
    SEARCH_STRING
    Search String
    String
    No
    type
    Type
    String
    No
    value
    Value
    String
    No
    TABLE_DATA
    Table Data
    ^(DeviceByCriteria|SubGroup)$
    No
    DeviceByCriteria
    OSVERSION
    OS Version
    String
    No
    OSTYPE
    OS Type
    String
    No
    DEVICE_TYPE
    Device Type
    String
    No
    MODEL
    Model
    String
    No
    Get render details of SNMP mapping
    deviceSNMPPreRender
    GET
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmdevice/deviceSNMPPreRender?apiKey=XXXXXXXXXXYYY&selectedDevices=["17"]
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    selectedDevices
    Resource ids of the devices
    JSONArray
    longJson
    No
    ["17"]
    Get all device templates
    deviceTemplates
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/v2/ncmdevice/deviceTemplates?apiKey=XXXXXXXXXXYYY
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    CUSTOM
    Custom templates
    boolean
    No
    restTemplateId
    ID of the REST template
    long
    No
    Get device summary
    devSummary
    GET
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmdevice/devSummary?apiKey=XXXXXXXXXXYYY&deviceId=302
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    deviceId
    Resource id of the device
    long
    No
    302
    ip
    IPAddress
    NCM_IP_V4_AND_V6_Address
    No
    snapType
    Snapshot Name
    ^(NCMDevice)$
    No
    Update VLAN
    discoverVlanDetails
    POST
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmdevice/discoverVlanDetails?apiKey=XXXXXXXXXXYYY
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    resourceId
    Resource id of the device
    long
    Yes
    Update custom columns via file
    editCustomColfromFileImp
    POST
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmdevice/editCustomColfromFileImp?apiKey=XXXXXXXXXXYYY
    Get EOL announced devices
    eolAnnouncedDevices
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmdevice/eolAnnouncedDevices?apiKey=XXXXXXXXXXYYY&isEolReportView=true
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    isEolReportView
    boolean
    No
    true
    Get EOL data not available devices
    eolDataNotAvailable
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmdevice/eolDataNotAvailable?apiKey=XXXXXXXXXXYYY&isEolReportView=true
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    isEolReportView
    boolean
    No
    true
    Get EOL data available devices
    eolDevices
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmdevice/eolDevices?apiKey=XXXXXXXXXXYYY&isEolReportView=true
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    isEolReportView
    boolean
    No
    true
    Label configuration(s)
    exeLabelCurrConfig
    POST
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmdevice/exeLabelCurrConfig?apiKey=XXXXXXXXXXYYY&SELECTED_DEVICES=["17"]&LABEL_NAME=label1&DESCRIPTION=Label Description&NEW_LABEL_NAME=New Label1
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    SELECTED_DEVICES
    Selected Devices
    JSONArray
    longJson
    Yes
    ["17"]
    LABEL_NAME
    Label Name
    ncmBasicTextChars
    No
    label1
    DESCRIPTION
    Label Description
    ncmBasicTextChars
    No
    Label Description
    NEW_LABEL_NAME
    New Label Name
    ncmBasicTextChars
    No
    New Label1
    LABLE_IDS
    Label Id(s)
    JSONArray
    longJson
    No
    Upload a configuration
    exeUploadConfig
    POST
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmdevice/exeUploadConfig?apiKey=XXXXXXXXXXYYY&CONFIG_ID=25816&DOWNLOAD_TYPE=CONFIG_BASED&DOWNLOAD_AS=Startup&DOWNLOAD_OPTION=DOWNLOAD_NOW&SCHEDULE_DATE=Wed Aug 21 2019 16:28:50 GMT+0530 (India Standard Time)&SCHEDULE_HOUR=16&SCHEDULE_MINUTE=28&SCHEDULE_TYPE=Now
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    CONFIG_ID
    Configuration Id
    long
    No
    25816
    DOWNLOAD_TYPE
    Download Type
    ^(VERSION_BASED|DRAFT_BASED)$
    No
    CONFIG_BASED
    DOWNLOAD_AS
    Download As
    ^(Startup|Running)$
    No
    Startup
    COMMENT
    Comment
    ncmBasicTextChars
    No
    DOWNLOAD_OPTION
    Download Option
    ^(DOWNLOAD_LATER|DOWNLOAD_NOW)$
    No
    DOWNLOAD_NOW
    SCHEDULE_DATE
    Schedule Date
    DateMMDDYYYYRegex
    No
    Wed Aug 21 2019 16:28:50 GMT+0530 (India Standard Time)
    SCHEDULE_HOUR
    Schedule Hours
    ^([01]?\d|2[0-3])$
    No
    16
    SCHEDULE_MINUTE
    Schedule Minutes
    ^([0-5]?\d)$
    No
    28
    SCHEDULE_TYPE
    Schedule Type
    ^(Once Only|Now)$
    No
    Now
    Export show command output
    exportShowCommandOutput
    GET
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmdevice/exportShowCommandOutput?apiKey=XXXXXXXXXXYYY&RESOURCEID=2&COMMAND=show version
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    RESOURCEID
    Resource id of the device
    long
    Yes
    2
    COMMAND
    Command
    text_basic_symbols
    Yes
    show version
    Get render details of change detection
    getChangeDetection
    GET
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmdevice/getChangeDetection?apiKey=XXXXXXXXXXYYY&RESOURCEID=["17"]&DEVICE_GROUP_ID=1
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    RESOURCEID
    Resource ids of the devices
    JSONArray
    longJson
    No
    ["17"]
    DEVICE_GROUP_ID
    ID of the device group
    long
    No
    1
    Get cisco inventory
    getCiscoInventory
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmdevice/getCiscoInventory?apiKey=XXXXXXXXXXYYY&deviceId=5
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    deviceId
    Resource id of the device
    long
    Yes
    5
    Get configuration content
    getConfigContents
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmdevice/getConfigContents?apiKey=XXXXXXXXXXYYY&RESOURCEID=2&FileType=Startup
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    RESOURCEID
    Resource id of the device
    long
    Yes
    2
    FileType
    File Type
    ncmFileType
    Yes
    Startup
    getConfigFileTypes
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmdevice/getConfigFileTypes?apiKey=XXXXXXXXXXYYY
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    RESOURCEID
    long
    Yes
    Get configlets executed for a device
    getDevConfiglets
    GET
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmdevice/getDevConfiglets?apiKey=XXXXXXXXXXYYY&deviceId=5
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    deviceId
    Resource id of the device
    long
    Yes
    5
    Get NCM device count
    getDeviceCount
    GET
    Allowed
    Allowed
    Restricted
    http://server-url:8060/api/json/ncmdevice/getDeviceCount?apiKey=XXXXXXXXXXYYY
    Get device groups list
    getDeviceGroupsList
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmdevice/getDeviceGroupsList?apiKey=XXXXXXXXXXYYY
    getDeviceTemplateUpdatePreRenders
    GET
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmdevice/getDeviceTemplateUpdatePreRenders?apiKey=XXXXXXXXXXYYY
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    RESOURCE_IDS
    JSONArray
    longJson
    No
    Get device interfaces
    getDevInterfaces
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmdevice/getDevInterfaces?apiKey=XXXXXXXXXXYYY&deviceId=5
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    deviceId
    Resource id of the device
    long
    Yes
    5
    Get security report
    getDevReport
    POST
    Allowed
    Restricted
    Restricted
    http://server-url:8060/api/json/ncmdevice/getDevReport?apiKey=XXXXXXXXXXYYY&deviceId=5&reportType=network_report
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    deviceId
    Resource id of the device
    long
    Yes
    5
    reportType
    Report Type
    ^(DeviceConfigurationReport|SecurityAuditReport)$
    Yes
    network_report
    Get device summary
    getDevSummaryforResId
    GET
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmdevice/getDevSummaryforResId?apiKey=XXXXXXXXXXYYY&RESOURCEID=302
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    RESOURCEID
    Resource id of the device
    long
    Yes
    302
    Get VLAN details
    getDevVlanDetails
    GET
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmdevice/getDevVlanDetails?apiKey=XXXXXXXXXXYYY
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    deviceId
    Resource id of the device
    long
    Yes
    Get interface/vlan last updated time
    getIntfVlanLastChangeDetails
    GET
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmdevice/getIntfVlanLastChangeDetails?apiKey=XXXXXXXXXXYYY
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    resourceId
    Resource id of the device
    long
    Yes
    Get device selection details
    getNCMDeviceSelectionDetails
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/v2/ncmdevice/getNCMDeviceSelectionDetails?apiKey=XXXXXXXXXXYYY
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    pageName
    Name of the page
    alphanumeric_basic
    Yes
    operationId
    Operation ID
    alphanumeric_basic
    Yes
    Get NCM device list
    getNCMDevicesList
    GET
    Allowed
    Allowed
    Restricted
    http://server-url:8060/api/json/ncmdevice/getNCMDevicesList?apiKey=XXXXXXXXXXYYY
    Get devices available for a user
    getResources
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmdevice/getResources?apiKey=XXXXXXXXXXYYY
    Get resources associated with device group
    getResourcesForGroups
    GET
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmdevice/getResourcesForGroups?apiKey=XXXXXXXXXXYYY&DEVICE_GROUP_ID=["1"]
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    DEVICE_GROUP_ID
    ID of the device group
    JSONArray
    longJson
    No
    ["1"]
    Get unmanaged devices
    getUnManagedDevices
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/v2/ncmdevice/getUnManagedDevices?apiKey=XXXXXXXXXXYYY
    Get device interfaces
    getV2DevInterfaces
    GET
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmdevice/getV2DevInterfaces?apiKey=XXXXXXXXXXYYY
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    deviceId
    Resource id of the device
    long
    Yes
    Import device group via file
    importDG
    POST
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmdevice/importDG?apiKey=XXXXXXXXXXYYY&GLOBAL_DEVICE_GROUP=true&isDistribute=true
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    DEVICE_GROUP_NAME
    Name of the device group
    ncmAllowedNameChars
    Yes
    DG_DESCRIPTION
    Device Group Description
    ncmBasicTextChars
    No
    GLOBAL_DEVICE_GROUP
    Global Device Group
    boolean
    No
    true
    isDistribute
    boolean
    No
    true
    Check is IPAddress is available
    isIPAvailable
    GET
    Allowed
    Allowed
    Restricted
    http://server-url:8060/api/json/ncmdevice/isIPAvailable?apiKey=XXXXXXXXXXYYY&IPADDRESS=2.3.2.1
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    IPADDRESS
    IPAddress
    ipAddress
    Yes
    2.3.2.1
    Is private device group
    isPrivateDeviceGroup
    GET
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmdevice/isPrivateDeviceGroup?apiKey=XXXXXXXXXXYYY
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    DEVICE_GROUP_ID
    ID of the device group
    String
    No
    Get render details of label configuration
    labelCurrConfigPreRenders
    GET
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmdevice/labelCurrConfigPreRenders?apiKey=XXXXXXXXXXYYY&RESOURCEID=["17"]
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    RESOURCEID
    Resource ids of the devices
    JSONArray
    longJson
    No
    ["17"]
    Last operation details
    lastOperationDetails
    GET
    Allowed
    Allowed
    Restricted
    http://server-url:8060/api/json/ncmdevice/lastOperationDetails?apiKey=XXXXXXXXXXYYY&deviceId=5
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    deviceId
    Resource id of the device
    long
    No
    5
    ip
    IpAddress
    NCM_IP_V4_AND_V6_Address
    No
    Get all devices
    listAllDevices
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmdevice/listAllDevices?apiKey=XXXXXXXXXXYYY&SSHKEYID=1&PROFILEID=303&EXPORT_AS_INV_REPORT=true
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    SSHKEYID
    ID of the SSH key
    long
    No
    1
    PROFILEID
    Profile Id
    long
    No
    303
    SEARCH_STRING
    Search String
    String
    No
    EXPORT_AS_INV_REPORT
    Is Exported as Inventory Report
    boolean
    No
    true
    Get all devices
    listAllDevices
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/v2/ncmdevice/listAllDevices?apiKey=XXXXXXXXXXYYY
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    SSHKEYID
    ID of the SSH key
    long
    No
    PROFILEID
    Profile Id
    long
    No
    SEARCH_STRING
    Search String
    String
    No
    EXPORT_AS_INV_REPORT
    Is Exported as Inventory Report
    boolean
    No
    skipMarkedDevices
    boolean
    No
    Get changes filters
    listChangesFilters
    GET
    Allowed
    Allowed
    Restricted
    http://server-url:8060/api/json/ncmdevice/listChangesFilters?apiKey=XXXXXXXXXXYYY
    Get configuration filters
    listConfigFilters
    GET
    Allowed
    Allowed
    Restricted
    http://server-url:8060/api/json/ncmdevice/listConfigFilters?apiKey=XXXXXXXXXXYYY
    Get all device groups
    listDeviceGroup
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmdevice/listDeviceGroup?apiKey=XXXXXXXXXXYYY
    Get device group details
    listDeviceGroupDetails
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmdevice/listDeviceGroupDetails?apiKey=XXXXXXXXXXYYY&dGroupId=1
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    dGroupId
    ID of the device group
    long
    Yes
    1
    Get device filters
    listDevicesFilters
    GET
    Allowed
    Allowed
    Restricted
    http://server-url:8060/api/json/ncmdevice/listDevicesFilters?apiKey=XXXXXXXXXXYYY
    Get draft filters
    listDraftFilters
    GET
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmdevice/listDraftFilters?apiKey=XXXXXXXXXXYYY
    Get inventory tabs
    listInventoryTabs
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmdevice/listInventoryTabs?apiKey=XXXXXXXXXXYYY
    Manage device(s)
    manage
    POST
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmdevice/manage?apiKey=XXXXXXXXXXYYY&RESOURCEID=["17"]
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    RESOURCEID
    Resource id of the device
    JSONArray
    longJson
    No
    ["17"]
    Request EOL data for a device
    markEOL
    POST
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmdevice/markEOL?apiKey=XXXXXXXXXXYYY&RESOURCEID=2&DISPLAYTYPE=HP Switch&MODEL=[NA]&SERIES=[NA]
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    RESOURCEID
    Resource id of the device
    long
    Yes
    2
    DISPLAYTYPE
    Display Type
    ncmPersonalityDisplayName
    Yes
    HP Switch
    MODEL
    Model
    String
    Yes
    [NA]
    SERIES
    Series
    String
    Yes
    [NA]
    Get matching devices for criteria
    matchingDevices
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmdevice/matchingDevices?apiKey=XXXXXXXXXXYYY
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    CRITERIA_LIST
    Criteria List
    JSONArray
    DGCriteriaJSON
    No
    multiConfigTemplates
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/v2/ncmdevice/multiConfigTemplates?apiKey=XXXXXXXXXXYYY
    Get the status of device(s)
    performStatusCheck
    GET
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmdevice/performStatusCheck?apiKey=XXXXXXXXXXYYY&DEVICE_GROUP_ID=1&RESOURCEIDS=["17"]
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    DEVICE_GROUP_ID
    ID of the device group
    long
    No
    1
    RESOURCEIDS
    Resource ids of the devices
    JSONArray
    longJson
    No
    ["17"]
    Get shared device templates
    sharedDeviceTemplates
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmdevice/sharedDeviceTemplates?apiKey=XXXXXXXXXXYYY
    Execute show command
    showCommandOutput
    POST
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmdevice/showCommandOutput?apiKey=XXXXXXXXXXYYY&RESOURCEID=2&COMMAND=show version
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    RESOURCEID
    Resource id of the device
    long
    Yes
    2
    COMMAND
    Command
    text_basic_symbols
    Yes
    show version
    Get render details of show command
    showCommandPreRenders
    GET
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmdevice/showCommandPreRenders?apiKey=XXXXXXXXXXYYY&RESOURCEID=2
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    RESOURCEID
    Resource id of the device
    long
    Yes
    2
    Stop the current operation
    stopOperation
    POST
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmdevice/stopOperation?apiKey=XXXXXXXXXXYYY&RESOURCEID=["17"]&DEVICE_GROUP_ID=1
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    RESOURCEID
    Resource id of the device
    JSONArray
    longJson
    No
    ["17"]
    DEVICE_GROUP_ID
    ID of the device group
    long
    No
    1
    Unmanage device(s)
    unmanage
    POST
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmdevice/unmanage?apiKey=XXXXXXXXXXYYY&RESOURCEID=["17"]
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    RESOURCEID
    Resource id of the device
    JSONArray
    longJson
    No
    ["17"]
    Update device summary
    updateDevSummary
    POST
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmdevice/updateDevSummary?apiKey=XXXXXXXXXXYYY&RESOURCEID=302&HOSTNAME=2.3.2.1&IPADDRESS=2.3.2.1&MODEL=2801&SERIES=2800&OLD_TEMPLATE_NAME=Cisco_IOS_Router&NEW_TEMPLATE_NAME=Cisco_IOS_Router
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    RESOURCEID
    Resource id of the device
    long
    Yes
    302
    HOSTNAME
    Host Name
    ncmHostOrIPAllowedChar
    Yes
    2.3.2.1
    IPADDRESS
    IPAddress
    NCM_IP_V4_AND_V6_Address
    Yes
    2.3.2.1
    OSVERSION
    OS Version
    ncmOSVersion
    Yes
    OSTYPE
    OS Type
    ncmOSType
    Yes
    MODEL
    Model
    ncmSeriesModel
    Yes
    2801
    SERIES
    Series
    ncmSeriesModel
    Yes
    2800
    SYSTEMDESCRIPTION
    System Description
    ncmSysInfo
    Yes
    SYSTEMLOCATION
    System Location
    ncmSysInfo
    Yes
    SYSTEMCONTACT
    ncmSysInfo
    Yes
    COLUMNNAME1
    Custom Column 1
    customColumnRegex
    Yes
    COLUMNNAME2
    Custom Column 2
    customColumnRegex
    Yes
    COLUMNNAME3
    Custom Column 3
    customColumnRegex
    Yes
    OLD_TEMPLATE_NAME
    Old Device Template Name
    ncmAllowedNameChars
    Yes
    Cisco_IOS_Router
    NEW_TEMPLATE_NAME
    New Device Template Name
    ncmAllowedNameChars
    Yes
    Cisco_IOS_Router
    Update device summary
    updateDevSysInfo
    POST
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmdevice/updateDevSysInfo?apiKey=XXXXXXXXXXYYY
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    IPADDRESSES
    IPAddress
    JSONArray
    ipAddrJson
    Yes
    OSVERSION
    OS version
    ncmOSVersion
    No
    OSTYPE
    OS type
    ncmOSType
    No
    MODEL
    Model
    ncmSeriesModel
    No
    SERIES
    Series
    ncmSeriesModel
    No
    SYSTEMDESCRIPTION
    System description
    ncmSysInfo
    No
    SYSTEMLOCATION
    System location
    ncmSysInfo
    No
    SYSTEMCONTACT
    ncmSysInfo
    No
    COLUMNNAME1
    Custom Column 1
    customColumnRegex
    No
    COLUMNNAME2
    Custom Column 2
    customColumnRegex
    No
    COLUMNNAME3
    Custom Column 3
    customColumnRegex
    No
    ENDOFSALEDATE
    End of sale date
    ncmDeviceEolDate
    No
    ENDOFSUPPORTDATE
    End of support date
    ncmDeviceEolDate
    No
    Update DNS
    updateDNS
    POST
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmdevice/updateDNS?apiKey=XXXXXXXXXXYYY&RESOURCEID=["17"]
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    RESOURCEID
    Resource ids of the devices
    JSONArray
    longJson
    No
    ["17"]
    Update hostname(s) via file
    updateHostNamefromFileImp
    POST
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmdevice/updateHostNamefromFileImp?apiKey=XXXXXXXXXXYYY
    Update hostname using snmp
    updateHostUsingSNMP
    POST
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmdevice/updateHostUsingSNMP?apiKey=XXXXXXXXXXYYY
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    DEVICEGROUPSELECTION
    ID of the device group
    long
    No
    SELECTEDDEVICES
    Resource ids of the devices
    JSONArray
    longJson
    No
    SELECTEDPROFILES
    Snmp profile name
    JSONArray
    strJson
    No
    ComponentSelection
    Device or device group selection
    ^(DeviceGroup|SpecificDevice)$
    Yes
    Update IPAddress
    updateIpAddress
    POST
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmdevice/updateIpAddress?apiKey=XXXXXXXXXXYYY&RESOURCEIDS=["17"]
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    RESOURCEIDS
    Resource ids of the devices
    JSONArray
    longJson
    No
    ["17"]
    Update interfaces
    updateNCMInterfaceDetails
    POST
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmdevice/updateNCMInterfaceDetails?apiKey=XXXXXXXXXXYYY
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    resourceId
    Resource id of the device
    long
    Yes
    Update device SNMP mapping
    updateSNMPMapping
    POST
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmdevice/updateSNMPMapping?apiKey=XXXXXXXXXXYYY&isDGSelected=true&selectedProfile=1&selectedDG=1&selectedDevices=["2"]
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    isDGSelected
    Is Device Group Selected
    boolean
    Yes
    true
    selectedProfile
    Selected profile
    long
    Yes
    1
    selectedDG
    Selected device group
    long
    No
    1
    selectedDevices
    Resource ids of the devices
    JSONArray
    longJson
    No
    ["2"]
    Upload a label
    uploadConfigDevices
    POST
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmdevice/uploadConfigDevices?apiKey=XXXXXXXXXXYYY&LABEL_NAME=BASELINE&RESOURCE_ID=["17"]&DEVICE_GROUP_ID=1&DOWNLOAD_OPTION=DOWNLOAD_NOW&SCHEDULE_DATE=Wed Aug 21 2019 16:28:50 GMT+0530 (India Standard Time)&SCHEDULE_HOUR=16&SCHEDULE_MINUTE=28
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    LABEL_NAME
    Label Name
    ncmBasicTextChars
    Yes
    BASELINE
    RESOURCE_ID
    Resource ids of the devices
    JSONArray
    longJson
    No
    ["17"]
    DEVICE_GROUP_ID
    ID of the device group
    long
    No
    1
    DOWNLOAD_OPTION
    Download Option
    ^(DOWNLOAD_LATER|DOWNLOAD_NOW)$
    No
    DOWNLOAD_NOW
    SCHEDULE_DATE
    Schedule Date
    DateDDMMYYYYRegex
    No
    Wed Aug 21 2019 16:28:50 GMT+0530 (India Standard Time)
    SCHEDULE_HOUR
    Schedule Hours
    ^([01]?\d|2[0-3])$
    No
    16
    SCHEDULE_MINUTE
    Schedule Minutes
    ^([0-5]?\d)$
    No
    28
    Get render details of upload configuration
    uploadConfigDevicesPrerender
    GET
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmdevice/uploadConfigDevicesPrerender?apiKey=XXXXXXXXXXYYY&RESOURCEIDS=["17"]
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    RESOURCEIDS
    Resource ids of the devices
    JSONArray
    longJson
    No
    ["17"]
    Get render details of upload configuration
    uploadConfigPreRenders
    GET
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmdevice/uploadConfigPreRenders?apiKey=XXXXXXXXXXYYY&DRAFT_ID=1&VERSION_ID=25816
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    DRAFT_ID
    Draft Id
    long
    No
    1
    VERSION_ID
    ID of the configuration version
    long
    No
    25816
  • ncmreports
    Title
    API Name
    Method
    Execution in Standalone/Probe
    Execution in Central
    Execution in Probe from Central
    Sample URL
    Add a advanced report
    addAdvReport
    POST
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmreports/addAdvReport?apiKey=XXXXXXXXXXYYY
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    report_name
    Name of the report
    [\p{L}\p{N}\P{InBasicLatin}\-\_\s\.]+
    Yes
    report_desc
    Description of the report
    ncmBasicTextChars
    No
    is_public
    Public or Private report
    boolean
    Yes
    similar_devices
    Similar device type or not
    boolean
    No
    filter_type
    Type of the filter
    ^(device|device_group|criteria)$
    Yes
    type
    Type of the report
    ^(NETWORK)$
    Yes
    criteria_expression
    Criteria expression
    alphanumeric_space
    No
    criteria_list
    List of criterias
    JSONArray
    filter_criteria
    No
    selected_ids
    Selected resources or device groups
    JSONArray
    longJson
    No
    sel_columns
    Selected columns
    JSONArray
    advReportColumns
    No
    Add a new custom report
    addNewCustomReport
    POST
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmreports/addNewCustomReport?apiKey=XXXXXXXXXXYYY
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    REPORTNAME
    Name of the report
    ncmAllowedNameChars
    No
    DESCRIPTION
    Description of the credential rule
    ncmBasicTextChars
    No
    REPORTOPTION
    Device or device group
    ^(Device|DeviceGroup)$
    No
    REPORTTYPE
    Type of the report
    ^(network_report|compliance_report)$
    No
    SELECTEDDEVICES
    Resource ids of the devices
    JSONArray
    longJson
    No
    DEVICETYPE
    Device type
    long
    No
    SELECTEDDEVICEGROUP
    ID of the device group
    long
    No
    SELECTEDREPORTCOLS
    Selected columns
    JSONArray
    customReportColsJson
    No
    SELECTEDRULES
    Selected rules
    JSONArray
    longJson
    No
    SELECTEDRULEGROUPS
    Selected rule groups
    JSONArray
    longJson
    No
    SELECTEDPOLICIES
    Selected policies
    JSONArray
    longJson
    No
    SHOWONLY
    Report options
    ^(ALL_RULES|VIOLATED_RULES_ONLY|COMPLIANT_RULES_ONLY)$
    No
    IS_ADD
    Add report or not
    boolean
    No
    REPORTID
    ID of the report
    long
    No
    Delete advanced report(s)
    deleteAdvReport
    POST
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmreports/deleteAdvReport?apiKey=XXXXXXXXXXYYY
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    report_id
    IDs of the report
    JSONArray
    longJson
    No
    Delete custom report(s)
    deleteCustomReport
    POST
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmreports/deleteCustomReport?apiKey=XXXXXXXXXXYYY&REPORTID=302
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    REPORTID
    ID of the custom report
    JSONArray
    longJson
    No
    302
    Edit advanced report
    editAdvReport
    POST
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmreports/editAdvReport?apiKey=XXXXXXXXXXYYY
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    report_id
    ID of the advanced report
    long
    Yes
    filter_id
    ID of the filter
    long
    Yes
    report_name
    Name of the report
    [\p{L}\p{N}\P{InBasicLatin}\-\_\s\.]+
    No
    report_desc
    Description of the report
    ncmBasicTextChars
    No
    is_public
    Public or Private report
    boolean
    No
    similar_devices
    Similar device type or not
    boolean
    No
    filter_type
    Type of the filter
    ^(device|device_group|criteria)$
    Yes
    type
    Type of the report
    ^(NETWORK)$
    Yes
    criteria_expression
    Criteria expression
    alphanumeric_space
    No
    criteria_list
    List of criterias
    JSONArray
    filter_criteria
    No
    selected_ids
    Selected resources or device groups
    JSONArray
    longJson
    No
    sel_columns
    Selected columns
    JSONArray
    advReportColumns
    No
    Get details of custom report
    editCustomReport
    POST
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmreports/editCustomReport?apiKey=XXXXXXXXXXYYY&REPORTID=302
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    REPORTID
    Report Id
    long
    No
    302
    Get configuration change inner data
    exeConfigChangeInnerData
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmreports/exeConfigChangeInnerData?apiKey=XXXXXXXXXXYYY&DG_ID=1
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    CUSTOMIZE_DATA_VIEWNAME
    View name of the report
    String
    No
    DG_ID
    ID of the device group
    long
    No
    1
    Export advanced report
    exportAdvReport
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmreports/exportAdvReport?apiKey=XXXXXXXXXXYYY
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    report_id
    ID of the advanced report
    long
    Yes
    export_type
    Export type
    ^(xlsx|csv|pdf)$
    No
    Export firmware vulnerability report
    exportFVReport
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmreports/exportFVReport?apiKey=XXXXXXXXXXYYY
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    DG_ID
    ID of the device group
    long
    No
    SEVERITY
    Severity of vulnerability
    (((critical|important|moderate|low)+)(,(critical|important|moderate|low)+)*)|(all)
    No
    EXPLOIT
    Is Exploitable Vulnerabilities
    boolean
    No
    export_type
    Type of report to be exported
    ^(csv|xlsx)$
    No
    CVEID
    ID of the CVE
    cve
    No
    vulReportType
    Type of vulnerability report
    ^(vuln|ExposedDevices|VersionDist)$
    No
    fv_search_key
    ^[\p{L}\p{N}-]+$
    No
    Export firmware vulnerability report
    exportFVReport
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmreports/exportFVReport?apiKey=XXXXXXXXXXYYY
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    DG_ID
    ID of the device group
    long
    No
    export_type
    Type of report to be exported
    ^(csv|xlsx)$
    No
    CVEID
    ID of the CVE
    cve
    No
    TIME_DURATION
    Time Duration
    ^(today|yesterday|last_7_days|last_30_days|custom)$
    No
    START_TIME
    Start Time
    long
    No
    END_TIME
    End Time
    long
    No
    Get render details of advanced report
    getAdvReportDetails
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmreports/getAdvReportDetails?apiKey=XXXXXXXXXXYYY
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    report_id
    ID of the advanced report
    long
    No
    Get all advanced report
    getAdvReportList
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmreports/getAdvReportList?apiKey=XXXXXXXXXXYYY
    Get meta data of advanced report
    getAdvReportMeta
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmreports/getAdvReportMeta?apiKey=XXXXXXXXXXYYY
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    report_id
    ID of the advanced report
    long
    Yes
    Get render details of annotation report
    getAnnotationReportPreRender
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmreports/getAnnotationReportPreRender?apiKey=XXXXXXXXXXYYY
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    DG_ID
    ID of the device group
    long
    No
    Get backup status report
    getBackupStatusReport
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmreports/getBackupStatusReport?apiKey=XXXXXXXXXXYYY
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    FILTER_VALUE
    ^(ALL|SUCCESS|FAILURE|NOTSTARTED|SUCCESS,FAILURE|FAILURE,NOTSTARTED|SUCCESS,NOTSTARTED)$
    Yes
    DG_ID
    ID of the device group
    long
    Yes
    Get render details of backup status report
    getBackupStatusReportRenderer
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmreports/getBackupStatusReportRenderer?apiKey=XXXXXXXXXXYYY
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    DG_ID
    ID of the device group
    long
    No
    Get change trend report
    getChangeTrendReport
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmreports/getChangeTrendReport?apiKey=XXXXXXXXXXYYY&DG_ID=1&deviceId=5
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    CUSTOMIZE_DATA_VIEWNAME
    View name of the report
    String
    No
    DG_ID
    ID of the device group
    long
    No
    1
    deviceId
    Resource id of the device
    long
    No
    5
    Get render details of compliance report
    getComplianceReportPreRender
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmreports/getComplianceReportPreRender?apiKey=XXXXXXXXXXYYY&DG_ID=1
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    DG_ID
    ID of the device group
    long
    No
    1
    CUSTOMIZE_DATA_VIEWNAME
    View name of the report
    String
    No
    Get render details of Config changes report
    getConfigChangeReportPreRender
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmreports/getConfigChangeReportPreRender?apiKey=XXXXXXXXXXYYY&DG_ID=1
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    DG_ID
    ID of the device group
    long
    No
    1
    CUSTOMIZE_DATA_VIEWNAME
    View name of the report
    String
    No
    Get configuration changes report
    getConfigChangesReport
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmreports/getConfigChangesReport?apiKey=XXXXXXXXXXYYY&DG_ID=1&ISCHANGES=true
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    CUSTOMIZE_DATA_VIEWNAME
    View name of the report
    String
    No
    DG_ID
    ID of the device group
    long
    Yes
    1
    ISCHANGES
    Is there a Configuration Change
    boolean
    Yes
    true
    Get config changes status
    getconfigChangesStatus
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmreports/getconfigChangesStatus?apiKey=XXXXXXXXXXYYY&DG_ID=1
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    CUSTOMIZE_DATA_VIEWNAME
    View name of the report
    String
    No
    DG_ID
    ID of the device group
    long
    Yes
    1
    Get configuration change trend report
    getConfigChangeTrendReport
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmreports/getConfigChangeTrendReport?apiKey=XXXXXXXXXXYYY&DG_ID=1
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    CUSTOMIZE_DATA_VIEWNAME
    View name of the report
    String
    No
    DG_ID
    ID of the device group
    long
    Yes
    1
    Get render details of Config change trend report
    getConfigChangeTrendReportPreRender
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmreports/getConfigChangeTrendReportPreRender?apiKey=XXXXXXXXXXYYY&DG_ID=1
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    DG_ID
    ID of the device group
    long
    No
    1
    Get render details of configuration upload request report
    getConfigUploadReqReportPreRender
    GET
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmreports/getConfigUploadReqReportPreRender?apiKey=XXXXXXXXXXYYY
    Get columns and models of custom report
    getCustomReportColNameandModels
    GET
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmreports/getCustomReportColNameandModels?apiKey=XXXXXXXXXXYYY&REPORTID=302
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    REPORTID
    ID of the custom report
    long
    Yes
    302
    Get render details of device audit report
    getDeviceAuditPrerender
    GET
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmreports/getDeviceAuditPrerender?apiKey=XXXXXXXXXXYYY&DG_ID=1
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    DG_ID
    ID of the device group
    long
    No
    1
    Get device ausit report
    getDeviceAuditReport
    GET
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmreports/getDeviceAuditReport?apiKey=XXXXXXXXXXYYY&RESOURCEID=2&DG_ID=1
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    RESOURCEID
    Resource id of the device
    long
    No
    2
    CUSTOMIZE_DATA_VIEWNAME
    View name of the report
    String
    No
    DG_ID
    ID of the device group
    long
    No
    1
    getDeviceCredentialProfiles
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmreports/getDeviceCredentialProfiles?apiKey=XXXXXXXXXXYYY
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    DG_ID
    long
    No
    getDeviceCredentialProfilesReportPreRender
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmreports/getDeviceCredentialProfilesReportPreRender?apiKey=XXXXXXXXXXYYY
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    DG_ID
    long
    No
    getDeviceCredentials
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmreports/getDeviceCredentials?apiKey=XXXXXXXXXXYYY
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    DG_ID
    long
    No
    getDeviceCredentialsReportPreRender
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmreports/getDeviceCredentialsReportPreRender?apiKey=XXXXXXXXXXYYY
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    DG_ID
    long
    No
    Get device list of device inventory report
    getDeviceInvInnerData
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmreports/getDeviceInvInnerData?apiKey=XXXXXXXXXXYYY&DG_ID=1&DEVICE_TYPE=CiscoRouter&MODEL=2801&SERIES=2801
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    CUSTOMIZE_DATA_VIEWNAME
    View name of the report
    String
    No
    DG_ID
    ID of the device group
    long
    Yes
    1
    DEVICE_TYPE
    Device Type
    String
    No
    CiscoRouter
    MODEL
    Model
    String
    No
    2801
    SERIES
    Series
    String
    No
    2801
    Get device management status report
    getDeviceMgmtStatusReport
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmreports/getDeviceMgmtStatusReport?apiKey=XXXXXXXXXXYYY&DG_ID=1
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    CUSTOMIZE_DATA_VIEWNAME
    View name of the report
    String
    No
    DG_ID
    ID of the device group
    long
    Yes
    1
    Get render details of device inventory report
    getDeviceModelInvPrerender
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmreports/getDeviceModelInvPrerender?apiKey=XXXXXXXXXXYYY&DG_ID=1
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    DG_ID
    ID of the device group
    long
    No
    1
    Get device inventory report
    getDeviceModelInvReport
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmreports/getDeviceModelInvReport?apiKey=XXXXXXXXXXYYY&DG_ID=1
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    CUSTOMIZE_DATA_VIEWNAME
    View name of the report
    String
    No
    DG_ID
    ID of the device group
    long
    Yes
    1
    Get devices and columns
    getDevicesAndColumnsOfDevType
    GET
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmreports/getDevicesAndColumnsOfDevType?apiKey=XXXXXXXXXXYYY&TYPEID=143
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    TYPEID
    Type Id
    long
    No
    143
    Get device status report
    getDeviceStatusReport
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmreports/getDeviceStatusReport?apiKey=XXXXXXXXXXYYY&DG_ID=1
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    CUSTOMIZE_DATA_VIEWNAME
    View name of the report
    String
    No
    DG_ID
    ID of the device group
    long
    Yes
    1
    Get vulnerability history for a device
    getDeviceVulnHistory
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmreports/getDeviceVulnHistory?apiKey=XXXXXXXXXXYYY
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    resourceId
    Resource id of the device
    long
    Yes
    Get render details of device management status report
    getDevMgmtStatusPrerender
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmreports/getDevMgmtStatusPrerender?apiKey=XXXXXXXXXXYYY&DG_ID=1
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    DG_ID
    ID of the device group
    long
    No
    1
    Get device response
    getDevResponse
    GET
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmreports/getDevResponse?apiKey=XXXXXXXXXXYYY&DeviceId=1&OperationId=10
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    DeviceId
    Resource id of the device
    long
    No
    1
    OperationId
    Operation Id
    long
    No
    10
    Get render details of device status report
    getDevStatusPrerender
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmreports/getDevStatusPrerender?apiKey=XXXXXXXXXXYYY&DG_ID=1
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    DG_ID
    ID of the device group
    long
    No
    1
    Get render details of EOL/EOS report
    getEOLEOSReportPreRender
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmreports/getEOLEOSReportPreRender?apiKey=XXXXXXXXXXYYY
    Get device list of firmware inventory report
    getFirmwareInvInnerData
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmreports/getFirmwareInvInnerData?apiKey=XXXXXXXXXXYYY&DG_ID=1&userIdforDeviceList=301
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    CUSTOMIZE_DATA_VIEWNAME
    View name of the report
    String
    No
    DG_ID
    ID of the device group
    long
    No
    1
    userIdforDeviceList
    User Id to list Devices
    long
    No
    301
    isUserAccessReport
    Is User Access Report
    String
    No
    OSVERSION
    OS Version
    String
    No
    OSTYPE
    OS Type
    String
    No
    DEVICE_TYPE
    Device Type
    String
    No
    Get render details of firmware inventory report
    getFirmwareInvPrerender
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmreports/getFirmwareInvPrerender?apiKey=XXXXXXXXXXYYY&DG_ID=1
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    DG_ID
    ID of the device group
    long
    No
    1
    Get firmware inventory report details
    getFirmwareInvReport
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmreports/getFirmwareInvReport?apiKey=XXXXXXXXXXYYY&DG_ID=1
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    CUSTOMIZE_DATA_VIEWNAME
    View name of the report
    String
    No
    DG_ID
    ID of the device group
    long
    No
    1
    Get render details of CVE-ID report
    getFirmwareVulCVEReportRender
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmreports/getFirmwareVulCVEReportRender?apiKey=XXXXXXXXXXYYY
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    DG_ID
    ID of the device group
    long
    No
    CUSTOMIZE_DATA_VIEWNAME
    View name of the report
    String
    No
    Get render details of exposed devices report
    getFirmwareVulDeviceReportRender
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmreports/getFirmwareVulDeviceReportRender?apiKey=XXXXXXXXXXYYY
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    DG_ID
    ID of the device group
    long
    No
    CUSTOMIZE_DATA_VIEWNAME
    View name of the report
    String
    No
    Get CVE render details
    getFirmwareVulnerabilityCVERender
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmreports/getFirmwareVulnerabilityCVERender?apiKey=XXXXXXXXXXYYY
    Get render details of firmware versions with vulnerabilities
    getFirmwareVulVersionReportRender
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmreports/getFirmwareVulVersionReportRender?apiKey=XXXXXXXXXXYYY
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    DG_ID
    ID of the device group
    long
    No
    CUSTOMIZE_DATA_VIEWNAME
    View name of the report
    String
    No
    Get firmware daily trend data
    getFVDailyTrendData
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmreports/getFVDailyTrendData?apiKey=XXXXXXXXXXYYY
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    CVEID
    ID of the CVE
    cve
    No
    TIME_DURATION
    Time duration
    ^(today|yesterday|last_7_days|last_30_days|custom)$
    No
    START_TIME
    Start time
    long
    No
    END_TIME
    End time
    long
    No
    Get device list of vulnerability fix trend report
    getFVDailyTrendDataSubGrid
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmreports/getFVDailyTrendDataSubGrid?apiKey=XXXXXXXXXXYYY
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    TREND_ID
    Trend ID
    long
    Yes
    Get graph data of vulnerability fix trend report
    getFVDailyTrendGraphData
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmreports/getFVDailyTrendGraphData?apiKey=XXXXXXXXXXYYY
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    CVEID
    ID of the CVE
    cve
    No
    TIME_DURATION
    Time duration
    ^(today|yesterday|last_7_days|last_30_days|custom)$
    No
    START_TIME
    Start time
    long
    No
    END_TIME
    End time
    long
    No
    Get render details of vulnerability history report
    getFvDeviceVulnHistoryReportPreRender
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmreports/getFvDeviceVulnHistoryReportPreRender?apiKey=XXXXXXXXXXYYY
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    DG_ID
    ID of the device group
    long
    No
    Get render details of firmware fix trend
    getFvFixTrendCveReportPreRender
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmreports/getFvFixTrendCveReportPreRender?apiKey=XXXXXXXXXXYYY
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    DG_ID
    ID of the device group
    long
    No
    Get render details of vulnerability fix trend report
    getFvFixTrendReportPreRender
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmreports/getFvFixTrendReportPreRender?apiKey=XXXXXXXXXXYYY
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    DG_ID
    ID of the device group
    long
    No
    Get all custom reports
    getListOfCustomReports
    GET
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmreports/getListOfCustomReports?apiKey=XXXXXXXXXXYYY
    Get hardware inventory report details
    getNetworkInvReport
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmreports/getNetworkInvReport?apiKey=XXXXXXXXXXYYY&PAGE_NO=1&PAGE_SIZE=10&DG_ID=1&PRERENDERS=true
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    PAGE_NO
    Page Number
    int
    No
    1
    PAGE_SIZE
    Page Size
    int
    No
    10
    DG_ID
    ID of the device group
    long
    No
    1
    PRERENDERS
    Is Pre Renders
    boolean
    No
    true
    Get render details of hardware inventory report
    getNetworkInvReportPreRender
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmreports/getNetworkInvReportPreRender?apiKey=XXXXXXXXXXYYY
    getOsVersionHistory
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmreports/getOsVersionHistory?apiKey=XXXXXXXXXXYYY
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    resourceId
    long
    Yes
    getOsVersionHistoryReportPreRender
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmreports/getOsVersionHistoryReportPreRender?apiKey=XXXXXXXXXXYYY
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    DG_ID
    long
    No
    getOsVersionsList
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmreports/getOsVersionsList?apiKey=XXXXXXXXXXYYY
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    DG_ID
    long
    No
    Get render details of PCI report
    getPCIReportPreRender
    GET
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmreports/getPCIReportPreRender?apiKey=XXXXXXXXXXYYY&DG_ID=1
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    DG_ID
    ID of the device group
    long
    No
    1
    Get render details of Startup-Running conflict report
    getStarupRunningConflictPreRender
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmreports/getStarupRunningConflictPreRender?apiKey=XXXXXXXXXXYYY&DG_ID=1
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    DG_ID
    ID of the device group
    long
    No
    1
    CUSTOMIZE_DATA_VIEWNAME
    View name of the report
    String
    No
    Get user access report
    getUserAccessReport
    GET
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmreports/getUserAccessReport?apiKey=XXXXXXXXXXYYY
    Get render details of user access report
    getUserAccessReportPreRender
    GET
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmreports/getUserAccessReportPreRender?apiKey=XXXXXXXXXXYYY
    Get user audit report
    getUserAuditReport
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmreports/getUserAuditReport?apiKey=XXXXXXXXXXYYY
    Get render details of user audit report
    getUserAuditReportPreRender
    GET
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmreports/getUserAuditReportPreRender?apiKey=XXXXXXXXXXYYY
    Get devices list affected with vulnerability
    getVulnDevicesList
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmreports/getVulnDevicesList?apiKey=XXXXXXXXXXYYY
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    DG_ID
    ID of the device group
    long
    No
    Get result details of advanced report
    loadAdvReport
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmreports/loadAdvReport?apiKey=XXXXXXXXXXYYY
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    report_id
    ID of the advanced report
    long
    Yes
    NCMReportCSVGenerator
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmreports/NCMReportCSVGenerator?apiKey=XXXXXXXXXXYYY&DG_ID=1
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    DG_ID
    long
    No
    1
    NCMReportCSVGenerator
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmreports/NCMReportCSVGenerator?apiKey=XXXXXXXXXXYYY&DG_ID=1&exportType=csv
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    DG_ID
    long
    No
    1
    exportType
    ^(csv|xlsx)$
    No
    csv
    NCMReportCSVGenerator
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmreports/NCMReportCSVGenerator?apiKey=XXXXXXXXXXYYY&DG_ID=1&FILTER_VALUE=ALL
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    DG_ID
    long
    No
    1
    FILTER_VALUE
    ^(ALL|SUCCESS|FAILURE|NOTSTARTED|SUCCESS,FAILURE|FAILURE,NOTSTARTED|SUCCESS,NOTSTARTED)$
    No
    ALL
    NCMReportCSVGenerator
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmreports/NCMReportCSVGenerator?apiKey=XXXXXXXXXXYYY&DG_ID=1&TIME_DURATION=today&START_TIME=1&END_TIME=1&exportType=csv
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    DG_ID
    long
    No
    1
    TIME_DURATION
    ^(today|yesterday|last_7_days|last_30_days|custom)$
    No
    today
    START_TIME
    long
    No
    1
    END_TIME
    long
    No
    1
    exportType
    ^(csv|xlsx)$
    No
    csv
    NCMReportCSVGenerator
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmreports/NCMReportCSVGenerator?apiKey=XXXXXXXXXXYYY&REPORTID=1
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    REPORTID
    long
    Yes
    1
    NCMReportCSVGenerator
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmreports/NCMReportCSVGenerator?apiKey=XXXXXXXXXXYYY&EXECUTION_ID=1&RESOURCE_ID=1
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    EXECUTION_ID
    long
    Yes
    1
    RESOURCE_ID
    long
    No
    1
    NCMReportCSVGenerator
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmreports/NCMReportCSVGenerator?apiKey=XXXXXXXXXXYYY&PROFILE_ID=1
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    PROFILE_ID
    long
    Yes
    1
    NCMReportPDFGenerator
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmreports/NCMReportPDFGenerator?apiKey=XXXXXXXXXXYYY&DEVICE_GROUP_ID=1&DG_ID=1
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    DEVICE_GROUP_ID
    long
    No
    1
    DG_ID
    long
    No
    1
    NCMReportPDFGenerator
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmreports/NCMReportPDFGenerator?apiKey=XXXXXXXXXXYYY
    NCMReportPDFGenerator
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmreports/NCMReportPDFGenerator?apiKey=XXXXXXXXXXYYY&DG_ID=1&FILTER_VALUE=ALL
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    DG_ID
    long
    No
    1
    FILTER_VALUE
    ^(ALL|SUCCESS|FAILURE|NOTSTARTED|SUCCESS,FAILURE|FAILURE,NOTSTARTED|SUCCESS,NOTSTARTED)$
    No
    ALL
    NCMReportPDFGenerator
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmreports/NCMReportPDFGenerator?apiKey=XXXXXXXXXXYYY&DEVICE_GROUP_ID=1&DG_ID=1&TIME_DURATION=today&START_TIME=1&END_TIME=1&DEVICE_ID=1
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    DEVICE_GROUP_ID
    long
    No
    1
    DG_ID
    long
    No
    1
    TIME_DURATION
    ^(today|yesterday|last_7_days|last_30_days|custom)$
    No
    today
    START_TIME
    long
    No
    1
    END_TIME
    long
    No
    1
    DEVICE_ID
    long
    No
    1
    NCMReportPDFGenerator
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmreports/NCMReportPDFGenerator?apiKey=XXXXXXXXXXYYY&REPORTID=1
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    REPORTID
    long
    Yes
    1
    NCMReportPDFGenerator
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmreports/NCMReportPDFGenerator?apiKey=XXXXXXXXXXYYY&DEVICE_GROUP_ID=1&DG_ID=1&DEVICE_ID=1
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    DEVICE_GROUP_ID
    long
    No
    1
    DG_ID
    long
    No
    1
    DEVICE_ID
    long
    No
    1
    NCMReportPDFGenerator
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmreports/NCMReportPDFGenerator?apiKey=XXXXXXXXXXYYY&DEVICE_ID=1
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    REP_CRI
    ^(ALL_RULES)$
    No
    DEVICE_ID
    long
    Yes
    1
    NCMReportPDFGenerator
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmreports/NCMReportPDFGenerator?apiKey=XXXXXXXXXXYYY&COMPPOLICY_ID=1
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    COMPPOLICY_ID
    long
    Yes
    1
    REP_CRI
    ^(ALL_RULES)$
    No
    NCMReportPDFGenerator
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmreports/NCMReportPDFGenerator?apiKey=XXXXXXXXXXYYY&DIFF_TYPE=VERSION_VERSION&SHOW_ALL=true&FIRST_VERSION_ID=1&SECOND_VERSION_ID=1
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    DIFF_TYPE
    ^(VERSION_VERSION|VERSION_DRAFT|DRAFT_VERSION|DRAFT_DRAFT|DRAFT_BASELINE)$
    Yes
    VERSION_VERSION
    SHOW_ALL
    boolean
    Yes
    true
    FIRST_VERSION_ID
    long
    Yes
    1
    SECOND_VERSION_ID
    long
    Yes
    1
    NCMReportPDFGenerator
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmreports/NCMReportPDFGenerator?apiKey=XXXXXXXXXXYYY&EXECUTION_ID=1&RESOURCE_ID=1
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    EXECUTION_ID
    long
    Yes
    1
    RESOURCE_ID
    long
    No
    1
    NCMReportPDFGenerator
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmreports/NCMReportPDFGenerator?apiKey=XXXXXXXXXXYYY&DG_ID=1&vulReportType=vuln&EXPLOIT=true
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    DG_ID
    long
    No
    1
    vulReportType
    ^(vuln|ExposedDevices|VersionDist)$
    No
    vuln
    SEVERITY
    (((critical|important|moderate|low)+)(,(critical|important|moderate|low)+)*)|(all)
    No
    EXPLOIT
    boolean
    No
    true
    fv_search_key
    ^[\p{L}\p{N}-]+$
    No
    NCMReportPDFGenerator
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmreports/NCMReportPDFGenerator?apiKey=XXXXXXXXXXYYY&DG_ID=1&TIME_DURATION=today&START_TIME=1&END_TIME=1
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    DG_ID
    long
    No
    1
    TIME_DURATION
    ^(today|yesterday|last_7_days|last_30_days|custom)$
    No
    today
    START_TIME
    long
    No
    1
    END_TIME
    long
    No
    1
    NCMReportPDFGenerator
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmreports/NCMReportPDFGenerator?apiKey=XXXXXXXXXXYYY&DG_ID=1&TIME_DURATION=today&START_TIME=1&END_TIME=1
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    DG_ID
    long
    No
    1
    CVEID
    cve
    No
    TIME_DURATION
    ^(today|yesterday|last_7_days|last_30_days|custom)$
    No
    today
    START_TIME
    long
    No
    1
    END_TIME
    long
    No
    1
    NCMReportPDFGenerator
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmreports/NCMReportPDFGenerator?apiKey=XXXXXXXXXXYYY&DG_ID=1
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    DG_ID
    long
    No
    1
    NCMReportPDFGenerator
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmreports/NCMReportPDFGenerator?apiKey=XXXXXXXXXXYYY&PROFILE_ID=1
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    PROFILE_ID
    Discovery profile id
    long
    Yes
    1
    NCMReportXLSGenerator
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmreports/NCMReportXLSGenerator?apiKey=XXXXXXXXXXYYY&DG_ID=1
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    DG_ID
    long
    No
    1
    NCMReportXLSGenerator
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmreports/NCMReportXLSGenerator?apiKey=XXXXXXXXXXYYY&REPORTID=1
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    REPORTID
    long
    Yes
    1
    NCMReportXLSGenerator
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmreports/NCMReportXLSGenerator?apiKey=XXXXXXXXXXYYY&DG_ID=1&FILTER_VALUE=ALL
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    DG_ID
    long
    No
    1
    FILTER_VALUE
    ^(ALL|SUCCESS|FAILURE|NOTSTARTED|SUCCESS,FAILURE|FAILURE,NOTSTARTED|SUCCESS,NOTSTARTED)$
    No
    ALL
    NCMReportXLSGenerator
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmreports/NCMReportXLSGenerator?apiKey=XXXXXXXXXXYYY
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    EXECUTION_ID
    long
    No
    RESOURCE_ID
    Resource id of the device
    long
    No
    Request to update EOL/EOS data
    requestToUpdateEOLEOSData
    POST
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmreports/requestToUpdateEOLEOSData?apiKey=XXXXXXXXXXYYY
    Send report via mail
    sendReportMail
    POST
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmreports/sendReportMail?apiKey=XXXXXXXXXXYYY&CUSTOMIZE_DATA_VIEWNAME=ConfigChangesReport_RTab&PDF_HANDLER_VIEW=GenerateDGReport_PDF&TIME_DURATION=custom&DEVICE_GROUP_ID=1&START_TIME=1&END_TIME=1&TO_ADDRESS=user1@testing.com&vulReportType=vuln&EXPLOIT=true&FILTER_VALUE=ALL
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    CUSTOMIZE_DATA_VIEWNAME
    View name of the report
    ^(HardwareInventoryReport_RTab|OSVersionReport_RTab|DeviceModelReport_RTab|DeviceStatusReport_RTab|DeviceManagementStatusReport_RTab|OperationAuditReport_RTab|ConflictReport_RTab|ConfigChangesReport_RTab|ConfigChangeTrendReport_RTab|AnnotationReport_RTab|BackupStatusReport_RTab|DeviceEOLReport_RTab|ComplianceReport_RTab|FirmVulCveReport_RTab|FirmVulDeviceReport_RTab|FirmVulVersionReport_RTab|UserAccessReport_RTab|UserUploadRequestReport_RTab|UserAuditReportView_RTab|PCIReviewReport_RTab|FvFixTrendReport_RTab|FvFixTrendCveReport_RTab|FvDeviceVulnHistoryReport_RTab|FirmwareVulnerabilityReport_RTab|OsVersionHistoryReport_RTab|DeviceCredentialProfilesReport_RTab|DeviceCredentialsReport_RTab)$
    Yes
    ConfigChangesReport_RTab
    PDF_HANDLER_VIEW
    PDF Handler View
    String
    No
    GenerateDGReport_PDF
    TIME_DURATION
    Time duration
    ^(custom|today|yesterday|last_7_days|last_30_days)$
    No
    custom
    DEVICE_GROUP_ID
    ID of the device group
    long
    No
    1
    START_TIME
    Start Time
    long
    No
    1
    END_TIME
    End Time
    long
    No
    1
    TO_ADDRESS
    To Address
    emailid
    Yes
    user1@testing.com
    vulReportType
    Firmware vulnerability report type
    ^(vuln|ExposedDevices|VersionDist)$
    No
    vuln
    SEVERITY
    Severity
    (((critical|important|moderate|low)+)(,(critical|important|moderate|low)+)*)|(all)
    No
    EXPLOIT
    Exploit
    boolean
    No
    true
    FILTER_VALUE
    ^(ALL|SUCCESS|FAILURE|NOTSTARTED|SUCCESS,FAILURE|FAILURE,NOTSTARTED|SUCCESS,NOTSTARTED)$
    No
    ALL
    CVEID
    ID of the CVE
    cve
    No
    Get compliance custom report details
    showComplianceCustomReportsDetails
    GET
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmreports/showComplianceCustomReportsDetails?apiKey=XXXXXXXXXXYYY&REPORT_ID=7&RESOURCE_ID=17
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    REPORT_ID
    Report Id
    long
    Yes
    7
    RESOURCE_ID
    Resource id of the device
    long
    Yes
    17
    Get result of custom report
    showCustomReportDetails
    GET
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmreports/showCustomReportDetails?apiKey=XXXXXXXXXXYYY&REPORTID=302
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    REPORTID
    ID of the custom report
    long
    Yes
    302
    Update a custom report
    updateCustomReport
    POST
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmreports/updateCustomReport?apiKey=XXXXXXXXXXYYY
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    REPORTNAME
    Name of the report
    ncmAllowedNameChars
    No
    DESCRIPTION
    Description of the credential rule
    ncmBasicTextChars
    No
    REPORTOPTION
    Device or device group
    ^(Device|DeviceGroup)$
    No
    REPORTTYPE
    Type of the report
    ^(network_report|compliance_report)$
    No
    SELECTEDDEVICES
    Resource ids of the devices
    JSONArray
    longJson
    No
    DEVICETYPE
    Device type
    long
    No
    SELECTEDDEVICEGROUP
    ID of the device group
    long
    No
    SELECTEDREPORTCOLS
    Selected columns
    JSONArray
    customReportColsJson
    No
    SELECTEDRULES
    Selected rules
    JSONArray
    longJson
    No
    SELECTEDRULEGROUPS
    Selected rule groups
    JSONArray
    longJson
    No
    SELECTEDPOLICIES
    Selected policies
    JSONArray
    longJson
    No
    SHOWONLY
    Report options
    ^(ALL_RULES|VIOLATED_RULES_ONLY|COMPLIANT_RULES_ONLY)$
    No
    IS_ADD
    Add report or not
    boolean
    No
    REPORTID
    ID of the report
    long
    No
    Update EOL data
    updateEOL
    POST
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmreports/updateEOL?apiKey=XXXXXXXXXXYYY
  • ncmsettings
    Title
    API Name
    Method
    Execution in Standalone/Probe
    Execution in Central
    Execution in Probe from Central
    Sample URL
    Add a new block exclude criteria
    addBlockExcludeCriteria
    POST
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmsettings/addBlockExcludeCriteria?apiKey=XXXXXXXXXXYYY&DEV_TEMPLATE=1&blockCondition=None&CRITERIA_ID=1&SENDEMAIL=true
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    DEV_TEMPLATE
    Device template
    long
    No
    1
    EXCLUDE_FROM_EMAIL
    Mail From address
    emailid
    No
    blockStartCriteria
    Start criteria of block
    String
    Yes
    blockEndCriteria
    End criteria of block
    String
    Yes
    criteriaName
    Name of the criteria
    text_basic_symbols_two_byte_support
    Yes
    blockCondition
    Additional block condition
    ^(None|Contains|NotContains)$
    No
    None
    blockCondition_value
    Block condition value
    String
    No
    CRITERIA_ID
    ID of the block criteria
    long
    No
    1
    SENDEMAIL
    Send mail notification
    boolean
    No
    true
    EXCLUDE_TO_EMAIL
    Mail To address
    (^[\w]([\w\-\.\+\'\/]*)@([\w\-\.]*)(\.[a-zA-Z]{2,22}(\.[a-zA-Z]{2}){0,2})(,[\w]([\w\-\.\+\'\/]*)@([\w\-\.]*)(\.[a-zA-Z]{2,22}(\.[a-zA-Z]{2}){0,2}))*)
    No
    Update custom column details
    addCustomColumn
    POST
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmsettings/addCustomColumn?apiKey=XXXXXXXXXXYYY&COLUMN_NAME1=Adress1&COLUMN_VALUE1=INDIA1st_Floor&COLUMN_NAME2=Adress2&COLUMN_VALUE2=Nelson_Road&COLUMN_NAME3=Adress3&COLUMN_VALUE3=1st_Floor
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    COLUMN_NAME1
    Custom Column Name 1
    customColumnRegex
    No
    Adress1
    COLUMN_VALUE1
    Custom Column Value 1
    customColumnRegex
    No
    INDIA1st_Floor
    COLUMN_NAME2
    Custom Column Name 2
    customColumnRegex
    No
    Adress2
    COLUMN_VALUE2
    Custom Column Value 2
    customColumnRegex
    No
    Nelson_Road
    COLUMN_NAME3
    Custom Column Name 3
    customColumnRegex
    No
    Adress3
    COLUMN_VALUE3
    Custom Column Value 3
    customColumnRegex
    No
    1st_Floor
    Add a device
    addDevice
    POST
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmsettings/addDevice?apiKey=XXXXXXXXXXYYY&DEVICE_BEHAVIOUR=Cisco IOS Router&ISMANUALADDITION=true&SERIES=2800&MODEL=2801&COLUMNNAME1=test1&COLUMNNAME2=test2&COLUMNNAME3=test3&IPADDRESS=2.3.2.1&VENDOR_NAME=Cisco&DISCOVERY_PROFILE_ID=1&ARE_FAILED_DISCOVERY_DEVICES=true&TAG_ID=1
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    DEVICE_BEHAVIOUR
    Device Behaviour
    ncmAllowedNameChars
    No
    Cisco IOS Router
    ISMANUALADDITION
    boolean
    No
    true
    SERIES
    Device Series
    ncmSeriesModel
    No
    2800
    MODEL
    Device Model
    ncmSeriesModel
    No
    2801
    COLUMNNAME1
    Custom Column Name 1
    customColumnRegex
    No
    test1
    COLUMNNAME2
    Custom Column Name 2
    customColumnRegex
    No
    test2
    COLUMNNAME3
    Custom Column Name 3
    customColumnRegex
    No
    test3
    BULKIPADDRESSES
    Bulk IPAddresses from Discovery
    JSONArray
    ipJson
    No
    IPADDRESS
    IPAddress
    ncmHostOrIPAllowedChar
    No
    2.3.2.1
    VENDOR_NAME
    Device Vendor Name
    ncmVendorName
    No
    Cisco
    DISCOVERY_PROFILE_ID
    Discovery Progress Profile Id
    long
    No
    1
    ARE_FAILED_DISCOVERY_DEVICES
    Add failed Discovery Devices
    boolean
    No
    true
    TAG_ID
    ID of the tag to be associated
    long
    No
    1
    Add a device template
    addDeviceTemplate
    POST
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmsettings/addDeviceTemplate?apiKey=XXXXXXXXXXYYY&multiConfigTemplate=true
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    sysoids
    List of sysoids
    JSONArray
    sysoidJson
    No
    DEVICETEMPLATEID
    ID of the device template
    long
    No
    templateName
    Name of the template
    ncmAllowedNameChars
    Yes
    share_to_community
    Share device template to community
    boolean
    No
    vendorName
    Name of the vendor
    ncmVendorDispName
    No
    personalityName
    Name of the personality
    ncmPersonalityName
    Yes
    sharedBy
    Shared by details
    text_basic_symbols
    No
    templateDescription
    Description of the device template
    ncmBasicTextChars
    No
    templateDesc
    Description of the device template
    ncmBasicTextChars
    No
    templateOSType
    OS type
    ncmOSType
    No
    vendorId
    ID of the vendor
    long
    Yes
    personalityId
    ID of the personality
    long
    Yes
    configuration
    Commands of the device template
    String
    No
    clonesysoid
    Clone existing sysoid or not
    boolean
    No
    multiConfigTemplate
    boolean
    No
    true
    baseTemplateName
    ncmAllowedNameChars
    No
    Add discovered devices to NCM
    addDiscoveredResources
    POST
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmsettings/addDiscoveredResources?apiKey=XXXXXXXXXXYYY&PROFILEID=1
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    REPORTIDS
    Report Id(s)
    JSONArray
    longJson
    No
    PROFILEID
    ID of the discovery profile
    long
    No
    1
    Add a exclude criteria
    addExcludeCriteria
    POST
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmsettings/addExcludeCriteria?apiKey=XXXXXXXXXXYYY&DEV_TEMPLATE=Cisco IOS XR&EXCLUDE_FROM_EMAIL=test@test.com&CRITERIA=clock&ENC_CRITERIA=clock&CRITERIA_ID=1&SENDEMAIL=false&EXCLUDE_TO_EMAIL=test@test.com
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    DEV_TEMPLATE
    Device Template
    ncmAllowedNameChars
    No
    Cisco IOS XR
    EXCLUDE_FROM_EMAIL
    Exclude From Mail
    emailid
    No
    test@test.com
    CRITERIA
    Criteria
    String
    No
    clock
    ENC_CRITERIA
    Encoded Criteria
    String
    No
    clock
    CRITERIA_ID
    Criteria Id
    long
    No
    1
    SENDEMAIL
    Send Mail
    boolean
    No
    false
    EXCLUDE_TO_EMAIL
    Exclude To Mail
    (^[\w]([\w\-\.\+\'\/]*)@([\w\-\.]*)(\.[a-zA-Z]{2,22}(\.[a-zA-Z]{2}){0,2})(,[\w]([\w\-\.\+\'\/]*)@([\w\-\.]*)(\.[a-zA-Z]{2,22}(\.[a-zA-Z]{2}){0,2}))*)
    No
    test@test.com
    Associate a flow configlet to device template
    addFlowConfiglets
    POST
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmsettings/addFlowConfiglets?apiKey=XXXXXXXXXXYYY&TEMPLATE_ID=["16","10"]&DEVICETEMPLATEID=20
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    TEMPLATE_ID
    Configlet Id
    JSONArray
    longJson
    Yes
    ["16","10"]
    DEVICETEMPLATEID
    Device Template Id
    long
    Yes
    20
    Get render details of flow configlets
    addFlowConfigletsPreRender
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmsettings/addFlowConfigletsPreRender?apiKey=XXXXXXXXXXYYY&DEVICETEMPLATEID=20
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    DEVICETEMPLATEID
    Device Template Id
    long
    Yes
    20
    Add a label
    addLabel
    POST
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmsettings/addLabel?apiKey=XXXXXXXXXXYYY&LABEL_NAME=Current Version&DESCRIPTION=Label for current configuration
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    LABEL_NAME
    Name of the label
    ncmBasicTextChars
    Yes
    Current Version
    DESCRIPTION
    Descripition of the label
    ncmBasicTextChars
    No
    Label for current configuration
    Add a PCI reviewer
    addReviewer
    POST
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmsettings/addReviewer?apiKey=XXXXXXXXXXYYY&LOGIN_ID=2&EMAIL_ID=user1@testing.com
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    LOGIN_ID
    Login Id of the User
    long
    Yes
    2
    EMAIL_ID
    Email Id of the User
    (^[\w]([\w\-\.\+\'\/]*)@([\w\-\.]*)(\.[a-zA-Z]{2,22}(\.[a-zA-Z]{2}){0,2})(,[\w]([\w\-\.\+\'\/]*)@([\w\-\.]*)(\.[a-zA-Z]{2,22}(\.[a-zA-Z]{2}){0,2}))*)
    No
    user1@testing.com
    Add a credential profile
    addSharedProfile
    POST
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmsettings/addSharedProfile?apiKey=XXXXXXXXXXYYY
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    IS_SNMP_PROFILE
    SNMP profile or CLI profile
    boolean
    No
    PROFILENAME
    Name of the profile
    text_basic_symbols_two_byte_support
    No
    snmp_port
    SNMP port number
    int
    No
    snmp_version
    SNMP version
    int
    No
    snmp_username
    SNMP User name
    String
    No
    snmp_contextname
    SNMP Context name
    String
    No
    snmp_authprotocol
    SNMP Auth protocol
    ^(20|21|22)$
    No
    snmp_privprotocol
    SNMP Priv protocol
    ^(49|50|51)$
    No
    snmp_authpassword
    SNMP Auth password
    String
    No
    snmp_privpassword
    SNMP Priv password
    String
    No
    snmp_readcommunity
    SNMP Read community
    String
    No
    snmp_writecommunity
    SNMP Write community
    String
    No
    telnet_loginname
    Telnet Login name
    String
    No
    telnet_password
    Telnet Password
    String
    No
    telnet_prompt
    Telnet Prompt
    String
    No
    telnet_enableUserName
    Telnet User name
    String
    No
    telnet_enablepassword
    Telnet Enable password
    String
    No
    telnet_enablepasswordType
    Telnet Enable password type
    ^(enablePassword|noEnablePassword|emptyEnablePassword)$
    No
    telnet_enableprompt
    Telnet Enable prompt
    String
    No
    ssh_loginname
    SSH Login name
    String
    No
    ssh_password
    SSH Password
    String
    No
    ssh_prompt
    SSH Prompt
    String
    No
    ssh_enableUserName
    SSH Enable user name
    String
    No
    ssh_enablepassword
    SSH Enable password
    String
    No
    ssh_enablepasswordType
    SSH Enable password type
    ^(enablePassword|noEnablePassword|emptyEnablePassword)$
    No
    ssh_enableprompt
    SSH Enable prompt
    String
    No
    PROFILEDESCRIPTION
    Description of the profile
    ncmBasicTextChars
    No
    Add or update show command
    addShowCommand
    POST
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmsettings/addShowCommand?apiKey=XXXXXXXXXXYYY&COMMAND_ID=73&ALIAS=show version&COMMAND=/system resource print&VENDOR=57
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    COMMAND_ID
    ID of the show command
    long
    No
    73
    ALIAS
    Command Alias
    text_basic_symbols_two_byte_support
    Yes
    show version
    COMMAND
    Command
    text_basic_symbols_two_byte_support
    Yes
    /system resource print
    VENDOR
    Vendor
    ncmVendorDispName
    Yes
    57
    Add a sysoid
    addSysOID
    POST
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmsettings/addSysOID?apiKey=XXXXXXXXXXYYY&SENDEMAIL=false&DEVICE_BEHAVIOUR=Cisco IOS Router&MODEL=C2951&SERIES=2951
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    SENDEMAIL
    Send Mail
    boolean
    No
    false
    DEVICE_BEHAVIOUR
    Device Behaviour
    ncmAllowedNameChars
    Yes
    Cisco IOS Router
    SYSOID
    SYSOID
    ncmSysoid
    Yes
    MODEL
    Model
    ncmSeriesModel
    No
    C2951
    SERIES
    Series
    ncmSeriesModel
    No
    2951
    Get all schedules
    allSchedules
    GET
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmsettings/allSchedules?apiKey=XXXXXXXXXXYYY&taskType=Configuration Backup
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    taskType
    Type of schedules that needs to be listed. All schedules will be listed if this parameter is empty
    ^(Configuration Backup|Compliance Check|Sync Configuration|Report Generation|Custom Template|PCI Review|Device Discovery)$
    No
    Configuration Backup
    Get all show commands
    allshowCommands
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmsettings/allshowCommands?apiKey=XXXXXXXXXXYYY
    Get all sysobject ids
    allSysOID
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmsettings/allSysOID?apiKey=XXXXXXXXXXYYY&DEVICETEMPLATEID=20
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    DEVICETEMPLATEID
    ID of the device template
    long
    No
    20
    Get approved requests
    approvedRequests
    GET
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmsettings/approvedRequests?apiKey=XXXXXXXXXXYYY
    Approve a pending request
    approveRequest
    POST
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmsettings/approveRequest?apiKey=XXXXXXXXXXYYY&ADMIN_COMMENTS=Approved&REQUEST_ID=1&REQUEST_APPROVED=true&SCHEDULE_TYPE=Now&IS_APPROVE_ONLY=true&ONCEONLY_START_TIME_HOUR=08&ONCEONLY_START_TIME_MIN=30&ONCEONLY_START_DATE=08/20/2019
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    ADMIN_COMMENTS
    Admin Comments
    ncmBasicTextChars
    No
    Approved
    REQUEST_ID
    ID of the approval request
    long
    Yes
    1
    REQUEST_APPROVED
    Is Request Approved
    boolean
    Yes
    true
    SCHEDULE_TYPE
    Schedule Type
    ^(Once Only|Now)$
    No
    Now
    IS_APPROVE_ONLY
    Is Approve only
    boolean
    No
    true
    ONCEONLY_START_TIME_HOUR
    Once Only Start Time Hours
    int
    No
    08
    ONCEONLY_START_TIME_MIN
    Once Only Start Time Minutes
    int
    No
    30
    ONCEONLY_START_DATE
    Once Only Start Date
    dateforapproval
    No
    08/20/2019
    Get render details of approval request
    approveRequestPrerender
    GET
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmsettings/approveRequestPrerender?apiKey=XXXXXXXXXXYYY&REQUEST_ID=1
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    REQUEST_ID
    ID of the approval request
    long
    Yes
    1
    Associate credential to device
    assocCredential
    POST
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmsettings/assocCredential?apiKey=XXXXXXXXXXYYY&authMode=sshKey&UPDATE_TYPE=UPDATE&BACKUP_STATUS=true&TEST_CRED=true&RESOURCEID_LIST=10&SNMP_VERSION=0&SNMP_PORT=161&SNMP_READCOMMUNITY=public&SNMP_WRITECOMMUNITY=password&SNMP_USERNAME=user1&SNMP_CONTEXTNAME=context1&SNMP_AUTHPROTOCOL=20&SNMP_AUTHPASSWORD=fakepassword&SNMP_PRIVPROTOCOL=49&SNMP_PRIVPASSWORD=fakepassword&SNMP_NATIP=1.1.1.1&TELNET_LOGINNAME=tempuser&TELNET_PASSWORD=temppassword&TELNET_PROMPT=:&TELNET_ENABLEUSERNAME=tempuser&TELNET_ENABLEPASSWORD=temppassword&TELNET_ENABLEPROMPT=:&TELNET_NATIP=1.1.1.1&TELNET_PORT=50&TELNET_LOGINPROMPT=:&TELNET_PASSWORDPROMPT=#&TELNET_ENABLEUSERNAMEPROMPT=>&TELNET_ENABLEPASSWORDPROMPT=?&TELNET_ENABLEPASSWORDTYPE=enablePassword&SSH_LOGINNAME=user&SSH_PASSWORD=r&SSH_PROMPT=>|#&SSH_ENABLEUSERNAME=tempuser&SSH_ENABLEPASSWORD=temppassword&SSH_ENABLEPROMPT=>|#&SSH_NATIP=1.1.1.1&SSH_PORT=22&SSH_LOGINPROMPT=>|#&SSH_PASSWORDPROMPT=>|#&SSH_ENABLEUSERNAMEPROMPT=>|#&SSH_ENABLEPASSWORDPROMPT=>|#&SSH_ENABLEPASSWORDTYPE=enablePassword
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    authMode
    SSH authentication mode
    ^(sshKey|password)$
    No
    sshKey
    SSH_PRIVATEKEYID
    ID of the SSH Key
    alphanumeric_basic
    No
    UPDATE_TYPE
    Update Type of Credentials
    ^(UPDATE)$
    No
    UPDATE
    BACKUP_STATUS
    Backup the Device immediately
    boolean
    No
    true
    TEST_CRED
    Test the Credential after Saving
    boolean
    No
    true
    RESOURCEID_LIST
    Resource Id List (Separated by comma)
    ((\d+)(,\d+)*)
    Yes
    10
    SNMP_PROFILELIST
    SNMP Profile List
    text_basic_symbols_two_byte_support
    No
    SNMP_VERSION
    SNMP Version
    ^(0|1|3)$
    No
    0
    SNMP_PORT
    SNMP Port
    ncmPortRegex
    No
    161
    SNMP_READCOMMUNITY
    SNMP Read Community
    String
    No
    public
    SNMP_WRITECOMMUNITY
    SNMP Write Community
    String
    No
    password
    SNMP_USERNAME
    SNMP User Name
    String
    No
    user1
    SNMP_CONTEXTNAME
    SNMP Context Name
    String
    No
    context1
    SNMP_AUTHPROTOCOL
    SNMP Auth Protocol (20=None, 21=MD5 and 22=SHA)
    ^(20|21|22)$
    No
    20
    SNMP_AUTHPASSWORD
    SNMP Auth Password
    String
    No
    fakepassword
    SNMP_PRIVPROTOCOL
    SNMP Priv Protocol (49=AES 128, 50=DES and 51=None)
    ^(49|50|51)$
    No
    49
    SNMP_PRIVPASSWORD
    SNMP Priv Password
    String
    No
    fakepassword
    SNMP_NATIP
    SNMP Network Address Translated IP Address
    ipAddress
    No
    1.1.1.1
    TELNET_PROFILELIST
    TELNET Profile List
    text_basic_symbols_two_byte_support
    No
    TELNET_LOGINNAME
    TELNET Login Name
    String
    No
    tempuser
    TELNET_PASSWORD
    TELNET Login Password
    String
    No
    temppassword
    TELNET_PROMPT
    TELNET Prompt
    String
    No
    :
    TELNET_ENABLEUSERNAME
    TELNET Enable UserName
    String
    No
    tempuser
    TELNET_ENABLEPASSWORD
    TELNET Enable Password
    String
    No
    temppassword
    TELNET_ENABLEPROMPT
    TELNET Enable Prompt
    String
    No
    :
    TELNET_NATIP
    TELNET Network Address Translated IP Address
    ipAddress
    No
    1.1.1.1
    TELNET_PORT
    TELNET Port
    ncmPortRegex
    No
    50
    TELNET_LOGINPROMPT
    TELNET Login Prompt
    String
    No
    :
    TELNET_PASSWORDPROMPT
    TELNET Password Prompt
    String
    No
    #
    TELNET_ENABLEUSERNAMEPROMPT
    TELNET Enable User Prompt
    String
    No
    >
    TELNET_ENABLEPASSWORDPROMPT
    TELNET Enable Password Prompt
    String
    No
    ?
    TELNET_ENABLEPASSWORDTYPE
    Telnet Enable Password Type
    ^(enablePassword|noEnablePassword|emptyEnablePassword)$
    No
    enablePassword
    SSH_PROFILELIST
    SSH Profile List
    text_basic_symbols_two_byte_support
    No
    SSH_LOGINNAME
    SSH Login Name
    String
    No
    user
    SSH_PASSWORD
    SSH Login Password
    String
    No
    r
    SSH_PROMPT
    SSH Prompt
    String
    No
    >|#
    SSH_ENABLEUSERNAME
    SSH Enable UserName
    String
    No
    tempuser
    SSH_ENABLEPASSWORD
    SSH Enable Password
    String
    No
    temppassword
    SSH_ENABLEPROMPT
    SSH Enable Prompt
    String
    No
    >|#
    SSH_NATIP
    SSH Network Address Translated IP Address
    ipAddress
    No
    1.1.1.1
    SSH_PORT
    SSH Port
    ncmPortRegex
    No
    22
    SSH_LOGINPROMPT
    SSH Login Prompt
    String
    No
    >|#
    SSH_PASSWORDPROMPT
    SSH Password Prompt
    String
    No
    >|#
    SSH_ENABLEUSERNAMEPROMPT
    SSH Enable User Prompt
    String
    No
    >|#
    SSH_ENABLEPASSWORDPROMPT
    SSH Enable Password Prompt
    String
    No
    >|#
    SSH_ENABLEPASSWORDTYPE
    SSH Enable Password Type
    ^(enablePassword|noEnablePassword|emptyEnablePassword)$
    No
    enablePassword
    protocolCombinationList
    Combination of Protocols
    ^(TELNET|TELNET - TFTP|SSH|SSH - TFTP|SSH - SCP|SSH - SFTP|SNMP - TFTP|REST API)$
    No
    REST_API_PARAMS
    REST API Parameters
    JSONArray
    restAPICredentialJSON
    No
    Get backup schedules
    backupSchedules
    GET
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmsettings/backupSchedules?apiKey=XXXXXXXXXXYYY
    Check DNS is resolved or not
    checkDNSName
    POST
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmsettings/checkDNSName?apiKey=XXXXXXXXXXYYY&IPADDRESS=2.3.2.1
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    IPADDRESS
    IP Address
    ncmHostOrIPAllowedChar
    Yes
    2.3.2.1
    Clone and export device template
    cloneExportSimpleDeviceTemplate
    POST
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmsettings/cloneExportSimpleDeviceTemplate?apiKey=XXXXXXXXXXYYY&multiConfigTemplate=true
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    sysoids
    List of sysoids
    JSONArray
    sysoidJsonExportDT
    No
    DEVICETEMPLATEID
    ID of the device template
    long
    No
    templateName
    Name of the template
    ncmAllowedNameChars
    Yes
    share_to_community
    Share device template to community
    boolean
    No
    vendorName
    Name of the vendor
    ncmVendorDispName
    No
    personalityName
    Name of the personality
    ncmPersonalityName
    Yes
    sharedBy
    Shared by details
    text_basic_symbols
    No
    templateDescription
    Description of the device template
    ncmBasicTextChars
    No
    templateDesc
    Description of the device template
    ncmBasicTextChars
    No
    templateOSType
    OS type
    ncmOSType
    No
    vendorId
    ID of the vendor
    long
    Yes
    personalityId
    ID of the personality
    long
    Yes
    configuration
    Commands of the device template
    String
    No
    clonesysoid
    Clone existing sysoid or not
    boolean
    No
    multiConfigTemplate
    boolean
    No
    true
    baseTemplateName
    ncmAllowedNameChars
    No
    Clone a device template
    cloneSimpleDeviceTemplate
    POST
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmsettings/cloneSimpleDeviceTemplate?apiKey=XXXXXXXXXXYYY&multiConfigTemplate=true
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    sysoids
    List of sysoids
    JSONArray
    sysoidJson
    No
    DEVICETEMPLATEID
    ID of the device template
    long
    No
    templateName
    Name of the template
    ncmAllowedNameChars
    Yes
    share_to_community
    Share device template to community
    boolean
    No
    vendorName
    Name of the vendor
    ncmVendorDispName
    No
    personalityName
    Name of the personality
    ncmPersonalityName
    Yes
    sharedBy
    Shared by details
    text_basic_symbols
    No
    templateDescription
    Description of the device template
    ncmBasicTextChars
    No
    templateDesc
    Description of the device template
    ncmBasicTextChars
    No
    templateOSType
    OS type
    ncmOSType
    No
    vendorId
    ID of the vendor
    long
    Yes
    personalityId
    ID of the personality
    long
    Yes
    configuration
    Commands of the device template
    String
    No
    clonesysoid
    Clone existing sysoid or not
    boolean
    No
    multiConfigTemplate
    boolean
    No
    true
    baseTemplateName
    ncmAllowedNameChars
    No
    Get show command details
    commandPreRender
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmsettings/commandPreRender?apiKey=XXXXXXXXXXYYY&commandId=73
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    commandId
    ID of the show command
    long
    No
    73
    Get configlet details
    configletPreRenders
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmsettings/configletPreRenders?apiKey=XXXXXXXXXXYYY&TEMPLATE_ID=4&DEVICETEMPLATEID=20
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    TEMPLATE_ID
    ID of the configlet
    long
    No
    4
    DEVICETEMPLATEID
    ID of the device template
    long
    No
    20
    Get render details of configlet during schedule
    configletSchedPreRenders
    GET
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmsettings/configletSchedPreRenders?apiKey=XXXXXXXXXXYYY&TEMPLATE_ID=4
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    TEMPLATE_ID
    ID of the configlet
    long
    Yes
    4
    Get credential details
    credentialPreRenders
    GET
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmsettings/credentialPreRenders?apiKey=XXXXXXXXXXYYY&PROFILEID=303&PROFILENAME=temp
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    PROFILEID
    Profile Id
    long
    No
    303
    PROFILENAME
    Profile Name
    text_basic_symbols
    No
    temp
    Get all credential profiles
    credProfList
    GET
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmsettings/credProfList?apiKey=XXXXXXXXXXYYY
    Get custom sysobject ids
    customSysOID
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmsettings/customSysOID?apiKey=XXXXXXXXXXYYY&DEVICETEMPLATEID=20
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    DEVICETEMPLATEID
    ID of the device template
    long
    No
    20
    Get configuration export details
    databaseBackupPreRender
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmsettings/databaseBackupPreRender?apiKey=XXXXXXXXXXYYY&OPERATION_TYPE=CONFIG_EXPORT
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    OPERATION_TYPE
    Operation Type
    ^(CONFIG_EXPORT)$
    Yes
    CONFIG_EXPORT
    Update database cleanup settings
    databaseCleanup
    POST
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmsettings/databaseCleanup?apiKey=XXXXXXXXXXYYY&DELETE_VERSION_HISTORY=true&DELETE_AUDIT_HISTORY=true&DELETE_VERSION_HISTORY_DAYS=true&VERSION_HISTORY_SIZE=30&AUDIT_HISTORY_SIZE=20&VERSION_HISTORY_SIZE_DAYS=1&cleanupUserAudit=true&ncm.cleanup.hour=08&ncm.cleanup.minute=30&SYSOG_MSG_HISTORY_SIZE_CHK=true&SYSOG_MSG_HISTORY_SIZE=30&FV_HISTORY_RETAIN_DAYS=1
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    DELETE_VERSION_HISTORY
    Delete Version History
    boolean
    No
    true
    DELETE_AUDIT_HISTORY
    Delete Audit History
    boolean
    No
    true
    DELETE_VERSION_HISTORY_DAYS
    Delete Version History Days
    boolean
    No
    true
    VERSION_HISTORY_SIZE
    Version History Size
    int
    No
    30
    AUDIT_HISTORY_SIZE
    Audit History Size
    int
    No
    20
    VERSION_HISTORY_SIZE_DAYS
    Version History Size Days
    int
    No
    1
    cleanupUserAudit
    Is User Audit Cleanup Enabled
    boolean
    No
    true
    ncm.cleanup.hour
    Database Cleanup Time Hours
    int
    No
    08
    ncm.cleanup.minute
    Database Cleanup Time Minutes
    int
    No
    30
    SYSOG_MSG_HISTORY_SIZE_CHK
    Whether to delete syslog message trend history
    boolean
    No
    true
    SYSOG_MSG_HISTORY_SIZE
    No. of days after which history must be deleted
    int
    No
    30
    FV_HISTORY_RETAIN_DAYS
    No. of days firmware history can be retained
    int
    No
    1
    Get database cleanup settings
    databaseCleanupPreRender
    GET
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmsettings/databaseCleanupPreRender?apiKey=XXXXXXXXXXYYY
    Delete configlet audit
    DelCustTempAudit
    POST
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmsettings/DelCustTempAudit?apiKey=XXXXXXXXXXYYY&EXECUTION_ID=1
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    EXECUTION_ID
    Execution Id of the Configlet
    JSONArray
    longJson
    Yes
    1
    Delete block criteria(s)
    deleteBlockExcludeCriteria
    POST
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmsettings/deleteBlockExcludeCriteria?apiKey=XXXXXXXXXXYYY
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    CRITERIA_ID
    ID of the block criteria
    JSONArray
    longJson
    Yes
    Delete credential profile(s)
    deleteCredentials
    POST
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmsettings/deleteCredentials?apiKey=XXXXXXXXXXYYY&PROFILEID=303
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    PROFILEID
    ID of the credential profile
    JSONArray
    longJson
    Yes
    303
    Delete device template(s)
    deleteDeviceTemplate
    POST
    Allowed
    Allowed
    Restricted
    http://server-url:8060/api/json/ncmsettings/deleteDeviceTemplate?apiKey=XXXXXXXXXXYYY&DEVICETEMPLATEID=20
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    DEVICETEMPLATEID
    Device Template Id
    long
    Yes
    20
    Delete exclude criteria(s)
    deleteExcludeCriteria
    POST
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmsettings/deleteExcludeCriteria?apiKey=XXXXXXXXXXYYY&CRITERIA_ID=["1"]
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    CRITERIA_ID
    Criteria Id
    JSONArray
    longJson
    Yes
    ["1"]
    Delete a specific configuration from label
    deleteLabel
    POST
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmsettings/deleteLabel?apiKey=XXXXXXXXXXYYY&LABEL_ID=["301"]
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    LABEL_ID
    ID of the label
    JSONArray
    longJson
    No
    ["301"]
    Delete a specific configuration from label
    deleteLabel
    POST
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmsettings/deleteLabel?apiKey=XXXXXXXXXXYYY&LABEL_ID=["301"]
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    LABEL_ID
    ID of the label
    long
    No
    ["301"]
    FILE_ID
    ID of the configuration file
    JSONArray
    longJson
    No
    Delete a PCI reviewer
    deleteReviewer
    POST
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmsettings/deleteReviewer?apiKey=XXXXXXXXXXYYY&LOGIN_ID=2
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    LOGIN_ID
    Login Id of the User
    long
    Yes
    2
    Delete schedule audit(s)
    deleteScheduleAudit
    POST
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmsettings/deleteScheduleAudit?apiKey=XXXXXXXXXXYYY&AUDIT_ID=["307"]
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    AUDIT_ID
    ID of the schedule audit
    JSONArray
    longJson
    No
    ["307"]
    Delete show command(s)
    deleteShowCommand
    POST
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmsettings/deleteShowCommand?apiKey=XXXXXXXXXXYYY&COMMAND_ID=73
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    COMMAND_ID
    Command Id
    JSONArray
    longJson
    Yes
    73
    Delete SSH key profile(s)
    deleteSSHKey
    POST
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmsettings/deleteSSHKey?apiKey=XXXXXXXXXXYYY
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    sshKeys
    ID of the SSH key
    JSONArray
    longJson
    No
    Delete configlet(s)
    deleteTemplate
    POST
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmsettings/deleteTemplate?apiKey=XXXXXXXXXXYYY&CONFIGLETS=[{"id":"71","name":"Alcatel_FlowExport"}]
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    CONFIGLETS
    Configlet Id(s)
    JSONArray
    delConfigletJson
    No
    [{"id":"71","name":"Alcatel_FlowExport"}]
    Demote configlet(s)
    demoteConfiglets
    POST
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmsettings/demoteConfiglets?apiKey=XXXXXXXXXXYYY&TEMPLATE_ID=4&DEVICETEMPLATEID=40
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    TEMPLATE_ID
    ID of the configlet
    long
    Yes
    4
    DEVICETEMPLATEID
    ID of the device template
    long
    Yes
    40
    Get device execution details of the executed configlet
    detailedExecResult
    GET
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmsettings/detailedExecResult?apiKey=XXXXXXXXXXYYY&EXECUTION_ID=1
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    EXECUTION_ID
    ID of the configlet audit
    long
    Yes
    1
    Get detailed configlet result
    detailedResult
    GET
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmsettings/detailedResult?apiKey=XXXXXXXXXXYYY&resourceId=2&executionId=1
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    resourceId
    Resource Id of the Host Device
    long
    Yes
    2
    executionId
    Configlet Execution Id
    long
    Yes
    1
    Get all device types
    deviceType
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmsettings/deviceType?apiKey=XXXXXXXXXXYYY&VENDOR_NAME=Cisco
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    VENDOR_NAME
    Vendor Name
    ncmVendorName
    Yes
    Cisco
    Edit a device template
    editDeviceTemplate
    POST
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmsettings/editDeviceTemplate?apiKey=XXXXXXXXXXYYY&DEVICETEMPLATEID=1
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    DEVICETEMPLATEID
    ID of the device template
    long
    No
    1
    protocolCommands
    Protocol and commands
    String
    No
    devProtocolIds
    IDs of the protocol
    JSONArray
    longJson
    No
    Get all exclude criterias
    excludeCriteria
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmsettings/excludeCriteria?apiKey=XXXXXXXXXXYYY
    Get exclude criteria details
    excludeCriteriaPreRenders
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmsettings/excludeCriteriaPreRenders?apiKey=XXXXXXXXXXYYY&CRITERIA_ID=2
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    CRITERIA_ID
    Criteria Id
    long
    No
    2
    Execute a configlet
    execConfiglet
    POST
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmsettings/execConfiglet?apiKey=XXXXXXXXXXYYY&DEVICEGROUPSELECTION=1&TEMPLATE_ID=4&ComponentSelection=SpecificDevice&SELECTEDDEVICES=["2"]&BACKUP_ENABLED=false
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    DEVICEGROUPSELECTION
    ID of the device group
    long
    No
    1
    EXEC_TYPE
    Execution Type
    ^(REMEDIATION_\d+)
    No
    TEMPLATE_ID
    ID of the configlet
    long
    No
    4
    ComponentSelection
    Device or device group selection
    ^(DeviceGroup|SpecificDevice)$
    No
    SpecificDevice
    SELECTEDDEVICES
    Resource ids of the devices
    JSONArray
    longJson
    No
    ["2"]
    BACKUP_ENABLED
    Execute backup before and after configlet execution
    boolean
    No
    false
    VARIABLES
    Name of the configlet script variables
    JSONObject
    configletVarJSON
    No
    VAR_NAME
    Variable Name
    JSONArray
    alphaNumericJSON
    No
    Execute a approved request
    executeApprovedRequest
    POST
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmsettings/executeApprovedRequest?apiKey=XXXXXXXXXXYYY
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    approved_req_id
    ID of the approval request
    long
    Yes
    Get render details of execute configlet
    exeTemplatePreRenders
    GET
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmsettings/exeTemplatePreRenders?apiKey=XXXXXXXXXXYYY&TEMPLATE_ID=4&TEMPLATE_NAME=test&IS_REMEDIATION=true&comprule_id=1&policy_id=1
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    TEMPLATE_ID
    ID of the configlet
    long
    No
    4
    TEMPLATE_NAME
    Name of the configlet
    text_basic_symbols
    No
    test
    IS_REMEDIATION
    Is Remediation
    boolean
    No
    true
    comprule_id
    ID of the rule
    long
    No
    1
    policy_id
    ID of the compliance policy
    long
    No
    1
    Export configlets
    exportConfigets
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmsettings/exportConfigets?apiKey=XXXXXXXXXXYYY&TEMPLATE_IDS=["7","27","54","73"]
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    TEMPLATE_IDS
    IDs of the configlet
    JSONArray
    longJson
    Yes
    ["7","27","54","73"]
    Render export configuration settings
    exportConfigPreRender
    GET
    Allowed
    Restricted
    Restricted
    http://server-url:8060/api/json/ncmsettings/exportConfigPreRender?apiKey=XXXXXXXXXXYYY&OPERATION_TYPE=CONFIG_EXPORT
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    OPERATION_TYPE
    Operation Type
    String
    Yes
    CONFIG_EXPORT
    Get configuration export history
    exportConfigs
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmsettings/exportConfigs?apiKey=XXXXXXXXXXYYY
    Export device template
    exportDeviceTemplate
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmsettings/exportDeviceTemplate?apiKey=XXXXXXXXXXYYY&DEVICETEMPLATEID=20
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    DEVICETEMPLATEID
    ID of the device template
    long
    Yes
    20
    Export flow configuration
    exportFlowConfig
    POST
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmsettings/exportFlowConfig?apiKey=XXXXXXXXXXYYY&RESOURCE_IDS=["17"]&Configlets=[{"Description":"Flow Export command for Cisco","TemplateName":"Cisco_CommonFlexible_FlowExport","Id":16,"TemplateType":"COMMAND_LINE_MODE","TemplateContents":"config t\nflow exporter NFAexporter\ndestination 12.1.2.3\nsource 2.3.2.1\nexport-protocol version-9\ntransport udp 9996\ntemplate data timeout 60\nexit\n\nflow monitor NFAmonitor\nrecord netflow-original\nexporter NFAexporter\ncache timeout active 60\ncache timeout inactive 15\nexit"}]
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    RESOURCE_IDS
    Resource ids of the devices
    JSONArray
    longJson
    No
    ["17"]
    Configlets
    IDs of the configlet
    JSONArray
    configletJson
    No
    [{"Description":"Flow Export command for Cisco","TemplateName":"Cisco_CommonFlexible_FlowExport","Id":16,"TemplateType":"COMMAND_LINE_MODE","TemplateContents":"config t\nflow exporter NFAexporter\ndestination 12.1.2.3\nsource 2.3.2.1\nexport-protocol version-9\ntransport udp 9996\ntemplate data timeout 60\nexit\n\nflow monitor NFAmonitor\nrecord netflow-original\nexporter NFAexporter\ncache timeout active 60\ncache timeout inactive 15\nexit"}]
    Export shared template
    exportSharedTemplate
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmsettings/exportSharedTemplate?apiKey=XXXXXXXXXXYYY&ID=40
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    ID
    ID of the device template
    String
    Yes
    40
    Find sysobjectid for a device
    findSysObjectId
    POST
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmsettings/findSysObjectId?apiKey=XXXXXXXXXXYYY&hostname=1.2.3.1&port=50&VER_TYPE=1&userName=tempuser&contextName=tempcontext&authProtocol=20&authPassword=temppassword&privProtocol=49&privPassword=temppassword&snmpv3Debug=true&timeout=20&retries=5&snmpSelection=snmpProfile&selectedProfile=Public
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    hostname
    Host Name
    ncmHostOrIPAllowedChar
    Yes
    1.2.3.1
    port
    Port
    ncmPortRegex
    No
    50
    VER_TYPE
    Version Type
    ^(0|1|3)$
    No
    1
    userName
    User Name
    String
    No
    tempuser
    contextName
    Context Name
    String
    No
    tempcontext
    authProtocol
    Auth Protocol (20=None, 21=MD5 and 22=SHA)
    ^(20|21|22|23|24)$
    No
    20
    authPassword
    Auth Password
    String
    No
    temppassword
    privProtocol
    Priv Protocol (49=AES 128, 50=DES and 51=None
    ^(47|48|49|50|51)$
    No
    49
    privPassword
    Priv Password
    String
    No
    temppassword
    snmpv3Debug
    Is SNMP Version 3 Debug
    boolean
    No
    true
    community
    Community
    String
    No
    timeout
    Timeout
    int
    No
    20
    retries
    Number of Retries
    int
    No
    5
    snmpSelection
    SNMP Selection
    ^(snmpProfile|manualCred)$
    No
    snmpProfile
    selectedProfile
    Selected Profile
    String
    No
    Public
    Get executable requests
    getApprovedList
    GET
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmsettings/getApprovedList?apiKey=XXXXXXXXXXYYY
    getBaseTemplateDetails
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmsettings/getBaseTemplateDetails?apiKey=XXXXXXXXXXYYY
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    VENDORID
    long
    Yes
    Get details of block exclude criteria
    getBlockExcludeCriteria
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmsettings/getBlockExcludeCriteria?apiKey=XXXXXXXXXXYYY&CRITERIA_ID=1
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    CRITERIA_ID
    ID of the block criteria
    long
    No
    1
    Get details of client-server settings
    getClientServerConfiguration
    GET
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmsettings/getClientServerConfiguration?apiKey=XXXXXXXXXXYYY
    Get configlets for vendor
    getConfiglet
    GET
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmsettings/getConfiglet?apiKey=XXXXXXXXXXYYY
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    VENDOR_NAME
    Vendor Name
    ncmVendorDispName
    Yes
    Get credential details for a device
    getCredentials
    POST
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmsettings/getCredentials?apiKey=XXXXXXXXXXYYY&resourceIds=["17"]
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    resourceIds
    Resource ids of the devices
    JSONArray
    longJson
    Yes
    ["17"]
    Get custom column details
    getCustColumns
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmsettings/getCustColumns?apiKey=XXXXXXXXXXYYY
    Get database sync settings
    getDBSyncSettings
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmsettings/getDBSyncSettings?apiKey=XXXXXXXXXXYYY
    Get devices for vendor
    getDevicesforVendor
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmsettings/getDevicesforVendor?apiKey=XXXXXXXXXXYYY
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    VENDOR_NAME
    Vendor Name
    ncmVendorDispName
    Yes
    Get device SNMP mapping
    getDeviceSNMPMapping
    GET
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmsettings/getDeviceSNMPMapping?apiKey=XXXXXXXXXXYYY
    Get device sysoid mapping
    getDeviceSysOIDMapping
    GET
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmsettings/getDeviceSysOIDMapping?apiKey=XXXXXXXXXXYYY
    Get device template details
    getDeviceTemplateDetails
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmsettings/getDeviceTemplateDetails?apiKey=XXXXXXXXXXYYY&DEVICETEMPLATEID=20&IS_CLONE=true
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    DEVICETEMPLATEID
    Device Template Id
    long
    Yes
    20
    IS_CLONE
    Is Clone Device Template
    boolean
    No
    true
    Get device template name
    getDeviceTemplateName
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmsettings/getDeviceTemplateName?apiKey=XXXXXXXXXXYYY
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    DEVICETEMPLATEID
    ID of the device template
    long
    Yes
    Get profile discovery details
    getDiscoveryDetails
    GET
    Allowed
    Restricted
    Restricted
    http://server-url:8060/api/json/ncmsettings/getDiscoveryDetails?apiKey=XXXXXXXXXXYYY&profileId=1
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    profileId
    ID of the discovery profile
    long
    Yes
    1
    Get profile discovery status
    getDiscoveryStatus
    GET
    Allowed
    Restricted
    Restricted
    http://server-url:8060/api/json/ncmsettings/getDiscoveryStatus?apiKey=XXXXXXXXXXYYY&isServiceNow=true
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    isServiceNow
    Discovery status of normal discovery / servicenow
    boolean
    No
    true
    Get profile discovery summary
    getDiscoverySummary
    GET
    Allowed
    Restricted
    Restricted
    http://server-url:8060/api/json/ncmsettings/getDiscoverySummary?apiKey=XXXXXXXXXXYYY&profileId=5
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    profileId
    ID of the discovery profile
    long
    Yes
    5
    Get flow export configlets for device
    getExportConfiglet
    GET
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmsettings/getExportConfiglet?apiKey=XXXXXXXXXXYYY&deviceId=5
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    deviceId
    Resource id of the device
    long
    Yes
    5
    IF_NAMES
    Interface Names for Flow Export
    JSONArray
    strJson
    No
    Export device template
    getExportedSimpleDeviceTemplate
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmsettings/getExportedSimpleDeviceTemplate?apiKey=XXXXXXXXXXYYY
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    fileName
    File name
    ([\p{L}\p{N}\P{InBasicLatin}\-_\s\.]+).xml
    No
    Get credential id for SNMP profile
    getNCMCredentialIDForSNMP
    GET
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmsettings/getNCMCredentialIDForSNMP?apiKey=XXXXXXXXXXYYY&credentialName=Public
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    credentialName
    Profile Name of SNMP Credential
    String
    Yes
    Public
    Get configuration difference limit
    getNCMDiffLimit
    GET
    Allowed
    Restricted
    Restricted
    http://server-url:8060/api/json/ncmsettings/getNCMDiffLimit?apiKey=XXXXXXXXXXYYY
    Get non-inventoried devices
    getNCMNonInventoriedDevices
    GET
    Allowed
    Restricted
    Restricted
    http://server-url:8060/api/json/ncmsettings/getNCMNonInventoriedDevices?apiKey=XXXXXXXXXXYYY
    getNearSysOID
    GET
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmsettings/getNearSysOID?apiKey=XXXXXXXXXXYYY
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    IPADDRESS
    NCM_IP_V4_AND_V6_Address
    No
    Get new device template render details
    getNewDeviceTemplate
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmsettings/getNewDeviceTemplate?apiKey=XXXXXXXXXXYYY
    Get nipper detailed result in schedule audit
    getNipperDetailedExecResult
    GET
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmsettings/getNipperDetailedExecResult?apiKey=XXXXXXXXXXYYY&EXECUTION_ID=1
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    EXECUTION_ID
    Execution Id
    String
    No
    1
    Get PMP settings
    getPasswordSyncDetails
    GET
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmsettings/getPasswordSyncDetails?apiKey=XXXXXXXXXXYYY
    Get resource ids for ipaddress
    getResourceIdsForIps
    GET
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmsettings/getResourceIdsForIps?apiKey=XXXXXXXXXXYYY&IPADDRESS=2.3.1.3
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    IPADDRESS
    IPAddress
    JSONArray
    ipAddrJson
    Yes
    2.3.1.3
    Get schedule audits
    getscheduleAudit
    GET
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmsettings/getscheduleAudit?apiKey=XXXXXXXXXXYYY
    Get SCP settings
    getSCPDetails
    GET
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmsettings/getSCPDetails?apiKey=XXXXXXXXXXYYY
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    serverDetails
    Server details
    boolean
    No
    Get shared device template details
    getSharedDeviceTemplate
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmsettings/getSharedDeviceTemplate?apiKey=XXXXXXXXXXYYY&ID=40
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    ID
    ID of the device template
    String
    Yes
    40
    Get render details of share device template
    getShareTemplateDetails
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmsettings/getShareTemplateDetails?apiKey=XXXXXXXXXXYYY&DEVICETEMPLATEID=20
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    DEVICETEMPLATEID
    Device Template Id
    long
    Yes
    20
    Get SNMP profiles
    getSNMPProfiles
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmsettings/getSNMPProfiles?apiKey=XXXXXXXXXXYYY
    Get details of SSH settings
    getSSHSettings
    GET
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmsettings/getSSHSettings?apiKey=XXXXXXXXXXYYY
    Get syslog blocked devices
    getSysLogBlockedHosts
    GET
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmsettings/getSysLogBlockedHosts?apiKey=XXXXXXXXXXYYY
    Get users to add PCI reviewer
    getUsersToAddReviewer
    GET
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmsettings/getUsersToAddReviewer?apiKey=XXXXXXXXXXYYY
    Get mail server settings
    hasPrimaryMailSettings
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmsettings/hasPrimaryMailSettings?apiKey=XXXXXXXXXXYYY
    Import configlets via file
    importConfiglets
    POST
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmsettings/importConfiglets?apiKey=XXXXXXXXXXYYY
    Import devices via file
    importDevices
    POST
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmsettings/importDevices?apiKey=XXXXXXXXXXYYY
    Import shared template
    importSharedTemplate
    POST
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmsettings/importSharedTemplate?apiKey=XXXXXXXXXXYYY&ID=40
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    ID
    ID of the device template
    String
    Yes
    40
    Import SSH key via file
    importSSHKey
    POST
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmsettings/importSSHKey?apiKey=XXXXXXXXXXYYY
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    keyName
    Name for SSH key
    alphanumeric_basic
    Yes
    passphrase
    SSH Key Passphrase
    String
    No
    comment
    Description of SSH Key
    alphanumeric_basic
    No
    Get configurations associated to a label
    labelConfigDetails
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmsettings/labelConfigDetails?apiKey=XXXXXXXXXXYYY&LabelId=["301"]&RESOURCEIDS=["17"]
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    LabelId
    ID of the label
    long
    Yes
    ["301"]
    RESOURCEIDS
    Resource ids of the devices
    JSONArray
    longJson
    No
    ["17"]
    Get all labels
    labelList
    GET
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmsettings/labelList?apiKey=XXXXXXXXXXYYY
    Get label details
    labelPreRenders
    GET
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmsettings/labelPreRenders?apiKey=XXXXXXXXXXYYY&LABEL_ID=["301"]
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    LABEL_ID
    ID of the label
    long
    No
    ["301"]
    Get all block criteria
    listAllBlockExcludeCriteria
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmsettings/listAllBlockExcludeCriteria?apiKey=XXXXXXXXXXYYY
    Get all configlets
    listAllConfiglets
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmsettings/listAllConfiglets?apiKey=XXXXXXXXXXYYY&DEVICETEMPLATEID=323&FILTER_TYPE=PROMOTE&INCLUDE_FLOW_CONFILGETS=true
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    DEVICETEMPLATEID
    Device Template Id
    long
    No
    323
    FILTER_TYPE
    Filter Type of Configlet
    ^(PROMOTE|FLOW)$
    No
    PROMOTE
    INCLUDE_FLOW_CONFILGETS
    Include flow configlets or not
    boolean
    No
    true
    Get supported templates for device type
    listExcludeCriteriaGridTemplates
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmsettings/listExcludeCriteriaGridTemplates?apiKey=XXXXXXXXXXYYY
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    deviceType
    Device type
    ncmPersonalityDisplayName
    Yes
    Get configlets history
    listExecutionHistory
    GET
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmsettings/listExecutionHistory?apiKey=XXXXXXXXXXYYY
    Get all SSH keys
    listNCMSSHKeys
    GET
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmsettings/listNCMSSHKeys?apiKey=XXXXXXXXXXYYY
    Get render details of log level
    logLevelPreRender
    GET
    Allowed
    Restricted
    Restricted
    http://server-url:8060/api/json/ncmsettings/logLevelPreRender?apiKey=XXXXXXXXXXYYY
    Get mail server settings
    mailSettingsPreRender
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmsettings/mailSettingsPreRender?apiKey=XXXXXXXXXXYYY
    Get probe details for the device
    ncmeeGetProbeDetailsForDevice
    GET
    Restricted
    Allowed
    Restricted
    http://server-url:8060/api/json/ncmsettings/ncmeeGetProbeDetailsForDevice?apiKey=XXXXXXXXXXYYY&DEVICE_ID=1
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    DEVICE_ID
    Resource id of the device
    long
    Yes
    1
    Get probe name for the device
    ncmeeGetProbeForDevice
    GET
    Restricted
    Allowed
    Restricted
    http://server-url:8060/api/json/ncmsettings/ncmeeGetProbeForDevice?apiKey=XXXXXXXXXXYYY&DEVICE_ID=1
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    DEVICE_ID
    Resource id of the device
    long
    Yes
    1
    Get probe status
    ncmeeGetProbeStatus
    GET
    Restricted
    Allowed
    Restricted
    http://server-url:8060/api/json/ncmsettings/ncmeeGetProbeStatus?apiKey=XXXXXXXXXXYYY
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    selectedProbe
    Probe name
    String
    Yes
    Get all probes
    ncmeeListProbes
    GET
    Restricted
    Allowed
    Restricted
    http://server-url:8060/api/json/ncmsettings/ncmeeListProbes?apiKey=XXXXXXXXXXYYY
    Share custom column to probes
    ncmeeShareCustomColumn
    POST
    Restricted
    Allowed
    Restricted
    http://server-url:8060/api/json/ncmsettings/ncmeeShareCustomColumn?apiKey=XXXXXXXXXXYYY
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    selectedProbes
    Selected probes
    String
    Yes
    Get REST configlet execution details
    NCMPopulateRestConfigletExecDetails
    GET
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmsettings/NCMPopulateRestConfigletExecDetails?apiKey=XXXXXXXXXXYYY&resourceId=1&executionId=1
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    resourceId
    Resource ID on which the operation was performed
    long
    Yes
    1
    executionId
    Execution ID for which the details are required
    long
    Yes
    1
    Get pending approval requests
    pendingRequests
    GET
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmsettings/pendingRequests?apiKey=XXXXXXXXXXYYY
    Ping a device
    pingCheck
    POST
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmsettings/pingCheck?apiKey=XXXXXXXXXXYYY&IPADDRESS=2.3.2.1&fromAddDevice=true
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    IPADDRESS
    IP Address
    ncmHostOrIPAllowedChar
    Yes
    2.3.2.1
    fromAddDevice
    Is Add device
    boolean
    No
    true
    populateCliCommandsByOperName
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmsettings/populateCliCommandsByOperName?apiKey=XXXXXXXXXXYYY
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    DTID
    long
    Yes
    OPERATION
    ^(Backup|Upload)$
    No
    FILETYPE
    ncmFileType
    No
    PROTOCOLNAME
    protocolList
    No
    Promote configlet(s)
    promoteConfiglets
    POST
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmsettings/promoteConfiglets?apiKey=XXXXXXXXXXYYY&TEMPLATE_ID=["4"]&DEVICETEMPLATEID=Cisco Integrated Services Router ISR
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    TEMPLATE_ID
    ID of the configlet
    JSONArray
    longJson
    Yes
    ["4"]
    DEVICETEMPLATEID
    ID of the device template
    ncmAllowedNameChars
    Yes
    Cisco Integrated Services Router ISR
    DEVICETEMPLATEIDS
    List of Device Template Id(s)
    JSONArray
    dtNameJson
    No
    Get render details of promote configlets
    promoteConfigletsPreRender
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmsettings/promoteConfigletsPreRender?apiKey=XXXXXXXXXXYYY&DEVICETEMPLATEID=20
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    DEVICETEMPLATEID
    Device Template Id
    long
    Yes
    20
    Get rebranding details
    rebrandingPreRender
    GET
    Allowed
    Restricted
    Restricted
    http://server-url:8060/api/json/ncmsettings/rebrandingPreRender?apiKey=XXXXXXXXXXYYY
    Get rejected requests
    rejectedRequests
    GET
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmsettings/rejectedRequests?apiKey=XXXXXXXXXXYYY
    Disassociate flow configlets from device template
    removeFlowConfiglets
    POST
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmsettings/removeFlowConfiglets?apiKey=XXXXXXXXXXYYY&TEMPLATE_ID=90&DEVICETEMPLATEID=40
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    TEMPLATE_ID
    ID of the configlet
    long
    Yes
    90
    DEVICETEMPLATEID
    ID of the device template
    long
    Yes
    40
    Remove devices from syslog blocked devices
    removeSysLogBlocedHosts
    POST
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmsettings/removeSysLogBlocedHosts?apiKey=XXXXXXXXXXYYY&HOSTID=["5","2"]
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    HOSTID
    Host Device ID(s)
    JSONArray
    longJson
    Yes
    ["5","2"]
    Get all PCI reviewers
    reviewersList
    GET
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmsettings/reviewersList?apiKey=XXXXXXXXXXYYY
    Execute a schedule
    runSchedule
    POST
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmsettings/runSchedule?apiKey=XXXXXXXXXXYYY&scheduleIds=["302"]
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    scheduleIds
    Schedule Id(s)
    JSONArray
    longJson
    Yes
    ["302"]
    Save and test credential
    saveandTestResult
    GET
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmsettings/saveandTestResult?apiKey=XXXXXXXXXXYYY&RESOURCEID=23&BACKUP_STATUS=true
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    RESOURCEID
    Resource id of the device
    long
    Yes
    23
    BACKUP_STATUS
    Backup Status
    boolean
    No
    true
    Get schedule details
    schedulePreRenders
    GET
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmsettings/schedulePreRenders?apiKey=XXXXXXXXXXYYY&SCHEDULE_ID=327&CONFIGLETID=1&REPORT_ID=1
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    SCHEDULE_ID
    Schedule Id
    long
    No
    327
    SELECTEDDEVICES
    Resource ids of the devices
    JSONArray
    longJson
    No
    CONFIGLETID
    Associated Configlet ID
    long
    No
    1
    REPORT_ID
    long
    No
    1
    REPORT_TYPE
    ADVANCED_REPORT
    No
    Get server settings
    serverSettings
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmsettings/serverSettings?apiKey=XXXXXXXXXXYYY
    Share device template to NCM support
    shareDeviceTemplate
    POST
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmsettings/shareDeviceTemplate?apiKey=XXXXXXXXXXYYY&DEVICETEMPLATEID=20&sharedBy=user1@testing.com&templateDescription=For all Cisco IOS Routers&templateName=Cisco_IOS_Router&vendorName=Cisco&osType=IOS
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    DEVICETEMPLATEID
    Device Template Id
    long
    Yes
    20
    sharedBy
    Shared User E-mail Id
    text_basic_symbols
    No
    user1@testing.com
    templateDescription
    Device Template Description
    ncmBasicTextChars
    No
    For all Cisco IOS Routers
    templateName
    Device Template Name
    ncmAllowedNameChars
    No
    Cisco_IOS_Router
    vendorName
    Device Vendor Name
    String
    No
    Cisco
    osType
    Device OS Type
    ncmOSType
    No
    IOS
    Update SNMP trap settings
    snmpTrapSettings
    POST
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmsettings/snmpTrapSettings?apiKey=XXXXXXXXXXYYY&HOSTNAME=27.1.1.27&PORT=162&COMMUNITY=public
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    HOSTNAME
    Host Name
    ncmHostOrIPAllowedChar
    No
    27.1.1.27
    PORT
    Port
    int
    No
    162
    COMMUNITY
    Community
    String
    No
    public
    Get SNMP trap settings details
    snmpTrapSettingsPreRender
    GET
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmsettings/snmpTrapSettingsPreRender?apiKey=XXXXXXXXXXYYY
    Sync service now devices with NCM
    syncServiceNowDevicesWithNCM
    POST
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmsettings/syncServiceNowDevicesWithNCM?apiKey=XXXXXXXXXXYYY
    Get render details of syslocation update
    sysLocDescPreRender
    GET
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmsettings/sysLocDescPreRender?apiKey=XXXXXXXXXXYYY
    Update syslog forwarder
    syslogForwarder
    POST
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmsettings/syslogForwarder?apiKey=XXXXXXXXXXYYY&SYSLOG_FRWD_IPS=27.1.1.27
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    SYSLOG_FRWD_IPS
    SYSLOG Forwarder IP Address
    IPNetOrRangeWithComma
    No
    27.1.1.27
    Get syslog forwarder details
    syslogForwarderPreRender
    GET
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmsettings/syslogForwarderPreRender?apiKey=XXXXXXXXXXYYY
    Get sysobjectid details
    sysOIDPreRender
    GET
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmsettings/sysOIDPreRender?apiKey=XXXXXXXXXXYYY
    Update trouble ticket details
    troubleTicket
    POST
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmsettings/troubleTicket?apiKey=XXXXXXXXXXYYY&TT_MAIL_ADDRESS=user1@testing.com
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    TT_MAIL_ADDRESS
    Trouble Ticket Mail Address
    (^[\w]([\w\-\.\+\'\/]*)@([\w\-\.]*)(\.[a-zA-Z]{2,22}(\.[a-zA-Z]{2}){0,2})(,[\w]([\w\-\.\+\'\/]*)@([\w\-\.]*)(\.[a-zA-Z]{2,22}(\.[a-zA-Z]{2}){0,2}))*)
    No
    user1@testing.com
    Get render details of trouble ticket
    troubleTicketPreRender
    GET
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmsettings/troubleTicketPreRender?apiKey=XXXXXXXXXXYYY
    Update client-server settings
    updateClientServerConfiguration
    POST
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmsettings/updateClientServerConfiguration?apiKey=XXXXXXXXXXYYY&configurations={"NCM_DIFF_LIMIT":"500","ncm.templates.visibletoall":true,"operator.configlet.restriction":true}
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    configurations
    Changes to be updated
    JSONObject
    clientServerConfigJson
    Yes
    {"NCM_DIFF_LIMIT":"500","ncm.templates.visibletoall":true,"operator.configlet.restriction":true}
    Add a new configlet
    updateConfiglet
    POST
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmsettings/updateConfiglet?apiKey=XXXXXXXXXXYYY&DESCRIPTION=Getting version info for Cisco devices&CONTENTS=show version&TEMPLATE_TYPE=COMMAND_LINE_MODE&TEMPLATE_ID=4&NAME=Cisco_Show_Version_Script&DEVICETEMPLATEID=20&VENDOR_NAME=Cisco&TAG_ID=1
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    DESCRIPTION
    Description of the Configlet
    text_basic_symbols_two_byte_support
    No
    Getting version info for Cisco devices
    CONTENTS
    Contents of the Configlet
    String
    No
    show version
    TEMPLATE_TYPE
    Template Type of the Configlet
    ^(COMMAND_LINE_MODE|TFTP_FILE_TRANSFER_MODE|ADVANCED_COMMAND_LINE_MODE)$
    Yes
    COMMAND_LINE_MODE
    TEMPLATE_ID
    Configlet Id
    long
    No
    4
    BACKUP_ENABLED
    Perform Configuration Backup before and after Configlet Execution
    boolean
    No
    NAME
    Name of the Configlet
    text_basic_symbols_two_byte_support
    No
    Cisco_Show_Version_Script
    DEVICETEMPLATEID
    Device Template Id
    long
    No
    20
    VENDOR_NAME
    Name of the vendor
    ncmVendorName
    No
    Cisco
    TAG_ID
    ID of the tag associated with the configlet
    long
    No
    1
    Update a label
    updateLabel
    POST
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmsettings/updateLabel?apiKey=XXXXXXXXXXYYY&LABEL_ID=["301"]&DESCRIPTION=This label is used for most stable configuration
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    LABEL_ID
    ID of the label
    long
    Yes
    ["301"]
    DESCRIPTION
    Descripition of the label
    ncmBasicTextChars
    No
    This label is used for most stable configuration
    Update configuration difference limit
    updateNCMDiffLimit
    POST
    Allowed
    Restricted
    Restricted
    http://server-url:8060/api/json/ncmsettings/updateNCMDiffLimit?apiKey=XXXXXXXXXXYYY&NCM_DIFF_LIMIT=30
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    NCM_DIFF_LIMIT
    Diff Content Limit
    String
    No
    30
    Update probe server settings
    updateProbeServerSettings
    POST
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmsettings/updateProbeServerSettings?apiKey=XXXXXXXXXXYYY&configurations={"ncmee.probe.restrict.distribution":"true"}
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    configurations
    Configuration that needs to be updated
    JSONObject
    probeServerConfigJson
    Yes
    {"ncmee.probe.restrict.distribution":"true"}
    Update a schedule
    updateSchedule
    POST
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmsettings/updateSchedule?apiKey=XXXXXXXXXXYYY&SCHEDULE_ID=327&REPORT_ID=1&IS_ADVANCED_REPORT=true
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    SCHEDULE_ID
    Schedule Id
    long
    No
    327
    TASK_TYPE
    Task type
    ^(Configuration Backup|Compliance Check|Sync Configuration|Report Generation|Custom Template|PCI Review|Device Discovery)$
    No
    EMAIL_RECIPIENTS
    Email address
    (^[\w]([\w\-\.\+\'\/]*)@([\w\-\.]*)(\.[a-zA-Z]{2,22}(\.[a-zA-Z]{2}){0,2})(,[\w]([\w\-\.\+\'\/]*)@([\w\-\.]*)(\.[a-zA-Z]{2,22}(\.[a-zA-Z]{2}){0,2}))*)
    No
    IP_RANGE
    Range of IPAddress
    ncmIPRangeAllowedChar
    No
    SNMP_PROFILELIST
    Profile names
    String
    No
    ComponentSelection
    Device or device group selection
    ^(SpecificDevice|DeviceGroup)$
    No
    DEVICEGROUPSELECTION
    ID of the device group
    long
    No
    SELECTEDDEVICES
    Resource ids of the devices
    JSONArray
    longJson
    No
    BKPNOTIF_CONDITION
    Notify if there is a failure in backing up a device
    boolean
    No
    BKPNOTIF_CONDITION_CONFIG_CHANGE
    Notify if there is a change in configuration
    boolean
    No
    EXCLUDE_CONFIG_CHANGE_IN_MAIL
    Exclude configuration difference from notification
    boolean
    No
    COMPNOTIF_CONDITION
    Notify only if there is a policy violation
    boolean
    No
    REPORT_FILE_TYPE
    Type of the report
    ^(PDF|CSV|TXT|XLSX)$
    No
    COMPLIANCE_SHOW_RESULT
    Compliance report rule condition
    ^(VIOLATED_RULES_ONLY|COMPLIANT_RULES_ONLY|ALL_RULES)$
    No
    REPORT_TEMPLATE_NAME
    Name of the report
    ncmSchedReportTemplate
    No
    REPORT_DURATION
    Duration of the report
    ^(today|yesterday|last_30_days|last_7_days|last_week|last_month|this_week|this_month)$
    No
    REVIEWER_ID
    ID of the PCI reviewer
    long
    No
    SYNCNOTIF_CONDITION
    Notify only if there is a failure in sync configuration operation
    boolean
    No
    IS_ADD
    Add report or not
    boolean
    No
    QUERYID
    Query ID
    long
    No
    TAG_ID
    ID of the tag to be associated
    long
    No
    ScheduleMailSubject
    Mail subject
    text_basic_symbols_two_byte_support
    No
    SKIP_MAIL
    Skip mail notification
    boolean
    Yes
    IS_PUBLIC
    Public or private schedule
    boolean
    Yes
    REPORT_ID
    long
    No
    1
    IS_ADVANCED_REPORT
    boolean
    No
    true
    SCHEDULE_TYPE
    Schedule type
    ^(Hourly|Daily|Weekly|Monthly|Once Only)$
    Yes
    HOURLY_START_DATE
    Hourly start date
    schStart_date
    No
    HOURLY_START_TIME_HOUR
    Hourly start hour
    hours
    No
    HOURLY_START_TIME_MIN
    Hourly start minutes
    minutes
    No
    HOURLY_INTERVAL
    Hourly interval
    long
    No
    DAILY_START_DATE
    Daily start date
    schStart_date
    No
    DAILY_START_TIME_HOUR
    Daily start hour
    hours
    No
    DAILY_START_TIME_MIN
    Daily start minutes
    minutes
    No
    WEEKLY_START_TIME_HOUR
    Weekly start hour
    hours
    No
    WEEKLY_START_TIME_MIN
    Weekly start minutes
    minutes
    No
    WEEKLY_DAYS
    Days on the week
    JSONArray
    day_dateJson
    No
    MONTHLY_START_TIME_HOUR
    Monthly start hour
    hours
    No
    MONTHLY_START_TIME_MIN
    Monthly start minutes
    minutes
    No
    MONTHLY_MONTHS
    Months on the year
    JSONArray
    day_dateJson
    No
    MONTHLY_DATE_OF_MONTH
    Date on the month
    int
    No
    ONCEONLY_START_TIME_HOUR
    Once only start hour
    hours
    No
    ONCEONLY_START_TIME_MIN
    Once only start minutes
    minutes
    No
    ONCEONLY_START_DATE
    Once only start date
    schStart_date
    No
    WEEKLY_START_DATE
    Weekly start date
    schStart_date
    No
    MONTHLY_START_DATE
    Monthly start date
    schStart_date
    No
    CUSTOM_TEMPLATE_ID
    ID of the configlet
    long
    No
    BACKUP_ENABLED
    Execute backup before and after configlet execution
    boolean
    No
    FILEUPLOADCONFIGLET
    Is configlet value uploaded via file
    boolean
    No
    VARIABLES
    Name of the configlet script variables
    String
    No
    FILENAME
    Name of the configlet value file
    ncmFileNameChars
    No
    VAR_NAME
    Configlet value variable name
    String
    No
    Update SCP settings
    updateSCPDetails
    POST
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmsettings/updateSCPDetails?apiKey=XXXXXXXXXXYYY
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    scp_username
    SCP user name
    text_basic_symbols_two_byte_support
    No
    scp_currentPwd
    Current SCP password
    String
    No
    scp_password
    New SCP password
    String
    No
    SCP_BINDTO_IP
    Bind to IPAddress
    server_combo
    No
    SCP_SERVER_IP
    SCP server IP
    ipAddress
    No
    SCP_START_SERVICE
    Start or Stop SCP service
    boolean
    No
    Update server settings
    updateServerSettings
    POST
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmsettings/updateServerSettings?apiKey=XXXXXXXXXXYYY&TFTP_COMBO_IP=localhost&TFTP_BOX_VISIBLE=12.2.3.1&TFTP_BOX_HIDDEN=12.2.3.1&TFTP_OPERATIONS=starttftp&SCP_COMBO_IP=localhost&SCP_BOX_VISIBLE=12.2.3.1&SCP_BOX_HIDDEN=12.2.3.1&SCP_OPERATIONS=startscp&SYSLOG_COMBO_IP=localhost&SYSLOG_BOX_VISIBLE=12.2.3.1&SYSLOG_BOX_HIDDEN=12.2.3.1&SYSLOG_OPERATIONS=startsyslog&SYSLOG_PORT=514,519&THREAD_COUNT=20
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    TFTP_COMBO_IP
    TFTP Combo IP Address
    server_combo
    Yes
    localhost
    TFTP_BOX_VISIBLE
    TFTP Combo Visible
    ipAddress
    Yes
    12.2.3.1
    TFTP_BOX_HIDDEN
    TFTP Combo Hidden
    ipAddress
    Yes
    12.2.3.1
    TFTP_OPERATIONS
    TFTP Operations
    ^(starttftp|stoptftp)$
    Yes
    starttftp
    SCP_COMBO_IP
    SCP Combo IP Address
    server_combo
    Yes
    localhost
    SCP_BOX_VISIBLE
    SCP Box Visible
    ipAddress
    Yes
    12.2.3.1
    SCP_BOX_HIDDEN
    SCP Box Hidden
    ipAddress
    Yes
    12.2.3.1
    SCP_OPERATIONS
    SCP Operations
    ^(startscp|stopscp)$
    Yes
    startscp
    SYSLOG_COMBO_IP
    SYSLOG Combo IP Address
    server_combo
    Yes
    localhost
    SYSLOG_BOX_VISIBLE
    SYSLOG Box Visible
    ipAddress
    Yes
    12.2.3.1
    SYSLOG_BOX_HIDDEN
    SYSLOG Box Hidden
    ipAddress
    Yes
    12.2.3.1
    SYSLOG_OPERATIONS
    SYSLOG Box Operations
    ^(startsyslog|stopsyslog)$
    Yes
    startsyslog
    SYSLOG_PORT
    SYSLOG Port
    comma_port
    Yes
    514,519
    THREAD_COUNT
    Thread Count
    int
    Yes
    20
    Update a credential profile
    updateSharedProfile
    POST
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmsettings/updateSharedProfile?apiKey=XXXXXXXXXXYYY&PROFILEID=303
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    PROFILEID
    ID of the profile
    long
    Yes
    303
    IS_SNMP_PROFILE
    SNMP profile or CLI profile
    boolean
    No
    PROFILENAME
    Name of the profile
    text_basic_symbols_two_byte_support
    No
    snmp_port
    SNMP port number
    int
    No
    snmp_version
    SNMP version
    int
    No
    snmp_username
    SNMP User name
    String
    No
    snmp_contextname
    SNMP Context name
    String
    No
    snmp_authprotocol
    SNMP Auth protocol
    ^(20|21|22)$
    No
    snmp_privprotocol
    SNMP Priv protocol
    ^(49|50|51)$
    No
    snmp_authpassword
    SNMP Auth password
    String
    No
    snmp_privpassword
    SNMP Priv password
    String
    No
    snmp_readcommunity
    SNMP Read community
    String
    No
    snmp_writecommunity
    SNMP Write community
    String
    No
    telnet_loginname
    Telnet Login name
    String
    No
    telnet_password
    Telnet Password
    String
    No
    telnet_prompt
    Telnet Prompt
    String
    No
    telnet_enableUserName
    Telnet User name
    String
    No
    telnet_enablepassword
    Telnet Enable password
    String
    No
    telnet_enablepasswordType
    Telnet Enable password type
    ^(enablePassword|noEnablePassword|emptyEnablePassword)$
    No
    telnet_enableprompt
    Telnet Enable prompt
    String
    No
    ssh_loginname
    SSH Login name
    String
    No
    ssh_password
    SSH Password
    String
    No
    ssh_prompt
    SSH Prompt
    String
    No
    ssh_enableUserName
    SSH Enable user name
    String
    No
    ssh_enablepassword
    SSH Enable password
    String
    No
    ssh_enablepasswordType
    SSH Enable password type
    ^(enablePassword|noEnablePassword|emptyEnablePassword)$
    No
    ssh_enableprompt
    SSH Enable prompt
    String
    No
    PROFILEDESCRIPTION
    Description of the profile
    ncmBasicTextChars
    No
    Update SSH settings
    updateSSHSettings
    POST
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmsettings/updateSSHSettings?apiKey=XXXXXXXXXXYYY&configurations={"ncm.ssh.blockCipherSuites":"arcfour256","ncm.ssh.allowKeyExchanges":"diffie-hellman-group-exchange-sha256","ncm.ssh.blockHmacs":"hmac-sha1-96"}
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    configurations
    Changes to be updated
    JSONObject
    cipherJSON
    Yes
    {"ncm.ssh.blockCipherSuites":"arcfour256","ncm.ssh.allowKeyExchanges":"diffie-hellman-group-exchange-sha256","ncm.ssh.blockHmacs":"hmac-sha1-96"}
    Update system location and description
    updateSysLocationDesc
    POST
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmsettings/updateSysLocationDesc?apiKey=XXXXXXXXXXYYY&DEVICEGROUPSELECTION=1&SELECTEDDEVICES=["2"]&SELECTEDPROFILES=["Public"]&ComponentSelection=DeviceGroup
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    DEVICEGROUPSELECTION
    ID of the device group
    long
    No
    1
    SELECTEDDEVICES
    Resource ids of the devices
    JSONArray
    longJson
    No
    ["2"]
    SELECTEDPROFILES
    Selected Profiles
    JSONArray
    strJson
    No
    ["Public"]
    ComponentSelection
    Component Selection
    ^(DeviceGroup|SpecificDevice)$
    Yes
    DeviceGroup
    Update sysobjectid for devices
    updateSysOIDForResources
    POST
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmsettings/updateSysOIDForResources?apiKey=XXXXXXXXXXYYY&DEVICEGROUPSELECTION=1&SELECTEDDEVICES=["2"]&ComponentSelection=DeviceGroup
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    DEVICEGROUPSELECTION
    ID of the device group
    long
    No
    1
    SELECTEDDEVICES
    Resource ids of the devices
    JSONArray
    longJson
    No
    ["2"]
    SELECTEDPROFILES
    Selected Profiles
    JSONArray
    strJson
    No
    ComponentSelection
    Component Selection
    ^(DeviceGroup|SpecificDevice)$
    Yes
    DeviceGroup
    Upload configlet script values via file
    uploadConfigletFile
    POST
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmsettings/uploadConfigletFile?apiKey=XXXXXXXXXXYYY&TEMPLATE_ID=4&IS_SCHEDULE=true&USE_FIRSTVALUE_FORALL=true&SCHEDULE_ID=327&BACKUP_ENABLED=true
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    TEMPLATE_ID
    ID of the configlet
    long
    No
    4
    IS_SCHEDULE
    Is Scheduled
    boolean
    No
    true
    USE_FIRSTVALUE_FORALL
    Should use First value for all Devices
    boolean
    No
    true
    SCHEDULE_ID
    ID of the schedule
    ^(new|\d+)$
    No
    327
    BACKUP_ENABLED
    Is Backup Enabled
    boolean
    No
    true
    Preview of uploaded configlet via file
    uploadConfigletPreView
    POST
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmsettings/uploadConfigletPreView?apiKey=XXXXXXXXXXYYY&TEMPLATE_ID=4&USE_FIRSTVALUE_FORALL=true
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    TEMPLATE_ID
    ID of the configlet
    long
    No
    4
    USE_FIRSTVALUE_FORALL
    Should use First value for all Devices
    boolean
    No
    true
    Get all vendors
    vendorList
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmsettings/vendorList?apiKey=XXXXXXXXXXYYY&IS_PRERENDER=false
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    IS_PRERENDER
    List is requested for prerendering
    boolean
    No
    false
    Get vendor details
    vendorMap
    GET
    Allowed
    Allowed
    Allowed
    http://server-url:8060/api/json/ncmsettings/vendorMap?apiKey=XXXXXXXXXXYYY
  • ncmtags
    Title
    API Name
    Method
    Execution in Standalone/Probe
    Execution in Central
    Execution in Probe from Central
    Sample URL
    Add a credential rule
    addCredentialRule
    POST
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmtags/addCredentialRule?apiKey=XXXXXXXXXXYYY
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    RULENAME
    Name of the credential rule
    ncmAllowedNameChars
    No
    DESCRIPTION
    Description of the credential rule
    ncmAllowedNameChars
    No
    DEVICE_CRI_TYPE
    Criteria type
    ^(DEVICEGROUP|CRITERIA)$
    No
    COMBINATIONID
    Protocol combination ID
    long
    No
    PROFILEID
    ID of the credential profile
    long
    No
    SELECTEDDEVICEGROUPS
    IDs of the device groups
    JSONArray
    longJson
    No
    CRITERIA_LIST
    List of criterias
    JSONArray
    criteriaJSON
    No
    STATUS
    Rule status
    boolean
    No
    Add a tag
    addTag
    POST
    Allowed
    Restricted
    Restricted
    http://server-url:8060/api/json/ncmtags/addTag?apiKey=XXXXXXXXXXYYY
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    TAG_NAME
    Name of the tag
    ncmAllowedNameChars
    No
    TAG_DISPLAY_NAME
    Display name of the tag
    ncmAllowedNameChars
    No
    TAG_DESC
    Description of the tag
    ncmBasicTextChars
    No
    customColVal1
    Custom column value 1
    customColumnRegex
    No
    customColVal2
    Custom column value 2
    customColumnRegex
    No
    customColVal3
    Custom column value 3
    customColumnRegex
    No
    selectedProbes
    Selected probes
    String
    Yes
    Associate tag to a device
    associateTagtoResource
    POST
    Allowed
    Restricted
    Restricted
    http://server-url:8060/api/json/ncmtags/associateTagtoResource?apiKey=XXXXXXXXXXYYY&TAG_ID=1&RESOURCEID=1
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    TAG_ID
    ID of the tag
    long
    No
    1
    RESOURCEID
    Resource id of the device
    long
    No
    1
    Delete credential rule(s)
    deleteCredentialRule
    POST
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmtags/deleteCredentialRule?apiKey=XXXXXXXXXXYYY&ruleId=1
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    ruleId
    Rule ID
    long
    No
    1
    ruleIds
    Rule ID's
    JSONArray
    longJson
    No
    Delete credential rule audit(s)
    deleteCrRuleAudit
    POST
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmtags/deleteCrRuleAudit?apiKey=XXXXXXXXXXYYY
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    AUDIT_IDS
    ID of the credential rule audits
    JSONArray
    longJson
    Yes
    Delete tag(s)
    deleteTag
    POST
    Allowed
    Restricted
    Restricted
    http://server-url:8060/api/json/ncmtags/deleteTag?apiKey=XXXXXXXXXXYYY
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    TAG_ID
    IDs of the tags
    JSONArray
    longJson
    No
    Get all credential rules
    getAllCredentialRules
    GET
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmtags/getAllCredentialRules?apiKey=XXXXXXXXXXYYY
    Get all credential rule audits
    getCrRuleAudit
    GET
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmtags/getCrRuleAudit?apiKey=XXXXXXXXXXYYY&ruleId=1
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    ruleId
    ID of the credential rule
    long
    No
    1
    Get tag custom column details
    getTagCustomColumnDetails
    GET
    Allowed
    Restricted
    Restricted
    http://server-url:8060/api/json/ncmtags/getTagCustomColumnDetails?apiKey=XXXXXXXXXXYYY
    Get tag name
    getTagName
    GET
    Allowed
    Restricted
    Restricted
    http://server-url:8060/api/json/ncmtags/getTagName?apiKey=XXXXXXXXXXYYY
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    TAG_ID
    ID of the tag
    long
    Yes
    Get all tags
    listAllTags
    GET
    Allowed
    Restricted
    Restricted
    http://server-url:8060/api/json/ncmtags/listAllTags?apiKey=XXXXXXXXXXYYY
    Get configlets associated with tag
    listTagConfiglets
    GET
    Allowed
    Restricted
    Restricted
    http://server-url:8060/api/json/ncmtags/listTagConfiglets?apiKey=XXXXXXXXXXYYY&TAG_ID=1
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    TAG_ID
    ID of the tag
    long
    Yes
    1
    Get credentials associated with tag
    listTagCredentials
    GET
    Allowed
    Restricted
    Restricted
    http://server-url:8060/api/json/ncmtags/listTagCredentials?apiKey=XXXXXXXXXXYYY&TAG_ID=1
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    TAG_ID
    ID of the tag
    long
    Yes
    1
    Get devices associated with tag
    listTagDevices
    GET
    Allowed
    Restricted
    Restricted
    http://server-url:8060/api/json/ncmtags/listTagDevices?apiKey=XXXXXXXXXXYYY&TAG_ID=1
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    TAG_ID
    ID of the tag
    long
    Yes
    1
    Get device groups associated with tag
    listTagDGs
    GET
    Allowed
    Restricted
    Restricted
    http://server-url:8060/api/json/ncmtags/listTagDGs?apiKey=XXXXXXXXXXYYY&TAG_ID=1
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    TAG_ID
    ID of the tag
    long
    Yes
    1
    Get change notifications associated with tag
    listTagNotifications
    GET
    Allowed
    Restricted
    Restricted
    http://server-url:8060/api/json/ncmtags/listTagNotifications?apiKey=XXXXXXXXXXYYY&TAG_ID=1
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    TAG_ID
    ID of the tag
    long
    Yes
    1
    Get compliance policies associated with tag
    listTagPolicies
    GET
    Allowed
    Restricted
    Restricted
    http://server-url:8060/api/json/ncmtags/listTagPolicies?apiKey=XXXXXXXXXXYYY&TAG_ID=1
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    TAG_ID
    ID of the tag
    long
    Yes
    1
    Get schedules associated with tag
    listTagSchedules
    GET
    Allowed
    Restricted
    Restricted
    http://server-url:8060/api/json/ncmtags/listTagSchedules?apiKey=XXXXXXXXXXYYY&TAG_ID=1
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    TAG_ID
    ID of the tag
    long
    Yes
    1
    Get SSH Keys associated with tag
    listTagSSHKeys
    GET
    Allowed
    Restricted
    Restricted
    http://server-url:8060/api/json/ncmtags/listTagSSHKeys?apiKey=XXXXXXXXXXYYY&TAG_ID=1
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    TAG_ID
    ID of the tag
    long
    Yes
    1
    Get users associated with tag
    listTagUsers
    GET
    Allowed
    Restricted
    Restricted
    http://server-url:8060/api/json/ncmtags/listTagUsers?apiKey=XXXXXXXXXXYYY&TAG_ID=1
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    TAG_ID
    ID of the tag
    long
    Yes
    1
    Get credential rule details
    renderCredentialsRule
    GET
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmtags/renderCredentialsRule?apiKey=XXXXXXXXXXYYY&RULEID=1
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    RULEID
    ID of the credential rule
    long
    No
    1
    Reorder credential rule
    ruleReorder
    POST
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmtags/ruleReorder?apiKey=XXXXXXXXXXYYY
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    ruleOrder
    Credential rule and rule order mapping
    JSONObject
    ruleOrderJSON
    No
    Execute credential rule
    runCredentialRule
    POST
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmtags/runCredentialRule?apiKey=XXXXXXXXXXYYY&ruleId=1
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    ruleId
    Rule ID
    long
    No
    1
    resourceIds
    Resource ids of the devices
    JSONArray
    longJson
    Yes
    Update status of credential rule
    setCredentialRuleStatus
    POST
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmtags/setCredentialRuleStatus?apiKey=XXXXXXXXXXYYY&ruleId=1&status=true
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    ruleId
    Rule ID
    long
    Yes
    1
    status
    Status of rule (Enable/Disable)
    boolean
    Yes
    true
    Get tag details
    tagPreRenders
    GET
    Allowed
    Restricted
    Restricted
    http://server-url:8060/api/json/ncmtags/tagPreRenders?apiKey=XXXXXXXXXXYYY&TAG_ID=1
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    TAG_ID
    ID of the tag
    long
    No
    1
    Get all tags
    tagsList
    GET
    Allowed
    Restricted
    Restricted
    http://server-url:8060/api/json/ncmtags/tagsList?apiKey=XXXXXXXXXXYYY
    Update a credential rule
    updateCredentialRule
    POST
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmtags/updateCredentialRule?apiKey=XXXXXXXXXXYYY&RULE_ORDER=1&RULEID=1
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    RULE_ORDER
    Rule order
    int
    No
    1
    RULEID
    ID of the credential rule
    long
    No
    1
    RULENAME
    Name of the credential rule
    ncmAllowedNameChars
    No
    DESCRIPTION
    Description of the credential rule
    ncmAllowedNameChars
    No
    DEVICE_CRI_TYPE
    Criteria type
    ^(DEVICEGROUP|CRITERIA)$
    No
    COMBINATIONID
    Protocol combination ID
    long
    No
    PROFILEID
    ID of the credential profile
    long
    No
    SELECTEDDEVICEGROUPS
    IDs of the device groups
    JSONArray
    longJson
    No
    CRITERIA_LIST
    List of criterias
    JSONArray
    criteriaJSON
    No
    STATUS
    Rule status
    boolean
    No
    Update a tag
    updateTag
    POST
    Allowed
    Restricted
    Restricted
    http://server-url:8060/api/json/ncmtags/updateTag?apiKey=XXXXXXXXXXYYY&TAG_ID=1
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    TAG_ID
    ID of the tag
    long
    No
    1
    TAG_NAME
    Name of the tag
    ncmAllowedNameChars
    No
    TAG_DISPLAY_NAME
    Display name of the tag
    ncmAllowedNameChars
    No
    TAG_DESC
    Description of the tag
    ncmBasicTextChars
    No
    customColVal1
    Custom column value 1
    customColumnRegex
    No
    customColVal2
    Custom column value 2
    customColumnRegex
    No
    customColVal3
    Custom column value 3
    customColumnRegex
    No
    selectedProbes
    Selected probes
    String
    Yes
    Update tag custom column details
    updateTagCustomColumnDetails
    POST
    Allowed
    Restricted
    Restricted
    http://server-url:8060/api/json/ncmtags/updateTagCustomColumnDetails?apiKey=XXXXXXXXXXYYY
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    customColName1
    Custom column value1
    customColumnRegex
    No
    customColName2
    Custom column value2
    customColumnRegex
    No
    customColName3
    Custom column value3
    customColumnRegex
    No
  • ncmzacautomation
    Title
    API Name
    Method
    Execution in Standalone/Probe
    Execution in Central
    Execution in Probe from Central
    Sample URL
    Create VLAN for REST resource
    createVLAN
    POST
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmzacautomation/createVLAN?apiKey=XXXXXXXXXXYYY&resourceId=1
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    resourceId
    Resource id of the device
    long
    Yes
    1
    vlanId
    VLAN id
    String
    Yes
    vlanName
    Name of the vlan
    String
    Yes
    description
    VLAN description
    String
    No
    Get interface details for REST resource
    getInterfaceDetails
    GET
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmzacautomation/getInterfaceDetails?apiKey=XXXXXXXXXXYYY&resourceId=1
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    resourceId
    Resource id of the device
    long
    Yes
    1
    interfaceId
    Interface id
    String
    Yes
    List interfaces for REST resource
    getInterfaces
    GET
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmzacautomation/getInterfaces?apiKey=XXXXXXXXXXYYY&resourceId=1
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    resourceId
    Resource id of the device
    long
    Yes
    1
    Get VLAN details for REST resource
    getVlanDetails
    GET
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmzacautomation/getVlanDetails?apiKey=XXXXXXXXXXYYY&resourceId=1
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    resourceId
    Resource id of the device
    long
    Yes
    1
    vlanId
    VLAN id
    String
    Yes
    List VLAN for REST resource
    getVlans
    GET
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmzacautomation/getVlans?apiKey=XXXXXXXXXXYYY&resourceId=1
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    resourceId
    Resource id of the device
    long
    Yes
    1
    Update tag for REST resource
    tagChange
    POST
    Allowed
    Restricted
    Allowed
    http://server-url:8060/api/json/ncmzacautomation/tagChange?apiKey=XXXXXXXXXXYYY&resourceId=1&operation=ACCESS_TO_ACCESS&action=ADD
    Param Name
    Description
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Sample Value
    resourceId
    Resource id of the device
    long
    Yes
    1
    interfaceId
    Id of the interface
    String
    Yes
    operation
    Tag Operation
    ^(ACCESS_TO_ACCESS|ACCESS_TO_TAG|TAG_TO_ACCESS|TAG_TO_TAG)$
    Yes
    ACCESS_TO_ACCESS
    action
    Action to be performed
    ^(ADD|REMOVE)$
    No
    ADD
    accessVlanId
    Id of the AccessVLAN
    String
    No
    nativeVlanId
    Id of the NativeVLAN
    String
    No
    vlanTrunks
    VLAN trunks
    JSONArray
    strJson
    No
  • advReportColumns
    Param Name / JSON Size
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    0-40
    ncmAdvReportColumns
    No
  • alphaNumericJSON
    Param Name / JSON Size
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    0-100000
    alphanumeric_basic_two_byte
    No
  • blockCriteriaListJson
    Param Name / JSON Size
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    condition
    ^(80|90|0)$
    No
    pattern
    String
    No
    operator
    ^(and|or|NA)$
    No
  • cipherJSON
    Param Name / JSON Size
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    ncm.ssh.blockCipherSuites
    supportedCipherSuits
    No
    ncm.ssh.allowKeyExchanges
    supportedKeyExchanges
    No
    ncm.ssh.blockHmacs
    supportedHMacs
    No
  • clientServerConfigJson
    Param Name / JSON Size
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    ncm.changedetection.backup.delayInSeconds
    int
    No
    ncm.schedule.backup.timeout
    int
    No
    ncm.schedule.backup.retry
    int
    No
    ncm.backup.enable.chinease.encoding
    boolean
    No
    ncm.report.saveAfterEmail
    boolean
    No
    autoSSHTelnet
    boolean
    No
    ncm.templates.visibletoall
    boolean
    No
    operator.configlet.autoapproval
    boolean
    No
    operator.configlet.restriction
    boolean
    No
    autoLoopDetection
    boolean
    No
    ncm.compliance.noblockviolation
    boolean
    No
    operator.uploadConfiguration.autoapproval
    boolean
    No
    EXCLUDE_CONFIG_CHANGE_ALARM_ALL_USERS
    boolean
    No
    EXCLUDE_CONFIG_CHANGE_ALARM_IF_CHANGEDBY_NA
    boolean
    No
    ncm.compliance.autoRemediation
    boolean
    No
    check.ncm.dnsNameForClientURL
    boolean
    No
    ncm.disable.reverseDns
    boolean
    No
    ncm.report.rebrand
    boolean
    No
    syslog.SHOW_WARNING
    boolean
    No
    ncm.discovery.autoAdd
    boolean
    No
    ncm.discovery.nearSysOIDMatcher
    boolean
    No
    ncm.accessSpark
    boolean
    No
    ncm.sparkAudit
    boolean
    No
    NCM_OPERATION_FAILURE_ALARM_SEVERITY
    int
    No
    NCM_CONFIG_CHANGE_ALARM_SEVERITY
    int
    No
    ncm.emailAttachment.maxSizeinMB
    int
    No
    ncm.configlets.execution.failure.retryCount
    int
    No
    NCM_FIRM_VULN_STATE
    ((ncm.firmvuln.Reported|ncm.firmvuln.Confirmed|ncm.firmvuln.Resolution_planned|ncm.firmvuln.Resolved|ncm.firmvuln.Not_applicable)(,(ncm.firmvuln.Reported|ncm.firmvuln.Confirmed|ncm.firmvuln.Resolution_planned|ncm.firmvuln.Resolved|ncm.firmvuln.Not_applicable))*)
    No
    ncm.report.nipperPath
    folderAndNetworkPath
    No
    ncm.creator.skipEOLSync
    boolean
    No
    ncm.creator.skipDTSync
    boolean
    No
    ncm.creator.skipFirmwareSync
    boolean
    No
    CONFIG_CHANGE_AUTHORIZED_USERS
    String
    No
    ncm.changes.authorizeAll
    boolean
    No
    EXCLUDE_CONFIG_CHANGE_ALARM_USERS
    String
    No
    NCM_DIFF_LIMIT
    long
    No
    ncm.fvAlertNCM
    boolean
    No
    ncm.remove.pdf.chart
    boolean
    No
    ncm.set.currentconfig.baseline
    boolean
    No
    ncm.interface.update
    boolean
    No
    ncm.vlan.update
    boolean
    No
    ncm.sysoid.update
    boolean
    No
    ncm.syslocation.description.update
    boolean
    No
    ncm.snmp.schedule.hours
    int
    No
    ncm.snmp.schedule.minutes
    int
    No
  • cloneRuleJson
    Param Name / JSON Size
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    id
    long
    No
    newName
    text_basic_symbols
    Yes
  • configletJson
    Param Name / JSON Size
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Id
    String
    No
    TemplateContents
    String
    No
    TemplateName
    String
    No
    TemplateType
    ^(COMMAND_LINE_MODE|ADVANCED_COMMAND_LINE_MODE|TFTP_FILE_TRANSFER_MODE)$
    No
    Description
    String
    No
  • configletVarJSON
    Param Name / JSON Size
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    alphanumeric_basic_two_byte
    String
    No
  • criteriaJSON
    Param Name / JSON Size
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Field
    ^(RESOURCENAME|ADDRESS|VENDORNAME|DEVICE_TEMPLATE|SERIES|MODEL|OSVERSION|COLUMNVALUE1|COLUMNVALUE2|COLUMNVALUE3)$
    No
    Value
    String
    No
    Comparator
    ^(and|or)$
    No
    Condition
    ^(EQUAL|NOT_EQUAL|LIKE|STARTS_WITH|ENDS_WITH|NOT_LIKE|IP_RANGE)$
    No
  • criteriaListJson
    Param Name / JSON Size
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    operator
    ^(and|or|NA)$
    No
    condition
    ^(80|90)$
    No
    pattern
    String
    No
    allowedCount
    ^(\d|[1-4]\d|50)$
    No
  • customReportColsJson
    Param Name / JSON Size
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    0-1000
    ^([a-zA-Z0-9\_])+$
    No
  • day_dateJson
    Param Name / JSON Size
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    0-1000
    schedule_date
    No
  • delConfigletJson
    Param Name / JSON Size
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    id
    long
    Yes
    name
    String
    No
  • DGCriteriaJSON
    Param Name / JSON Size
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    Field
    ^(RESOURCENAME|ADDRESS|VENDORNAME|DISPLAYTYPE|SERIES|MODEL|OSVERSION|OSTYPE|MANAGED|BACKUP_STATUS|ISCONFLICT|BASELINE_ISCONFLICT|COMPLIANCE_STATUS|COLUMNVALUE1|COLUMNVALUE2|COLUMNVALUE3)$
    No
    Value
    String
    No
    Comparator
    ^(and|or)$
    No
    Condition
    ^(EQUAL|NOT_EQUAL|LIKE|STARTS_WITH|ENDS_WITH|NOT_LIKE)$
    No
  • dtNameJson
    Param Name / JSON Size
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    0-1000
    ncmAllowedNameChars
    No
  • filter_criteria
    Param Name / JSON Size
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    column_id
    ncmAdvReportColumns
    No
    value
    String
    No
    comparator
    ^(and|or)$
    No
    condition
    ^(EQUAL|NOT_EQUAL|LIKE|STARTS_WITH|ENDS_WITH|NOT_LIKE)$
    No
  • firmwareVulStateJson
    Param Name / JSON Size
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    vulid
    long
    No
    state
    ^(Reported|Confirmed|Resolution planned|Resolved|Not applicable)$
    No
  • ipAddrJson
    Param Name / JSON Size
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    0-100000
    NCM_IP_V4_AND_V6_Address
    No
  • ipJson
    Param Name / JSON Size
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    0-100000
    ipaddress
    No
  • longJson
    Param Name / JSON Size
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    0-100000
    long
    Yes
  • probeServerConfigJson
    Param Name / JSON Size
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    ncmee.probe.restrict.distribution
    boolean
    No
  • restAPICredentialJSON
    Param Name / JSON Size
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    0-1000
    JSONObject
    restAPICredentialsJSONObject
    No
  • restAPICredentialsJSONObject
    Param Name / JSON Size
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    name
    String
    No
    value
    String
    No
    isPassword
    boolean
    No
  • ruleOrderJSON
    Param Name / JSON Size
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    \d+
    int
    No
  • searchJSON
    Param Name / JSON Size
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    andor
    ^(AND|OR)$
    No
    condition
    ^(search|contains|notcontains|linestartswith|lineendswith)$
    No
    value
    String
    No
  • searchStringJSON
    Param Name / JSON Size
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    criteria
    JSONArray
    searchJSON
    No
  • strJson
    Param Name / JSON Size
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    0-100000
    String
    No
  • sysoidJson
    Param Name / JSON Size
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    model
    ncmSeriesModel
    No
    series
    ncmSeriesModel
    No
    sysoid
    ncmSysoid
    No
  • sysoidJsonExportDT
    Param Name / JSON Size
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    model
    ncmSeriesModel
    No
    series
    ncmSeriesModel
    No
    sysoid
    ncmSysoid
    No
  • webhookAuthenticationObject
    Param Name / JSON Size
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    type
    ^(authentication)$
    No
    key
    String
    No
    value
    String
    No
  • webhookCustomArray
    Param Name / JSON Size
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    0-20
    JSONObject
    webhookCustomObject
    No
  • webhookCustomObject
    Param Name / JSON Size
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    type
    ^(form-urlencoded|form-data|raw)$
    No
    key
    String
    No
    value
    String
    No
  • webhookHeaderArray
    Param Name / JSON Size
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    0-20
    JSONObject
    webhookHeaderObject
    No
  • webhookHeaderObject
    Param Name / JSON Size
    Type / Regex / Regex Template
    JSON Template
    Mandatory
    key
    String
    No
    value
    String
    No
Name
Value
deviceOrInterfaceAction
^(?i)(ADD|SKIP|UNMANAGE|DELETE|undefined)$
discoveryProfileType
^(?i)(SingleDevice|IPRange|CIDR|CSV|ExistingDevices|ActiveDirectory)$
existingDevicesType
^(?i)(bv|devices|category|group)$
minutes
^(0|5|10|15|20|25|30|35|40|45|50|55)$
ncmAdvReportColumns
^(resourcename|ipaddress|vendor_name|device_type|dt_name|series|model|os_type|os_version|mac_address|img_file|serial_number|backup_status|compliance_status|startup_conflict|running_conflict|oper_status|managed|cred_validity|protocol_combination|syslog_status|sys_location|sys_desc|sys_contact|eo_sale|eo_support|last_backup|cc1|cc2|cc3|probe_name)$
ncmSchedReportTemplate
^(HardwareInventoryReport_RTab|DeviceStatusReport_RTab|OSVersionReport_RTab|DeviceManagementStatusReport_RTab|DeviceModelReport_RTab|ConflictReport_RTab|ConfigChangesReport_RTab|ConfigChangeTrendReport_RTab|ConfigurationAanlysis_Report|SecurityAudit_Report|FirmVulCveReport_RTab|FirmVulDeviceReport_RTab|FirmVulVersionReport_RTab|FvFixTrendReport_RTab|FvDeviceVulnHistoryReport_RTab|OperationAuditReport_RTab|BackupStatusReport_RTab|AnnotationReport_RTab|DeviceEOLReport_RTab|ComplianceReport_RTab|ADVANCED_REPORT|OsVersionHistoryReport_RTab|DeviceCredentialProfilesReport_RTab|DeviceCredentialsReport_RTab)$
protocolList
^(?i)((all|SNMP|WMI|CLI|VIWebService|VIWMI|CLI|XenService|PrismAPI|NetAppAPI|SMI)(,(all|SNMP|WMI|CLI|VIWebService|VIWMI|CLI|XenService|PrismAPI|NetAppAPI|SMI))*)+$
supportedCipherSuits
((aes256-gcm@openssh.com|aes128-gcm@openssh.com|chacha20-poly1305@openssh.com|aes256-ctr|aes192-ctr|aes128-ctr|arcfour256|aes256-cbc|3des-cbc|3des-ctr|aes192-cbc|aes128-cbc|blowfish-cbc|arcfour128|arcfour)(,(aes256-gcm@openssh.com|aes128-gcm@openssh.com|chacha20-poly1305@openssh.com|aes256-ctr|aes192-ctr|aes128-ctr|arcfour256|aes256-cbc|3des-cbc|3des-ctr|aes192-cbc|aes128-cbc|blowfish-cbc|arcfour128|arcfour))*)
supportedHMacs
((hmac-sha2-512-etm@openssh.com|hmac-sha2-512-96|hmac-sha2-512|hmac-sha2-256-etm@openssh.com|hmac-sha2-256|hmac-sha2-256-96|hmac-sha1-etm@openssh.com|hmac-sha1|hmac-sha1-96|hmac-md5|hmac-md5-etm@openssh.com|hmac-md5-96)(,(hmac-sha2-512-etm@openssh.com|hmac-sha2-512-96|hmac-sha2-512|hmac-sha2-256-etm@openssh.com|hmac-sha2-256|hmac-sha2-256-96|hmac-sha1-etm@openssh.com|hmac-sha1|hmac-sha1-96|hmac-md5|hmac-md5-etm@openssh.com|hmac-md5-96))*)
supportedKeyExchanges
((curve25519-sha256|rsa2048-sha256|curve25519-sha256@libssh.org|rsa1024-sha1|diffie-hellman-group18-sha512|diffie-hellman-group17-sha512|diffie-hellman-group16-sha512|diffie-hellman-group15-sha512|diffie-hellman-group14-sha256|diffie-hellman-group14-sha1|diffie-hellman-group-exchange-sha256|ecdh-sha2-nistp521|ecdh-sha2-nistp384|diffie-hellman-group-exchange-sha1|diffie-hellman-group1-sha1|ecdh-sha2-nistp256)(,(curve25519-sha256|rsa2048-sha256|curve25519-sha256@libssh.org|rsa1024-sha1|diffie-hellman-group18-sha512|diffie-hellman-group17-sha512|diffie-hellman-group16-sha512|diffie-hellman-group15-sha512|diffie-hellman-group14-sha256|diffie-hellman-group14-sha1|diffie-hellman-group-exchange-sha256|ecdh-sha2-nistp521|ecdh-sha2-nistp384|diffie-hellman-group-exchange-sha1|diffie-hellman-group1-sha1|ecdh-sha2-nistp256))*)
syslogAlertSeverity
^(Critical|Attention|Trouble|Or ignore the event)$
syslogSeverity
^(Emergency|Alert|Critical|Error|Warning|Notice|Information|Debug)(,(Emergency|Alert|Critical|Error|Warning|Notice|Information|Debug))*$
webhookMethods
^(GET|PUT|POST|HEAD|DELETE|PATCH)$

Was this article helpful?