Skip to content

Report API

There are several types of audit reports:

  • vulnerability summary;
  • host summary;
  • list of detected vulnerabilities;
  • list of performed scans;
  • list of vulnerabilities on a host.

Each of the report can be retrieved through a corresponding method. All calls have similar parameters:

  • limit and offset parameters to get pagination,
  • filter parameter eg filter = { 'OS': 'Centos', 'OSVersion': '7'};
  • sort parameter to sort results by the selected field, e.g. sort='-published'.

Vulnerability summary report

Query: 

POST /api/v3/reports/vulnsreport/

Query example: 

curl -XPOST https://vulners.com/api/v3/reports/vulnsreport/ -H  'Content-Type: application/json' -d '{
"reporttype": "vulnssummary",
}'


report = vulners_api.vulnssummary_report()

[
  {
    "vulnID": "CVE-2019-8457",
    "title": "CVE-2019-8457",
    "family": "cve",
    "severity": 4,
    "severityText": "high",
    "count": 2,
    "score": 7.5
  },
  {
    "vulnID": "CVE-2022-32774",
    "title": "CVE-2022-32774",
    "family": "cve",
    "severity": 2,
    "severityText": "low",
    "count": 2,
    "score": 0.0
  }, ...
]

Host summary report

Query: 

POST /api/v3/reports/vulnsreport/

Query example: 

curl -XPOST https://vulners.com/api/v3/reports/vulnsreport/ -H  'Content-Type: application/json' -d '{
"reporttype": "ipssummary",
"skip": 2,
"size": 4
}'


report = vulners_api.ipsummary_report(limit=2, offset=4)

[
 {
   "agentid": "30TS<...>LKLE",
   "agentip": "10.1.1.1",
   "agentfqdn": "somehost1",
   "osname": "windows",
   "osversion": "10.0.19045",
   "score": 16.4,
   "total": 10,
   "vulnerabilities": {
     "low": 9,
     "high": 1
   }
 },
 {
   "agentid": "MVEB<...>3HCC",
   "agentip": "10.2.2.2",
   "agentfqdn": "somehost2",
   "osname": "debian",
   "osversion": "10",
   "score": 12.3,
   "total": 5,
   "vulnerabilities": {
     "low": 5
   }
 }]

List of detected vulnerabilities

Query: 

POST /api/v3/reports/vulnsreport/

Query example: 

curl -XPOST https://vulners.com/api/v3/reports/vulnsreport/ -H  'Content-Type: application/json' -d '{
"reporttype":"vulnslist",
"filter":{"agentip": "10.2.2.2"}
}'


  report = vulners_api.vulnslist_report(filter={"agentip": "10.2.2.2"})

[{
    "vulnID": "DEBIAN:DSA-5235-1:A2B24",
    "title": "[SECURITY] [DSA 5235-1] bind9 security update",
    "family": "debian",
    "severity": 2,
    "severityText": "low",
    "agentip": "10.2.2.2",
    "agentfqdn": "somehost2",
    "cumulativeFix": "sudo apt-get --assume-yes install --only-upgrade bind9-host",
    "scanid": "Q13T<...>IQU9"
  },
  {
    "vulnID": "DEBIAN:DSA-5105-1:A867B",
    "title": "[SECURITY] [DSA 5105-1] bind9 security update",
    "family": "debian",
    "severity": 2,
    "severityText": "low",
    "agentip": "10.2.2.2",
    "agentfqdn": "somehost2",
    "cumulativeFix": "sudo apt-get --assume-yes install --only-upgrade bind9-host",
    "scanid": "Q13T<...>IQU9"
  },]

List of performed scans

Query: 

POST /api/v3/reports/vulnsreport/

Query example: 

curl -XPOST https://vulners.com/api/v3/reports/vulnsreport/ -H  'Content-Type: application/json' -d '{
"reporttype":"scanlist",
"sort":"-modified"
}'


report = vulners_api.scanlist_report(sort='-modified')

[
  {
    "ipaddress": "10.3.3.3",
    "OS": "redhat",
    "fqdn": "somehost3",
    "OSVersion": "8.7",
    "modified": "2023-02-01T10:44:21",
    "id": "F8YD<...>IHFC",
    "cvss": {
      "score": 9.0,
      "vector": "AV:N/AC:L/Au:S/C:C/I:C/A:C"
    }
  },
  {
    "ipaddress": "10.1.1.1",
    "OS": "windows",
    "fqdn": "somehost1",
    "OSVersion": "10.0.19045",
    "modified": "2023-01-13T10:06:49",
    "id": "QJN1<...>TAIH",
    "cvss": {
      "score": 0.0,
      "vector": "NONE"
    }
  },...]

List of vulnerabilities on a host

Query: 

POST /api/v3/reports/vulnsreport/

Query example: 

curl -XPOST https://vulners.com/api/v3/reports/vulnsreport/ -H  'Content-Type: application/json' -d '{
"reporttype":"hostvulns"
}'


report5 = vulners_api.hostvulns_report()

[
  {
      "agentip": "10.2.2.2",
      "agentfqdn": "somehost2",
      "osname": "debian",
      "osversion": "10",
      "cumulativeFix": "sudo apt-get --assume-yes install --only-upgrade bind9-host",
      "vulnerabilities": [
        "DEBIAN:DSA-5105-1:A867B",
        "DEBIAN:DSA-5235-1:A2B24",
        "DEBIAN:DLA-2955-1:40374",
        "DEBIAN:DLA-3138-1:2F5A9",
        "DEBIAN:DLA-2955-2:CDB18"
      ],
      "published": "2023-02-23T10:55:41"
    },
    {
      "agentip": "10.1.1.1",
      "agentfqdn": "somehost1",
      "osname": "windows",
      "osversion": "10.0.19045",
      "cumulativeFix": "",
      "vulnerabilities": [
        "CVE-2022-32774",
        "OSV:CVE-2021-20227",
        "CVE-2022-37332",
        "CVE-2019-16168",
        "CVE-2022-42919",
        "CVE-2016-6153",
        "CVE-2019-8457",
        "CVE-2022-35737",
        "CVE-2022-40129",
        "CVE-2022-38097"
      ],
      "published": "2022-12-30T13:08:59"
    },...]
Back to top