REST API - Firewall Analyzer


    Firewall Analyzer offers REST APIs for adding and fetching data from Firewall Analyzer. Using these APIs, you can integrate Firewall Analyzer with 3rd party IT management/service desk software.

    How Firewall Analyzer REST APIs work? 

    The APIs work with an API key. The API key is unique for each Firewall Analyzer account and has to be passed as a parameter in every API request made. Default API key is available and you can regenerate API key.

    Go to Settings > Basic Settings > REST API in Firewall Analyzer web client andyou will find the API key.

     Generate API Key 

    To generate an API key, click on Regenerate Key.

     

    API List:

     

     

    Dashboard:

    REST API Method Description Parameters Sample URL
    getWidgetsList GET Fetches all widgets available in the given dashboard apiKey - API Key to access your FirewallAnalyzer server.
    dashboardName - dashboard ID.
    http://localhost:8060/api/json/dashboard/getWidgetsList?apiKey=081c9ac51ba16ab061d5efee583dcd2f&dashboardName=dashboardoverview
    getWidgetData GET Displays the data present in the given widget apiKey - API Key to access your FirewallAnalyzer server.
    widgetID - Widget ID
    http://localhost:8060/api/json/dashboard/getWidgetData?apiKey=83155f195334a19df5e58a8a33a6f804&widgetID=255
    getDashboardList GET Fetches all available dashboards apiKey - API Key to access your Firewall Analyzer server. http://localhost:8060/api/json/dashboard/getDashboardList?apiKey=081c9ac51ba16ab061d5efee583dcd2f
    getReportData GET To get the data for the reports. reportName - Name of the report.
    RBBNAME - Name of the report Building block.
    reportParams - Parameters in the report(in json object format).
    type - Type of the report.
    _search - Whether search is done or not.
    nd 
    rows - No of rows.
    page - Page number
    sortByColumn - Based on which column is the data sorted.
    sortByType - Whether the sorting is in ascending order or descending order.
    snapType - Type of the snapshot.
    title1 - Type of the tab like device/cloud etc.
    value1 - Name of the device/cloud etc.
    title2 - Type of the interface/rule etc.
    value2 - Name of the interface/rule etc.
    exportFWAV2WidData 
    Exporting v2 widget data or not. 
    pdfReqFrom - From where the req has been raised.
    reportTitle - Title for the report.
    userLocale - The locale of the user.
    pdfSnapAssID - The snapShot association ID for the widget.
    value - To determine the drilldown.
    mail - To check if mail option is added in widget.
    csv - To check if csv option is added in widget.
    exportFWAMail - Whether to export the mail or not.
    fromEmailid - Sender email ID
    toEmailid - Receiver email ID
    emailSubject - Subject for the email
    message - message for the email
    http://localhost:8060/api/json/fwareport/getReportData?reportName=FTP+Protocol+Group+Top+Hosts+-+Sent&reportParams=%7B%22applyTimeCriteria%22%3A%22true%22%2C%22wrapperType%22%3A%22table%22%2C%22layout%22%3A%221%22%2C%22isRptTab%22%3A%22true%22%2C%22resolvedns%22%3Afalse%2C%22reportId%22%3A%223%22%2C%22timeFrame%22%3A%22today%22%2C%22linkingRBBG%22%3A31%2C%22rowCount%22%3A%225%22%7D&apiKey=ecf7691a575255636e2c28bba73ae213
    getCompleteData GET To get the complete report and other drilldown related datas. reportName - Name of the report.
    RBBNAME - Name of the report building block.(eg : Top Protocols for Sender)
    reportParams - The parameters for the report.
    type - Type of the report.
    _search - Whether the report is based on search or not.
    nd 
    rows - Total number of rows.
    page - Total number of pages.
    sortByColumn - The column name based on which sorting is done.
    sortByType - Whether the sorting is done in ascending order or descending order.
    timeFrame - The timeframe for which the report has been selected.
    startDate - The start date and time for the report generated.
    endDate - The end date and time for the report generated.
    pdf - Type of the report generated.
    resolvedns - Whether the dns has been resolved or not.
    wrapperType - Type of the wrapper used.
    applyTimeCriteria - Whether the time criteria is applied or not.
    rid - Resource ID.
    selColId - Selected Collector ID.
    snapType - Type of the snapshot taken.
    title1 - Type of the tab like device/cloud etc.
    value1 - Name of the device/cloud etc.
    title2 - Type of the interface/rule etc.
    value2 - Name of the interface/rule etc.
    exportFWAV2WidData 
    Exporting v2 widget data or not.
    pdfReqFrom - From where the req has been raised.
    reportTitle - Title for the report.
    reportSubTitle - SubTitle for the report.
    userLocale - The locale of the user.
    expand - Whether it is expanded or not.
    pdfSnapAssID - The snapShot association ID for the widget.
    value - To determine the drilldown.
    url - Url of the requet.
    mail - To check if mail option is added in widget.
    csv - To check if csv option is added in widget.
    exportFWAMail - Whether to export the mail or not.
    fromEmailid - Sender email ID
    toEmailid - Receiver email ID
    emailSubject - Subject for the email
    message - message for the email
    ifCrit - Interface Criteria
    pGroup - Protocol Group
    ATTACK - Attack parameters.
    clientType - Type of the client
    bwUsageType - Bandwidth Usage Type.
    eventType - Type of the event.
    http://localhost:8060/api/json/fwareport/getCompleteData?reportParams=%7B%22RBBNAME%22%3A%22Top+Protocols+for+Sent+Protocol+Group%22%2C%22rid%22%3A%22all%22%2C%22value%22%3A%22Unassigned%22%2C%22applyTimeCriteria%22%3A%22true%22%2C%22resolvedns%22%3Afalse%2C%22timeFrame%22%3A%22today%22%7D&_search=false&nd=1547044166668&rows=50&page=1&sortByColumn=Starton&sortByType=desc&apiKey=ecf7691a575255636e2c28bba73ae213
    showWidgets GET Display all available widgets in a dashboard apiKey - API Key to access your Firewall Analyzer server. http://localhost:8060/api/json/dashboard/showWidgets?apiKey=081c9ac51ba16ab061d5efee583dcd2f
    createDashboard POST Creates new dashboard view apiKey - API Key to access to your Firewall Analyzer
    dashboardName - Name of the dashboard.
    columnWidth - column width
    numberOfColumns - number of columns.
    selectedWidgets - widget Ids
    dashboardDescription– Description of the dashboard.
    http://localhost:8060/api/json/dashboard/createDashboard?apiKey=081c9ac51ba16ab061d5efee583dcd2f&dashboardName=test&columnWidth=100&numberOfColumns=1&selectedWidgets=144&dashboardDescription=desssc
    listCCTVView GET Lists all the CCTV views apiKey - API Key to access your Firewall Analyzer server. http://localhost:8060/api/json/dashboard/listCCTVView?apiKey=081c9ac51ba16ab061d5efee583dcd2f
    getDashBoardsForCCTV GET Get dashboards for the given CCTV view apiKey - API Key to access your Firewall Analyzer server.
    cctvID - 
    cctv ID.
    http://localhost:8060/api/json/dashboard/getDashBoardsForCCTV?apiKey=081c9ac51ba16ab061d5efee583dcd2f&cctvID=1
    addCCTVView POST Add new CCTV view dashboardId - dashboard ID.
    cctvName - name of the cctv.
    cctvDescription - CCTV id
    time - refreshing time interval
    http://localhost:8060/api/json/dashboard/addCCTVView?apiKey=081c9ac51ba16ab061d5efee583dcd2f&dashboardId=1&cctvName=testcctv&cctvDescription=newcctv&time=5
    deleteCCTVView POST Deletes CCTV view apiKey - API Key to access your Firewall Analyzer server.
    cctvID - cctv ID.
    http://localhost:8060/api/json/dashboard/deleteCCTVView&cctvID=2&apiKey=081c9ac51ba16ab061d5efee583dcd2f
    getCCTVView GET Gets CCTV view widgets/dashboards apiKey - API Key to access your Firewall Analyzer server.
    cctvID - cctv ID.
    http://localhost:8060/api/json/dashboard/getCCTVView?apiKey=081c9ac51ba16ab061d5efee583dcd2f&cctvID=1
    deleteWidget POST Deletes the widget in dashboard page apiKey - API Key to access your Firewall Analyzer server.
    widgetID - Widget ID
    http://localhost:8060/api/json/dashboard/deleteWidget?apiKey=081c9ac51ba16ab061d5efee583dcd2f&widgetID=240
    embedWidget POST Embeds URL of a widget apiKey - API Key to access your Firewall Analyzer server.
    regenerate - true or false
    height - height of the widget
    width - width of the widget content
    http://localhost:8060/api/json/dashboard/embedWidget?apiKey=081c9ac51ba16ab061d5efee583dcd2f&widgetID=144&regenerate=true&height=10&width=10

     

    Inventory:

    REST API Method Description Parameters Sample URL
    updateInterfaceInfo POST To update the interface information rid - resource id (eg : 1)
    resName - resourceName
    submitAction - Action performed
    ifIP - Interface Ipaddress
    ifMask - Interface ip mask
    upSpeed - Uplink speed
    downSpeed - Downlink speed
    ifName - Interface Name
    resIP - Resource IP
    snmpComm - SNMP community name
    snmpPort - port value
    https://localhost:8060/api/json/livetraffic/updateInterfaceInfo?apiKey=ecf7691a575255636e2c28bba73ae213
    getFWAInterfaceBandwidthData GET To get the interface/device bandwidth data interfaceID - Interface id
    rid - resource id
    resType - Resource Type
    graphType - Type of graph
    graphUnit - Unit of the graph
    pdf - whether it is pdf or not
    reportName - Name of the reports
    startDate - Starting time
    endDate - Ending time
    expand - Whether it is expanded view or not
    snapType - Type of the snapshot.
    title1 - Type of the tab like device/cloud etc.
    value1 - Name of the device/cloud etc.
    title2 - Type of the interface/rule etc.
    value2 - Name of the interface/rule etc.
    exportFWAV2WidData 
    Exporting v2 widget data or not.
    pdfReqFrom - From where the req has been raised.
    reportTitle - Title for the report.
    userLocale - The locale of the user.
    exportFWAMail - Whether to export the mail or not.
    fromEmailid - Sender email ID
    toEmailid - Receiver email ID
    emailSubject - Subject for the email
    message - message for the email
    mail - To check if mail option is added in widget.
    csv - To check if csv option is added in widget.
    http://localhost:8060/api/json/v2/livetraffic/getFWAInterfaceBandwidthData?interfaceID=25&graphType=bothInAndOut&graphUnit=Kbps&pdf=pdf&reportName=today&apiKey=ecf7691a575255636e2c28bba73ae213
    updateInterfaceName POST Updating the name of the interface ifName - Interface Name
    rid - resource id (eg : 1)
    ifDispName - interface display name   
    https://localhost:8060/api/json/livetraffic/updateInterfaceName?apiKey=ecf7691a575255636e2c28bba73ae213
    getInterfaceList GET Get the list of the interfaces advancedFilters - Set of filters chosen.
    rid - resource id
    timeFrame - selected timeFrame
    startDate 
    Start date according to the time period selected.Format is yyyy/mm/dd hh:mm
    endDate 
    End date according to the time period selected. Format is yyyy/mm/dd hh:mm
    http://localhost:8060/api/json/livetraffic/getInterfaceList?rid=2&apiKey=ecf7691a575255636e2c28bba73ae213
    getUnknownIdentifiers GET To get unknown protocols from the device. reportId - Id of the report.
    applyTimeCriteria - The time period selected.
    startDate - Start date according to the time period selected.Format is yyyy/mm/dd hh:mm
    endDate - End date according to the time period selected. Format is yyyy/mm/dd hh:mm
    hitsCount - Number of hits.
    value - Value of the Identifiers.
    http://localhost:8060/api/json/fwadashboard/getUnknownIdentifiers?reportId=1202&applyTimeCriteria=true&startDate=2018-12-03+10%3A09&endDate=2018-12-03+11%3A09&hitsCount=0&value=Fortigate1-FW&apiKey=ecf7691a575255636e2c28bba73ae213
    getFWAInventoryDeviceList GET To get the device list in inventory tab. vendor - Vendor for the devices.
    resType - Type of the devices added.
    advancedFilters - Any filters that are added. 
    timeFrame - Timeframe selected
    startDate - Value for the starting time.
    endDate - Value for the ending time.
    http://localhost:8060/api/json/fwainventory/getFWAInventoryDeviceList?advancedFilters=%7B%7D&timeFrame=today&apiKey=ecf7691a575255636e2c28bba73ae213
    getDeviceDetails GET To get the details for the selected device rid - Resource ID http://localhost:8060/api/json/fwainventory/getDeviceDetails?rid=1&apiKey=ecf7691a575255636e2c28bba73ae213
    getFWAInventoryTabs GET To get the tabs in the inventory timeFrame - Selected timeframe.
    startDate - Starting date for the selected timeframe.
    endDate - Ending date for the selected timeframe
    http://localhost:8060/api/json/fwainventory/getFWAInventoryTabs?timeFrame=7Days&apiKey=ecf7691a575255636e2c28bba73ae213
    getResourcesList GET To get the list of resources. NIL http://localhost:8060/api/json/fwainventory/getResourcesList?apiKey=ecf7691a575255636e2c28bba73ae213
    getCloudTabList GET To get the details for the cloud tab in inventory page. advancedFilters - The selected filters in the cloud page.
    timeFrame - Selected timeframe.
    startDate - Starting Date for the selected timeframe.
    endDate - Ending date for the selected timeframe.
    http://localhost:8060/api/json/fwainventory/getCloudTabList?advancedFilters=%7B%7D&timeFrame=7Days&apiKey=ecf7691a575255636e2c28bba73ae213
    getUserTabList GET To get the details for the users tab in inventory page. advancedFilters - The selected filters in the users page.
    timeFrame - Selected Timeframe
    startDate - Starting date for the selected timeframe.
    endDate - Ending date for the selected timeframe.
    http://localhost:8060/api/json/fwainventory/getUserTabList?advancedFilters=%7B%7D&timeFrame=7Days&apiKey=ecf7691a575255636e2c28bba73ae213
    getRuleTabList GET To get the details for the rules tab in inventory page. advancedFilters - The selected filters in the Rules page.
    timeFrame - Selected Timeframe
    startDate - Starting date for the selected timeframe.
    endDate - Ending date for the selected timeframe.
    http://localhost:8060/api/json/fwainventory/getRuleTabList?advancedFilters=%7B%7D&timeFrame=7Days&apiKey=ecf7691a575255636e2c28bba73ae213
    getCompleteData** GET To get the complete report and other drilldown related datas. reportName - Name of the report.
    RBBNAME - Name of the report building block.(eg : Top Protocols for Sender)
    reportParams - The parameters for the report.
    type - Type of the report.
    _search - Whether the report is based on search or not.
    nd 
    rows - Total number of rows.
    page - Total number of pages.
    sortByColumn - The column name based on which sorting is done.
    sortByType - Whether the sorting is done in ascending order or descending order.
    timeFrame - The timeframe for which the report has been selected.
    startDate - The start date and time for the report generated.
    endDate - The end date and time for the report generated.
    pdf - Type of the report to be generated.
    resolvedns - Whether the dns has been resolved or not.
    wrapperType - Type of the wrapper used.
    applyTimeCriteria - Whether the time criteria is applied or not.
    rid - Resource ID.
    http://localhost:8060/api/json/fwareport/getCompleteData?reportParams=%7B%22RBBNAME%22%3A%22Top+Protocols+for+Sent+Protocol+Group%22%2C%22rid%22%3A%22all%22%2C%22value%22%3A%22Unassigned%22%2C%22applyTimeCriteria%22%3A%22true%22%2C%22resolvedns%22%3Afalse%2C%22timeFrame%22%3A%22today%22%7D&_search=false&nd=1547044166668&rows=50&page=1&sortByColumn=Starton&sortByType=desc&apiKey=ecf7691a575255636e2c28bba73ae213
     
    getDrilldownReportList** GET To get the drill down details for the reports. url - url for the drill down.
    pGroup - protocol group
    clientType - Type of the client
    bwUsageType - Bandwidth usage type.
    eventType - Type of the event.
    reportParams - The parameters to be added to generate the drill down report.
    http://localhost:8060/api/json/fwareport/getDrilldownReportList?pGroup=FTP&reportParams=%7B%22linkingRBBG%22%3A30%2C%22value%22%3A%22172.16.2.119%22%2C%22reportId%22%3A%2265%22%2C%22timeFrame%22%3A%22today%22%7D&apiKey=ecf7691a575255636e2c28bba73ae213
    assignProtocols POST To assign the unknown protocols group - protocol group name
    protocol - Protocol name to be assigned.
    identifiers - Identifier for the protocol and protocol group.(comma seperated values)
    (5666/tcp,8014/tcp)
    http://localhost:8060/api/json/v2/fwadashboard/assignProtocols?apiKey=ecf7691a575255636e2c28bba73ae213
     
    getDeviceSummary GET To get the summary of the device. rid - Resource ID
    pdf - Type of the report being exported.
    snapshotName - Name of the snapshot.
    snapType - Type of the snapshot.
    timeFrame - Time frame selected for which the data is shown.
    startDate - The starting date from which the data is displayed.
    endDate - The ending date upto which the data is displayed.
    speedType - Type of the speed unit which is selected.
    title1 - Type of the tab like device/cloud etc.
    value1 - Name of the device/cloud etc.
    title2 - Type of the interface/rule etc.
    value2 - Name of the interface/rule etc.
    exportFWAV2WidData 
    Exporting v2 widget data or not.
    pdfReqFrom - From where the req has been raised.
    reportTitle - Title for the report.
    userLocale - The locale of the user.
    pdfSnapAssID - The snapShot association ID for the widget.
    exportFWAMail - Whether to export the mail or not.
    fromEmailid - Sender email ID
    toEmailid - Receiver email ID
    emailSubject - Subject for the email
    message - message for the email
    mail - To check if mail option is added in widget.
    csv - To check if csv option is added in widget.
    http://localhost:8060/api/json/fwaglobal/getDeviceSummary?rid=1&snapshotName=FWAFirewall&snapType=FirewallDevice&apiKey=ecf7691a575255636e2c28bba73ae213

     

     

     

    Alarms: 

    REST API Method Description Parameters Sample URL
    listAlarms GET To list the alarms that have been raised. deviceName - name of the device.
    severity - The severity of the alarm raised.
    category - The category selected based on which the alarms are displayed.
    period - Alarms raised for the particular time period.
    entity - The entity or profile for which the alarms are raised.
    alarmCode - Alarm code specified for the alarm.
    eventType - Type of the event 
    alertType - Type of the alarm.
    fromTime - The starting time range that is selected.
    toTime - The Ending time range that is selected.
    isFromIPSLA - To check whether the alarm is raised from IPSLA module.
    monitorType - Type of the monitor for which the alarm has been raised.
    probeId - The Id of the probe.
    limit - Limit for the number of alarms.
    pageNumber - The current page number that is shown.
    isAcknowledge - Has the alarm been acknowledged or not.
    sortByCategory- The alarms are sorted based on category or not.
    page - The current page number that is displayed.
    rows - Maximum number of  alarms displayed per page.
    isNotes - Whether any notes is present for the alarm or not.
    _search - Whether search action is performed or not.
    nd 
    probeName - Name of the probe.
    fromNFA - Whether the alarm has been raised from NFA module.
    isVirtualEntity - Whether the entity is virtual or not.
    showHWAlarms- Whether HWalarms is enabled or not.
    filters - The search string that is given when performing search action.
    sortByColumn - Column based on which the alarms are sorted.
    sortByType - The sort type whether the alarms are displayed in ascending or descending order.
    collOpt - The collector for the alarm has been raised.
    isFluidic - Whether the alarm is of type fluidic or not.
    isWebclient - Whether the alarm has been raised by webclient or not.
    timeFrame - The time period selected for which the alarms have been raised.
    DateRange - The Dates selected for which the alarms have been raised.
    http://localhost:8060/api/json/alarm/listAlarms?isFluidic=true&isWebclient=true&alertType=ActiveAlarms&sortByCategory=true&isNotes=true&_search=false&nd=1557835535125&rows=100&page=1&sortByColumn=modTime&sortByType=desc&apiKey=ecf7691a575255636e2c28bba73ae213
    alarmProperties GET To get the properties for the alarm entity - Name of the entity/profile for which the alarm has been raised.
    alarmSpecific - Whether it is alarm specific or not.
    deviceID - The ID of the device for which the alarm has been raised.
    http://localhost:8060/api/json/alarm/alarmProperties?entity=testalert_5&apiKey=ecf7691a575255636e2c28bba73ae213
    getAlertDetails GET To get the alarm details auditId - Id of the alarm.
    Alert_type - Type of the alert.
    entity - Name of the entity/profile for which the alarm was raised.
    http://localhost:8060/api/json/fwaalarms/getAlertDetails?auditId=167&Alert_type=Normal%20Alert&entity=cxz_328&apiKey=ecf7691a575255636e2c28bba73ae213
    getAlarmActions GET To get the list of actions for the particular alarm entity - Name of the entity/profile for which the alarm was raised. http://localhost:8060/api/json/alarm/getAlarmActions?isFluidic=true&entity=testalert_5&apiKey=ecf7691a575255636e2c28bba73ae213
    deleteAlarm POST To delete the alarms entity - Name of the entity/profile for which the alarm was raised.
    type - Type of the alarm.
    isFluidic - Whether the alarm raised is fluidic or not.
    http://localhost:8060/api/json/alarm/deleteAlarm?isFluidic=true&apiKey=ecf7691a575255636e2c28bba73ae213
    addNotes POST To add the required notes for an alarm entity - Name of the entity/profile for which the alarm was raised.
    notes - The notes that have been added for the alarm.
    type - Type of the alarm for which the note has been added.
    isFluidic - Whether the alarm is fluidic or not.
    http://localhost:8060/api/json/alarm/addNotes?isFluidic=true&apiKey=ecf7691a575255636e2c28bba73ae213

     

     

    Reports:

    Custom Reports:

    REST API Method Description Parameters Sample URL
    getReportProfiles GET To get the report profiles configured. NIL http://localhost:8060/api/json/fwareporttab/getReportProfiles?apiKey=ecf7691a575255636e2c28bba73ae213
    addRptProfile POST To add the report profile profName - Name of the profile.
    resId - resource ID. (comma seperated value) (eg :1,2,3)
    userId - User ID. (eg : 1)
    selectedRpts - The reports that are selected.
    selectedFilters - The filters that are selected.
    rptType - Type of the report (pdf or csv).
    type - Type
    emailId - List of emails to send notifications.
    subject - subject for the email
    note - note for the email
    schType - Type of the schedule (Ex: Hourly).
    onceOnlyTime - Executed only once at time on date.
    onceTimeCrit - The criteria for the once report.
    dailyHrs - To send report at specified hours daily.
    dailyMns - To send report at specified minutes daily.
    dailyTimeCrit - The criteria for the daily Time.
    nonworkHour - Whether report for nonwork hour or working hour.
    startTime - Start time for the workhour.
    endTime - endTime for the workhour.
    dailyCheck - is it run daily or only on weekdays.
    hourlyHrs - At what hour should the report generate.
    hourlyMns - At what minute should the report generate.
    hourlyTimeCrit - The criteria for the hourly report.
    monthHrs - At what hours should the report be generated for a month.
    monthMns - At what minutes should the report be generated for a month.
    monthDay - The day on which the report should be generated for each month.
    monthTimeCrit - The criteria for the month.
    monthlyCheck - Whether the report is for weekdays only or all days.
    weeklyHrs - The hour at which the report should be generated each week
    weeklyMns - The minutes at which the report should be generated each week.
    weekDay - The day on which the report should be generated each week.
    weeklyTimeCrit - The criteria for the week.
    weeklyCheck - Whether it is run only on week days or all days.
    reportId - Report ID.
    http://localhost:8060/api/json/fwareporttab/addRptProfile?apiKey=ecf7691a575255636e2c28bba73ae213
    editRptProfile GET Edit the report profile reportId - Report ID http://localhost:8060/api/json/fwareporttab/editRptProfile?reportId=3&apiKey=ecf7691a575255636e2c28bba73ae213
    getMyReportData GET To get the data of specific report. reportId - Report ID
    rbbgId - reportbuildingblock group ID.
    rType - Report type
    http://localhost:8060/api/json/fwareporttab/getMyReportData?reportId=3&rbbgId=65&rType=MyRep&apiKey=ecf7691a575255636e2c28bba73ae213
    getDrilldownReportList GET To get the drill down details for the reports. url - url for the drill down.
    pGroup - protocol group
    clientType - Type of the client
    bwUsageType - Bandwidth usage type.
    eventType - Type of the event.
    reportParams - The parameters to be added to generate the drill down report.
    http://localhost:8060/api/json/fwareport/getDrilldownReportList?pGroup=FTP&reportParams=%7B%22linkingRBBG%22%3A30%2C%22value%22%3A%22172.16.2.119%22%2C%22reportId%22%3A%2265%22%2C%22timeFrame%22%3A%22today%22%7D&apiKey=ecf7691a575255636e2c28bba73ae213
    getCompleteData GET To get the complete report and other drilldown related datas. reportName - Name of the report.
    RBBNAME - Name of the report building block.(eg : Top Protocols for Sender)
    reportParams - The parameters for the report.
    type - Type of the report.
    _search - Whether the report is based on search or not.
    nd 
    rows - Total number of rows.
    page - Total number of pages.
    sortByColumn - The column name based on which sorting is done.
    sortByType - Whether the sorting is done in ascending order or descending order.
    timeFrame - The timeframe for which the report has been selected.
    startDate - The start date and time for the report generated.
    endDate - The end date and time for the report generated.
    pdf - Type of the report generated.
    resolvedns - Whether the dns has been resolved or not.
    wrapperType - Type of the wrapper used.
    applyTimeCriteria - Whether the time criteria is applied or not.
    rid - Resource ID.
    selColId - Selected Collector ID.
    snapType - Type of the snapshot taken.
    title1 - Type of the device.
    value1 - Name of the device.
    title2 - Type of the interface.
    value2 - Name of the interface.
    exportFWAV2WidData
    Exporting v2 widget data or not.
    pdfReqFrom - From where the req has been raised.
    reportTitle - Title for the report.
    reportSubTitle - SubTitle for the report.
    userLocale - The locale of the user.
    expand - Whether it is expanded or not.
    pdfSnapAssID - The snapShot association ID for the widget.
    value - To determine the drilldown.
    url - Url of the requet.
    mail - To check if mail option is added in widget.
    csv - To check if csv option is added in widget.
    exportFWAMail - Whether to export the mail or not.
    fromEmailid - Sender email ID
    toEmailid - Receiver email ID
    emailSubject - Subject for the email
    message - message for the email
    ifCrit - Interface Criteria
    pGroup - Protocol Group
    ATTACK - Attack parameters.
    clientType - Type of the client
    bwUsageType - Bandwidth Usage Type.
    eventType - Type of the event.
    http://localhost:8060/api/json/fwareport/getCompleteData?reportParams=%7B%22RBBNAME%22%3A%22Top+Protocols+for+Sent+Protocol+Group%22%2C%22rid%22%3A%22all%22%2C%22value%22%3A%22Unassigned%22%2C%22applyTimeCriteria%22%3A%22true%22%2C%22resolvedns%22%3Afalse%2C%22timeFrame%22%3A%22today%22%7D&_search=false&nd=1547044166668&rows=50&page=1&sortByColumn=Starton&sortByType=desc&apiKey=ecf7691a575255636e2c28bba73ae213
    exportReport GET To export the report data into a document FORMAT - format of the exported document.(pdf)
    rId - Resource ID
    reportId - Report ID
    rbbgName - Name of the report building block.
    isPolicyReportSpecific - Is the exported report related to policy or not.
    showRuleSummary - Show the summary of the rules.
    colList - The list of columns that have been selected.
    reportName - Name of the report.
    reportTitle - Title for the report.
    rbbname - Name of the report building block.
    policyID - ID for the policy.
    selPolicyNames - Name of the selected policies.
    resourceName - Name of the resource.
    displayName - Display name for the resource.
    deviceType - Type of the device.
    rpt - Report generated.
    anomalyType - type of the anomaly for which report is generated.
    hideFromAndTo - Hide the from and to in the report or not.
    qRBBGID - Quick report building block id
    startDate - The start date and time for which the report is generated.
    endDate - The end date and time for which the report is generated.
    applyTimeCriteria - Whether the timecriteria is applied or not.
    fromComptTab - Is the report generated from compliance tab or not.
    rowCount - Number of rows in the report.
    compType - Type of the compliance report.
    isCisco - Is the report generated for cisco device or not.
    DateRange - Is the date range specified for the report or not.
    http://localhost:8060/api/json/fwareport/exportReport?reportId=602&reportName=zvcxxzvc&qRBBGID=6&applyTimeCriteria=true&FORMAT=pdf&startDate=2019-01-09%2000:00:00&endDate=2019-01-09%2019:43:59&rowCount=5&apiKey=ecf7691a575255636e2c28bba73ae213

     

     

    Firewall Reports:

    REST API Method Description Parameters Sample URL
    getReportData GET To get the data for the reports. reportName - Name of the report.
    RBBNAME - Name of the report Building block.
    reportParams - Parameters in the report(in json object format).
    type - Type of the report.
    _search - Whether search is done or not.
    nd 
    rows - No of rows.
    page - Page number
    sortByColumn - Based on which column is the data sorted.
    sortByType - Whether the sorting is in ascending order or descending order.
    snapType - Type of the snapshot.
    title1 - Type of the tab like device/cloud etc.
    value1 - Name of the device/cloud etc.
    title2 - Type of the interface/rule etc.
    value2 - Name of the interface/rule etc.
    exportFWAV2WidData 
    Exporting v2 widget data or not. 
    pdfReqFrom - From where the req has been raised.
    reportTitle - Title for the report.
    userLocale - The locale of the user.
    pdfSnapAssID - The snapShot association ID for the widget.
    value - To determine the drilldown.
    mail - To check if mail option is added in widget.
    csv - To check if csv option is added in widget.
    exportFWAMail - Whether to export the mail or not.
    fromEmailid - Sender email ID
    toEmailid - Receiver email ID
    emailSubject - Subject for the email
    message - message for the email
    http://localhost:8060/api/json/fwareport/getReportData?reportName=FTP+Protocol+Group+Top+Hosts+-+Sent&reportParams=%7B%22applyTimeCriteria%22%3A%22true%22%2C%22wrapperType%22%3A%22table%22%2C%22layout%22%3A%221%22%2C%22isRptTab%22%3A%22true%22%2C%22resolvedns%22%3Afalse%2C%22reportId%22%3A%223%22%2C%22timeFrame%22%3A%22today%22%2C%22linkingRBBG%22%3A31%2C%22rowCount%22%3A%225%22%7D&apiKey=ecf7691a575255636e2c28bba73ae213
    getCompleteData GET To get the complete report and other drilldown related datas. reportName - Name of the report.
    RBBNAME - Name of the report building block.(eg : Top Protocols for Sender)
    reportParams - The parameters for the report.
    type - Type of the report.
    _search - Whether the report is based on search or not.
    nd 
    rows - Total number of rows.
    page - Total number of pages.
    sortByColumn - The column name based on which sorting is done.
    sortByType - Whether the sorting is done in ascending order or descending order.
    timeFrame - The timeframe for which the report has been selected.
    startDate - The start date and time for the report generated.
    endDate - The end date and time for the report generated.
    pdf - Type of the report generated.
    resolvedns - Whether the dns has been resolved or not.
    wrapperType - Type of the wrapper used.
    applyTimeCriteria - Whether the time criteria is applied or not.
    rid - Resource ID.
    selColId - Selected Collector ID.
    snapType - Type of the snapshot taken.
    title1 - Type of the tab like device/cloud etc.
    value1 - Name of the device/cloud etc.
    title2 - Type of the interface/rule etc.
    value2 - Name of the interface/rule etc.
    exportFWAV2WidData 
    Exporting v2 widget data or not.
    pdfReqFrom - From where the req has been raised.
    reportTitle - Title for the report.
    reportSubTitle - SubTitle for the report.
    userLocale - The locale of the user.
    expand - Whether it is expanded or not.
    pdfSnapAssID - The snapShot association ID for the widget.
    value - To determine the drilldown.
    url - Url of the requet.
    mail - To check if mail option is added in widget.
    csv - To check if csv option is added in widget.
    exportFWAMail - Whether to export the mail or not.
    fromEmailid - Sender email ID
    toEmailid - Receiver email ID
    emailSubject - Subject for the email
    message - message for the email
    ifCrit - Interface Criteria
    pGroup - Protocol Group
    ATTACK - Attack parameters.
    clientType - Type of the client
    bwUsageType - Bandwidth Usage Type.
    eventType - Type of the event.
    http://localhost:8060/api/json/fwareport/getCompleteData?reportParams=%7B%22RBBNAME%22%3A%22Top+Protocols+for+Sent+Protocol+Group%22%2C%22rid%22%3A%22all%22%2C%22value%22%3A%22Unassigned%22%2C%22applyTimeCriteria%22%3A%22true%22%2C%22resolvedns%22%3Afalse%2C%22timeFrame%22%3A%22today%22%7D&_search=false&nd=1547044166668&rows=50&page=1&sortByColumn=Starton&sortByType=desc&apiKey=ecf7691a575255636e2c28bba73ae213
    getDrilldownReportList GET To get the drill down details for the reports. url - url for the drill down.
    pGroup - protocol group
    clientType - Type of the client
    bwUsageType - Bandwidth usage type.
    eventType - Type of the event.
    reportParams - The parameters to be added to generate the drill down report.
    http://localhost:8060/api/json/fwareport/getDrilldownReportList?pGroup=FTP&reportParams=%7B%22linkingRBBG%22%3A30%2C%22value%22%3A%22172.16.2.119%22%2C%22reportId%22%3A%2265%22%2C%22timeFrame%22%3A%22today%22%7D&apiKey=ecf7691a575255636e2c28bba73ae213
    getReportList GET To get the report list. reportGroup - Report Group.
    rid - Resource ID.
    reportName - Name of the report.
    reportId - Id for the report.
    rtab - Raw tab or not.
    rowCount - Number of rows to be displayed.
    timeFrame - Time frame that has been selected.
    startDate - Starting date from which the data is shown.
    endDate - Ending date upto which the data is shown.
    isRptTab - Whether it is report tab or not.
    resolvedns - Whether resolve dns is enabled or not.
    wrapperType - Type of the wrapper.
    applyTimeCriteria - Whether the time criteria is applied or not.
    title1 - Type of the tab like device/cloud etc.
    value1 - Name of the device/cloud etc.
    title2 - Type of the interface/rule etc.
    value2 - Name of the interface/rule etc.
    exportFWAV2WidData 
    Exporting v2 widget data or not.
    pdfReqFrom - From where the req has been raised.
    reportTitle - Title for the report.
    userLocale - The locale of the user.
    type - Type of the report.
    _search - Whether the report is based on search or not.
    nd 
    rows - Total number of rows.
    page - Total number of pages.
    sortByColumn - The column name based on which sorting is done.
    sortByType - Whether the sorting is done in ascending order or descending order.
    headerText1 - Type of the device/report etc.
    headerText2 - Type of the device/report/widget etc.
    headerVal1 - Value of the device/report etc.
    headerVal2 - Value of the device/report/widget etc.
    value - Value of the parameters for the drilldown report.
    layout - Layout for the report
    series - Series of the reports
    exportFWAMail - Whether mail is to be sent or not.
    fromEmailid - Sender Email address 
    toEmailid - Receiver Email address 
    emailSubject - Subject of the email
    message - Message in the email

    http://localhost:8060/api/json/fwareport/getReportList?reportGroup=65&rid=1&apiKey=ecf7691a575255636e2c28bba73ae213

    exportMultiWidgetPDF GET To export more than 1 widget of a page as a report. rows - Total number of rows.
    page - Total number of pages.
    rid - Resource ID.
    ifCrit - Interface Criteria
    headerText1 - Type of the device/report etc.
    headerText2 - Type of the device/report/widget etc.
    headerVal1 - Value of the device/report etc.
    headerVal2 - Value of the device/report/widget etc.
    value - Value of the parameters for the drilldown report.
    series - Series of the reports
    reportGroup - The group to which the report belongs.
    timeFrame - Time frame selected to view the report.
    startDate - Starting date for which the report is shown.
    endDate - Ending date for which the report is shown.
    snapshotName - Name of the snapshot.
    snapType - Type of the snapshot.
    exportFWAV2WidData - Exporting v2 widget data or not.
    pdfReqFrom - From where the req has been raised.
    reportTitle - Title for the report.
    userLocale - The locale of the user.
    exportFWAMail - Whether mail is to be sent or not.
    fromEmailid - Sender Email address 
    toEmailid - Receiver Email address 
    emailSubject - Subject of the email
    message - Message in the email
    mail - To check if mail option is added in widget.
    csv - To check if csv option is added in widget.
    graphUnit - The unit for the graph to be displayed.
    http://localhost:8060/api/json/fwareport/getReportList?reportGroup=61&headerText1=Device+Name&headerText2=Report+Name&headerVal1=All+Devices&headerVal2=Traffic+Reports&applyTimeCriteria=true&wrapperType=table&layout=1&isRptTab=true&resolvedns=false&reportId=all&rtab=rtr&rowCount=5&timeFrame=today&exportFWAV2WidData=true&pdfReqFrom=FWAReportMultiWidget&userLocale=en_US&apiKey=ecf7691a575255636e2c28bba73ae213

     

     

     

    Schedule List:

    REST API Method Description Parameters Sample URL
    getFWAScheduleList GET To get the configured list of schedules. NIL http://localhost:8060/api/json/fwasettings/getFWAScheduleList?apiKey=ecf7691a575255636e2c28bba73ae213
    addFWASchedule POST To add the schedule report. mail - The to which the schedule is to be sent.(can be comma seperated)
    taskName - The name of the task.
    profileName - The name of the profile.
    hiddenField - Whether hiddenField is true or false.
    taskType - Type of the tassk.
    hourlyHrs - The schedule time in hours for hourly schedule.
    hourlyMns - The schedule time in minutes for hourly schedule.
    hourlyTimeCrit - The criteria for the hourly schedule.
    dailyHrs - The schedule time in hours for the daily schedule.
    dailyMns - The schedule time in minutes for the daily schedule.
    dailyTimeCrit - The criteria for the daily schedule.
    nonworkHour - Whether the daily/once only time report is generated for the working hour or non-working hour
    startTime - The start time for the working hour.
    endTime - The endtime for the working hour.
    dailyCheck - Whether the report has to be generated for everyday or only on weekdays.
    weekDay - Day of the week for which the report has to be scheduled.
    weeklyHrs - The schedule time in hours for the weekly schedule.
    weeklyMns - The schedule time in minutes for the weekly schedule.
    weeklyTimeCrit - The crietira for the weekly schedule.
    weeklyCheck - Whether the report should be generated only for weekdays or for all days of the week.
    monthDay - The day of the month on which the report has to be generated.
    monthHrs - The schedule time in hours for the monthly schedule.
    monthMns - The schedule time in minutes for the monthly schedule.
    monthTimeCrit - The criteria for monthly schedule.
    monthlyCheck - Whether the report should be generated only for weekdays or for all days.
    onceOnlyTime - The time and date at which the report has to be scheduled.
    onceTimeCrit - The criteria for the only one time schedule.
    http://localhost:8060/api/json/v2/fwasettings/addFWASchedule?apiKey=ecf7691a575255636e2c28bba73ae213
    setFWAScheduleStatus POST To enable or disable the schedules. TASKNAME - Name of the schedule task. http://localhost:8060/api/json/fwasettings/setFWAScheduleStatus?apiKey=ecf7691a575255636e2c28bba73ae213
    deleteFWASchedule POST To delete the existing schedule. TASKNAME - Name of the schedule task. http://localhost:8060/api/json/fwasettings/deleteFWASchedule?apiKey=ecf7691a575255636e2c28bba73ae213

     

     

    Report Filter:

    REST API Method Description Parameters Sample URL
    getFilterList GET To get the list of filters already added. userId - User ID http://localhost:8060/api/json/fwareporttab/getFilterList?userId=1&apiKey=ecf7691a575255636e2c28bba73ae213
    getProtoList** GET To get the list of protocols. NIL http://localhost:8060/api/json/fwareporttab/getProtoList?apiKey=ecf7691a575255636e2c28bba73ae213
    addOrEditFilter** POST To create or edit the report filters userId - User ID (eg : 1)
    filterName - Name of the filter.
    fType - Type of the filter.
    protocols - list of protocols selected for the filter.(comma seperated)
    src - source addresses for the filter.(comma seperated)
    dst - destination addresses for the filter.(comma seperated)
    pri - Events selected for the filters(comma seperated)
    user - The users to be included in the filter.(comma seperated)
    mode - Mode of operation(add|edit).
    http://localhost:8060/api/json/fwareporttab/addOrEditFilter?apiKey=ecf7691a575255636e2c28bba73ae213
    getFilterDetails GET To get the filter details filterName  -  Name of the filter http://localhost:8060/api/json/fwareporttab/getFilterDetails?filterName=asd&apiKey=ecf7691a575255636e2c28bba73ae213
    deleteFilter POST To delete the filter filters  - The filter to be deleted. http://localhost:8060/api/json/fwareporttab/deleteFilter?apiKey=ecf7691a575255636e2c28bba73ae213

     

     

    Report Type:

    REST API Method Description Parameters Sample URL
    getAllReportList GET To get all reports list configured. frmRptType - is the page report type or not(true|false) http://localhost:8060/api/json/fwareporttab/getAllReportList?frmRptType=true&apiKey=ecf7691a575255636e2c28bba73ae213
    addCustomReport POST To add the custom reports mode  - Mode of action (add)
    perName - Report based on criteria. 
    reportName-Name of the report 
    type - Type of the report 
    graphType - Type of graph  
    yaxis- value on yaxis 
    xaxis - value on xaxis 
    groupBy-Groupby condition 
    orderBy - orderBy condition  
    selectedHeaders - Selected headers for table(comma seperated)
    rbbgid - ReportBuilding block group id. 
    http://localhost:8060/api/json/fwareporttab/addCustomReport?apiKey=ecf7691a575255636e2c28bba73ae213

     

     

     

    Compliance:

    Rule Management:

     

    REST API Method Description Parameters Sample URL
    getOverviewDetails GET To get Policy overview report names and selected device policy details and able to search across the reports DEVICEID - Firewall ID
    policyID - policy id's
    rbbName - rbbname
    _search - boolean
    nd - long
    rows - long
    page - long
    sortByColumn - only alphabets
    sortByType - only alphabets
    filters - json object
    http://localhost:8060/api/json/ffwacompliance/getpolicyOverview?DEVICEID=2&policyID=2%2C3%2C4%2C5%2C6%2C7%2C8%2C9%2C10%2C11%2C12%2C13%2C14%2C15%2C16%
    2C17%2C18%2C19%2C20%2C21%2C22%2C23%2C24%2C25%2C26%2C27%2C28%2C29%2C30%2C31%2C32%2C33%2C34%2C35%2C36%2C37%2C38%2C39%2C40%2C41%2C42%
    2C43%2C44%2C45%2C46%2C47%2C48%2C49%2C50%2C51%2C52%2C53%2C54%2C55%2C56%2C57%2C58&rbbName=Total+Rules&_search=true&nd=1557391515909&rows=20&
    page=1&sortByColumn=Starton&sortByType=desc&filters=%7B%22groupOp%22%3A%22AND%22%2C%22rules%22%3A%5B%7B%22field%22%3A%22policyname%22%2C%22op%22%
    3A%22bw%22%2C%22data%22%3A%22dmz%22%7D%5D%7D&apiKey=ecf7691a575255636e2c28bba73ae213
    getpolicyOverview GET To get Policy data DEVICEID - Firewall ID
    policyID - Policy ID (Comma separated number for cisco)
    rbbName - Selected statictic report name
    http://localhost:8060/api/json/fwacompliance/getpolicyOverview?DEVICEID=601&policyID=320,321,322,323,324,325,326,327&rbbName=Total%20Rules&apiKey=ecf7691a575255636e2c28bba73ae213
    addOrEditRuleMgmtSchedule POST To add and edit rule management schedule
    rid - Firewall ID
    repId - Report id
    resName - Firewall name
    rbbName - Selected Statistic report name
    rbbTitle -  Firewall Display name
    policyID - Policy ID (Comma separated number for cisco)
    schDays - The day on which the report should be generated of the month.
    schHours - At what hours should the report be generated .
    schMns - At what minutes should the report be generated
    repName - Report name (User input)
    mailto - List of emails by comma separator to send report 
    colList - Policy Overview report's Selected column list by comma separator
    action -Action performed(add/edit)
     
    http://localhost:8060/api/json/fwacompliance/addOrEditRuleMgmtSchedule?apiKey=ecf7691a575255636e2c28bba73ae213
    modifyRuleMgmtSchedule POST To change rule management schedule status & To delete rule management schedule policyReportID - Scheduled policy report id

    action - Action performed (enable/disable/delete)
    http://localhost:8060/api/json/fwacompliance/modifyRuleMgmtSchedule?apiKey=ecf7691a575255636e2c28bba73ae213
    loadAnomalyJSON GET To get policy optimization tab details and selected device data rID - Firewall ID http://localhost:8060/api/json/fwacompliance/loadAnomalyJSON?rID=601&apiKey=ecf7691a575255636e2c28bba73ae213
    getPolicyOptimization GET To get policy optimization data for selected device  DEVICEID - Firewall ID
    anomalyType - Selected anomaly type
    http://localhost:8060/api/json/fwacompliance/getPolicyOptimization?DEVICEID=601&anomalyType=all&apiKey=ecf7691a575255636e2c28bba73ae213
    getRuleOptimizationScheduleDetails GET To get policy optimization schedule detail. rid - Firewall ID http://localhost:8060/api/json/fwacompliance/getRuleOptimizationScheduleDetails?rid=601&apiKey=ecf7691a575255636e2c28bba73ae213
    addordeleteOptimizationSchedule POST To add/delete policy optimization schedule
    rid - Firewall ID
    action - Action performed (add/delete)
    taskType - Schedule type (Ex: Once)
    mailId List of emails by comma separator to send report 
    gentime - At what time report should  be generated (Once type schedule time)
    hourlyHrs At what hours report should  be generated 
    hourlyMns At what hours minutes should  be generated 
    weeklyHrs At what hours each week the report should  be generated 
    weeklyMns At what Minutes each week the report should  be generated 
    monthDay - At what day for  each month the report should  be generated 
    monthHrs At what hours each month the report should  be generated 
    monthMns At what Minutes each month  the report should  be generated 
    weekDay At what day for  each week the report should  be generated 
    http://localhost:8060/api/json/fwacompliance/addordeleteOptimizationSchedule?apiKey=ecf7691a575255636e2c28bba73ae213
    getDeviceUnusedDetails GET To get Rule cleanup tab details and selected device unused rule data.
    DEVICEID  - Firewall ID
    startDate - From date
    endDate - To date
    repId  - Report id
    http://localhost:8060/api/json/fwacompliance/getDeviceUnusedDetails?DEVICEID=601&startDate=2019-01-23%2008:52&endDate=2019-01-23%2009:52&repId=1802&apiKey=ecf7691a575255636e2c28bba73ae213
    getRuleReorderList GET To get Rule reorder suggestion data for selected device rID - Firewall ID http://localhost:8060/api/json/fwacompliance/getRuleReorderList?rID=601&apiKey=ecf7691a575255636e2c28bba73ae213
    updateRuleReorderList POST To genereate Rule reorder report
    rID  - Firewall ID
    DateRange Custom date range enabled or disabled value
    timeFrame - Predefined time range
    startDate - Start date of custom range
    endDate - End date of custom range
    urOption - action to process Unresolved data (processUnResolved/skipUnResolved)
    ipData - Unresolved ip details
    serviceData - Unresolved service details
    applicationData - Unresolved application details
    formSubmit - empty value
    http://localhost:8060/api/json/fwacompliance/updateRuleReorderList?rID=601&timeFrame=LastHour&DateRange=false&apiKey=ecf7691a575255636e2c28bba73ae213
    loadPreImpactAnalyzedListJSON GET To get all the generated rule impact report rID  - Firewall ID http://localhost:8060/api/json/fwacompliance/loadPreImpactAnalyzedListJSON?rid=2701&apiKey=ecf7691a575255636e2c28bba73ae213
    getSecurityImpactReport GET to view the generated rule impact report and export rule impact report rID  - Firewall ID
    isExport - boolean
    impactReportId - impactReportId
    type - report type
    exportFWAV2WidData - boolean
    pdfReqFrom FWARuleImpact
    reportTitle - title
    userLocale - used locale
    http://localhost:8060/api/json/fwacompliance/getSecurityImpactReport?rID=2701&impactReportId=6001&type=html&exportFWAV2WidData=true&pdfReqFrom=FWARuleImpact&userLocale=en_US&apiKey=ecf7691a575255636e2c28bba73ae213
    getRuleImpactAnalysisReport POST generate the rule impact report blacklistip - blacklistedip file
    srcnetwork - ipwithnetmask
    srciprange - ip range
    dstnetwork - ipwithnetmask
    dstiprange - ip range
    policyName - policy name
    ruleName - rulename
    position - long
    srcService - service object/group
    dstService - service object/group
    src - network object/group
    dst - network object/group
    srcInt - interface
    dstInt - interface
    service -  service object/group
    action - allow/deny
    DEVICEID - Firewall ID
    objRepRowCount - long
    selRowCount - All
    http://localhost:8060/api/json/fwacompliance/getRuleImpactAnalysisReport?apiKey=ecf7691a575255636e2c28bba73ae213

     

     

    Standards:

    REST API Method Description Parameters Sample URL
    changeWidgetView POST To show selected standard reports in UI
    rID - Firewall ID
    reportID - Report ID
    displayName - Firewall display Name
    deviceType - Firewall vendor
    resourceName - Firewall Name
    selectedWidgets -  Selected standard reports name separated by comma
    http://localhost:8060/api/json/fwacompliance/changeWidgetView?apiKey=ecf7691a575255636e2c28bba73ae213
    saveUserInput POST To update interface details in Edit settings
    rID - Firewall ID
    reportID Report ID
    displayName - Firewall display Name
    deviceType - Firewall vendor
    resourceName - Firewall Name
    userInput - Interface details
    (Ex: LAN=internal&DMZ=dmz)
    eeFwd- show in distributed server(true)
    http://localhost:8060/api/json/fwacompliance/saveUserInput?apiKey=ecf7691a575255636e2c28bba73ae213
    getComplianceDashboard GET To get standards page details and selected device data NIL http://localhost:8060/api/json/fwacompliance/getComplianceDashboard?apiKey=ecf7691a575255636e2c28bba73ae213
    regenerate POST To generate standard Report
    rID - Firewall ID
    reportID Report ID
    reportName - Standard report name
    displayName - Firewall display Name
    deviceType - Firewall vendor
    resourceName - Firewall Name
    userInput - Interface details
    (Ex: LAN=internal&DMZ=dmz)
    eeFwd- show in distributed server(true)
    isServiceChanged*** - status of exclude service update 
    userInput*** - Interface details
    http://localhost:8060/api/json/fwacompliance/regenerate?apiKey=ecf7691a575255636e2c28bba73ae213
    parseConfig POST To fetch latest firewall configuration of selected firewall rid - Firewall ID http://localhost:8060/api/json/fwacompliance/parseConfig?rid=601&apiKey=ecf7691a575255636e2c28bba73ae213
    scheduleList POST To get standard report schedules rid - Firewall ID http://localhost:8060/api/json/fwacompliance/scheduleList?apiKey=ecf7691a575255636e2c28bba73ae213
    addReport POST To add schedule for standards report
    rid - Firewall ID
    selReport- Selected standard reports separated by comma
    taskType - Schedule type (Ex: Once)
    mailId List of emails by comma separator to send report 
    onceOnlyTime- At what time report should  be generated (Once type schedule time)
    hourlyHrs At what hours report should  be generated 
    hourlyMns At what hours minutes should  be generated 
    weeklyHrs At what hours each week the report should  be generated 
    weeklyMns At what Minutes each week the report should  be generated 
    monthDay - At what day for  each month the report should  be generated 
    monthHrs At what hours for each month the report should  be generated 
    monthMns At what Minutes for each month  the report should  be generated 
    weekDay At what day for  each week the report should  be generated 
    dailyHrs At what hours of daily  the report should  be generated 
    dailyMns At what Minutes of daily the report should  be generated 
    http://localhost:8060/api/json/fwacompliance/addReport?apiKey=ecf7691a575255636e2c28bba73ae213
    editSave POST To edit standard reports schedule
    rid - Firewall ID
    selReport- Selected standard reports separated by comma
    taskType - Schedule type (Ex: Once)
    mailId List of emails by comma separator to send report 
    onceOnlyTime- At what time report should  be generated (Once type schedule time)
    hourlyHrs At what hours report should  be generated 
    hourlyMns At what hours minutes should  be generated 
    weeklyHrs At what hours each week the report should  be generated 
    weeklyMns At what Minutes each week the report should  be generated 
    monthDay - At what day for  each month the report should  be generated 
    monthHrs At what hours for each month the report should  be generated 
    monthMns At what Minutes for each month  the report should  be generated 
    weekDay At what day for  each week the report should  be generated 
    dailyHrs At what hours of daily  the report should  be generated 
    dailyMns At what Minutes of daily the report should  be generated 
    http://localhost:8060/api/json/fwacompliance/editSave?apiKey=ecf7691a575255636e2c28bba73ae213
    deleteSingle POST To delete standard reports schedule reportName - Standard report name
    rid - Firewall id
    http://localhost:8060/api/json/fwacompliance/deleteSingle?apiKey=ecf7691a575255636e2c28bba73ae213

     

     

     

    Change Management:

     

    REST API Method Description Parameters Sample URL
    getDeviceChanges GET To get Change Management Report data 
    DEVICEID -  Firewall ID
    DateRange - Custom date range enabled or disabled value
    timeFrame - Predefined time range
    startDate - Start date of custom range
    endDate - End date of custom range
    applyTimeCriteria*** -  Time criteria identifier  
    http://localhost:8060/api/json/fwacompliance/getDeviceChanges?DEVICEID=301&DateRange=true&startDate=2019-01-20%2000:00&endDate=2019-01-23%2005:54&apiKey=ecf7691a575255636e2c28bba73ae213
    getChangeMgmtSchDetail GET To get change management schedule details. rID - Firewall ID
     
    http://localhost:8060/api/json/fwacompliance/getChangeMgmtSchDetail?rID=601&apiKey=ecf7691a575255636e2c28bba73ae213
    getChangeMgmtNotiDetail GET To get change management notification details. rID - Firewall ID http://localhost:8060/api/json/fwacompliance/getChangeMgmtNotiDetail?rID=601&apiKey=ecf7691a575255636e2c28bba73ae213
    setChangeMgmtSchDetail POST To set change management schedule details. rID - Firewall ID
    ScheduleMailId - Schedule mail id
    selectedCMDay - Selected day
    selectedCMHour - selected hour
    selectedCMMinute - selected minute
    selRptOption - selected report option
    reportType- report type (pdf/csv)
    http://localhost:8060/api/json/fwacompliance/setChangeMgmtSchDetail?apiKey=ecf7691a575255636e2c28bba73ae213
    setChangeMgmtNotiDetail POST To set change management notification details. rID - Firewall ID
    NotiMailId - Notification mail id
    toNumber - Notification mobile number.
    http://localhost:8060/api/json/fwacompliance/setChangeMgmtNotiDetail?apiKey=ecf7691a575255636e2c28bba73ae213

     

     

     

    Security Audit:

     

    REST API Method Description Parameters Sample URL
    getSecurityAudit GET To get security Audit report of selected Firewall rID - Firewall ID http://localhost:8060/api/json/fwacompliance/getSecurityAudit?rID=301&apiKey=ecf7691a575255636e2c28bba73ae213
    getSecurityAuditPDFFile GET To export Security audit report rID - Firewall ID
    pdfFileName - Name of File name (format : <Firewall Name>_ComplianceReport.pdf)
    http://localhost:8060/api/json/fwacompliance/getSecurityAuditPDFFile?rID=601&pdfFileName=CiscoASA_ComplianceReport.pdf&apiKey=ecf7691a575255636e2c28bba73ae213

     

     


    Common:

     


    REST API Method Description Parameters Sample URL
    getDDIDResourcesInfo GET To get Firewall list and mark first device which configured in Device rule listType - Type to get data for selected device (ruleDeviceList) http://localhost:8060/api/json/fwacompliance/getDDIDResourcesInfo?listType=ruleDeviceList&apiKey=ecf7691a575255636e2c28bba73ae213

     

     

     


    REST API Method Description Parameters Sample URL
    getSearchTabList get to get search criteria sMode  -             Search type
    selectedDevices - Selected devices list
    criteria - Search criterias
    matchStatus - match condition (or & and)
    http://localhost:8060/api/json/fwasearch/getSearchTabList?sMode=agg&selectedDevices=127.0.0.1%2CCiscoVPN&criteria=%5B%7B%22key%22%3A%22Protocol%22%2C%22operator%22%3A%22isn%27t%22%2C%22value%22%3A%22null%22%7D%5D&matchStatus=OR&apiKey=ecf7691a575255636e2c28bba73ae213
    getAggSearchData get To get aggregated search result                                         sMode  - Search type
    selectedDevices - Selected devices list
    criteria - Search criterias
    matchStatus - match condition (or & and)
    rbbName - Report name
    completeData - to apply the row numbers
    reportParams - Array which contains time criteria
    _search - to find search type
    row - row count
    page - page number
    sortByColumn - sort by column number
    sortByType - ascending or desending order
    http://localhost:8060/api/json/fwasearch/getAggSearchData?sMode=agg&selectedDevices=FGT1000R%2CFGT100D186_Sim&criteria=%5B%7B%22key%22%3A%22Source%22%2C%22operator%22%3A%22starts+with%22%2C%22value%22%3A%22192.168.%22%7D%5D&matchStatus=OR&rbbName=Mgmt+Details&completeData=true&reportParams=%7B%22applyTimeCriteria%22%3A%22true%22%2C%22timeFrame%22%3A%22today%22%7D&_search=false&nd=1548141634333&rows=50&page=1&sortByColumn=Starton&sortByType=desc&apiKey=ecf7691a575255636e2c28bba73ae213

     
    getIndexInfo get To get Raw settings configuration details NIL http://localhost:8060/api/json/fwaglobal/getIndexInfo?apiKey=ecf7691a575255636e2c28bba73ae213
    getIndexInfo get To update Raw settings configuration details mode - save
    rawSearch - enabled or disabled
    indexAll-  index traffic & security logs (true or false)
    indexSecurity - index security logs only (true or false)
    http://localhost:8060/api/json/fwaglobal/getIndexInfo?mode=save&rawSearch=enabled&indexAll=true&indexSecurity=false&apiKey=ecf7691a575255636e2c28bba73ae213
    getRawColList get To get Raw search result columns based on search option NIL http://localhost:8060/api/json/fwasearch/getRawColList?apiKey=ecf7691a575255636e2c28bba73ae213
    getRawData get  To get Raw serach result selectedDevices - Selected firewall/proxy devices with comma separator
    criteria - Search criteria
    matchStatus-  match condition (or & and)
    type - Result type (formatted or raw)
    completeData - Default row count identifier (always true)
    reportParams - Time criteria and index details
    logFormat - Used to get result columns based on serach type (s or u or proxy)
    dataType -  Serach type identifier
    log - Serach criteria for Database update
    sLogType - Serach log option number with comma separated
    (1 for selected option and 0 for non-selected)
    _search - client generated value (always false)
    nd - number
    rows - row count
    page - Page number
    sidx - Sort index (empty value)
    sord - Sort type (asc)
     
    http://localhost:8060/api/json/fwasearch/getRawData?selectedDevices=FGT1000R&criteria=%5B%7B%22key%22%3A%22Protocol%22%2C%22operator%22%3A%22isn%27t%22%2C%22value%22%3A%22null%22%7D%2C%7B%22key%22%3A%22Source%22%2C%22operator%22%3A%22starts+with%22%2C%22value%22%3A%22192.168%22%7D%5D&matchStatus=AND&type=formatted&completeData=true&reportParams=%7B%22applyTimeCriteria%22%3A%22true%22%2C%22startDate%22%3A%222019-01-22+01%3A00%22%2C%22endDate%22%3A%222019-01-22+15%3A59%22%2C%22partialCountDetails%22%3A%22335_-2%22%2C%22startIndex%22%3A%220%22%2C%22totalPoint%22%3A%220_0_0%22%2C%22endPoint%22%3A%222147483647_0%22%2C%22basicCount%22%3A%22335%22%2C%22basicDocIdArr%22%3A%226707_6502%22%2C%22storedPoint%22%3A%22-1_-1%22%2C%22endIndex%22%3A%220%22%2C%22startPoint%22%3A%222147483647_0%22%7D&logFormat=s&dataType=raw&log=&sLogType=1%2C1%2C1%2C1%2C1&_search=false&nd=1548153010968&rows=500&page=1&sidx=&sord=asc&apiKey=ecf7691a575255636e2c28bba73ae213
    saveAsProfile POST To save search result as custom Report profile
    sMode  - Search type (agg or raw)
    selectedDevices - Selected firewall/proxy devices with comma separator
    Search criteria
    matchStatus-  match condition (or & and)
    profileName - Custom report name
    selectedRpt - Selected Reports of Aggregated search result separated by comma
    userId - Logged in User ID 
    selectedCols - Selected column index number of raw search result separated by '-'
    logFormat - Used to get result columns based on serach type (s or u or proxy)
    dataType -  Serach type identifier
    log - Serach criteria for Database update
    sLogType - Serach log option number with comma separated
    (1 for selected option and 0 for non-selected)
    mode - Save
    addSchedule - Enable schedule (true or false)
    rptType - Type of the report (Pdf or CSV). 
    emailId - List of emails to send notifications.
    subject - subject for the email
    note - note for the email
    schType - Type of the schedule (Ex: Hourly).
    onceOnlyTime - Executed only once at time on date.
    onceTimeCrit - The criteria for the once report.
    dailyHrs - To send report at specified hours daily.
    dailyMns - To send report at specified minutes daily.
    dailyTimeCrit - The criteria for the daily Time.
    nonworkHour - Whether report for nonwork hour or working hour.
    startTime - Start time for the workhour.
    endTime - endTime for the workhour.
    dailyCheck - is it run daily or only on weekdays.
    hourlyHrs - At what hour should the report generate.
    hourlyMns - At what minute should the report generate.
    hourlyTimeCrit - The criteria for the hourly report.
    monthHrs - At what hours should the report be generated for a month.
    monthMns - At what minutes should the report be generated for a month.
    monthDay - The day on which the report should be generated for each month.
    monthTimeCrit - The criteria for the month.
    monthlyCheck - Whether the report is for weekdays only or all days.
    weeklyHrs - The hour at which the report should be generated each week
    weeklyMns - The minutes at which the report should be generated each week.
    weekDay - The day on which the report should be generated each week.
    weeklyTimeCrit - The criteria for the week.
    weeklyCheck - Whether it is run only on week days or all days.
    http://localhost:8060/api/json/fwasearch/saveAsProfile?apiKey=ecf7691a575255636e2c28bba73ae213

     


     

    Settings:

    Syslog Server:
     

    REST API Method Description Parameters Sample URL
    handleSyslogAction POST To change syslog port listening status & delete syslog port  action-change status/delete port (stop,restart,delete)
    sys_id -  Selected Syslog server id
    sys_port - UDP port(1514|1515 etc)
    http://localhost:8060/api/json/fwasettings/handleSyslogAction?apiKey=ecf7691a575255636e2c28bba73ae213
    addNewSyslogServer POST To add new syslog listener port serverName -  profile name (user input)
    syslogPort -  UDP port to receive syslogs forwarded from firewall(1514|1515 etc)
    http://localhost:8060/api/json/fwasettings/addNewSyslogServer?apiKey=ecf7691a575255636e2c28bba73ae213
    showLiveSyslog GET To view live streaming of sylogs for specific UDP port key -  Selected Syslog server id http://localhost:8060/api/json/fwaglobal/showLiveSyslog?key=602&apiKey=ecf7691a575255636e2c28bba73ae213
    getSyslogServerTableData GET To view the list of syslog servers that have been configured NIL http://localhost:8060/api/json/fwasettings/getSyslogServerTableData?apiKey=ecf7691a575255636e2c28bba73ae213
    getLivePacketCount GET To get the number of packets of data received through the syslogs configured. NIL http://localhost:8060/api/json/fwaglobal/getLivePacketCount?apiKey=ecf7691a575255636e2c28bba73ae213

     

    Diagnose Connections:

    REST API Method Description Parameters Sample URL
    getFWAResourceDetails GET To get the resources of type cisco or netscreen. NIL http://localhost:8060/api/json/fwasettings/getFWAResourceDetails?apiKey=ecf7691a575255636e2c28bba73ae213
    diagnoseFWConnection POST To check if the selected firewall is reachable or not(available for cisco and netscreen firewalls) resourceId - Resource ID (eg: 1)
    associatedDeviceProfileId - The credential profile ID associated with the device.
    associatedDeviceProfileName- The credential profile ID associated with the device.
    deviceType - Type of the device.
    ciscoType - Type of cisco if the vendor is cisco(ASA|PIX|FWSM).
    lhs[0-9]* - Corresponds to the left hand side criterias(Source IP|Destination IP|Protocol|Source Port|Dest Port)
    rhs[0-9]* - Corresponds to the right hand side values(Values corresponding to the selected criteria in the left hand side).
    http://localhost:8060/api/json/fwasettings/diagnoseFWConnection?apiKey=ecf7691a575255636e2c28bba73ae213

     

     

     

    Availability Alert:

    REST API Method Description Parameters Sample URL
    getFWAAvailabilityAlert GET To get the list of availability alerts already configured. NIL http://localhost:8060/api/json/fwasettings/getFWAAvailabilityAlert?apiKey=ecf7691a575255636e2c28bba73ae213
    handleAvailabilityAlert POST To enable or disable or delete the availability alert. mode - Whether it is enabled or disabled.(enable|disable|delete)
    faa_id - firewall availablity alert id.(eg : 2)
    http://localhost:8060/api/json/fwasettings/handleAvailabilityAlert?apiKey=ecf7691a575255636e2c28bba73ae213
    addAvailabilityAlert POST To add firewall availability alert selectedDevices - The list of selected Devices.(comma seperated values)(1,2,3...)
    timeInterval - The timeinterval to report for when the logs do not reach the server.
    toMailId - The mailId to send the notification.
    subject - The subject for the email.
    toNumber - The number to which the notification has to be sent.
    alertType - The type of alert that has been selected.(email|sms|script).
    file filePath -> the script file that has been uploaded.
    http://localhost:8060/api/json/fwasettings/addAvailabilityAlert?apiKey=ecf7691a575255636e2c28bba73ae213

     

     

     

    Device Details:

    REST API Method Description Parameters Sample URL
    getFWDeviceDetails GET To get the device details such as Unsupported logs received, supported logs received, schedules executed. NIL http://localhost:8060/api/json/fwasettings/getFWDeviceDetails?apiKey=ecf7691a575255636e2c28bba73ae213
    getUnparsedLogsSummary GET To get the list of unparsed records. NIL http://localhost:8060/api/json/fwasettings/getUnparsedLogsSummary?apiKey=ecf7691a575255636e2c28bba73ae213
    deleteUnparsedRecords POST To delete the unparsedRecords that are received. resourceName - Name of the resource
    unparsedResource - Unparsed Resource name.
    http://localhost:8060/api/json/fwasettings/deleteUnparsedRecords?apiKey=ecf7691a575255636e2c28bba73ae213
    getScheduleExecutionSummary GET To get the list of schedules that have been executed NIL http://localhost:8060/api/json/fwasettings/getScheduleExecutionSummary?apiKey=ecf7691a575255636e2c28bba73ae213

     

     

     

    Archived Files:

    REST API Method Description Parameters Sample URL
    getArchiveSettingsTableData GET To get the list of files that have been archived. NIL http://localhost:8060/api/json/fwasettings/getArchiveSettingsTableData?apiKey=ecf7691a575255636e2c28bba73ae213
    getArchiveSettingDBValues POST To get and edit the archive setting values. NIL http://localhost:8060/api/json/fwasettings/getArchiveSettingDBValues?apiKey=ecf7691a575255636e2c28bba73ae213

     

     

     

    Customize Reports:

    REST API Method Description Parameters Sample URL
    getResourcesTableInfo** GET To get the list of devices added in the fwanalyzer NIL http://localhost:8060/api/json/fwaglobal/getResourcesTableInfo?apiKey=ecf7691a575255636e2c28bba73ae213
    configureDefaultReports POST To configure the default reports to be listed for the firewalls resId - Resource ID.(eg : 1)
    selectedReports - The reports that are selected for the device.(comma seperated values).(61,62,63,64,65)
    http://localhost:8060/api/json/fwasettings/configureDefaultReports?apiKey=ecf7691a575255636e2c28bba73ae213

     

     

     

    Device Group:

    REST API Method Description Parameters Sample URL
    getDeviceGroup GET To get the device groups that have been configured. NIL http://localhost:8060/api/json/v2/fwadashboard/getDeviceGroup?apiKey=ecf7691a575255636e2c28bba73ae213
    addOrUpdateDeviceGroup POST To Add or update a device group grpName - Name of the group.
    action - action performed(add/update)
    viewId - Id of the group(only in update cases).(eg : 3)
    deviceList - List of devices selected to be added in group(comma seperated value).
    http://localhost:8060/api/json/v2/fwadashboard/addOrUpdateDeviceGroup?apiKey=ecf7691a575255636e2c28bba73ae213
    getResourcesList GET To get the resources list. cid - collector id http://localhost:8060/api/json/fwaenterprise/getResourcesList?selColId=1&apiKey=ecf7691a575255636e2c28bba73ae213

     

     

     

    Data Storage:

    REST API Method Description Parameters Sample URL
    getDataStorageConfigData GET To get the configured data storage for database and archive. NIL http://localhost:8060/api/json/fwasettings/getDataStorageConfigData?apiKey=ecf7691a575255636e2c28bba73ae213

     

     

     

    License Management:

    REST API Method Description Parameters Sample URL
    getFWAInventoryDeviceList GET To get the list of devices added in the fwanalyzer NIL http://localhost:8060/api/json/fwainventory/getFWAInventoryDeviceList?apiKey=ecf7691a575255636e2c28bba73ae213
    manageFirewall POST To manage or unmanage the firewall. devIdList - The list of device IDs selected.(Comma seperated value).(eg : 1,2,3)
    action - The action performed(manage|unmanage).
    http://localhost:8060/api/json/fwasettings/manageFirewall?apiKey=ecf7691a575255636e2c28bba73ae213

     

     

     

    Archive Encryption:

    REST API Method Description Parameters Sample URL
    getArchiveSettingDBValues GET To get the archive setting values currently configured. NIL http://localhost:8060/api/json/fwasettings/getArchiveSettingDBValues?apiKey=ecf7691a575255636e2c28bba73ae213

     

     

     

    Simulate:

    REST API Method Description Parameters Sample URL
    getSimulatorFWDetails GET To get the currently simulated firewall. NIL http://localhost:8060/api/json/fwasettings/getSimulatorFWDetails?apiKey=ecf7691a575255636e2c28bba73ae213
    handleSimulatorFWAction POST To handle the firewall simulator option action - The action performed.(save/delete/stop)
    srcRange - Ip range for the simulator.
    vendor - Vendor type for the simulator.
    http://localhost:8060/api/json/fwasettings/handleSimulatorFWAction?apiKey=ecf7691a575255636e2c28bba73ae213
    removeLearnings POST To remove the device when deletion operation is performed. resourcesList - List of resources removed.(eg : 127.0.0.1) http://localhost:8060/api/json/fwasettings/removeLearnings?apiKey=ecf7691a575255636e2c28bba73ae213

     

     

     

    Protocol Groups:

    REST API Method Description Parameters Sample URL
    getProtocolGroupsTableData GET To get the protocol group data pgName - Name of the page. http://localhost:8060/api/json/fwasettings/getProtocolGroupsTableData?pgName=All&apiKey=ecf7691a575255636e2c28bba73ae213
    importFirewallProfiles** POST To import firewall profiles such as protocol groups/alarm profiles/report profiles type - type of the profile imported.(alert|protocol|report)
    action - action performed(import).
    file importfile -> the file that is uploaded.
    http://localhost:8060/api/json/fwasettings/importFirewallProfiles?type=alert&action=import&apiKey=ecf7691a575255636e2c28bba73ae213
    exportFirewallProfiles** GET To export the firewall profiles such as protocol groups/alarm profiles/report profiles action - action performed(export)
    type - type of the profile exported.(alert|protocol|report)
    http://localhost:8060/api/json/fwasettings/exportFirewallProfiles?apiKey=ecf7691a575255636e2c28bba73ae213
    addUpdateProtocolGroup POST To update/add value in protocol group selProList - Selected list of protocols(comma seperated values)
    pgName - Nmae of the page.
    pgDesc - Description for the page.
    mode - mode of action(add)
    http://localhost:8060/api/json/fwasettings/addUpdateProtocolGroup?apiKey=ecf7691a575255636e2c28bba73ae213
    addUpdateProtocol POST To update/add the value of protocol selectedIdentifiers - The list of identifiers selected.(comma seperated values)
    selectedProto - The protocol that is selected.
    selectedGroup - The protocol group that is selected.
    mode - Mode of action(add)
    http://localhost:8060/api/json/fwasettings/addUpdateProtocol?apiKey=ecf7691a575255636e2c28bba73ae213
    getEditProtocolGroupDetails GET To get the protocol group details for edit action. pgName - Name of the page. http://localhost:8060/api/json/fwasettings/getEditProtocolGroupDetails?pgName=News&apiKey=ecf7691a575255636e2c28bba73ae213
    getEditProtocolDetails GET To get the protocol details for edit action. selProto - Selected protocol name. http://localhost:8060/api/json/fwasettings/getEditProtocolDetails?selProto=nntps&apiKey=ecf7691a575255636e2c28bba73ae213

     

     

     

    Working Hours:

    REST API Method Description Parameters Sample URL
    getWorkingHourData GET To get the configured working hour data. NIL http://localhost:8060/api/json/fwasettings/getWorkingHourData?apiKey=ecf7691a575255636e2c28bba73ae213
    updateWorkingHourConfig POST To update the time in working hours. advSelect - advanced is selected or not.
    workStart - Start hour 
    workEnd - End hour
    advHours - Advanced values for the working hours.(comma seperated values)(10,11,12,13,14,15,16,17,18,19,20)
    http://localhost:8060/api/json/fwasettings/updateWorkingHourConfig?apiKey=ecf7691a575255636e2c28bba73ae213

     

     

     

    DNS:

    REST API Method Description Parameters Sample URL
    getManualDnsMappingData GET To get the configured Dns mapping data. NIL http://localhost:8060/api/json/fwasettings/getManualDnsMappingData?apiKey=ecf7691a575255636e2c28bba73ae213
    getDnsResolveConfigData GET To get the configured resolve config data. NIL http://localhost:8060/api/json/fwasettings/getDnsResolveConfigData?apiKey=ecf7691a575255636e2c28bba73ae213
    updateDnsResolveConfig POST To update the dns resolve configurations dnsOption - The option that is selected(never/on click/automatic)
    dnsMemory - Resolved DNS count in cache(5000/7500/10000)
    http://localhost:8060/api/json/fwasettings/updateDnsResolveConfig?apiKey=ecf7691a575255636e2c28bba73ae213
    handleManualDnsMappingEntries POST To add or edit the dns mapping entries. mode - Mode of action(add|edit|delete).
    dnsIp - Ip to be mapped to the Dns.
    dnsId - ID for the Dns. 
    dnsName - Name of the dns.
    importFile - File with the mapping to be imported(txt|csv formats)
    http://localhost:8060/api/json/fwasettings/handleManualDnsMappingEntries?apiKey=ecf7691a575255636e2c28bba73ae213

     

     

     

    Intranet:

    REST API Method Description Parameters Sample URL
    getIntranetTableData** GET To get the data in intranet settings and exclude hosts. selectedtab - The tab that is selected(intranet/exclude hosts) http://localhost:8060/api/json/fwasettings/getIntranetTableData?selectedtab=Intranet&apiKey=ecf7691a575255636e2c28bba73ae213
    getDeviceIntranetSettings** GET To get the intranet settings for the device selectedTab - The tab that is selected(intranet/exclude hosts)
    devName - Name of the device.
    devId - Id of the device
    http://localhost:8060/api/json/fwasettings/getDeviceIntranetSettings?devId=-1&selectedTab=Intranet&apiKey=ecf7691a575255636e2c28bba73ae213
    addIntranetSettings** POST To add the data for the intranet settings selectedtab - The tab that is selected(intranet/exclude hosts)
    devName - Name of the device.(comma seperated values).
    devId - Id of the device (comma seperated values).
    ipaddress - The ip address in the intranet.(can have multiple values).
    network - network of the intranet.(can have multiple values).
    iprange - iprange of the intranet.(can have multiple values).
    http://localhost:8060/api/json/fwasettings/addIntranetSettings?apiKey=ecf7691a575255636e2c28bba73ae213
    getResourcesTableInfo** GET To get the list of devices added in the fwanalyzer NIL http://localhost:8060/api/json/fwaglobal/getResourcesTableInfo?apiKey=ecf7691a575255636e2c28bba73ae213

     

     

     

    Repository:

    REST API Method Description Parameters Sample URL
    handleCloudRepositoryChanges GET To get the changes that are done in the repository action - The action that is performed(add)
    serName - Name of the service
    cat - The catefory of the service.
    startip - Start ip of the service
    endip - End ip of the service
    ServiceId - Id of the service.
    oldSerId - Old Id of the service(when edit).
    http://localhost:8060/api/json/cloudcontrol/handleCloudRepositoryChanges?action=add&serName=uy&cat=Image+Editing&startip=1.1.1.1&endip=2.2.2.2&apiKey=ecf7691a575255636e2c28bba73ae213
    getCloudCategoryListDetails GET To get the category list of the repository NIL http://localhost:8060/api/json/cloudcontrol/getCloudCategoryListDetails?apiKey=ecf7691a575255636e2c28bba73ae213
    getCloudControlRepositoryTableData GET To get the table data in the repository NIL http://localhost:8060/api/json/cloudcontrol/getCloudControlRepositoryTableData?apiKey=ecf7691a575255636e2c28bba73ae213

     

     

     

    Exclude Hosts:

    REST API Method Description Parameters Sample URL
    getIntranetTableData** GET To get the data in intranet settings and exclude hosts. selectedtab - The tab that is selected(intranet/exclude hosts) http://localhost:8060/api/json/fwasettings/getIntranetTableData?selectedtab=ExcludeHost&apiKey=ecf7691a575255636e2c28bba73ae213
    getResourcesTableInfo** GET To get the list of devices added in the fwanalyzer NIL http://localhost:8060/api/json/fwaglobal/getResourcesTableInfo?apiKey=ecf7691a575255636e2c28bba73ae213
    getDeviceIntranetSettings** GET To get the intranet settings for the device selectedTab - The tab that is selected(intranet/exclude hosts)
    devName - Name of the device.
    devId - Id of the device
    http://localhost:8060/api/json/fwasettings/getDeviceIntranetSettings?devId=-1&selectedTab=ExcludeHost&apiKey=ecf7691a575255636e2c28bba73ae213
    addIntranetSettings** POST To add the data for the intranet settings selectedtab - The tab that is selected(intranet/exclude hosts)
    devName - Name of the device.(comma seperated values)
    devId - Id of the device(comma seperated values)
    ipaddress - The ip address in the intranet.(can have multiple values)
    network - network of the intranet.(can have multiple values)
    iprange - iprange of the intranet.(can have multiple values)
    http://localhost:8060/api/json/fwasettings/addIntranetSettings?apiKey=ecf7691a575255636e2c28bba73ae213

     

     

     

    Username/IP Mapping:

    REST  API Method Description Parameters Sample URL
    getIPToUserMappingDetails GET To get the currently configured user name and ip mapping details NIL http://localhost:8060/api/json/fwasettings/getIPToUserMappingDetails?apiKey=ecf7691a575255636e2c28bba73ae213
    addDHCPServerInFWA POST To add the dhcp server as a device action - Action performed(enable/disable). http://localhost:8060/api/json/fwasettings/addDHCPServerInFWA?apiKey=ecf7691a575255636e2c28bba73ae213
    handleUserIPLookupAssoication POST To handle the user ip lookup association. configType - Type of the configuration.
    server - Type of the server(manual).
    action - Action performed.(assignDevice/clear).
    selDevices - Selected Devices.(comma seperated)
    http://localhost:8060/api/json/fwasettings/handleUserIPLookupAssoication?apiKey=ecf7691a575255636e2c28bba73ae213
    getUserIPLookupServersMappings GET For getting the mapping between server and user. configType - Type of the configuration.
    server - Type of the server.
    http://localhost:8060/api/json/fwasettings/getUserIPLookupServersMappings?configType=manual&server=zxczxc&apiKey=ecf7691a575255636e2c28bba73ae213
    getADToResourceMapping GET To get the resources mapped with the selected AD. ADServerName - Name of the ad server http://localhost:8060/api/json/fwasettings/getADToResourceMapping?ADServerName=adap-dc2&apiKey=ecf7691a575255636e2c28bba73ae213
    disableManualUserIpMappingLookup POST To disable or enable the manual user ip mapping action - Action performed(enable/disable) http://localhost:8060/api/json/fwasettings/disableManualUserIpMappingLookup?apiKey=ecf7691a575255636e2c28bba73ae213
    updateManualUserIPMapServerName POST To update the manual useripmapping action(enable/disable) configType - Type of the configuration
    server - Server name 
    action - Action performed(enable/disable).
    http://localhost:8060/api/json/fwasettings/updateManualUserIPMapServerName?apiKey=ecf7691a575255636e2c28bba73ae213
    handleADToResourceMapping POST To add the active directory and map resources that are required for that active directory. domainName - Name of the domain.
    domainController - Name of the domain controller.
    domainUser - Name of the domain user.
    domainPassword - Password for the domain.
    selectedDevices - Devices that are selected to be mapped to the corresponding active directory.(comma seperated values)
    excludedUsers - User that are to excluded from being added to the active directory(comma seperated values)
    action - Action performed.
    http://localhost:8060/api/json/fwasettings/handleADToResourceMapping?apiKey=ecf7691a575255636e2c28bba73ae213
    disableADProxyLookup POST To disable or enable the activedirectory/proxy mapping action - Action performed(Enabled or disabled). http://localhost:8060/api/json/fwasettings/disableADProxyLookup?apiKey=ecf7691a575255636e2c28bba73ae213
    updateUserIPMappingForAD POST To update the user name and ip mapping for the active directory action - action performed(edit)
    selectedADs - The ADs that are selected.(comma seperated values
    http://localhost:8060/api/json/fwasettings/updateUserIPMappingForAD?apiKey=ecf7691a575255636e2c28bba73ae213

     

     

     

    Exclude Criteria:

     

    REST  API Method Description Parameters Sample URL
    listExcludeCriteria GET To get added exclude criteria list NIL http://localhost:8060/api/json/fwasettings/listExcludeCriteria?apiKey=ecf7691a575255636e2c28bba73ae213
    saveExcludeCriteria POST To add/edit exclude criteria critId - Exclude criteria ID
    items - Selected vendor type and criteria details
    http://localhost:8060/api/json/fwasettings/saveExcludeCriteria?apiKey=ecf7691a575255636e2c28bba73ae213
    updateExcludeCriteriaStatus POST To enable/disable exclude criteria critId - Exclude criteria ID
    enableStatus - value to enable/disable exclude criteria (true or false)
    http://localhost:8060/api/json/fwasettings/updateExcludeCriteriaStatus?apiKey=ecf7691a575255636e2c28bba73ae213
    deleteExcludeCriteria POST To delete Exclude criterias critId - Exclude criteria ID separated by comma http://localhost:8060/api/json/fwasettings/deleteExcludeCriteria?apiKey=ecf7691a575255636e2c28bba73ae213

     

     

    Check Point:


    REST  API Method Description Parameters Sample URL
    getCheckPointTableData GET To get added Checkpoint firewall details NIL http://localhost:8060/api/json/fwasettings/getCheckPointTableData?apiKey=ecf7691a575255636e2c28bba73ae213
    getCheckPointFormSubmitStatus POST To configure checkpoint LEA
    mode - Action performed (add/edit/delete)
    leaid - Checkpoint LEA id
    leaHost - Host Name/IP address
    leaPort - LEA port
    debug - Debug mode status (true or false)
    authLogin - Authentication/Unauthentication Communictaion (true/false)
    newCert - value to create new certificate (true/false)
    opsecName - Lea opsec name 
    opsecKey - Lea opsec password
    opsecSIC - Lea opsec SIC Name
    authType - Lea server authentication Type
    leaSIC -  Lea server SIC Name
    fwName - Checkpoint Host name/IP address (used when delete)
    fwip - Checkpoint Host name/IP address (used when delete)
    http://localhost:8060/api/json/fwasettings/getCheckPointFormSubmitStatus?apiKey=ecf7691a575255636e2c28bba73ae213
    getCheckPointEditData GET To edit Checkpoint LEA configuration leaHost - Checkpoint Host name/IP address http://localhost:8060/api/json/fwasettings/getCheckPointEditData?leaHost=test&apiKey=ecf7691a575255636e2c28bba73ae213

     

    Imported Logs:


    REST  API Method Description Parameters Sample URL
    getImportedLogTableData GET To get Imported log file details NIL http://localhost:8060/api/json/fwasettings/getImportedLogTableData?apiKey=ecf7691a575255636e2c28bba73ae213
    getLocalImportOptions** GET To get Local import options NIL http://localhost:8060/api/json/fwasettings/getLocalImportOptions?apiKey=ecf7691a575255636e2c28bba73ae213
    handleLocalHostImport POST To import file from Local server
    importType - File import type
    logtype - import file from local server
    ignoreUnParsedRecords - Value to drop unparsed records while reading file
    considerAsVdom - Value to consider Firewall as Virtual firewall while add device
    assignDeviceName - Assign Imported logs to already added Firewall/Proxy
    vdomIPAddress - Ip address of Virtual firewall
    dirName - Folder path to import
    schFile - Absoluet path of file for scheduled import
    patternCombo -value to select file name pattern (true/false) 
    filePattern - Selected file name Pattern
    scheduleTime - Import schedule time
    timeTostartHour - Hour to start schedule
    timeTostartMins - Minutes to start schedule
    http://localhost:8060/api/json/fwasettings/handleLocalHostImport?importType=schedule&logtype=local&ignoreUnParsedRecords=true&considerAsVdom=false&schFile=E%3Atest.txt&scheduleTime=15&timeTostartHour=17&timeTostartMins=00&patternCombo=true&filePattern=test_dd&apiKey=ecf7691a575255636e2c28bba73ae213
    handleImportScheduleAction POST To enable/diasble import schedule imp_id - Import log id
    status - value to enable/disable schedule (enable/disable
    http://localhost:8060/api/json/fwasettings/handleImportScheduleAction?apiKey=ecf7691a575255636e2c28bba73ae213
    deleteImportedFiles POST To delete imported log file details imp_id - Import log id separated by comma http://localhost:8060/api/json/fwasettings/deleteImportedFiles?apiKey=ecf7691a575255636e2c28bba73ae213
    handleRemoteHostImport POST To import file from remote host
    importType - File import type
    logtype - import file from remote server
    remotehostName - Server name
    remoteuserName - User name
    remotepasswd -  Password
    protocol - Selected protocol
    ftpPort - protocol port (21/22)
    remoteIgnoreUnParsedRecords - Value to drop unparsed records while reading file
    remoteConsiderAsVdom  - Value to consider Firewall as Virtual firewall while add device
    assignDeviceName - Assign Imported logs to already added Firewall/Proxy
    remoteVdomIPAddress - Ip address of Virtual firewall
    dynamic - value to select file name pattern (true/false) 
    pattern - Selected file name Pattern
    remoteTime - Import schedule time
    timeTostartHour - Hour to start schedule
    timeTostartMins - Minutes to start schedule
    remotefilelocation - File location
    remotedirlocation - Folder location
    http://localhost:8060/api/json/fwasettings/handleRemoteHostImport?apiKey=ecf7691a575255636e2c28bba73ae213

     

     
     

    Device Rule:

     
    REST  API Method Description Parameters Sample URL
    listDC GET To get added device rule details NIL http://localhost:8060/api/json/fwacompliance/listDC?apiKey=ecf7691a575255636e2c28bba73ae213
    listVDOM GET To get vdom firewall details of a device rule ddid - Device rule id http://localhost:8060/api/json/fwacompliance/listVDOM?ddid=1&apiKey=ecf7691a575255636e2c28bba73ae213
    deleteVDOM POST To delete virtual firewall from device rule ddid - Device rule id
    rid - Firewall id
    isProfBased - True if device rule added using credential
    http://localhost:8060/api/json/fwacompliance/deleteVDOM?apiKey=ecf7691a575255636e2c28bba73ae213
    addOrEditDCPreRender GET To add or edit the device rule that are configured ddid - Device rule id.
    devName - Device for which the device rule is configured.
    resName - ResourceName for which the device rule is configured.
    isProfBased - Is is profile based or not.
    http://localhost:8060/api/json/fwacompliance/addOrEditDCPreRender?apiKey=ecf7691a575255636e2c28bba73ae213
    addOrEditDC POST To add or edit the device rule 
    fetchMode - Mode of configuration fetching
    devType -Vendor type
    attributesOverwritten - Value names separated by comma
    selectedDeviceName - Firewall name
    selectedProtocol - Protocol
    protocol - Protocol port
    associatedDeviceProfileName- Credential profile name
    isProfBased - value to check if profile associated
    fetchFrom - Fetch otipon (Firewall/File/API)
    deviceIP  - Firewall IP
    loginName - User login name
    password - Password
    adminPriv - is Given user has adminitrator privilege (true/false)
    bannerPrompt - banner prompt
    bannerInput -  banner prompt
    prompt - CLI prompt
    enableCommand  - Enable command
    enableUserName - Enable User name
    enablePassword - Enable password
    enablePrompt - enable prompt
    port - Protocol port
    loginPrompt - Login prompt
    passwordPrompt - Password prompt
    enableUserPrompt  - Enable user prompt
    enablePasswordPrompt - Enable password prompt
    command - Fetch rule commad for test action
    dipid - profile id
    devRules - value of fetch rule selection
    schedule - Schedule typs
    selectedDay - Day of month to fetch Rule/Configurtion for Fetct rules/Security audit report
    selectedHour - Hour of month to fetch Rule/Configurtion for Fetct rules/Security audit report
    selectedMinute - Hour of month to fetch Rule/Configurtion for Fetct rules/Security audit report
    genConfMgmtRpt - value of change management report selection
    genCompRpt - value of security audit report
    NotiMailId - Mail id to send On demand change notification
    ScheduleMailId - Mail id to send change management report
    toNumber - Number to send On demand change notification
    selectedCMDay - Day of month to fetch Configurtion for change management report
    selectedCMHour - Day of month to fetch Configurtion for change management report
    selectedCMMinute -Day of month to fetch Configurtion for change management report
    selRptOption - Time period of schedule report 
    reportType - Type of scheduled report (pdf/csv)
    notifyType - Notification type for schedules
    mode - Action performed
    ddid - Device rule id
    ruleFileName - Name of importing rule file
    ruleFilePath - Path of  importing rule file
    configFileName - Name of importing Configuration file
    configFilePath - Path of  importing Configuration file
    webServerPath - Webserver path of Checkpoint firewall
    userName - User name of Checkpoint firewall
    domain - Domain details of Checkpoint firewall
    http://localhost:8060/api/json/fwacompliance/addOrEditDC?apiKey=ecf7691a575255636e2c28bba73ae213
    testCredential POST To test given  credential of Firewall
    fetchMode - Mode of configuration fetching
    devType -Vendor type
    attributesOverwritten - Value names separated by comma
    selectedDeviceName - Firewall name
    selectedProtocol - Protocol
    protocol - Protocol port
    associatedDeviceProfileName- Credential profile name
    isProfBased - value to check if profile associated
    fetchFrom - Fetch otipon (Firewall/File/API)
    deviceIP  - Firewall IP
    loginName - User login name
    password - Password
    adminPriv - is Given user has adminitrator privilege (true/false)
    bannerPrompt - banner prompt
    bannerInput -  banner prompt
    prompt - CLI prompt
    enableCommand  - Enable command
    enableUserName - Enable User name
    enablePassword - Enable password
    enablePrompt - enable prompt
    port - Protocol port
    loginPrompt - Login prompt
    passwordPrompt - Password prompt
    enableUserPrompt  - Enable user prompt
    enablePasswordPrompt - Enable password prompt
    command - Fetch rule commad for test action
    webServerPath - Webserver path of Checkpoint firewall
    userName - User name of Checkpoint firewall
    domain - Domain details of Checkpoint firewall
    http://localhost:8060/api/json/fwacompliance/testCredential?apiKey=ecf7691a575255636e2c28bba73ae213
    deleteDC POST To delete device rule ddid - Device rule ids separated by comma http://localhost:8060/api/json/fwacompliance/deleteDC?apiKey=ecf7691a575255636e2c28bba73ae213
    genCompRpt POST To generate on demand report rID - Firewall ID
    fType - Fetch type
    genCM - Value to denote Security audit selelecd or not
    compRptType - Report type
    http://localhost:8060/api/json/fwacompliance/genCompRpt?apiKey=ecf7691a575255636e2c28bba73ae213
    storeFetchFiles POST To upload imported Rule & Configuratin file deviceName - Firewall name
    deviceType - Vendor type
    rule - Rule file 
    config - Configuration file
    http://localhost:8060/api/json/fwacompliance/storeFetchFiles?apiKey=ecf7691a575255636e2c28bba73ae213
    fetchBrowseRules POST To Import rule for generating on demand report rID - Firewall ID
    ddid - Device rule id
    isVdom - Value to identify vdom or not
    importType  -  Rules
    ruleFileName - Rule File name
    http://localhost:8060/api/json/fwacompliance/fetchBrowseRules?apiKey=ecf7691a575255636e2c28bba73ae213
    importBrowseConfiguration POST To Import Configuration  for generating ondemand report rID - Firewall ID
    compRptType - Report type
    configFile - Config file
    http://localhost:8060/api/json/fwacompliance/importBrowseConfiguration?apiKey=ecf7691a575255636e2c28bba73ae213

     

     

    Credential Profile:

     
    REST  API Method Description Parameters Sample URL
    listDIP GET To get credential profiles list NIL http://localhost:8060/api/json/fwacompliance/listDIP?apiKey=ecf7691a575255636e2c28bba73ae213
    dipPrerender GET To get device rule supported device list   NIL http://localhost:8060/api/json/fwacompliance/dipPrerender?apiKey=ecf7691a575255636e2c28bba73ae213
    addOrEditDIP POST To add/edit credential profile
    dipid - profile id
    deviceInfoProfileName - profile name
    deviceInfoProfileDesc - profile description
    protocol - Selected protocol
    loginName - User login name
    password - Password
    adminPriv - is Given user has adminitrator privilege (true/false)
    bannerPrompt - banner prompt
    bannerInput -  banner prompt
    prompt - CLI prompt
    enableCommand  - Enable command
    enableUserName - Enable User name
    enablePassword - Enable password
    enablePrompt - enable prompt
    port - Protocol port
    loginPrompt - Login prompt
    passwordPrompt - Password prompt
    enableUserPrompt  - Enable user prompt
    enablePasswordPrompt - Enable password prompt
    deviceTypeInfo - Vendor type
    command - Fetch rule commad for test action
    selectedProtocol - Selected protocol to fetch configuration
     
    http://localhost:8060/api/json/fwacompliance/addOrEditDIP?apiKey=ecf7691a575255636e2c28bba73ae213

     

     

    Alarm Profiles:

    REST  API Method Description Parameters Sample URL
    getAlarmTabs GET To get the alarmprofile configured timeFrame - Time Range for the alarms.
    DateRange - Whether date is configured or not.
    http://localhost:8060/api/json/fwaalarms/getAlarmTabs?timeFrame=LastDay&DateRange=false&apiKey=ecf7691a575255636e2c28bba73ae213
    updateAlertProfileStatus POST To change the status of alert profile nf_id - id of the alert profile.
    alertType - Type of the alert profile.
    enable - is alert enabled or disabled.
    http://localhost:8060/api/json/fwaalarms/updateAlertProfileStatus?nf_id=301&alertType=Bandwidth&enable=false&apiKey=ecf7691a575255636e2c28bba73ae213
    populateAlertForm POST Entering the required details for creating the alert profileid - ID of the profile (eg : 1).
    mode - Mode of action
    profileType - Type of the profile.
     profileAction - Action performed on profile.
    newRequest - whether it is new request or not.
    profileName - Name of the profile.
    firewallName - Name of the firewalls.
    matchStatus - OR or AND.
    searchFields - The value for searching.
    criticality - criticality of the alert.
    eventCount - Number of events for which alarm is to be generated.
    timeInMinutes - Time in minutes.
    alertOwner - Owner assigned for the alert.
    applyThresholdFor - Minimum threshold to be applied.  
    notiFrequency - Frequency at which the notification is to be generated.
    reportType - Type of the report.
    timeCondition - Time Condition.
    timeValue - Time value.
    sourceCondtion - condition set for the source.
    sourceCondition - Condition set for the source.
    sourceCountryCondition - condition set for the source country.
    sourceCountryValue - Value entered for the sourceCountry.
    destCountryCondition - Condition set for the destination country.
    destCountryValue - Value entered for the destination country.
    sourceValue - Value entered for the source.
    protocolCondition - condition set for the protocol.
    protocolValue - Value entered for the protocol.
    destinationCondtion - Condition entered for the destination.
    destinationValue - Value entered for the destination.
    userCondition - condition entered for the user.
    userValue - Value entered for the user.
    ruleCondition - Condtion entered for the rule.
    ruleValue - Value entered for the rule.
    attackCondition - Condition entered for the attack.
    attackValue - Value entered for the attack.
    virusCondition - Condition entered for the virus.
    virusValue - Value entered for the virus.
    vpnCondition - Condition entered for the vpn.
    vpnValue - Value entered for the vpn.
    groupVpnCondition - Condition entered for the groupVpnCondition.
    groupVpnValue - Value entered for the groupVpn.
    urlCondition - Condition entered for the url.
    urlValue - Value entered for the url.
    categoryCondition - Condition entered for the category.
    categoryValue - Value entered for the category.
    appCondition - Condition entered for the application.
    appValue - Value entered for the application.
    messageCondition - Condition entered for the message.
    messageValue - Value entered for the message.
    severityCondition - Condition entered for the severity.
    severityValue - Value entered for the severity.
    timeThreshold - Threshold set for the time
    subReportType - subReportType set.
    subCritType - Sub criteria type set.
    sumThreshold - Threshold for the sum set.
    sumThresholdUnit - Unit for the sum threshold.
    anomalyCriticality - Criticality of the anomaly.
    anomalyAlertOwner - Owner for the anomaly alert.
    queryInterval - Interval for the query.
    BWsearchFields - Set of conditions set for the bandwidth type alert.
    advNotifierSelected - Advanced notifier is selected or not.
    advNotiTimer - Advanced notification Timer
    notificationDays - Days on which notification should be triggered.
    notificationHours - Hour at which the notification should be triggered for that day.
    notificationMins - Minutes at which the notification should be triggered for that particular day and hour.
    emailselected - Whether the email notification has been enabled or not.
    mailId - The email ids to which the notification should be sent.
    alertSub - Subject for the alert.
    comment - Comment for the alert.
    smsselected - Whether the sms notification has been enabled or not.
    smsno - The number to which the sms notification should be sent.
    runscriptselected - Whether run a script option has been selected or not.
    scriptArgs - Arguments to be added for the script.
    scriptName - Name for the script.
    http://localhost:8060/api/json/fwaalarms/populateAlertForm?apiKey=ecf7691a575255636e2c28bba73ae213
    viewAlarmProfileDetails GET To view the alarms generated for a particular profile alarmID - Id of the alarm profile.
    alarmType - Type of the alarm profile(alert/anomaly/bandwidth)
    alarmName - Name of the alarm profile.
    page - Page number
    rows - Number of Rows to be displayed.
    sortByColumn - Based on which column the sorting is to be done.
    sortByType - Type of sort(asc/desc)
    pdfReqFrom - Where the req is from for generating pdf(used in phantom)
    exportFWAV2WidData - Whether the export is selected or not(used in phantom).
    header - Header for the report.
    title1 - Title 1 for the report.
    value1 - Value for the title1.
    title2 - Title 2 for the report.
    value2 - Value for the title 2
    http://localhost:8060/api/json/fwaalarms/viewAlarmProfileDetails?alarmID=301&alarmType=Alert&alarmName=testalertnormal&rows=50&page=1&sortByColumn=Starton&sortByType=desc&apiKey=ecf7691a575255636e2c28bba73ae213
    deleteAlarmProfileDetails POST To delete the alarms generated for a particular profile alarmID - ID of the alarm profile
    alarmType - Type of the alarm profile(alert/anomaly/bandwidth)
    alarmName - Name of the alarm profile.
    http://localhost:8060/api/json/fwaalarms/deleteAlarmProfileDetails?alarmID=301&alarmType=Alert&alarmName=testalertnormal
       
     
     
     

    SNMP Settings:

    REST API Method Description Parameters Sample URL
    listSnmpDevices GET List the snmp configured devices NIL http://localhost:8060/api/json/v2/livetraffic/listSnmpDevices?apiKey=ecf7691a575255636e2c28bba73ae213
    getSnmpDetails GET To get the SNMP details configured resId - resourceID
    action - action performed(edit)
    http://localhost:8060/api/json/v2/livetraffic/getSnmpDetails?apiKey=ecf7691a575255636e2c28bba73ae213
    testSnmpCredentials POST To test the SNMP Credentials rIds - Resource ID (comma seperated value) (eg : 1,2,3)
    community - SNMP community name
    port - port value
    version - Version of the SNMP
    userName - Name of the user
    ctxName - Context name 
    authProto - authentication protocol(MD5|SHA)
    authPwd - Authentication Password
    encProto - Encryption Protocol(AES|DES)
    encPwd - Encryption Password
    interval - Time gap
    selectedRbbgs - Selected reports
    http://localhost:8060/api/json/v2/livetraffic/testSnmpCredentials?apiKey=ecf7691a575255636e2c28bba73ae213
    addOrDeleteSnmpDetails POST To add or delete the snmp configuration rIds - Resource ID. (eg : 1)
    community - snmp community name
    port - port value
    version - snmp version configured.(V1|V2|V3)
    interval - time gap
    selectedRbbgs - Selected report names 
    action - Action performed(add|delete)
    http://localhost:8060/api/json/v2/livetraffic/addOrDeleteSnmpDetails?apiKey=ecf7691a575255636e2c28bba73ae213
    updateSnmpStatus POST To update the status of snmp configuration rid - resourceID (eg : 1)
    status - Status of configuration whether it is enable or disable(ENABLE|DISABLE)
    http://localhost:8060/api/json/v2/livetraffic/updateSnmpStatus?rid=601&status=false&apiKey=ecf7691a575255636e2c28bba73ae213
     

     

    Enterprise:

    Collector down page (Admin Server home page):

     

    REST API Method Description Parameters Sample URL
    getCollectorList** GET To get the list of collectors added to the admin cid - Collector id http://localhost:8060/api/json/fwaenterprise/getCollectorList?selColId=1&apiKey=ecf7691a575255636e2c28bba73ae213
    getCollectorDetails** GET To get the collector details NIL http://localhost:8060/api/json/fwaenterprise/getCollectorDetails?selColId=1&apiKey=ecf7691a575255636e2c28bba73ae213
    updateCollectorDetails** POST To update the details of the collector uName - Username of the collector.
    accessKey - Password for the collector.
    protocol - Protocol used to connect with collector.
    port - Port used.
    dName - Display name of the collector.
    cid - Collector id  (eg : 1)
    http://localhost:8060/api/json/fwaenterprise/updateCollectorDetails?selColId=1&apiKey=ecf7691a575255636e2c28bba73ae213

     

    Collector Settings:

     

    REST API Method Description Parameters Sample URL
    getCollectorList** GET To get the list of collectors added to the admin cid - Collector id http://localhost:8060/api/json/fwaenterprise/getCollectorList?selColId=1&apiKey=ecf7691a575255636e2c28bba73ae213
    getCollectorDetails** GET To get the collector details NIL http://localhost:8060/api/json/fwaenterprise/getCollectorDetails?selColId=1&apiKey=ecf7691a575255636e2c28bba73ae213
    updateCollectorDetails** POST To update the details of the collector uName - Username of the collector.
    accessKey - Password for the collector.
    protocol - Protocol used to connect with collector.
    port - Port used.
    dName - Display name of the collector.
    cid - Collector id (eg : 1)
    http://localhost:8060/api/json/fwaenterprise/updateCollectorDetails?selColId=1&apiKey=ecf7691a575255636e2c28bba73ae213