Swimlane VRM Enrichment
a brief description goes here be sure to provide an overview of what the plugin does include description of the product being integrated, plus use cases/value prop of the swimlane integration prerequisites prerequisites, everything outside of the plugin itself this should include info on how to configure the device (api key, perms, ect) capabilities this connector provides the following capabilities capabilities go here e g manage firewall policies instead of listing each individual tasks limitations include information about known limitations here, including supported or minimum versions, especially known unsupported versions asset setup the content here should discuss asset setup in a conversational manner be sure to include any known login and test connection errors tasks setup special task setup as needed depending on plugin, exclude if empty known available allowed input options from enum type selection notes any other notes not fitting other sections go here any reference urls to external docs or other resources configurations vrm enrichment attachment this asset is used to enrich vulnerability findings with attachment data configuration parameters parameter description type required page size the number of incoming findings to store in a staging record integer optional account id the swimlane account id string optional tenant id the swimlane tenant id string optional host the swimlane host (e g , stage swimlane app) string optional pat the private access token for api authentication string optional assets app the name of the assets application string optional exceptions app the name of the exceptions application string optional findings app the name of the findings application string optional ingestion pages app the name of the ingestion pages application string optional staged ingestion app the name of the staged ingestion application string optional risk score parameters json string containing risk score parameter definitions (weights, max values, keys, etc ) string optional actions enrich findings read findings from a staging record and enrich them with async concurrency endpoint method post input argument name type required description staging record id string required the tracking id or record id of the staging record to process concurrency integer optional maximum number of concurrent api calls (default 10) batch size integer optional number of records per batch create api call (default 50) only applies when batching is enabled use batching boolean optional use batch api for creating new findings (much faster) set to false to use individual creates input example {"staging record id" "string","concurrency" 10,"batch size" 50,"use batching"\ true} output parameter type description status string the status of the enrichment process findings processed number number of findings processed findings successful number number of findings successfully enriched findings skipped number number of findings skipped findings failed number number of findings that failed existing findings file array the updated existing findings database file (may be split into multiple parts if >512mb) existing findings file file string the file id existing findings file file name string the filename failed findings file array json file containing findings that failed enrichment failed findings file file string the file id failed findings file file name string the filename output example {"status" "string","findings processed" 123,"findings successful" 123,"findings skipped" 123,"findings failed" 123,"existing findings file" \[],"failed findings file" \[]} populate existing findings populate existing findings database from findings app and upload to staging record endpoint method post input argument name type required description staging record id string required the tracking id or record id of the staging record to process input example {"staging record id" "string"} output parameter type description status string the status of the population process existing findings file array the uploaded existing findings database file existing findings file file string the file id existing findings file file name string the filename total findings received number number of findings received from the api total findings stored number number of findings stored in the database findings without unique id number number of findings that were skipped due to missing unique id duplicate unique ids count number number of unique ids that appeared multiple times final db count number final count of records in the database database file size bytes number size of the database file in bytes output example {"status" "string","existing findings file" \[],"total findings received" 123,"total findings stored" 123,"findings without unique id" 123,"duplicate unique ids count" 123,"final db count" 123,"database file size bytes" 123} populate vulncheck cache populate vulncheck cache using cve ids from findings in a staging record endpoint method post input argument name type required description staging record id string required the tracking id or record id of the staging record to process input example {"staging record id" "string"} output parameter type description status string the status of the cache population process vulncheck cache file array the uploaded vulncheck cache database file vulncheck cache file file string the file id vulncheck cache file file name string the filename cve ids found array list of all unique cve ids found in the findings total findings count number total number of findings that have cve ids findings failed metadata count number number of findings that failed metadata enrichment findings failed exploit count number number of findings that failed exploit enrichment cve ids processed number number of unique cve ids processed populated count number number of cve ids successfully cached failed exploit ids array list of cve ids that failed exploit lookup failed metadata ids array list of cve ids that failed metadata lookup cache file size bytes number size of the cache database file in bytes output example {"status" "string","vulncheck cache file" \[],"cve ids found" \[],"total findings count" 123,"findings failed metadata count" 123,"findings failed exploit count" 123,"cve ids processed" 123,"populated count" 123,"failed exploit ids" \[],"failed metadata ids" \[],"cache file size bytes" 123} stage enrichment read ingestion pages and create a staging record endpoint method get output parameter type description status string the status of the enrichment output example {"status" "string"} response headers header description example content type the media type of the resource application/json date the date and time at which the message was originated thu, 01 jan 2024 00 00 00 gmt