Remove peers

You can use this API to remove/disconnect a connected peer from an active room. 100ms provides options to disconnect a peer either with their peer_id or role.

1. If peer_id is specified -- respective connected peer will be disconnected from the active room.
2. If the role is specified -- all the connected peers assigned with that particular role will be disconnected from the active room.
3. If both peer_id and role are specified -- preference will be given to the peer_id and the respective peer will be disconnected from the active room.
4. If both peer_id and role are not specified -- you must specify peer_id or role for this request.

curl --location --request POST 'https://api.100ms.live/v2/active-rooms/<room_id>/remove-peers' \
--header 'Authorization: Bearer <management_token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "peer_id": "fd9e87d8-5c7b-4750-932f-d8d2ff18b70b",
    "role": "host",
    "reason": ""
}'
 

{
    "message": "peer remove request submitted"
}
 

Arguments

Why would you use this API?

• Use this API to remove a peer from an active room for misconduct (e.g., abusive chat). This can be combined with custom logic not to generate app tokens for this user to block them from future joins.