# simplecloud

## Docs

- [Droplets](https://new-docs.simplecloud.app/en/course/foundations/droplets.md): Use Droplets to manage your cloud from anywhere
- [Installation](https://new-docs.simplecloud.app/en/course/foundations/installation.md): Install and configure SimpleCloud on your machine
- [Introduction](https://new-docs.simplecloud.app/en/course/foundations/introduction.md): Get started with SimpleCloud - your first steps into cloud-managed Minecraft servers
- [Plugins](https://new-docs.simplecloud.app/en/course/foundations/plugins.md): Extend SimpleCloud with plugins for your servers
- [Server Groups & Templates](https://new-docs.simplecloud.app/en/course/foundations/server-groups-and-templates.md): Learn how to organize servers and manage their configurations
- [Linux Essentials](https://new-docs.simplecloud.app/en/course/guides/linux-essentials.md): Essential Linux commands for managing SimpleCloud
- [Permissions](https://new-docs.simplecloud.app/en/course/guides/permissions.md): Setting up permissions for your SimpleCloud network
- [Multi-Root Setup](https://new-docs.simplecloud.app/en/course/in-depth/multi-root.md): Scale your network across multiple machines
- [Remote Access](https://new-docs.simplecloud.app/en/course/in-depth/remote-access.md): Securely access and manage your cloud from anywhere
- [Self-Hosted Setup](https://new-docs.simplecloud.app/en/course/in-depth/self-hosted.md): Run SimpleCloud on your own dedicated server or VPS
- [List all networks (admin only)](https://new-docs.simplecloud.app/en/developer/api-reference/admin/list-all-networks-admin-only.md): List all networks. Requires admin access.
- [Create a new blueprint](https://new-docs.simplecloud.app/en/developer/api-reference/blueprints/create-a-new-blueprint.md): Create a new blueprint for a network
- [Delete a blueprint](https://new-docs.simplecloud.app/en/developer/api-reference/blueprints/delete-a-blueprint.md): Delete an existing blueprint
- [List blueprints](https://new-docs.simplecloud.app/en/developer/api-reference/blueprints/list-blueprints.md): Get a list of blueprints for a network
- [Partially update a blueprint](https://new-docs.simplecloud.app/en/developer/api-reference/blueprints/partially-update-a-blueprint.md): Partially update an existing blueprint
- [Update a blueprint](https://new-docs.simplecloud.app/en/developer/api-reference/blueprints/update-a-blueprint.md): Update an existing blueprint
- [Query current metric values](https://new-docs.simplecloud.app/en/developer/api-reference/metrics/query-current-metric-values.md): Get the latest values for a metric, optionally grouped by a label
- [Query logs with flexible filters](https://new-docs.simplecloud.app/en/developer/api-reference/metrics/query-logs-with-flexible-filters.md): Query logs using POST body with array-based filters for maximum flexibility
- [Query metric time series](https://new-docs.simplecloud.app/en/developer/api-reference/metrics/query-metric-time-series.md): Get time-bucketed metric values for charts, optionally grouped by a label
- [Stream logs in real-time via SSE](https://new-docs.simplecloud.app/en/developer/api-reference/metrics/stream-logs-in-real-time-via-sse.md): Server-Sent Events endpoint for real-time log streaming with filters
- [Create network secret](https://new-docs.simplecloud.app/en/developer/api-reference/networks/create-network-secret.md): Create a new network secret for the authenticated network
- [Delete a network and all its resources](https://new-docs.simplecloud.app/en/developer/api-reference/networks/delete-a-network-and-all-its-resources.md): Delete a network and cascade delete all associated resources (servers, groups, blueprints, etc.)
- [Delete network secret](https://new-docs.simplecloud.app/en/developer/api-reference/networks/delete-network-secret.md): Delete a network secret from the authenticated network
- [List network secrets](https://new-docs.simplecloud.app/en/developer/api-reference/networks/list-network-secrets.md): List all network secrets for the authenticated network
- [Register a new network](https://new-docs.simplecloud.app/en/developer/api-reference/networks/register-a-new-network.md): Register a new network and generate credentials
- [Update a network](https://new-docs.simplecloud.app/en/developer/api-reference/networks/update-a-network.md): Update the authenticated network
- [Verify network credentials](https://new-docs.simplecloud.app/en/developer/api-reference/networks/verify-network-credentials.md): Verify if the provided network credentials are valid
- [Create a new persistent server](https://new-docs.simplecloud.app/en/developer/api-reference/persistent-servers/create-a-new-persistent-server.md): Create a new persistent server for a network
- [Delete a persistent server](https://new-docs.simplecloud.app/en/developer/api-reference/persistent-servers/delete-a-persistent-server.md): Delete an existing persistent server
- [Delete persistent server property keys](https://new-docs.simplecloud.app/en/developer/api-reference/persistent-servers/delete-persistent-server-property-keys.md): Delete specific property keys from a persistent server
- [Execute a manual workflow for all running servers of a persistent server](https://new-docs.simplecloud.app/en/developer/api-reference/persistent-servers/execute-a-manual-workflow-for-all-running-servers-of-a-persistent-server.md): Execute a configured manual workflow for all eligible running servers of a persistent server
- [List persistent servers](https://new-docs.simplecloud.app/en/developer/api-reference/persistent-servers/list-persistent-servers.md): Get a list of persistent servers for a network
- [Merge persistent server properties](https://new-docs.simplecloud.app/en/developer/api-reference/persistent-servers/merge-persistent-server-properties.md): Merge/update specific property keys for a persistent server (deep merge)
- [Partially update a persistent server](https://new-docs.simplecloud.app/en/developer/api-reference/persistent-servers/partially-update-a-persistent-server.md): Partially update an existing persistent server
- [Replace persistent server properties](https://new-docs.simplecloud.app/en/developer/api-reference/persistent-servers/replace-persistent-server-properties.md): Replace entire properties object for a persistent server
- [Update a persistent server](https://new-docs.simplecloud.app/en/developer/api-reference/persistent-servers/update-a-persistent-server.md): Update an existing persistent server
- [Connect player to server](https://new-docs.simplecloud.app/en/developer/api-reference/players/connect-player-to-server.md): Connect a player to a specific server, server group, or persistent server
- [Delete player properties](https://new-docs.simplecloud.app/en/developer/api-reference/players/delete-player-properties.md): Delete specific property keys
- [Get client settings](https://new-docs.simplecloud.app/en/developer/api-reference/players/get-client-settings.md): Get client settings for an online player's current session
- [Get current session](https://new-docs.simplecloud.app/en/developer/api-reference/players/get-current-session.md): Get the current active session for an online player
- [Get latest player profile](https://new-docs.simplecloud.app/en/developer/api-reference/players/get-latest-player-profile.md): Get the most recent profile (name/skin) for a player
- [Get online player count](https://new-docs.simplecloud.app/en/developer/api-reference/players/get-online-player-count.md): Get the count of online players
- [Get player by name](https://new-docs.simplecloud.app/en/developer/api-reference/players/get-player-by-name.md): Get a player by their name
- [Get player by UUID](https://new-docs.simplecloud.app/en/developer/api-reference/players/get-player-by-uuid.md): Get a player by their Minecraft UUID
- [Get player online time](https://new-docs.simplecloud.app/en/developer/api-reference/players/get-player-online-time.md): Get total online time for a player on this network
- [Get player properties](https://new-docs.simplecloud.app/en/developer/api-reference/players/get-player-properties.md): Get custom properties for a player
- [Kick a player](https://new-docs.simplecloud.app/en/developer/api-reference/players/kick-a-player.md): Kick a player from the network
- [List online players](https://new-docs.simplecloud.app/en/developer/api-reference/players/list-online-players.md): Get a list of online players
- [List player profiles](https://new-docs.simplecloud.app/en/developer/api-reference/players/list-player-profiles.md): Get a player's profile history (name/skin changes)
- [List player sessions](https://new-docs.simplecloud.app/en/developer/api-reference/players/list-player-sessions.md): Get session history for a player on this network
- [List players](https://new-docs.simplecloud.app/en/developer/api-reference/players/list-players.md): Get a list of players for a network with optional filtering
- [Partially update a player](https://new-docs.simplecloud.app/en/developer/api-reference/players/partially-update-a-player.md): Partially update admin-managed player fields like online time and optionally reset first/last seen timestamps to now
- [Patch player properties](https://new-docs.simplecloud.app/en/developer/api-reference/players/patch-player-properties.md): Merge properties with existing ones
- [Update client settings](https://new-docs.simplecloud.app/en/developer/api-reference/players/update-client-settings.md): Update client settings for an online player's current session
- [Update player properties](https://new-docs.simplecloud.app/en/developer/api-reference/players/update-player-properties.md): Replace all player properties
- [Create a new plugin assignment](https://new-docs.simplecloud.app/en/developer/api-reference/plugin-assignments/create-a-new-plugin-assignment.md): Assign a plugin to a server group or persistent server. You can either provide a plugin_id to use an existing plugin, or provide plugin_name, source_type, and source_value to find or create the plugin automatically.
- [Delete a plugin assignment](https://new-docs.simplecloud.app/en/developer/api-reference/plugin-assignments/delete-a-plugin-assignment.md): Delete an existing plugin assignment
- [List plugin assignments](https://new-docs.simplecloud.app/en/developer/api-reference/plugin-assignments/list-plugin-assignments.md): Get a list of plugin assignments for a network, optionally filtered by server group or persistent server
- [Create a new plugin](https://new-docs.simplecloud.app/en/developer/api-reference/plugins/create-a-new-plugin.md): Create a new plugin for a network
- [Delete a plugin](https://new-docs.simplecloud.app/en/developer/api-reference/plugins/delete-a-plugin.md): Delete an existing plugin
- [List plugins](https://new-docs.simplecloud.app/en/developer/api-reference/plugins/list-plugins.md): Get a list of plugins for a network
- [Update a plugin](https://new-docs.simplecloud.app/en/developer/api-reference/plugins/update-a-plugin.md): Update an existing plugin
- [Cancel a rolling restart](https://new-docs.simplecloud.app/en/developer/api-reference/server-groups/cancel-a-rolling-restart.md): Cancel an in-progress rolling restart for a server group
- [Clear queued server group starts](https://new-docs.simplecloud.app/en/developer/api-reference/server-groups/clear-queued-server-group-starts.md): Clear all queued server starts for one server group
- [Create a new server group](https://new-docs.simplecloud.app/en/developer/api-reference/server-groups/create-a-new-server-group.md): Create a new server group for a network
- [Delete a server group](https://new-docs.simplecloud.app/en/developer/api-reference/server-groups/delete-a-server-group.md): Delete an existing server group
- [Delete server group property keys](https://new-docs.simplecloud.app/en/developer/api-reference/server-groups/delete-server-group-property-keys.md): Delete specific property keys from a server group
- [Execute a manual workflow for all running servers in a server group](https://new-docs.simplecloud.app/en/developer/api-reference/server-groups/execute-a-manual-workflow-for-all-running-servers-in-a-server-group.md): Execute a configured manual workflow for all eligible servers in a server group
- [Get rolling restart status](https://new-docs.simplecloud.app/en/developer/api-reference/server-groups/get-rolling-restart-status.md): Get the status of a rolling restart for a server group
- [List queued server group starts](https://new-docs.simplecloud.app/en/developer/api-reference/server-groups/list-queued-server-group-starts.md): List queued server starts aggregated by server group
- [List server groups](https://new-docs.simplecloud.app/en/developer/api-reference/server-groups/list-server-groups.md): Get a list of server groups for a network
- [Merge server group properties](https://new-docs.simplecloud.app/en/developer/api-reference/server-groups/merge-server-group-properties.md): Merge/update specific property keys for a server group (deep merge)
- [Partially update a server group](https://new-docs.simplecloud.app/en/developer/api-reference/server-groups/partially-update-a-server-group.md): Partially update an existing server group
- [Queue a server group start](https://new-docs.simplecloud.app/en/developer/api-reference/server-groups/queue-a-server-group-start.md): Persist one queued server start for a server group that will be executed by the reconciler on the next tick
- [Replace server group properties](https://new-docs.simplecloud.app/en/developer/api-reference/server-groups/replace-server-group-properties.md): Replace entire properties object for a server group
- [Start a rolling restart](https://new-docs.simplecloud.app/en/developer/api-reference/server-groups/start-a-rolling-restart.md): Start a rolling restart operation for a server group. Restarts servers one by one while ensuring availability.
- [Stop all servers in a server group](https://new-docs.simplecloud.app/en/developer/api-reference/server-groups/stop-all-servers-in-a-server-group.md): Send stop commands to all running servers in a server group
- [Update a server group](https://new-docs.simplecloud.app/en/developer/api-reference/server-groups/update-a-server-group.md): Update an existing server group
- [Deactivate or reactivate a serverhost](https://new-docs.simplecloud.app/en/developer/api-reference/serverhosts/deactivate-or-reactivate-a-serverhost.md): Deactivate or reactivate a serverhost to prevent/allow new server allocations
- [Delete a serverhost](https://new-docs.simplecloud.app/en/developer/api-reference/serverhosts/delete-a-serverhost.md): Delete an existing serverhost
- [List serverhosts](https://new-docs.simplecloud.app/en/developer/api-reference/serverhosts/list-serverhosts.md): Get a list of serverhosts for a network
- [Register a new serverhost](https://new-docs.simplecloud.app/en/developer/api-reference/serverhosts/register-a-new-serverhost.md): Register a new serverhost for a network
- [Update a serverhost](https://new-docs.simplecloud.app/en/developer/api-reference/serverhosts/update-a-serverhost.md): Update an existing serverhost
- [Verify a serverhost](https://new-docs.simplecloud.app/en/developer/api-reference/serverhosts/verify-a-serverhost.md): Verify if a serverhost exists and belongs to the specified network
- [Delete a server row from the database](https://new-docs.simplecloud.app/en/developer/api-reference/servers/delete-a-server-row-from-the-database.md): Delete a server row from the database without stopping the server or publishing events
- [Delete server property keys](https://new-docs.simplecloud.app/en/developer/api-reference/servers/delete-server-property-keys.md): Delete specific property keys from a server
- [Execute a manual workflow for a server](https://new-docs.simplecloud.app/en/developer/api-reference/servers/execute-a-manual-workflow-for-a-server.md): Execute a configured manual workflow for a running server
- [List servers](https://new-docs.simplecloud.app/en/developer/api-reference/servers/list-servers.md): Get a list of servers for a network with optional filters. Returns comprehensive server information including server group or persistent server details, blueprint information, and workflow configurations. Filters for type, name, and tags work with both server groups and persistent servers.
- [Merge server properties](https://new-docs.simplecloud.app/en/developer/api-reference/servers/merge-server-properties.md): Merge/update specific property keys for a server (deep merge)
- [Partially update a server](https://new-docs.simplecloud.app/en/developer/api-reference/servers/partially-update-a-server.md): Partially update an existing server
- [Replace server properties](https://new-docs.simplecloud.app/en/developer/api-reference/servers/replace-server-properties.md): Replace entire properties object for a server
- [Send command to server](https://new-docs.simplecloud.app/en/developer/api-reference/servers/send-command-to-server.md): Send a command to a running server via NATS
- [Stop a server](https://new-docs.simplecloud.app/en/developer/api-reference/servers/stop-a-server.md): Stop an existing server
- [Get cloud statistics](https://new-docs.simplecloud.app/en/developer/api-reference/stats/get-cloud-statistics.md): Get aggregated statistics for the network including server counts, player stats, resource utilization, and health status
- [Events API](https://new-docs.simplecloud.app/en/developer/api/events.md): Subscribe to real-time events from your cloud network
- [Groups API](https://new-docs.simplecloud.app/en/developer/api/groups.md): Manage server groups programmatically
- [Players API](https://new-docs.simplecloud.app/en/developer/api/players.md): Manage players and send cross-server messages
- [Servers API](https://new-docs.simplecloud.app/en/developer/api/servers.md): Query and manage running server instances
- [Handle Events in Real-Time](https://new-docs.simplecloud.app/en/developer/guides/event-handling.md): React to server, group, and player changes with the Events API
- [Transfer Players Between Servers](https://new-docs.simplecloud.app/en/developer/guides/player-transfer.md): Move players across your network programmatically
- [Manage Servers Programmatically](https://new-docs.simplecloud.app/en/developer/guides/server-management.md): Start, stop, and monitor servers with the Cloud API
- [Installation](https://new-docs.simplecloud.app/en/developer/installation.md): Add the Cloud API to your Minecraft plugin or standalone application
- [Cloud API](https://new-docs.simplecloud.app/en/developer/overview.md): Build integrations with SimpleCloud using our Java/Kotlin API
- [Configurators](https://new-docs.simplecloud.app/en/manual/configuration/configurators.md): Automatic server configuration based on server software
- [Workflows](https://new-docs.simplecloud.app/en/manual/configuration/workflows.md): Define server preparation and cleanup processes with workflow steps
- [CLI](https://new-docs.simplecloud.app/en/manual/introduction/architecture/cli.md): The command-line interface for managing your SimpleCloud installation
- [Controller](https://new-docs.simplecloud.app/en/manual/introduction/architecture/controller.md): The central orchestration service that manages your SimpleCloud infrastructure
- [Architecture](https://new-docs.simplecloud.app/en/manual/introduction/architecture/overview.md): Learn about the core concepts and distributed architecture of SimpleCloud v3
- [Serverhost](https://new-docs.simplecloud.app/en/manual/introduction/architecture/serverhost.md): The execution agent responsible for running Minecraft servers
- [FAQ](https://new-docs.simplecloud.app/en/manual/introduction/faq.md): Frequently asked questions about SimpleCloud
- [Overview](https://new-docs.simplecloud.app/en/manual/introduction/overview.md): SimpleCloud is a management system for Minecraft server networks with auto-scaling, a dashboard, and developer APIs.
- [Philosophy](https://new-docs.simplecloud.app/en/manual/introduction/philosophy.md): Our guiding principles and approach to building SimpleCloud
- [Updates](https://new-docs.simplecloud.app/en/manual/introduction/updates.md): Keep your SimpleCloud installation up to date with our built-in update mechanisms
- [Cloud Command](https://new-docs.simplecloud.app/en/manual/plugin/cloud-command.md): Learn about SimpleCloud's in-game command plugin for managing your server network
- [Notify](https://new-docs.simplecloud.app/en/manual/plugin/notify.md): Learn about SimpleCloud's notify plugin for real-time server state notifications
- [NPCs](https://new-docs.simplecloud.app/en/manual/plugin/npcs.md): Learn about SimpleCloud's NPCs plugin for interactive server navigation and management
- [Overview](https://new-docs.simplecloud.app/en/manual/plugin/overview.md): Plugins extend SimpleCloud functionality directly within your Minecraft servers
- [Placeholders](https://new-docs.simplecloud.app/en/manual/plugin/placeholders.md): Use Controller API parameters for servers and groups as placeholders in your server
- [Prefixes](https://new-docs.simplecloud.app/en/manual/plugin/prefixes.md): Learn about SimpleCloud's prefixes plugin for managing player ranks in chat and tab list
- [Proxy Essentials](https://new-docs.simplecloud.app/en/manual/plugin/proxy-essentials.md): Learn about SimpleCloud's proxy essentials plugin for customizable MOTD, Tablist, and Joinstates
- [Server Connection](https://new-docs.simplecloud.app/en/manual/plugin/server-connection.md): Learn how SimpleCloud's server connection plugin handles fallback and connection logic
- [Server Registration](https://new-docs.simplecloud.app/en/manual/plugin/server-registration.md): Learn about SimpleCloud's server registration plugin for proxy server management
- [Signs](https://new-docs.simplecloud.app/en/manual/plugin/signs.md): Learn about SimpleCloud's signs plugin for server navigation and status display
- [Installation](https://new-docs.simplecloud.app/en/manual/setup/installation.md): Get started with SimpleCloud by creating your account and connecting your first server host
- [Multi-Root Setup](https://new-docs.simplecloud.app/en/manual/setup/multi-root.md): Run SimpleCloud across multiple machines with distributed serverhosts
- [Persistent Servers](https://new-docs.simplecloud.app/en/manual/setup/persistent-servers.md): Create always-on server instances that maintain state between restarts
- [Self Hosting](https://new-docs.simplecloud.app/en/manual/setup/self-hosting.md): Run SimpleCloud across multiple machines with distributed serverhosts
- [Server Groups](https://new-docs.simplecloud.app/en/manual/setup/server-groups.md): Create and manage server groups with auto-scaling in the SimpleCloud dashboard
- [Servers](https://new-docs.simplecloud.app/en/manual/setup/servers.md): Understanding server instances in your SimpleCloud network
- [Templates](https://new-docs.simplecloud.app/en/manual/setup/templates.md): Templates define the files, plugins, and configurations that get copied to new servers

## OpenAPI Specs

- [doc](https://controller.simplecloud.app/swagger/doc.json)
- [openapi](https://new-docs.simplecloud.app/api-reference/openapi.json)