HTTP API reference › Gala Launchpad › simulcasts

Gala Launchpad — simulcasts

3 operations in this group.

GET /v1/tokens/{tokenName}/simulcasts — Get simulcast targets
POST /v1/tokens/{tokenName}/simulcasts — Add simulcast target
DELETE /v1/tokens/{tokenName}/simulcasts/{targetId} — Remove simulcast target

GET `/v1/tokens/{tokenName}/simulcasts`

SimulcastsController_getSimulcastTargets

Get simulcast targets

List all simulcast targets for a token

Authentication: apiKeyAuth, bearer

Parameters

Name	In	Required	Type	Description
tokenName	path	required	string

Responses

200 — Mux simulcast targets for this token, returned as an array in the success envelope.

Content type: application/json

Schema: ApiSuccessEnvelopeMetadataDto & object

Field	Type	Required	Description
error	boolean enum: false	yes	Successful response marker.
message	string	yes	Response message.
status	number	yes	HTTP status code.
data	array<SimulcastTargetResponseDto>	yes

401 — Unauthorized - missing or invalid JWT token in Authorization header

Content type: application/json

Schema: ApiErrorEnvelope

Field	Type	Required	Description
error	boolean enum: true	yes
message	oneOf: string \| array<string>	yes
status	integer	yes	HTTP status code.
message	string	yes
statusCode	integer	yes	HTTP status code.

403 — Forbidden - user lacks MANAGE_SIMULCAST permission

Content type: application/json

Schema: ApiErrorEnvelope

Field	Type	Required	Description
error	boolean enum: true	yes
message	oneOf: string \| array<string>	yes
status	integer	yes	HTTP status code.
message	string	yes
statusCode	integer	yes	HTTP status code.

404 — Token not found - tokenName does not match any existing pool

Content type: application/json

Schema: ApiErrorEnvelope

Field	Type	Required	Description
error	boolean enum: true	yes
message	oneOf: string \| array<string>	yes
status	integer	yes	HTTP status code.
message	string	yes
statusCode	integer	yes	HTTP status code.

500 — Internal server error - failed to retrieve simulcast configuration

Content type: application/json

Schema: ApiErrorEnvelope

Field	Type	Required	Description
error	boolean enum: true	yes
message	oneOf: string \| array<string>	yes
status	integer	yes	HTTP status code.
message	string	yes
statusCode	integer	yes	HTTP status code.

default — Shared error envelope for simulcast lookup failures.

Content type: application/json

Schema: ApiErrorEnvelope

Field	Type	Required	Description
error	boolean enum: true	yes
message	oneOf: string \| array<string>	yes
status	integer	yes	HTTP status code.
message	string	yes
statusCode	integer	yes	HTTP status code.

Example response

[]

POST `/v1/tokens/{tokenName}/simulcasts`

SimulcastsController_addSimulcastTarget

Add simulcast target

Add a new simulcast target for multi-platform streaming

Authentication: apiKeyAuth, bearer

Parameters

Name	In	Required	Type	Description
tokenName	path	required	string

Request body

Required: yes

application/json

Schema: CreateSimulcastTargetDto

Field	Type	Required
passthrough	string	no
platform	string enum: youtube, twitch, facebook, custom	yes
streamKey	string	yes
url	string	yes

Responses

200 — Created Mux simulcast target in the success envelope.

Content type: application/json

Schema: ApiSuccessEnvelopeMetadataDto & object

Field	Type	Required	Description
error	boolean enum: false	yes	Successful response marker.
message	string	yes	Response message.
status	number	yes	HTTP status code.
data	SimulcastTargetResponseDto	yes

400 — Bad request - platform is invalid, URL is malformed or missing, or streamKey is missing

Content type: application/json

Schema: ApiErrorEnvelope

Field	Type	Required	Description
error	boolean enum: true	yes
message	oneOf: string \| array<string>	yes
status	integer	yes	HTTP status code.
message	string	yes
statusCode	integer	yes	HTTP status code.

401 — Unauthorized - missing or invalid JWT token in Authorization header

Content type: application/json

Schema: ApiErrorEnvelope

Field	Type	Required	Description
error	boolean enum: true	yes
message	oneOf: string \| array<string>	yes
status	integer	yes	HTTP status code.
message	string	yes
statusCode	integer	yes	HTTP status code.

403 — Forbidden - user lacks MANAGE_SIMULCAST permission or user is banned

Content type: application/json

Schema: ApiErrorEnvelope

Field	Type	Required	Description
error	boolean enum: true	yes
message	oneOf: string \| array<string>	yes
status	integer	yes	HTTP status code.
message	string	yes
statusCode	integer	yes	HTTP status code.

404 — Token not found - tokenName does not match any existing pool

Content type: application/json

Schema: ApiErrorEnvelope

Field	Type	Required	Description
error	boolean enum: true	yes
message	oneOf: string \| array<string>	yes
status	integer	yes	HTTP status code.
message	string	yes
statusCode	integer	yes	HTTP status code.

500 — Internal server error - failed to create simulcast target in database

Content type: application/json

Schema: ApiErrorEnvelope

Field	Type	Required	Description
error	boolean enum: true	yes
message	oneOf: string \| array<string>	yes
status	integer	yes	HTTP status code.
message	string	yes
statusCode	integer	yes	HTTP status code.

default — Shared error envelope for simulcast target creation failures.

Content type: application/json

Schema: ApiErrorEnvelope

Field	Type	Required	Description
error	boolean enum: true	yes
message	oneOf: string \| array<string>	yes
status	integer	yes	HTTP status code.
message	string	yes
statusCode	integer	yes	HTTP status code.

