Skip to content

Reports API

GET /reports

List the reports of the authenticated user.

Parameters:

  • page (optional, default: 1): the page to start

Example request:

GET /api/reports HTTP/1.1
Host: example.com
Accept: application/json

Example response:

HTTP/1.1 200 OK

[
  ...
  {
    "id": "E8FBU53LDW8O",
    "created_at": "2021-04-01T19:40:30Z",
    "details": [
      "apache"
    ]
  },
  ...
]

Get a specific report.

Example request:

GET /api/reports/E8FBU53LDW8O HTTP/1.1
Host: example.com
Accept: application/json

Example response:

HTTP/1.1 200 OK

{
  "id": "E8FBU53LDW8O",
  "created_at": "2021-04-01T19:40:30Z",
  "details": [
    "apache"
  ],
  "alerts": [{
    "id": "a7098731-ddca-4a40-9b0e-e7f513ce76ad",
    "created_at": "2021-04-01T19:40:29Z",
    "cve": "CVE-2020-27223",
    "details": {
      "products": [],
      "vendors": [
        "apache"
      ],
      "filters": [
        "references"
      ]
    }
  }]
}