@datafire/patrowl_local v3.0.0

@datafire/patrowl_local

Client library for Swagger API-REST for Patrowl Engines

Installation and Usage

npm install --save @datafire/patrowl_local

let patrowl_local = require('@datafire/patrowl_local').create();

.then(data => {
  console.log(data);
});

Description

This is the API documentation for Patrowl Engines usage.

Actions

getDefaultPage

Return index page

patrowl_local.getDefaultPage(null, context)

Input

This action has no parameters

Output

• output ApiResponse

CleanScansPage

Clean all current scans.

patrowl_local.CleanScansPage(null, context)

Input

This action has no parameters

Output

• output ApiResponse

CleanScanPage

Clean scan identified by id.

patrowl_local.CleanScanPage({
  "scanId": 0
}, context)

Input

• input object
  • scanId required integer: Numeric ID of the scan to clean

Output

• output ApiResponse

GetFindingPage

Get findings on finished scans.

patrowl_local.GetFindingPage({
  "scanId": 0
}, context)

Input

• input object
  • scanId required integer: Numeric ID of the scan to get findings

Output

• output Findings

getInfoPage

Return information on engine.

patrowl_local.getInfoPage(null, context)

Input

This action has no parameters

Output

• output ApiResponse

getLivenessPage

Return liveness page

patrowl_local.getLivenessPage(null, context)

Input

This action has no parameters

Output

Output schema unknown

getReadinessPage

Return liveness page

patrowl_local.getReadinessPage(null, context)

Input

This action has no parameters

Output

Output schema unknown

reloadConfigurationPage

Reload the configuration file.

patrowl_local.reloadConfigurationPage(null, context)

Input

This action has no parameters

Output

• output ApiResponse

StartScanPage

Start a new scan.

patrowl_local.StartScanPage({
  "body": null
}, context)

Input

• input object
  • body required ScanDefinition

Output

• output ApiResponse

StatusScansPage

Status all current scans.

patrowl_local.StatusScansPage(null, context)

Input

This action has no parameters

Output

• output ApiResponse

StatusScanPage

Status of a scan identified by id.

patrowl_local.StatusScanPage({
  "scanId": 0
}, context)

Input

• input object
  • scanId required integer: Numeric ID of the scan to get status

Output

• output ApiResponse

StopScanPage

Stop a scan identified by id.

patrowl_local.StopScanPage({
  "scanId": 0
}, context)

Input

• input object
  • scanId required integer: Numeric ID of the scan to stop

Output

• output ApiResponse

StopScansPage

Stop all current scans.

patrowl_local.StopScansPage(null, context)

Input

This action has no parameters

Output

• output ApiResponse

getTestPage

Return test page

patrowl_local.getTestPage(null, context)

Input

This action has no parameters

Output

Output schema unknown

Definitions

ApiResponse

• ApiResponse object
  • page string
  • status string

Findings

• Findings array
  • items object
    • confidence string
    • description string
    • issue_id integer
    • meta_links array
      • items string
    • meta_risk object
      • cvss_base_score array
        • items string
      • cvss_vector array
        • items string
      • exploit_available array
        • items string
      • exploitability_ease array
        • items string
      • patch_publication_date array
        • items string
    • meta_tags array
      • items string
    • meta_vuln_refs object
      • bid array
        • items string
      • cpe array
        • items string
      • cve array
        • items string
      • cwe array
        • items string
    • raw string
    • severity string (values: info, low, medium, high)
    • solution string
    • target_addrs array
      • items string
    • target_proto array
      • items string
    • timestamp string
    • title string
    • type string

ScanDefinition

• ScanDefinition object
  • assets array
    • items object
      • criticity string (values: low, medium, high)
      • datatype string (values: ip, ip-range, ip-subnet, fqdn, domain, url, keyword, person, organisation, path, application)
      • id string
      • value string
  • options object
  • scan_id integer