Skip to main content

Reconcile RTMP push destinations and enabled state

PATCH 

/program/api/v2/streams/:id/rtmp-push

warning

This endpoint is available in private cloud only. Use your global host URL if self-hosted.

Declaratively reconcile the stream's RTMP push destinations against the request body. The server upserts each destination in the request with that row's enabled value, and deletes any stored destination not present in the request.

Each row carries its own enabled flag, so a single PATCH can express any combination of enabled/disabled destinations.

The endpoint is idempotent — repeating the same request produces the same state.

Changes apply on the next stream connect. Mid-stream toggling does NOT affect a currently-running push (no side-channel to media).

Maximum 10 destinations per stream.

Validates the stream belongs to the token's project.

Generate JWT

Request

Responses

Destinations reconciled

Bad request - validation error (unknown type, empty key, cap exceeded, etc.)

Forbidden - Stream belongs to different project

Stream not found

Conflict - one of the proposed enabled destinations is already enabled on a related stream in the source/derivation family (rtmp_push_sibling_conflict). The error payload names the offending sibling streamId; the destination key value is NOT included. To resolve, use POST /v2/streams/rtmp-push-bulk to atomically reconcile both streams in one call.

Internal Server Error