Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1439243197.0 KB

Disconnects a specified participant from a specified stage. If the participant is publishing using an <a>IngestConfiguration</a>, DisconnectParticipant also updates the <code>stageArn</code> in the IngestConfiguration to be an empty string.

post/DisconnectParticipant

Request body

stageArnstring required

ARN of the stage to which the participant is attached.

participantIdstring required

Identifier of the participant to be disconnected. IVS assigns this; it is returned by <a>CreateParticipantToken</a> (for streams using WebRTC ingest) or <a>CreateIngestConfiguration</a> (for streams using RTMP ingest).

reasonstring

Description of why this participant is being disconnected.

Response

Success

DisconnectParticipantResponse required