Formats#

Data from the scans#

Data from the various scanning tools is stored to the following format.

{
    "version": "1",
    "format": "scanning",
    "meta": {
        "uuid": "<UUID>",
        "ts": "date",
        "type": "nmap-scan"
    },
    "payload": {
        "row": "<base64-encoded-string>"
    }
}

As defined here. Validation of the format is made with Pydantic. The base64 encoded string is the raw output from a scanning tool.

HTTP API#

The API is based on the FastAPI framework.

OpenAPI documentation#

Documentation is OpenAPI Specification v3.1.0 compliant.

GET /TimeStampTokens/#

Read Tsts

Query Parameters:
  • skip (integer) –

  • limit (integer) –

Status Codes:
POST /TimeStampTokens/#

Create Tst

Insert a TimeStampToken and publish it through the WebSocket.

Status Codes:
  • 200 OK – Successful Response

GET /items/#

Read Items

Query Parameters:
  • skip (integer) –

  • limit (integer) –

  • q (string) –

Status Codes:
POST /items/#

Create Item

Insert a new item and publish it through the WebSocket.

Status Codes:
GET /items/{item_id}#

Read Item

Parameters:
  • item_id (integer) –

Status Codes:
GET /system/info/#

System Info

Provides information about the instance.

Status Codes:
  • 200 OK – Successful Response

GET /system/stats/#

Stats

Provides stats about the database.

Status Codes:
  • 200 OK – Successful Response

Agent configuration#

{
    "uuid": "",
    "period": 3600,
    "target": "",
    "command": "",
    "args": [],
    "expected_value": "",
    "up_agent": ""
    "jid": "",
    "passwd": ""
}