StreamProfile
4 operations generated from the Engine OpenAPI schema. Request and response model names can be expanded in the interactive schema.
GET /api/v1/profiles
Export the stream profiles by IDs.
Authentication: Authorization header (ApiKeyAuth)
Parameters
| Name | Location | Type | Required | Description |
|---|---|---|---|---|
id | query | array of integer | Yes | 1-1000 positive stream profile IDs, comma separated |
Responses
| Status | Description | Schema |
|---|---|---|
200 | OK | route.APIResponse |
POST /api/v1/profiles
Import the stream profiles.
Authentication: Authorization header (ApiKeyAuth)
Parameters
| Name | Location | Type | Required | Description |
|---|---|---|---|---|
profiles | body | array of object | Yes | Slice of stream profile map |
Responses
| Status | Description | Schema |
|---|---|---|
200 | OK | route.APIResponse |
DELETE /api/v1/profiles/{id}
Delete the stream profile by ID or Name.
Authentication: Authorization header (ApiKeyAuth)
Parameters
| Name | Location | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes | stream profile ID or Name |
include_streams | query | boolean | No | Delete streams using this profile |
Responses
| Status | Description | Schema |
|---|---|---|
200 | OK | route.APIResponse |
POST /api/v1/profiles/{id}/streams/{action}
Start, restart, or stop all streams using a profile.
Authentication: Authorization header (ApiKeyAuth)
Parameters
| Name | Location | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes | Stream profile ID or Name |
action | path | string: start, restart, stop | Yes | Control action |
Responses
| Status | Description | Schema |
|---|---|---|
200 | OK | route.APIResponse |