Skip to content

Overview

Tenzir REST API v0

Section titled “Tenzir REST API v0”

Use the Tenzir REST API to manage pipelines and read pipeline output from a Tenzir node.

Authenticate every request with a token in the X-Tenzir-Token request header. Generate tokens with tenzir-ctl web generate-token.

All endpoints are versioned. Prefix every path in this specification with /v0.

Operations

Section titled “ Operations ”
POST
/ping
POST
/pipeline/create
POST
/pipeline/delete
POST
/pipeline/launch
POST
/pipeline/list
POST
/pipeline/reset-ttl
POST
/pipeline/update
POST
/serve
POST
/serve-multi

Authentication

Section titled “ Authentication ”

TenzirToken

Section titled “TenzirToken ”

Security scheme type: apiKey

Header parameter name: X-Tenzir-Token