Skip to main content
The Cloud API connects your Java or Kotlin Minecraft plugin to SimpleCloud. Use it to query, manage, and react to the current state of your network. With the Cloud API, you can:
  • Create and configure server groups
  • Manage long-running persistent servers
  • Find and update running server instances
  • Look up players, send messages, and transfer them between servers
  • React when resources in your network change

​
Choose where to begin

Install the Cloud API

Add the dependency and create a client for your plugin.

Groups

Create groups, change their configuration, and request new servers.

Running servers

Find, inspect, update, and stop server instances.

Persistent servers

Manage servers that keep their identity across restarts.

Players

Look up players, send messages, and connect them to servers.

Events

Run code when groups, servers, persistent servers, or blueprints change.

​
Build a common workflow

Transfer a player

Move an online player to another server and handle the result.

Manage scaler-provided servers

Select available capacity without competing with SimpleCloud autoscaling.

Handle events safely

Subscribe to network changes for the lifetime of your plugin.