How to Set Up ServerTap on Your Minecraft Server

ServerTap allows your Minecraft server to communicate with external applications, bots, and automation tools using a simple REST API. This guide will show you how to install and configure ServerTap on your server using the Peel Panel.

Requirements

Before getting started, make sure your server meets the following:

  • Running Paper, Purpur, Spigot, or Fabric

  • Access to the File Manager in the Peel Panel

  • Ability to restart the server

  BananaServers already includes extra network ports with each server, so you won’t need to manually request one.

Step 1: Install ServerTap

  1. Download the latest release of ServerTap from the official page:
    https://github.com/servertap-io/servertap/releases/latest

  2. In the Peel Panel, open your server’s File Manager.

  3. Upload the downloaded .jar file to the following directory:

     
    /plugins/

  4. Restart your server completely (do not use “Reload”).

Step 2: Configure ServerTap

After restarting, open the configuration file:

 
/plugins/servertap/config.yml

You’ll see something similar to:

 
port: 25891 useKeyAuth: true key: 'YOUR_API_KEY'

Set a Secure API Key

Replace 'YOUR_API_KEY' with your own unique key.
For example:

 
key: 'MySecureKey123'

Choose an Available Port

If 25891 is already in use (for example by RCON or another plugin), you can select any free port — such as 25750.

 
port: 25750

Once you’ve made these changes, save the file and restart the server again.

Step 3: Confirm Your ServerTap Endpoint

After restarting, your ServerTap API will be available at:

 
http://YOUR.SERVER.IP:PORT/v1/

Example:

 
http://123.45.67.89:25750/v1/

(Insert screenshot showing successful API response here.)

Step 4: Test ServerTap on Windows

You can verify that ServerTap is responding by running one of the following commands on your computer.

Option 1: PowerShell (Recommended)

 
Invoke-RestMethod -Uri "http://YOUR.SERVER.IP:PORT/v1/server" -Headers @{ "key" = "MySecureKey123" }

Option 2: Using curl

PowerShell aliases curl, so use the full executable:

 
curl.exe -H "key: MySecureKey123" "http://YOUR.SERVER.IP:PORT/v1/server"

Example Output:

 
{"name":"Paper","motd":"Your Server MOTD","tps":20,...}

(Insert screenshot showing JSON output here.)

Common Issues & Fixes

Issue Cause Solution
Unauthorized key Incorrect header name Use key: instead of x-api-key:
No response / timeout Port blocked or plugin not running Restart your server and verify your chosen port isn’t in use
Port conflict RCON or another plugin using same port Change the port: value in config.yml to an unused one

Important Notes

  • Ensure no two plugins or services are using the same port.

  • The REST API endpoint can be used for custom dashboards, Discord bots, or server monitoring tools.

(Insert screenshot example showing a port conflict resolution.)

Conclusion

ServerTap is now installed and responding to API requests!
You can integrate it with tools such as:

  • Web dashboards

  • Discord bots

  • Custom scripts and automation systems

If you experience issues:

  1. Verify your API key and port configuration.

  2. Restart the server to apply any changes.

  3. Check your console logs for any plugin errors.

Want to build something powerful with your server?
BananaServers offers reliable, automation-ready hosting with full API support.
Get started today at BananaServers.ca

  • 0 Users Found This Useful
Was this answer helpful?

Related Articles

Forge/Fabric mods that improve performance

Performance Mods to Install: Smooth Chunk Save: This mod smooths out the process of saving...

How much ram/memory does my minecraft server need?

How Much RAM/Memory Does My Minecraft Server Need? When running a Minecraft server, it's crucial...

How do I make myself admin on my Minecraft server?

Step 1: Accessing the Peel Panel Log in to your BananaServers account. Navigate to Peel Panel...

How to build a nether portal in Minecraft.

How to Build a Nether Portal in Minecraft Building a Nether Portal in Minecraft is an exciting...

How to reset your Minecraft world

How to Reset Your Minecraft World Step 1: Log in to Bananaservers Peel Panel Go to...