Omi's API

Quick rating

Omi's API

No reviews yet

Omi's API is a server-sided mod that includes a configurable API for developers to interact with.

QoL & Tweaks
Mod Loaders
Forge
Minecraft

Community voices

Reviews

Versions
Loading versions…
Match includes

Click once to include, again to exclude, again to clear

Rating Any
Any 0.5 1.0 1.5 2.0 2.5 3.0 3.5 4.0 4.5 5.0
Min
Max
Play Status
Reviews
Time Played
hrs+
Verified developers only
Has developer response
List view
Grid view
Compact view
Sort by
Date
Rating
Helpful
Unhelpful
Edited
Sort ascending
Delete this review?

This removes your review from the project. You can write a new review after.

Review submitted for moderation

Your review has been sent to moderators, who will check that it meets our guidelines before it appears publicly.

No reviews yet. Be the first to review this project!

Get it on

Available Platforms

About

Project Details

Type
Mod
Latest Version
omiapi-1.0.jar
Authors

For authors

Embed Badge

If you're the author of this project, you can embed a live badge anywhere that supports HTML or Markdown. It updates automatically whenever ratings change.

Custom banner text
ModDex rating badge preview

Use HTML for any page that supports it, or Markdown for README files and Markdown-based descriptions.

Identifiers

Platform IDs

CurseForge ID

Resources

External Links

Source Issues Wiki Discord

About

Description

Omi's_Api_banner

 Omi's Minecraft API is a server-side mod which creates a simple API to connect with.

 
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.

Screenshots

Gallery

  • banner12.png
    banner12.png banner12.png

Versions

Files

Relations

Project Relations

More like this

Similar Mods

Suggestions use data such as tags, dependencies, dependents, descriptions, titles, and more to rank how much they overlap with this mod.

On ModDex

Community snapshot

0
Ratings
0
Followers
0
In stacks

By the numbers

Statistics

<1,000
Downloads
Last Updated
Created
Last synced
When ModDex last fetched this project from CurseForge or Modrinth. Every project is re-checked on a schedule, and any project that ships a new file is synced automatically within hours of the release.
New file updates sync automatically
How syncing works