{ "opencollection": "1.0.0", "info": { "name": "Forward Networks: Complete Aliases Vulnerability Analysis API", "version": "26.6" }, "items": [ { "info": { "name": "Vulnerability Analysis", "type": "folder" }, "items": [ { "info": { "name": "Get full vulnerability analysis", "type": "http" }, "http": { "method": "GET", "url": "/api/networks/:networkId/vulnerabilities", "params": [ { "name": "networkId", "value": "", "type": "path" }, { "name": "snapshotId", "value": "", "type": "query", "description": "An optional Snapshot id. If omitted, the network’s latest processed Snapshot is used." }, { "name": "offset", "value": "", "type": "query", "description": "An optional number of vulnerabilities to skip. Useful for paging. Defaults to 0." }, { "name": "limit", "value": "", "type": "query", "description": "An optional maximum number of vulnerabilities desired. Useful for paging. Defaults to 1000." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Get the CVEs that may impact devices in the network.\n\nEach OsVulnerability corresponds to a distinct CVE-OS combination that could possibly impact devices in the\nnetwork. An OsVulnerability includes basic CVE information, an affected OS, the affected versions of that OS,\nand a vulnerability detection result for each possibly impacted device.\n\nThis operation’s response can get quite large for large networks. Paging is supported via the `limit` and\n`offset` parameters." }, { "info": { "name": "Get vulnerabilities", "type": "http" }, "http": { "method": "GET", "url": "/api/networks/:networkId/vulnerabilities?v=2", "params": [ { "name": "networkId", "value": "", "type": "path" }, { "name": "internetAddressable", "value": "", "type": "query", "description": "Whether to limit the analysis to internet-addressable devices. Defaults to false." }, { "name": "location", "value": "", "type": "query", "description": "The IDs of the locations to include in the analysis. Defaults to all locations." }, { "name": "tag", "value": "", "type": "query", "description": "Device tags used to limit the scope of the analysis. A device must have at least one of these\ntags to be included." }, { "name": "snapshotId", "value": "", "type": "query", "description": "An optional Snapshot id. If omitted, the network’s latest processed Snapshot is used." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Get the CVEs that may impact devices in the network.\n\nEach Vulnerability object includes basic CVE information, the CVE’s affected OSes and versions, and a\nsummary of vulnerability detection results for possibly impacted devices." }, { "info": { "name": "Get a vulnerability", "type": "http" }, "http": { "method": "GET", "url": "/api/networks/:networkId/vulnerabilities/:cveId", "params": [ { "name": "networkId", "value": "", "type": "path" }, { "name": "cveId", "value": "", "type": "path", "description": "A CVE ID from the\n[Get vulnerabilities](https://docs.fwd.app/latest/api/vulnerability-analysis/get-vulnerabilities/) response." }, { "name": "snapshotId", "value": "", "type": "query", "description": "An optional Snapshot id. If omitted, the network’s latest processed Snapshot is used." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Get detailed information about a vulnerability that might impact devices in the network, including basic CVE\ninformation, affected OSes and versions, and a vulnerability detection result for each possibly impacted device." } ] } ], "bundled": true }