Getting Started

Download the mod and place it on your server.
When starting the server, the mod will boot up and the config file should show up in the config folder.
Modify the omiapi-common.toml file as you like.
Be sure to change the auth settings to avoid third-party connections
Restart the server
If when first sending a request to the server, you notice an error in the server console, just ignore it.

About the API

The API allows server admins to connect and interact remotely while maintaining a simple and secure style. This tool will come in handy while working with integrations or webhooks.

Currently, the API supports:

Retrieving the general status of the server
Retrieving detailed information about the server (players, config, memory...)
Retrieving the player list
Retrieving a player's inventory
Retrieving the Ban List
Broadcasting a Minecraft-formatted message
Whispering to a user
Executing a command
Shutdown the server
Kick a player
Ban a player (Both via IP and GameProfile/UUID)
Unbanning a player (IP or GameProfile/UUID)

Moreover, the API not only uses Basic Auth to ensure security but it can also be configured to disable routes you may not use.

You can see the routes documentation here.

Omi's API