Example request

[]

Example response

[]

DELETE `/v1/tokens/{tokenName}/simulcasts/{targetId}`

SimulcastsController_removeSimulcastTarget

Remove simulcast target

Remove a simulcast target

Authentication: apiKeyAuth, bearer

Parameters

Name	In	Required	Type	Description
tokenName	path	required	string
targetId	path	required	string

Responses

200 — Target was removed; the success envelope omits data.

Content type: application/json

Schema: ApiSuccessEnvelopeMetadataDto

Field	Type	Required	Description
error	boolean enum: false	yes	Successful response marker.
message	string	yes	Response message.
status	number	yes	HTTP status code.

401 — Unauthorized - missing or invalid JWT token in Authorization header

Content type: application/json

Schema: ApiErrorEnvelope

Field	Type	Required	Description
error	boolean enum: true	yes
message	oneOf: string \| array<string>	yes
status	integer	yes	HTTP status code.
message	string	yes
statusCode	integer	yes	HTTP status code.

403 — Forbidden - user lacks MANAGE_SIMULCAST permission or user is banned

Content type: application/json

Schema: ApiErrorEnvelope

Field	Type	Required	Description
error	boolean enum: true	yes
message	oneOf: string \| array<string>	yes
status	integer	yes	HTTP status code.
message	string	yes
statusCode	integer	yes	HTTP status code.

404 — Token not found or simulcast targetId does not exist for this token

Content type: application/json

Schema: ApiErrorEnvelope

Field	Type	Required	Description
error	boolean enum: true	yes
message	oneOf: string \| array<string>	yes
status	integer	yes	HTTP status code.
message	string	yes
statusCode	integer	yes	HTTP status code.

500 — Internal server error - failed to delete simulcast target from database

Content type: application/json

Schema: ApiErrorEnvelope

Field	Type	Required	Description
error	boolean enum: true	yes
message	oneOf: string \| array<string>	yes
status	integer	yes	HTTP status code.
message	string	yes
statusCode	integer	yes	HTTP status code.

default — Shared error envelope for simulcast target removal failures.

Content type: application/json

Schema: ApiErrorEnvelope

Field	Type	Required	Description
error	boolean enum: true	yes
message	oneOf: string \| array<string>	yes
status	integer	yes	HTTP status code.
message	string	yes
statusCode	integer	yes	HTTP status code.

Example response

[]

Previous group: recording-assets · Next group: trade

GET /v1/tokens/&#123;tokenName&#125;/simulcasts​

Parameters​

Responses​

200 — Mux simulcast targets for this token, returned as an array in the success envelope.​

401 — Unauthorized - missing or invalid JWT token in Authorization header​

403 — Forbidden - user lacks MANAGE_SIMULCAST permission​

404 — Token not found - tokenName does not match any existing pool​

500 — Internal server error - failed to retrieve simulcast configuration​

default — Shared error envelope for simulcast lookup failures.​

Example response​

POST /v1/tokens/&#123;tokenName&#125;/simulcasts​

Parameters​

Request body​

application/json​

Responses​

200 — Created Mux simulcast target in the success envelope.​

400 — Bad request - platform is invalid, URL is malformed or missing, or streamKey is missing​

401 — Unauthorized - missing or invalid JWT token in Authorization header​

403 — Forbidden - user lacks MANAGE_SIMULCAST permission or user is banned​

404 — Token not found - tokenName does not match any existing pool​

500 — Internal server error - failed to create simulcast target in database​

default — Shared error envelope for simulcast target creation failures.​

Example request​

Example response​

DELETE /v1/tokens/&#123;tokenName&#125;/simulcasts/&#123;targetId&#125;​

Parameters​

Responses​

200 — Target was removed; the success envelope omits data.​

401 — Unauthorized - missing or invalid JWT token in Authorization header​

403 — Forbidden - user lacks MANAGE_SIMULCAST permission or user is banned​

404 — Token not found or simulcast targetId does not exist for this token​

500 — Internal server error - failed to delete simulcast target from database​

default — Shared error envelope for simulcast target removal failures.​

Example response​

GET `/v1/tokens/{tokenName}/simulcasts`

Parameters

Responses

200 — Mux simulcast targets for this token, returned as an array in the success envelope.

401 — Unauthorized - missing or invalid JWT token in Authorization header

403 — Forbidden - user lacks MANAGE_SIMULCAST permission

404 — Token not found - tokenName does not match any existing pool

500 — Internal server error - failed to retrieve simulcast configuration

default — Shared error envelope for simulcast lookup failures.

Example response

POST `/v1/tokens/{tokenName}/simulcasts`

Parameters

Request body

application/json

Responses

200 — Created Mux simulcast target in the success envelope.

400 — Bad request - platform is invalid, URL is malformed or missing, or streamKey is missing

401 — Unauthorized - missing or invalid JWT token in Authorization header

403 — Forbidden - user lacks MANAGE_SIMULCAST permission or user is banned

404 — Token not found - tokenName does not match any existing pool

500 — Internal server error - failed to create simulcast target in database

default — Shared error envelope for simulcast target creation failures.

Example request

Example response

DELETE `/v1/tokens/{tokenName}/simulcasts/{targetId}`

Parameters

Responses

200 — Target was removed; the success envelope omits data.

401 — Unauthorized - missing or invalid JWT token in Authorization header

403 — Forbidden - user lacks MANAGE_SIMULCAST permission or user is banned

404 — Token not found or simulcast targetId does not exist for this token

500 — Internal server error - failed to delete simulcast target from database

default — Shared error envelope for simulcast target removal failures.

Example response