User
12 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)
Responses
| Status | Description | Schema |
|---|---|---|
200 | OK | array of app.User |
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)
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}/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 |