Web Server API


v5.1.0 API -

    /api/

  • [POST] /api/command: Sends a given command to the bot.
    Example request body: { "text": "!echo test" }
  • [GET] /api/lastcommand: Retrieves the most recent command sent to the bot.
  • [POST] /api/clearcmdhistory: Clears the command history of the bot.
    Example request body: No request body required
  • [GET] /api/cmdhistory: Retrieves the command history of the bot.
  • [GET] /api/plugins: Retrieves a list of all the active plugins in the bot.
  • [GET] /api/channels: Retrieves a list of all the server channels in the mumble server.

  • /api/general/

  • [GET] /api/general/: Retrieves general bot information such as the name and command token.
  • [GET] /api/general/name: Retrieves the bot name.
  • [GET] /api/general/token: Retrieves the bot command token.
  • [GET] /api/general/system: Retrieves the system information that the bot is running on.
  • [GET] /api/general/uptime: Retrieves the bot up-time information.
  • [GET] /api/general/version: Retrieves the bot version information.
  • [GET] /api/general/about: Retrieves the bot about information.

  • /api/audio/

  • [POST] /api/audio/pause: Pauses the audio interface.
    Example request body: No request body required
  • [POST] /api/audio/pause: Pauses the current track in the audio interface.
    Example request body: No request body required
  • [POST] /api/audio/resume: Resumes the current track in the audio interface.
    Example request body: No request body required
  • [POST] /api/audio/replay: Replays the current track in the audio interface.
    Example request body: No request body required
  • [POST] /api/audio/nexttrack: Skips to the next track in the audio interface queue.
    Example request body: No request body required
  • [POST] /api/audio/decreasevolume: Decreases the volume of the audio interface by 0.1
    Example request body: No request body required
  • [POST] /api/audio/increasevolume: Increases the volume of the audio interface by 0.1
    Example request body: No request body required
  • [POST] /api/audio/loop: Sets the audio interface to loop tracks.
    Example request body: No request body required
  • [POST] /api/audio/skipto: Skips to the given track in the audio interface queue.
    Example request body: { "text": "track_index_in_queue" }
  • [POST] /api/audio/removetrack: Removes the given track in the audio interface queue.
    Example request body: { "text": "track_index_in_queue" }
  • [POST] /api/audio/stop: Stops the current track and clears the queue in the audio interface.
    Example request body: No request body required

  • /api/admin/users/

  • [POST] /api/admin/users/join - Join the channel of a given user.
    Example request body: { "text": "username" }
  • [POST] /api/admin/users/move - Move the given user to a channel.
    Example request body: { "text": "username channel_name" }
  • [POST] /api/admin/users/kick - Kick the given user and provide an optional reason.
    Example request body: { "text": "username" } Example request body: { "text": "username reason" }
  • [POST] /api/admin/users/ban - Ban the given user and provide an optional reason.
    Example request body: { "text": "username" } Example request body: { "text": "username reason" }
  • [POST] /api/admin/users/mute - Mute/Unmute the given user.
    Example request body: { "text": "username" }
  • [POST] /api/admin/users/deafen - Deafen/Undeafen the given user.
    Example request body: { "text": "username" }

  • /api/admin/channels/

  • [POST] /api/admin/channels/rename - Rename the given channel to a new name.
    Example request body: { "text": "current_name new_name" }
  • [POST] /api/admin/channels/remove - Remove the given channel.
    Example request body: { "text": "channel_name" }
  • [POST] /api/admin/channels/move - Move to the given channel.
    Example request body: { "text": "channel_name" }
  • [POST] /api/admin/channels/leave - Leave the current channel and return to the default channel.
    Example request body: No request body required
  • [POST] /api/admin/channels/make_temporary - Make a temporary channel with the given name.
    Example request body: { "text": "channel_name" }
  • [POST] /api/admin/channels/make_permanent - Make a permanent channel with the given name.
    Example request body: { "text": "channel_name" }

  • /api/admin/plugins/

  • [POST] /api/admin/plugins/stop - Stops an existing, running plugin with the given name.
    Example request body: { "text": "plugin_name" }
  • [POST] /api/admin/plugins/start - Starts an existing, stopped plugin with the given name.
    Example request body: { "text": "plugin_name" }
  • [POST] /api/admin/plugins/restart - Restarts an existing plugin with the given name.
    Example request body: { "text": "plugin_name" }
  • [POST] /api/admin/plugins/restart_all - Restarts all existing plugins.
    Example request body: No request body required

  • /api/admin/plugins/metadata/

  • [POST] /api/admin/plugins/metadata/get - Retrieves the metadata file contents of the plugin with the given name.
    Example request body: { "text": "plugin_name" }
  • [POST] /api/admin/plugins/metadata/set - Overwrites the metadata file contents of the plugin with the given name, with the provided data.
    Example request body: { "name": "plugin_name" "text": "<JSON Data>" }

  • /api/sound_board/

  • [GET] /api/sound_board/clips: Retrieves a list of all the sound_board clips in local storage.
  • [POST] /api/sound_board/random: Plays a random soundboard clip from local storage.
    Example request body: No request body required
  • [POST] /api/sound_board/play: Plays a soundboard clip by the given name from local storage.
    Example request body: { "text": "my_clip_name" }
v5.0.0 API - Deprecated
  • [POST] /api/command: Sends a given command to the bot.
    Example request body: { "text": "!echo test" }
  • [GET] /api/lastcommand: Retrieves the most recent command sent to the bot.
  • [POST] /api/pause: Pauses the audio interface.
    Example request body: No request body required
  • [POST] /api/pause: Pauses the current track in the audio interface.
    Example request body: No request body required
  • [POST] /api/resume: Resumes the current track in the audio interface.
    Example request body: No request body required
  • [POST] /api/replay: Replays the current track in the audio interface.
    Example request body: No request body required
  • [POST] /api/nexttrack: Skips to the next track in the audio interface queue.
    Example request body: No request body required
  • [POST] /api/decreasevolume: Decreases the volume of the audio interface by 0.1
    Example request body: No request body required
  • [POST] /api/increasevolume: Increases the volume of the audio interface by 0.1
    Example request body: No request body required
  • [POST] /api/clearcmdhistory: Clears the command history of the bot.
    Example request body: No request body required
  • [GET] /api/cmdhistory: Retrieves the command history of the bot.
  • [POST] /api/loop: Sets the audio interface to loop tracks.
    Example request body: No request body required
  • [POST] /api/skipto: Skips to the given track in the audio interface queue.
    Example request body: { "text": "track_index_in_queue" }
  • [POST] /api/removetrack: Removes the given track in the audio interface queue.
    Example request body: { "text": "track_index_in_queue" }
  • [POST] /api/stop: Stops the current track and clears the queue in the audio interface.
    Example request body: No request body required
  • [GET] /api/plugins: Retrieves a list of all the active plugins in the bot.
  • [GET] /api/channels: Retrieves a list of all the server channels in the mumble server.
  • [GET] /api/soundboardclips: Retrieves a list of all the sound_board clips in local storage.
  • [POST] /api/soundboard-random: Plays a random soundboard clip from local storage.
    Example request body: No request body required
  • [POST] /api/soundboard-play: Plays a soundboard clip by the given name from local storage.
    Example request body: { "text": "my_clip_name" }
  • [GET] /api/system: Retrieves the system information that the bot is running on.
  • [GET] /api/general/: Retrieves general bot information such as the name and command token.
  • [GET] /api/general/name: Retrieves the bot name.
  • [GET] /api/general/token: Retrieves the bot command token.