Skip to main content
ErsatzTV Legacy ships a REST API that lets you inspect and control every major subsystem — channels, transcoding profiles, media libraries, smart collections, HLS sessions, and scripted playout builds — from any HTTP client. All endpoints accept and return application/json and are documented with an OpenAPI 3.1 specification served directly from the running instance.

​
Base URL

All endpoints are served on port 8409:

​
OpenAPI Specifications

ErsatzTV Legacy ships two separate OpenAPI documents: The specs are machine-readable and compatible with tools like Swagger UI, Redoc, and Postman.

​
Authentication

Authentication is optional and controlled by the ErsatzTV authentication settings. When enabled, all API requests must include a Bearer token in the Authorization header.
Refer to the streaming authentication documentation for instructions on obtaining a token and configuring authentication.

​
Content Type

All request bodies must be sent with Content-Type: application/json. All responses are returned as JSON.

​
Version Endpoint

The simplest endpoint to verify connectivity is GET /api/version. It returns the API protocol version alongside the running application version string.
​
integer
required
Integer protocol version of the ErsatzTV REST API.
​
string
required
Full application version string, including the git commit hash suffix.

​
Endpoint Groups

Channels

List all channels and reset channel playouts.

FFmpeg Profiles

Create, list, update, and delete FFmpeg transcoding profiles.

Libraries

Trigger full library scans or targeted per-show scans.

Collections

Manage smart collections built from search queries.

Sessions

View active HLS streaming sessions and stop them on demand.

Maintenance

Garbage collection, empty trash, and artwork cache cleanup.

Scripted Schedule

Programmatic playout building for scripted schedules.