Skip to content

MongooseIM's REST API for backend administration

Configuration

Commands used by the REST API are provided by modules:

mod_commands - provides general purpose commands: both user-like (e.g. sending a message and retrieving messages from the archive) and administration-like (e.g. 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 the modules you need into the mongooseim.toml file:

1
2
3
4
5
  [modules.mod_commands]

  [modules.mod_muc_commands]

  [modules.mod_muc_light_commands]

You also have to hook the mongoose_api_admin module to an HTTP endpoint as described in the admin REST API handlers configuration section of the listeners documentation.

OpenAPI specifications

Read the beautiful Swagger documentation for more information.

Swagger