System
8 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 |