Skip to content
PrexorCloud
Search
Ctrl
K
Cancel
GitHub
Getting Started
What is PrexorCloud?
Installation
Quickstart (10 min)
Core Concepts
Your First Network
Concepts
Architecture
Cluster Model
Groups, Instances, Templates
Scheduling + Auto-Scaling
Module System
Overview
Platform Modules
Daemon Modules
Capability Registry
Module Lifecycle
Plugin System
Events + EventBus
Security
Deployments + Rolling Updates
Guides
Multi-Node Setup
Rolling Deployments
Crash Recovery
Custom Scaling Rules
Backup + Restore
HA Controller (Redis)
Operations
Production Checklist
Configuration Reference
Monitoring + Metrics
Logs + Audit
Backups + DR
Upgrading
HA Setup
Disaster Drill
Recipes
BedWars Network
Survival Server
Multi-Game Network
Reverse Proxy in Front
CI/CD Deployments
Discord Notifications
Custom Scaling Logic
Migrate from CloudNet 4
Migrate from SimpleCloud V2
Migrate from Pterodactyl
Reference
REST API
Overview
Plugin
Rotate plugin workload token
Publish a custom event from game server
Issue SSE ticket for plugin events
List groups visible to plugin
List backend instances visible to plugin
Send a /msg from game server
Report periodic metrics snapshot
Report player join from game server
Report player leave from game server
List players visible to plugin
Report server startup complete
Queue a player transfer
Queue a group-based transfer
Proxy
Rotate workload token
Publish a custom event from proxy
Issue SSE ticket for proxy events
List groups visible to proxy
List backend instances visible to proxy
List pending messages for proxy
Mark a message delivered
Report proxy metrics
List networks visible to proxy
List pending transfers
Report player join
Report player leave
List players visible to proxy
Report proxy ready
Acknowledge transfer
Tokens
List join tokens
Create join token
Revoke join token
List workload credentials
Revoke all workload credentials for an instance
Revoke a workload credential
Audit
List audit log
Auth
Change own password
Login
Logout (revoke token)
Get current user
Complete password reset
Request password reset
Refresh JWT
Backups
List backups
Create a backup bundle
Prune old backups
Get backup manifest
Delete a backup
Verify backup integrity
Apply or dry-run a restore
Catalog
List catalog entries
Add catalog version
Delete catalog version
Update catalog version
Set version as recommended
Crashes
List crash reports
Crash trend buckets
Get crash detail
Share a crash report via pste
Events
List configured choreography entries
List currently active choreography overlays
SSE event stream
Issue SSE ticket for events stream
Groups
List all groups
Create group
Get group
Delete group
Partial update group
Get group with inheritance resolved
Rolling restart
Schedule new instances
Deployments
Trigger manual deployment
List deployment history
Get deployment detail
Pause deployment
Resume deployment
Rollback deployment
Maintenance
Get maintenance config
Update maintenance config
Metrics
Metrics summary
Modules
List modules with frontend metadata
List installed platform modules
List platform-module capability bindings
List platform-module extensions
Resolve extension variants for a runtime
Get module classloader leak status
Force module classloader cleanup
List platform module manifests
Install a new platform module from JAR
Uninstall a platform module
Stream a platform module artifact
Hot-reload a module's frontend bundle without touching its classloader
Drop a module's Mongo/Redis storage
Upgrade an installed platform module
Serve a module frontend asset
Networks
List network compositions
Create network composition
Get network composition
Update network composition
Delete network composition
Nodes
List nodes
List revoked subject CNs
Get node by ID
Delete (unregister) a disconnected node
Get node cache status
Request cache status refresh
Pre-warm node cache
Cordon a node (no new schedules, existing instances stay)
Drain a node
Recent daemon log records
Share recent daemon logs via pste
SSE daemon log stream
Issue SSE ticket for daemon log stream
Node metrics timeseries
Revoke a node's certificate
Uncordon a node
Cancel drain on a node
Unrevoke a node's certificate
Overview
Dashboard overview
Overview timeseries
Players
List online players
Get player by UUID
Get a player's journey log
Transfer player to another instance
Roles
List roles
Create role
Get role
Delete role
Update role permissions
Instances
List instances
Get instance by ID
Delete instance
Send console command
Get instance composition plan
SSE console output stream
Get console history
Share instance console history via pste
Read a bounded slice of a single file under an instance directory
Force stop
Get instance metrics snapshot
Instance metrics timeseries
Get proxy metrics
Graceful stop
Shares
List recent paste shares
Get a paste share by id
Revoke a paste share
System
Aggregated diagnostics document
Share the diagnostics bundle via pste
System health check
Recent controller log records
Share recent controller logs via pste
SSE controller log stream
Issue SSE ticket for controller log stream
Readiness check
Redis keyspace report
Redis key policies
Non-sensitive settings
Controller version info
Templates
List templates
Create template
Import template from uploaded tar.gz
Get template
Delete template
Update template metadata
Export template as tar.gz
Browse template files
Delete template file or directory
Read template file content
Save template file content
Download template file
Extract a ZIP already in the template
Create directory in template
Rename template file
Upload file(s) into template
Get template inheritance chain
Recompute template hash
Rollback to previous hash
Search within template files
Get template variables
Replace template variables
Scan template files for {{var}} placeholders
List template version snapshots
Delete a template version snapshot
Users
List users
Create user
Get user
Delete user
Update user
Get user avatar image
Upload user avatar
Delete user avatar
Link a Minecraft account
Unlink Minecraft account
Get user preferences
Update user preferences
API Playground
CLI (prexorctl)
Overview
Setup + Auth
Cluster Commands
Group + Instance
Templates
Users + Roles
Modules + Plugins
Utilities + Scripting
Module SDK
Overview
PlatformModule
DaemonModule
ModuleContext
EventBus
Capability API
Storage API
REST Routes
module.yaml Manifest
Plugin SDK
Overview
CloudPluginContext
EventHandler
Players + Commands
@CloudPlugin
Internals
Architecture Deep-Dive
gRPC Protocol
Overview
DaemonService
BootstrapService
AdminService
Storage Schema
Cosign Pipeline
Tech Stack
Compare
vs CloudNet 4
vs SimpleCloud V2
Project
Blog
Changelog
Performance Benchmarks
Contributing
GitHub
Publish a custom event from proxy
POST
/api/proxy/events
Authorizations
Section titled “Authorizations ”
workloadToken
Responses
Section titled “ Responses ”
200
Section titled “200 ”
Event published
