Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/ohemilyy/universe/llms.txt

Use this file to discover all available pages before exploring further.

The Universe REST API runs on the Master node and provides programmatic access to instance management and command execution. It is built on Ktor and serves JSON over HTTP. All four endpoints are available as soon as the Master node starts.

​
Base URL

http://<master-address>:<apiPort>
The default apiPort is 7000. Both values come from config.json on the Master node.
config.json
{
  "address": "127.0.0.1",
  "apiPort": 7000
}

​
Available endpoints

MethodPathDescription
GET/api/instancesReturn all known instances
POST/api/instancesCreate a new instance from a configuration
PUT/api/instances/{id}/stateUpdate an instance’s state and heartbeat
POST/api/commands/executeExecute a console command and return its output
See Instances and Commands for full per-endpoint documentation.

​
Authentication

Universe does not require authentication by default. The Ktor security plugin is configured in the codebase but no auth middleware is active out of the box. Restrict network access at the infrastructure level if you expose the API port publicly.

​
Content-Type

Every request that includes a body must set Content-Type: application/json. Every response is also JSON. 
curl -X POST http://localhost:7000/api/instances \
  -H "Content-Type: application/json" \
  -d '{"configurationName": "default"}'

​
HTTP status codes

CodeMeaning
200 OKRequest succeeded. Response body contains the result.
201 CreatedInstance was created. Response body contains the new InstanceInfo.
400 Bad RequestMissing or invalid request body field. Response body contains {"error": "..."}.
404 Not FoundThe referenced instance ID does not exist.
503 Service UnavailableNo cluster node has sufficient resources to start the requested instance.

​
Error response shape

All error responses share the same envelope: 
{
  "error": "Human-readable description of the problem"
}

Build docs developers (and LLMs) love

Get started for freeTalk to us