System
14 operations generated from the Engine OpenAPI schema. Request and response model names can be expanded in the interactive schema.
DELETE /api/v1/connections/{id}
Kick an active streaming connection.
Removes the connection from the owning server’s in-memory connection cache through RPC. The stream stops when its next connection check observes that the cache entry no longer exists. Administrators may kick any connection. Reseller and subreseller accounts may kick only connections belonging to one of their directly owned streaming users.
Authentication: Authorization header (ApiKeyAuth)
Parameters
| Name | Location | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes | Stream connection UUID |
Responses
| Status | Description | Schema |
|---|---|---|
200 | OK | route.APIResponse + object |
POST /api/v1/epg/load
Load EPG data immediately.
Authentication: Authorization header (ApiKeyAuth)
Parameters
| Name | Location | Type | Required | Description |
|---|---|---|---|---|
source | formData | string | No | Optional EPG source |
Responses
| Status | Description | Schema |
|---|---|---|
200 | OK | route.APIResponse |
PATCH /api/v1/system/config
Update the system settings.
Authentication: Authorization header (ApiKeyAuth)
Parameters
| Name | Location | Type | Required | Description |
|---|---|---|---|---|
database | body | app.SystemConfig | Yes | system config |
Responses
| Status | Description | Schema |
|---|---|---|
200 | OK | route.APIResponse + object |
POST /api/v1/system/email/test
Send an SMTP configuration test email.
Authentication: Authorization header (ApiKeyAuth)
Responses
| Status | Description | Schema |
|---|---|---|
200 | OK | route.APIResponse |
DELETE /api/v1/system/logs
Delete system logs.
Authentication: Authorization header (ApiKeyAuth)
Responses
| Status | Description | Schema |
|---|---|---|
204 | No Content | — |
GET /api/v1/system/logs
List system logs.
Authentication: Authorization header (ApiKeyAuth)
Parameters
| Name | Location | Type | Required | Description |
|---|---|---|---|---|
after | query | integer | No | Log sequence cursor; values less than or equal to 0 return all logs |
Responses
| Status | Description | Schema |
|---|---|---|
200 | OK | array of route.SystemLogEntry |
GET /api/v1/system/logs/download
Download system logs.
Authentication: Authorization header (ApiKeyAuth)
Responses
| Status | Description | Schema |
|---|---|---|
200 | OK | file |
POST /api/v1/system/maintenance
Start, schedule, or stop management maintenance mode.
Maintenance mode blocks non-full-administrator management access without stopping existing streams or media delivery.
Authentication: Authorization header (ApiKeyAuth)
Parameters
| Name | Location | Type | Required | Description |
|---|---|---|---|---|
action | formData | string: start, stop | No | Use stop to disable maintenance mode |
reason | formData | string | No | Maintenance reason; required when starting or scheduling maintenance |
starts_at | formData | string | No | Optional RFC3339 start time |
ends_at | formData | string | No | Optional RFC3339 end time |
notify_email | formData | boolean | No | Notify eligible management accounts by email |
Responses
| Status | Description | Schema |
|---|---|---|
200 | OK | route.APIResponse |
GET /api/v1/system/releases
List available Engine releases.
Full Administrator on the Master only. Returns cached current and newer releases. The current release can be reinstalled. Force Downgrade adds lower releases with the same major version. all_versions returns every cached release for viewing changelogs; installation restrictions still apply.
Authentication: Authorization header (ApiKeyAuth)
Parameters
| Name | Location | Type | Required | Description |
|---|---|---|---|---|
force_downgrade | query | boolean | No | Include lower releases with the same major version |
all_versions | query | boolean | No | Include all releases for viewing changelogs only |
Responses
| Status | Description | Schema |
|---|---|---|
200 | OK | route.APIResponse + object |
POST /api/v1/system/releases/check
Check for Engine updates.
Full Administrator on the Master only. Refreshes the shared release catalog, at most once per minute.
Authentication: Authorization header (ApiKeyAuth)
Responses
| Status | Description | Schema |
|---|---|---|
200 | OK | route.APIResponse + object |
GET /api/v1/system/update
Get the Master software update status.
Full Administrator only. Status and estimated stage progress survive Master restarts. Progress reaches 100 only after the Master installer exits successfully; check Servers for subsequent synchronization progress.
Authentication: Authorization header (ApiKeyAuth)
Responses
| Status | Description | Schema |
|---|---|---|
200 | OK | route.APIResponse + object |
POST /api/v1/system/update
Install an Engine release on the Master.
Full Administrator only. Requires explicit terms acceptance. Send build_id from the selected release to install that exact build. The current release can be reinstalled. Lower releases require Force Downgrade and the same major version. The Master restarts during installation and then synchronizes other servers through the existing installation workflow.
Authentication: Authorization header (ApiKeyAuth)
Parameters
| Name | Location | Type | Required | Description |
|---|---|---|---|---|
request | body | route.SoftwareUpdateRequest | Yes | Release to install |
Responses
| Status | Description | Schema |
|---|---|---|
200 | OK | route.APIResponse |
GET /api/v1/system/update/logs/{name}
Preview a Master installation log.
Full Administrator on the Master only. Returns up to the last 256 KiB with log session creation and last modification times. created_at is zero for older logs without a timestamp. A log may not exist if installation has not reached that stage.
Authentication: Authorization header (ApiKeyAuth)
Parameters
| Name | Location | Type | Required | Description |
|---|---|---|---|---|
name | path | string: update, installer | Yes | Log to read |
Responses
| Status | Description | Schema |
|---|---|---|
200 | OK | route.APIResponse + object |
GET /api/v1/system/update/logs/{name}/download
Download a complete Master installation log.
Full Administrator on the Master only. Streams the complete selected log as a text file.
Authentication: Authorization header (ApiKeyAuth)
Parameters
| Name | Location | Type | Required | Description |
|---|---|---|---|---|
name | path | string: update, installer | Yes | Log to download |
Responses
| Status | Description | Schema |
|---|---|---|
200 | OK | file |