Formats#
Data from the scans#
Data from the various scanning tools is stored to the following format.
{
"version": "1",
"format": "scanning",
"meta": {
"uuid": "<UUID>",
"source": "<source>",
"ts": "date",
"type": "nmap-scan"
},
"payload": {
"raw": "<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:
200 OK – Successful Response
422 Unprocessable Entity – Validation Error
- 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:
200 OK – Successful Response
422 Unprocessable Entity – Validation Error
- POST /items/#
Create Item
Insert a new item and publish it through the WebSocket.
- Status Codes:
200 OK – Successful Response
422 Unprocessable Entity – Validation Error
- GET /items/{item_id}#
Read Item
- Parameters:
item_id (integer)
- Status Codes:
200 OK – Successful Response
422 Unprocessable Entity – Validation Error
Agent configuration#
{
"uuid": "",
"period": 3600,
"target": "",
"command": "",
"args": [],
"expected_value": "",
"up_agent": ""
"jid": "",
"passwd": ""
}