api
Use Tenzir’s REST API directly from a pipeline.
api endpoint:string, [request_body:string]Description
Section titled “Description”The api operator interacts with Tenzir’s REST API without needing to spin up a
web server, making all APIs accessible from within pipelines.
endpoint: string
Section titled “endpoint: string”The endpoint to request, e.g., /pipeline/list to list all managed pipelines.
Tenzir’s REST API specification lists all available endpoints.
request_body: string (optional)
Section titled “request_body: string (optional)”A single string containing the JSON request body to send with the request.
Examples
Section titled “Examples”List all running pipelines
Section titled “List all running pipelines”api "/pipeline/list"Create a new pipeline and start it immediately
Section titled “Create a new pipeline and start it immediately”api "/pipeline/create", { name: "Suricata Import", definition: "from file /tmp/eve.sock read suricata", autostart: { created: true },}