Create a new live channel

post

https://serviceApiUrl/createLiveChannel

Provisions a new live channel with the specified configuration including type, security settings, and output options. Automatically generates a route name from the channel name and resolves security group names to IDs.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

name

string

required

The display name for the live channel

thumbnailImageId

string

required

The asset ID of the thumbnail image

archiveFolderAssetId

string

required

The asset ID of the archive folder

enableHighAvailability

boolean

required

Whether to enable high availability

enableLiveClipping

boolean

required

Whether to enable live clipping

isSecureOutput

boolean

required

Whether the output stream is secure

isOutputScreenshots

boolean

required

Whether to capture output screenshots

type

string

required

The channel type: "External", "IVS", "Normal", or "Realtime"

externalServiceApiUrl

string

required

externalOutputProfiles

array of objects

required

External output profile configurations

externalOutputProfiles*

securityGroups

array of strings

required

Security group names (e.g., "Content Manager", "Everyone", "Guest")

securityGroups*

Responses

200

Success

400

Bad Request

401

The caller is not authenticated

Language

Loading…

Response

Click Try It! to start a request and see the response here!