API

Semoxy API Documentation

Welcome to the documentation of the Semoxy API.

This documentation is for those who want to help developing Semoxy or write external automation for their minecraft servers.

Since the Semoxy Software is decentralized, everyone can setup their own instance and thus the base API URL varies. You need to find out the URL of the Semoxy instance your developing for, before you can use the API. The API is proxied by the frontend at the /api path, so for example if the frontend is running on https://127.0.0.1/, the API will listen on https://127.0.0.1/api/. You can check the API status by GET / More infos about this endpoint here [WIP].

Once you have found out the base API URL, you can continue with authentication.