MongooseIM's REST API for backend administration


Commands used by the REST API are provided by modules:

mod_commands - provides general purpose commands: both user-like (f.e. sending a message and retrieving messages from the archive) and administration-like (f.e. create/delete a user and change the password)

mod_muc_commands - commands related to Multi-user Chat rooms: create a room, invite users, send a message etc.

mod_muc_light_commands - same but for rooms based on the muc-light protocol.

To activate those commands, put modules you need into the mongooseim.cfg file:

  {mod_commands, []},
  {mod_muc_commands, []},
  {mod_muc_light_commands, []},

You also have to hook mongoose_api_admin module to an HTTP endpoint:

  { {8088, ""} , ejabberd_cowboy, [
      {num_acceptors, 10},
      {transport_options, [{max_connections, 1024}]},
      {modules, [
          {"localhost", "/api", mongoose_api_admin, []}

OpenAPI specifications

Read the beautiful Swagger documentation for more information.