Files
upstream-jitsi-videobridge/doc/rest-muc-client.md
upstream-mirror e1257b7a05
Some checks failed
Java CI with Maven / Java 17 (push) Failing after 7m2s
Java CI with Maven / Java 21 (push) Failing after 5m0s
snapshot of https://github.com/jitsi/jitsi-videobridge.git @ fcbf741c646bc237d2ed85a1e86910532532b831 (2026-09-15)
2026-09-15 16:12:38 +05:00

1.3 KiB

The configuration for the XMPP client connections that jitsi-videobridge uses can be modified at run time using REST calls to /colibri/muc-client/.

Adding an XMPP client connection

A new XMPP client connection (i.e. a MucClient) can be added by posting a JSON which contains its configuration to /colibri/muc-client/add:

{
  "id": "new-client-connection",
  "domain":"xmpp.example.com",
  "hostname":"10.0.0.1",
  "username":"xmpp-username",
  "password":"xmpp-password",
  "muc_jids":"JvbBrewery@conference.xmpp.example.com",
  "muc_nickname":"unique-resource",
  "disable_certificate_verification":"false"
}

If a configuration with the specified ID already exists the behavior depends on whether the hostname, port, domain and username fields match the existing client. If they match no changes are made, otherwise the existing MucClient is removed and a new one is added.

Removing an XMPP client connection

An XMPP client connection (i.e. a MucClient) can be removed by posting a JSON which contains its ID to /colibri/muc-client/remove:

{
  "id": "new-client-connection"
}

The request will be successful (return 200) if an XMPP client connection was removed.

Listing XMPP client connections

IDs of previously added XMPP client connections can be listed using a GET call to /colibri/muc-client/list.