User
13 operations generated from the Engine OpenAPI schema. Request and response model names can be expanded in the interactive schema.
GET /api/v1/users
List manageable streaming users.
Authentication: Authorization header (ApiKeyAuth)
Parameters
| Name | Location | Type | Required | Description |
|---|---|---|---|---|
page | query | integer | No | One-based page number |
page_size | query | integer | No | Rows per page |
search | query | string | No | Global text search |
sort | query | string: id, username, auth_mode, access_mode, password_ip, package, expire_date, connections, traffic, speed, last_active, owner, status | No | Sort field |
direction | query | string: asc, desc | No | Sort direction |
include_facets | query | boolean | No | Include list-filter candidates |
Responses
| Status | Description | Schema |
|---|---|---|
200 | OK | route.APIResponse |
POST /api/v1/users
Create a streaming user.
Authentication: Authorization header (ApiKeyAuth)
Parameters
| Name | Location | Type | Required | Description |
|---|---|---|---|---|
user | body | app.User | Yes | User settings |
Responses
| Status | Description | Schema |
|---|---|---|
201 | Created | app.User |
GET /api/v1/users/stats
List manageable streaming user stats.
Authentication: Authorization header (ApiKeyAuth)
Parameters
| Name | Location | Type | Required | Description |
|---|---|---|---|---|
ids | query | array of integer | Yes | Current page user IDs |
Responses
| Status | Description | Schema |
|---|---|---|
200 | OK | route.APIResponse + object |
DELETE /api/v1/users/{id}
Delete a streaming user.
Authentication: Authorization header (ApiKeyAuth)
Parameters
| Name | Location | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes | User ID or username |
Responses
| Status | Description | Schema |
|---|---|---|
200 | OK | route.APIResponse |
GET /api/v1/users/{id}
Get a streaming user by ID or username.
Authentication: Authorization header (ApiKeyAuth)
Parameters
| Name | Location | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes | User ID or username |
Responses
| Status | Description | Schema |
|---|---|---|
200 | OK | app.User |
PATCH /api/v1/users/{id}
Update a streaming user.
Authentication: Authorization header (ApiKeyAuth)
Parameters
| Name | Location | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes | User ID or username |
user | body | app.User | Yes | User settings |
Responses
| Status | Description | Schema |
|---|---|---|
200 | OK | app.User |
DELETE /api/v1/users/{id}/package
Manage a streaming user’s package.
Add, renew, change, or cancel the package assigned to a streaming user. package_id is required for add and change.
Authentication: Authorization header (ApiKeyAuth)
Parameters
| Name | Location | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes | User ID or username |
package | body | object | No | Package selection; use package_id for add or change |
Responses
| Status | Description | Schema |
|---|---|---|
200 | OK | app.User |
PATCH /api/v1/users/{id}/package
Manage a streaming user’s package.
Add, renew, change, or cancel the package assigned to a streaming user. package_id is required for add and change.
Authentication: Authorization header (ApiKeyAuth)
Parameters
| Name | Location | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes | User ID or username |
package | body | object | No | Package selection; use package_id for add or change |
Responses
| Status | Description | Schema |
|---|---|---|
200 | OK | app.User |
POST /api/v1/users/{id}/package
Manage a streaming user’s package.
Add, renew, change, or cancel the package assigned to a streaming user. package_id is required for add and change.
Authentication: Authorization header (ApiKeyAuth)
Parameters
| Name | Location | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes | User ID or username |
package | body | object | No | Package selection; use package_id for add or change |
Responses
| Status | Description | Schema |
|---|---|---|
200 | OK | app.User |
POST /api/v1/users/{id}/package/renew
Manage a streaming user’s package.
Add, renew, change, or cancel the package assigned to a streaming user. package_id is required for add and change.
Authentication: Authorization header (ApiKeyAuth)
Parameters
| Name | Location | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes | User ID or username |
package | body | object | No | Package selection; use package_id for add or change |
Responses
| Status | Description | Schema |
|---|---|---|
200 | OK | app.User |
GET /api/v1/users/{id}/playback-analytics
Get streaming-user playback analytics.
Authentication: Authorization header (ApiKeyAuth)
Parameters
| Name | Location | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes | User ID or username |
days | query | integer | No | Calendar range: up to 30 days uses daily summaries; longer ranges use whole months, capped at the current and previous 12 months |
date | query | string | No | UTC date (YYYY-MM-DD) within the last 30 calendar days; connection details are limited to retained sessions |
month | query | string | No | UTC month (YYYY-MM) within the current and previous 12 months; mutually exclusive with date |
section | query | string: overview, media, servers, sessions | No | Load overview or media; a date also allows servers or sessions. A month allows overview or media. Omit for the complete report. |
Responses
| Status | Description | Schema |
|---|---|---|
200 | OK | route.APIResponse |
GET /api/v1/users/{id}/stats
Get streaming user stats by ID.
Authentication: Authorization header (ApiKeyAuth)
Parameters
| Name | Location | Type | Required | Description |
|---|---|---|---|---|
id | path | integer | Yes | User ID |
Responses
| Status | Description | Schema |
|---|---|---|
200 | OK | route.APIResponse + object |
POST /api/v1/users/{id}/traffic/reset
Reset a streaming user’s cumulative traffic.
Authentication: Authorization header (ApiKeyAuth)
Parameters
| Name | Location | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes | User ID or username |
Responses
| Status | Description | Schema |
|---|---|---|
200 | OK | route.APIResponse + object |