Chronicle Server
An HTTPS Chronicle report server.
Installation
npm install -g @panosoft/chronicle-server
Usage
Usage: chronicle-server --key <path> --cert <path> [options]
An HTTPS Chronicle Server.
Options:
-h, --help output usage information
-V, --version output the version number
-k, --key <path> Path to the private key of the server in PEM format.
-c, --cert <path> Path to the certificate key of the server in PEM format.
-p, --port <port> The port to accept connections on. Default: 8443.
-i, --interface <interface> The interface to accept connections on. Default: 0.0.0.0.
HTTPS API
run
Run a report with a set of parameters.
Request
- Pathname:
/
- Method:
POST
- Headers:
-
Content-Type
-'application/json'
-
- Body:
-
report
- {String} The url of the report bundle to run. -
[parameters]
- {Object} The parameters to pass to report at runtime.
-
Responses
Success
- Status Code:
200
- Headers:
-
Request-Id
- {String} The unique request identifier. -
Content-Type
-'application/json'
-
- Body:
-
result
- {*} The report output.
-
Error
- Status Code:
500
- Headers:
-
Request-Id
- {String} The unique request identifier. -
Content-Type
-'application/json'
-
- Body:
-
error
- {String} The error message.
-