An all-in-all Discord Bot that offers many cool new features in plugins which you can install to your Discord server!
Discord • Crowdin • Bugs & Suggestions
LupoBot offers a RESTful API as interface for other services, like our website. The REST API (version: 1) has GET and POST http requests. By default, it is available on port 7000 (configurable) on the /v1 path:
| HTTP request | Route | Explanation |
|---|---|---|
| GET | /bot | Get information about the bot |
| GET | /bot/status | Get the status of the bot |
| POST | /bot/status/:key | Set the status of the bot (ONLINE, IDLE, DO_NOT_DISTURB, INVISIBLE, OFFLINE) |
| GET | /bot/activity-name | Get the current activity name of the bot |
| POST | /bot/activity-name/:name | Set the activity name of the bot |
| POST | /bot/update-commands | Update all Slash Commands (register them again if the options etc. have been changed) |
| GET | /commands | Get all loaded commands |
| POST | /commands/:name | Enable or disable a command. The query param type is required (the type can be "disable" or "enable") |
| GET | /commands/:name | Get a specific command by its name |
| POST | /guilds/:id/messages | Create or edit a message on a guild. The query params id (= guild id) and channelId are required, the param messageId is optional if you want to edit a message and don't want to create a new one. Optional params to build the message or embed: content, description, thumbnail, authorName, authorIconUrl, authorUrl, title, titleUrl, footer, footerIconUrl, image, color (as int) |
| GET | /guilds/:id/channels | Get all channels on a guild by guild id |
| GET | /guilds/:id/channels/:channel | Get a specific channel on a guild by guild id and channel id |
| GET | /guilds/:id/roles | Get all roles on a guild by guild id |
| GET | /guilds/:id/roles/:role | Get a specific role on a guild by guild id and role id |
| GET | /guilds/members/:member | Get a specific role on a guild by member id |
| GET | /oauth2 | Get information about the user and the guilds which the has joined. The query params code (of Discord OAuth2) and redirect (redirect url after auth) are required |
| GET | /plugins | Get all loaded plugins |
| POST | /plugins/:name | Unload or reload a plugin by name. The query param type is required (the type can be "reload" or "unload") |
| GET | /plugins/:name | Get a specific plugin by its name |
| GET | /servers | Get all cached servers |
| GET | /servers/total | Get the total server count (also uncached servers) |
| POST | /servers/:id | Edit server data by guild id. The params key and value are required, plugin (= plugin name) is optional. If the param plugin is not given, the data will be set as core data (e.g. the prefix). Only the value of keys which exist in the server data can be edited! |
| GET | /servers/:id | Get a specific server by guild id (if it is not cached, it will be loaded) |
| GET | /shards | Get all shards |
| GET | /shards/total | Get the total shard count |
| GET | /shards/:id | Get a shard by id (starts with 0) |
| POST | /shards/:id | Shutdown or restart a shard by id. The query param type is required (the type can be "shutdown" or "restart") |
| GET | /users | Get all cached users |
| GET | /users/total | Get the total user count (also uncached users) |
| POST | /users/:id | Edit user data by member/user id. The params key and value are required, plugin (= plugin name) is optional. If the param plugin is not given, the data will be set as core data. Only the value of keys which exist in the user data can be edited! |
| GET | /users/:id | Get a specific user by guild id (if it is not cached, it will be loaded) |