OpenAPI
This OpenAPI document is generated from the same request catalogue used by the reference pages.
The raw JSON version is available at /docs/api/openapi.json.
{
"openapi": "3.1.0",
"info": {
"title": "CreeperHost Aries API",
"version": "1.1.0",
"description": "Static OpenAPI representation generated from the legacy public Aries API documentation."
},
"servers": [
{
"url": "https://api.creeper.host"
}
],
"components": {
"securitySchemes": {
"keyHeader": {
"type": "apiKey",
"in": "header",
"name": "key"
},
"secretHeader": {
"type": "apiKey",
"in": "header",
"name": "secret"
}
}
},
"paths": {
"/os/getram": {
"get": {
"tags": [
"Server"
],
"summary": "Get server RAM details",
"description": "Returns current memory usage.",
"operationId": "os-getram",
"x-aries-daemon": "os",
"x-aries-command": "getram",
"parameters": [],
"responses": {
"200": {
"description": "Successful Aries response",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"status": "success",
"free": 8319,
"used": 69,
"endPoint": "aries-production-59c48bc84-hpqw4"
}
}
}
}
},
"security": [
{
"keyHeader": [],
"secretHeader": []
}
]
}
},
"/os/gethdd": {
"get": {
"tags": [
"Server"
],
"summary": "Get server HDD details",
"description": "Returns current hard disk usage.",
"operationId": "os-gethdd",
"x-aries-daemon": "os",
"x-aries-command": "gethdd",
"parameters": [],
"responses": {
"200": {
"description": "Successful Aries response",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"status": "success",
"free": 47443608,
"used": 4027364,
"endPoint": "aries-production-59c48bc84-hpqw4"
}
}
}
}
},
"security": [
{
"keyHeader": [],
"secretHeader": []
}
]
}
},
"/os/getcpu": {
"get": {
"tags": [
"Server"
],
"summary": "Get server CPU details",
"description": "Returns current CPU usage.",
"operationId": "os-getcpu",
"x-aries-daemon": "os",
"x-aries-command": "getcpu",
"parameters": [],
"responses": {
"200": {
"description": "Successful Aries response",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"status": "success",
"free": 99.8,
"used": 0.2,
"cron": 1,
"endPoint": "aries-production-59c48bc84-hpqw4"
}
}
}
}
},
"security": [
{
"keyHeader": [],
"secretHeader": []
}
]
}
},
"/os/getssd": {
"get": {
"tags": [
"Server"
],
"summary": "Get server SSD details",
"description": "Returns current disk usage through the SSD alias.\n\nThis is an alias for os/gethdd and returns the same data.",
"operationId": "os-getssd",
"x-aries-daemon": "os",
"x-aries-command": "getssd",
"parameters": [],
"responses": {
"200": {
"description": "Successful Aries response",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"status": "success",
"free": 47249692,
"used": 4221280,
"endPoint": "aries-production-59c48bc84-hpqw4"
}
}
}
}
},
"security": [
{
"keyHeader": [],
"secretHeader": []
}
]
}
},
"/os/getnet": {
"get": {
"tags": [
"Server"
],
"summary": "Get server network details",
"description": "Returns current network receive and transmit counters.",
"operationId": "os-getnet",
"x-aries-daemon": "os",
"x-aries-command": "getnet",
"parameters": [],
"responses": {
"200": {
"description": "Successful Aries response",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"status": "success",
"rx": 1920,
"tx": 91360,
"endPoint": "aries-production-59c48bc84-hpqw4"
}
}
}
}
},
"security": [
{
"keyHeader": [],
"secretHeader": []
}
]
}
},
"/os/getprocesses": {
"get": {
"tags": [
"Server"
],
"summary": "Get server processes",
"description": "Lists running server processes.",
"operationId": "os-getprocesses",
"x-aries-daemon": "os",
"x-aries-command": "getprocesses",
"parameters": [],
"responses": {
"200": {
"description": "Successful Aries response",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"status": "success",
"processes": [
{
"user": "root",
"pid": "1",
"cpu": "0.1",
"ram": "0.0"
}
],
"endPoint": "aries-production-59c48bc84-hpqw4"
}
}
}
}
},
"security": [
{
"keyHeader": [],
"secretHeader": []
}
]
}
},
"/os/systemupdate": {
"get": {
"tags": [
"Server"
],
"summary": "Check for server updates",
"description": "Checks whether supported operating system updates are available.",
"operationId": "os-systemupdate",
"x-aries-daemon": "os",
"x-aries-command": "systemupdate",
"parameters": [],
"responses": {
"200": {
"description": "Successful Aries response",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"status": "success",
"message": "Your operating system is currently running the latest supported software.",
"updates": null,
"endPoint": "aries-production-59c48bc84-hpqw4"
}
}
}
}
},
"security": [
{
"keyHeader": [],
"secretHeader": []
}
]
}
},
"/os/restart": {
"get": {
"tags": [
"Server"
],
"summary": "Restart server",
"description": "Power cycles the server.",
"operationId": "os-restart",
"x-aries-daemon": "os",
"x-aries-command": "restart",
"parameters": [],
"responses": {
"200": {
"description": "Successful Aries response",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"status": "success",
"message": "Your server has been restarted.",
"endPoint": "aries-production-59c48bc84-hpqw4"
}
}
}
}
},
"security": [
{
"keyHeader": [],
"secretHeader": []
}
]
}
},
"/os/generatekeys": {
"get": {
"tags": [
"Server"
],
"summary": "Create SSH key",
"description": "Generates a temporary SSH key for server access.",
"operationId": "os-generatekeys",
"x-aries-daemon": "os",
"x-aries-command": "generatekeys",
"parameters": [],
"responses": {
"200": {
"description": "Successful Aries response",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"status": "success",
"key": "RSA style key file",
"public": null,
"expires": 1493388746,
"endPoint": "aries-production-59c48bc84-hpqw4"
}
}
}
}
},
"security": [
{
"keyHeader": [],
"secretHeader": []
}
]
}
},
"/os/invalidatekeys": {
"get": {
"tags": [
"Server"
],
"summary": "Invalidate SSH key",
"description": "Invalidates the previous generated SSH key.",
"operationId": "os-invalidatekeys",
"x-aries-daemon": "os",
"x-aries-command": "invalidatekeys",
"parameters": [],
"responses": {
"200": {
"description": "Successful Aries response",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"status": "success",
"message": "Your previous SSH key has been invalidated.",
"endPoint": "aries-production-59c48bc84-hpqw4"
}
}
}
}
},
"security": [
{
"keyHeader": [],
"secretHeader": []
}
]
}
},
"/os/availableservices": {
"get": {
"tags": [
"Services"
],
"summary": "List available services",
"description": "Lists services that can be installed on the server.",
"operationId": "os-availableservices",
"x-aries-daemon": "os",
"x-aries-command": "availableservices",
"parameters": [],
"responses": {
"200": {
"description": "Successful Aries response",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"status": "success",
"services": {
"7dtd": {
"id": "7dtd",
"displayName": "7 Days to Die",
"displayVersion": "Beta",
"category": "Games",
"requireWipe": true
}
},
"endPoint": "aries-production-59c48bc84-hpqw4"
}
}
}
}
},
"security": [
{
"keyHeader": [],
"secretHeader": []
}
]
}
},
"/os/listservices": {
"get": {
"tags": [
"Services"
],
"summary": "List installed services",
"description": "Lists services currently installed on the server.",
"operationId": "os-listservices",
"x-aries-daemon": "os",
"x-aries-command": "listservices",
"parameters": [],
"responses": {
"200": {
"description": "Successful Aries response",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"status": "success",
"services": {
"unturned": {
"id": "unturned",
"displayName": "Unturned",
"displayVersion": "Alpha",
"category": "Games"
},
"mc": {
"id": "mc",
"displayName": "Minecraft",
"displayVersion": "Release",
"category": "Games"
}
},
"endPoint": "aries-production-59c48bc84-hpqw4"
}
}
}
}
},
"security": [
{
"keyHeader": [],
"secretHeader": []
}
]
}
},
"/os/installservice": {
"put": {
"tags": [
"Services"
],
"summary": "Install new service",
"description": "Installs a new service by service id.",
"operationId": "os-installservice",
"x-aries-daemon": "os",
"x-aries-command": "installservice",
"parameters": [],
"responses": {
"200": {
"description": "Successful Aries response",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"status": "success",
"message": "The requested service is being installed."
}
}
}
}
},
"security": [
{
"keyHeader": [],
"secretHeader": []
}
],
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"id": "unturned"
}
}
}
}
}
},
"/{daemon}/uninstall": {
"get": {
"tags": [
"Services"
],
"summary": "Remove service",
"description": "Uninstalls an installed service.",
"operationId": "daemon-uninstall",
"x-aries-daemon": "{daemon}",
"x-aries-command": "uninstall",
"parameters": [
{
"name": "daemon",
"in": "path",
"required": true,
"description": "Use the installed service name in the first path segment, for example mc, unturned, ark, or valheim.",
"schema": {
"type": "string"
},
"example": "mc"
}
],
"responses": {
"200": {
"description": "Successful Aries response",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"status": "success",
"message": "This service has been removed.",
"endPoint": "aries-production-59c48bc84-hpqw4"
}
}
}
}
},
"security": [
{
"keyHeader": [],
"secretHeader": []
}
]
}
},
"/{daemon}/installing": {
"put": {
"tags": [
"Services"
],
"summary": "Check service install status",
"description": "Checks whether a service is still installing.\n\nThe instance field is required when the target service uses named instances; omit it for single-instance services.",
"operationId": "daemon-installing",
"x-aries-daemon": "{daemon}",
"x-aries-command": "installing",
"parameters": [
{
"name": "daemon",
"in": "path",
"required": true,
"description": "Use the installed service name in the first path segment, for example mc, unturned, ark, or valheim.",
"schema": {
"type": "string"
},
"example": "mc"
}
],
"responses": {
"200": {
"description": "Successful Aries response",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"status": "success",
"installing": true,
"endPoint": "aries-production-59c48bc84-hpqw4"
}
}
}
}
},
"security": [
{
"keyHeader": [],
"secretHeader": []
}
],
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"instance": "mc-59026a225dc14"
}
}
}
}
}
},
"/{daemon}/progress": {
"get": {
"tags": [
"Services"
],
"summary": "Check service install progress",
"description": "Returns progress text for a service install.",
"operationId": "daemon-progress",
"x-aries-daemon": "{daemon}",
"x-aries-command": "progress",
"parameters": [
{
"name": "daemon",
"in": "path",
"required": true,
"description": "Use the installed service name in the first path segment, for example mc, unturned, ark, or valheim.",
"schema": {
"type": "string"
},
"example": "mc"
}
],
"responses": {
"200": {
"description": "Successful Aries response",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"status": "success",
"message": "Loading installation scripts...",
"progress": "0%",
"log": "latest",
"endPoint": "aries-production-59c48bc84-hpqw4"
}
}
}
}
},
"security": [
{
"keyHeader": [],
"secretHeader": []
}
]
}
},
"/{daemon}/versions": {
"get": {
"tags": [
"Services"
],
"summary": "Get service versions",
"description": "Lists installable versions for a service.",
"operationId": "daemon-versions",
"x-aries-daemon": "{daemon}",
"x-aries-command": "versions",
"parameters": [
{
"name": "daemon",
"in": "path",
"required": true,
"description": "Use the installed service name in the first path segment, for example mc, unturned, ark, or valheim.",
"schema": {
"type": "string"
},
"example": "mc"
}
],
"responses": {
"200": {
"description": "Successful Aries response",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"status": "success",
"versions": {
"7385": {
"id": 7385,
"displayName": "RocketMod",
"displayVersion": "Latest",
"requireWipe": false
}
},
"total": 1,
"endPoint": "aries-production-59c48bc84-hpqw4"
}
}
}
}
},
"security": [
{
"keyHeader": [],
"secretHeader": []
}
]
}
},
"/{daemon}/install": {
"put": {
"tags": [
"Services"
],
"summary": "Install service version",
"description": "Installs a specific service version.",
"operationId": "daemon-install",
"x-aries-daemon": "{daemon}",
"x-aries-command": "install",
"parameters": [
{
"name": "daemon",
"in": "path",
"required": true,
"description": "Use the installed service name in the first path segment, for example mc, unturned, ark, or valheim.",
"schema": {
"type": "string"
},
"example": "mc"
}
],
"responses": {
"200": {
"description": "Successful Aries response",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"status": "success",
"message": "Your requested software is currently installing...",
"result": "",
"id": "mc-59026a225dc14-590345e9d52f5",
"endPoint": "aries-production-59c48bc84-hpqw4"
}
}
}
}
},
"security": [
{
"keyHeader": [],
"secretHeader": []
}
],
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"id": "versionID",
"instance": "mc-59026a225dc14"
}
}
}
}
}
},
"/{daemon}/startserver": {
"put": {
"tags": [
"Services"
],
"summary": "Start game service",
"description": "Starts a game service.",
"operationId": "daemon-startserver",
"x-aries-daemon": "{daemon}",
"x-aries-command": "startserver",
"parameters": [
{
"name": "daemon",
"in": "path",
"required": true,
"description": "Use the installed service name in the first path segment, for example mc, unturned, ark, or valheim.",
"schema": {
"type": "string"
},
"example": "mc"
}
],
"responses": {
"200": {
"description": "Successful Aries response",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"status": "success",
"pid": 0,
"message": "Server has been started.",
"code": 1,
"endPoint": "aries-production-59c48bc84-hpqw4"
}
}
}
}
},
"security": [
{
"keyHeader": [],
"secretHeader": []
}
],
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"instance": "ut-5902260d6b88e"
}
}
}
}
}
},
"/{daemon}/stopserver": {
"put": {
"tags": [
"Services"
],
"summary": "Stop game service",
"description": "Stops a game service.",
"operationId": "daemon-stopserver",
"x-aries-daemon": "{daemon}",
"x-aries-command": "stopserver",
"parameters": [
{
"name": "daemon",
"in": "path",
"required": true,
"description": "Use the installed service name in the first path segment, for example mc, unturned, ark, or valheim.",
"schema": {
"type": "string"
},
"example": "mc"
}
],
"responses": {
"200": {
"description": "Successful Aries response",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"status": "success",
"keptlogs": false,
"message": "Server has been stopped.",
"code": 4,
"endPoint": "aries-production-59c48bc84-hpqw4"
}
}
}
}
},
"security": [
{
"keyHeader": [],
"secretHeader": []
}
],
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"instance": "ut-5902260d6b88e"
}
}
}
}
}
},
"/{daemon}/restartserver": {
"put": {
"tags": [
"Services"
],
"summary": "Restart game service",
"description": "Restarts a game service.",
"operationId": "daemon-restartserver",
"x-aries-daemon": "{daemon}",
"x-aries-command": "restartserver",
"parameters": [
{
"name": "daemon",
"in": "path",
"required": true,
"description": "Use the installed service name in the first path segment, for example mc, unturned, ark, or valheim.",
"schema": {
"type": "string"
},
"example": "mc"
}
],
"responses": {
"200": {
"description": "Successful Aries response",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"status": "success",
"message": "This service has been started.",
"stop": {
"status": "success",
"message": "This service has been stopped."
},
"endPoint": "aries-production-59c48bc84-hpqw4"
}
}
}
}
},
"security": [
{
"keyHeader": [],
"secretHeader": []
}
],
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"instance": "ut-5902260d6b88e"
}
}
}
}
}
},
"/{daemon}/readconsole": {
"put": {
"tags": [
"Services"
],
"summary": "Get server console",
"description": "Reads recent console lines for a game service.",
"operationId": "daemon-readconsole",
"x-aries-daemon": "{daemon}",
"x-aries-command": "readconsole",
"parameters": [
{
"name": "daemon",
"in": "path",
"required": true,
"description": "Use the installed service name in the first path segment, for example mc, unturned, ark, or valheim.",
"schema": {
"type": "string"
},
"example": "mc"
}
],
"responses": {
"200": {
"description": "Successful Aries response",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"status": "success",
"log": "<formatted console output>",
"count": 50,
"raw": [
[
"Apr 28 00:03:00 Loading level: 100%"
]
],
"endPoint": "aries-production-59c48bc84-hpqw4"
}
}
}
}
},
"security": [
{
"keyHeader": [],
"secretHeader": []
}
],
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"lines": 50,
"format": true,
"type": "normal",
"instance": "ut-5902260d6b88e"
}
}
}
}
}
},
"/{daemon}/writeconsole": {
"put": {
"tags": [
"Services"
],
"summary": "Send command to console",
"description": "Writes a command to a game service console.",
"operationId": "daemon-writeconsole",
"x-aries-daemon": "{daemon}",
"x-aries-command": "writeconsole",
"parameters": [
{
"name": "daemon",
"in": "path",
"required": true,
"description": "Use the installed service name in the first path segment, for example mc, unturned, ark, or valheim.",
"schema": {
"type": "string"
},
"example": "mc"
}
],
"responses": {
"200": {
"description": "Successful Aries response",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"status": "success",
"command": "Command to send",
"message": null,
"endPoint": "aries-production-59c48bc84-hpqw4"
}
}
}
}
},
"security": [
{
"keyHeader": [],
"secretHeader": []
}
],
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"command": "Command to send",
"instance": "ut-5902260d6b88e"
}
}
}
}
}
},
"/{daemon}/players": {
"put": {
"tags": [
"Services"
],
"summary": "Get player list",
"description": "Lists players for a game service.",
"operationId": "daemon-players",
"x-aries-daemon": "{daemon}",
"x-aries-command": "players",
"parameters": [
{
"name": "daemon",
"in": "path",
"required": true,
"description": "Use the installed service name in the first path segment, for example mc, unturned, ark, or valheim.",
"schema": {
"type": "string"
},
"example": "mc"
}
],
"responses": {
"200": {
"description": "Successful Aries response",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"status": "success",
"method": "logScrape",
"players": [],
"endPoint": "aries-production-59c48bc84-hpqw4"
}
}
}
}
},
"security": [
{
"keyHeader": [],
"secretHeader": []
}
],
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"instance": "mc-59026a225dc14"
}
}
}
}
}
},
"/{daemon}/createinstance": {
"put": {
"tags": [
"Instances"
],
"summary": "Create a new instance",
"description": "Creates a new named service instance.",
"operationId": "daemon-createinstance",
"x-aries-daemon": "{daemon}",
"x-aries-command": "createinstance",
"parameters": [
{
"name": "daemon",
"in": "path",
"required": true,
"description": "Use the installed service name in the first path segment, for example mc, unturned, ark, or valheim.",
"schema": {
"type": "string"
},
"example": "mc"
}
],
"responses": {
"200": {
"description": "Successful Aries response",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"status": "success",
"instance": {
"id": "ut-59022ccd106fc",
"displayName": "Instance name",
"daemon": "RocketLauncher.exe",
"path": "/home/minecraft/unturned/ut-instances/ut-59022ccd106fc/",
"port": 27015,
"memory": "adaptive",
"argType": "memory"
},
"endPoint": "aries-production-59c48bc84-hpqw4"
}
}
}
}
},
"security": [
{
"keyHeader": [],
"secretHeader": []
}
],
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"nickname": "Instance name"
}
}
}
}
}
},
"/{daemon}/destroyinstance": {
"put": {
"tags": [
"Instances"
],
"summary": "Destroy an instance",
"description": "Destroys a service instance.",
"operationId": "daemon-destroyinstance",
"x-aries-daemon": "{daemon}",
"x-aries-command": "destroyinstance",
"parameters": [
{
"name": "daemon",
"in": "path",
"required": true,
"description": "Use the installed service name in the first path segment, for example mc, unturned, ark, or valheim.",
"schema": {
"type": "string"
},
"example": "mc"
}
],
"responses": {
"200": {
"description": "Successful Aries response",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"status": "success",
"message": "The instance has been destroyed.",
"endPoint": "aries-production-59c48bc84-hpqw4"
}
}
}
}
},
"security": [
{
"keyHeader": [],
"secretHeader": []
}
],
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"id": "ut-59022ccd106fc"
}
}
}
}
}
},
"/{daemon}/datainstance": {
"put": {
"tags": [
"Instances"
],
"summary": "Get instance data",
"description": "Returns metadata for a service instance.",
"operationId": "daemon-datainstance",
"x-aries-daemon": "{daemon}",
"x-aries-command": "datainstance",
"parameters": [
{
"name": "daemon",
"in": "path",
"required": true,
"description": "Use the installed service name in the first path segment, for example mc, unturned, ark, or valheim.",
"schema": {
"type": "string"
},
"example": "mc"
}
],
"responses": {
"200": {
"description": "Successful Aries response",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"status": "success",
"instance": {
"id": "ut-5902260d6b88e",
"displayName": "Test",
"daemon": "RocketLauncher.exe",
"path": "/home/minecraft/unturned/ut-instances/ut-5902260d6b88e/",
"port": 27015,
"memory": "adaptive",
"argType": "memory"
},
"match": "ut-5902260d6b88e",
"endPoint": "aries-production-59c48bc84-hpqw4"
}
}
}
}
},
"security": [
{
"keyHeader": [],
"secretHeader": []
}
],
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"id": "ut-59022ccd106fc",
"instance": "ut-59022ccd106fc"
}
}
}
}
}
},
"/{daemon}/exportinstance": {
"put": {
"tags": [
"Instances"
],
"summary": "Export instance",
"description": "Exports a Minecraft instance package.",
"operationId": "daemon-exportinstance",
"x-aries-daemon": "{daemon}",
"x-aries-command": "exportinstance",
"parameters": [
{
"name": "daemon",
"in": "path",
"required": true,
"description": "Minecraft is the documented daemon for this request.",
"schema": {
"type": "string"
},
"example": "mc"
}
],
"responses": {
"200": {
"description": "Successful Aries response",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"status": "success",
"message": "The instance named 'testinstance' has been exported.",
"url": "http://fdn.redstone.tech/instances/server.mc-59026a225dc14.1493490791.instance",
"endPoint": "aries-production-59c48bc84-hpqw4"
}
}
}
}
},
"security": [
{
"keyHeader": [],
"secretHeader": []
}
],
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"id": "mc-59026a225dc14",
"instance": "mc-59026a225dc14"
}
}
}
}
}
},
"/{daemon}/importinstance": {
"put": {
"tags": [
"Instances"
],
"summary": "Import instance",
"description": "Imports a Minecraft instance package from a URL.",
"operationId": "daemon-importinstance",
"x-aries-daemon": "{daemon}",
"x-aries-command": "importinstance",
"parameters": [
{
"name": "daemon",
"in": "path",
"required": true,
"description": "Minecraft is the documented daemon for this request.",
"schema": {
"type": "string"
},
"example": "mc"
}
],
"responses": {
"200": {
"description": "Successful Aries response",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"status": "success",
"message": "The instance 'mc-5904dd8d16011' has been imported",
"instance": {
"id": "mc-5904dd8d16011",
"displayName": "mc-5904dd8d16011",
"jar": "Auto-Detect",
"path": "/home/minecraft/mc-instances/mc-5904dd8d16011/",
"infoPort": 25566,
"port": 25565,
"memory": "adaptive",
"argType": "memory",
"lastUpdated": 1493491085
},
"endPoint": "aries-production-59c48bc84-hpqw4"
}
}
}
}
},
"security": [
{
"keyHeader": [],
"secretHeader": []
}
],
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"url": "http://fdn.redstone.tech/instances/server.mc-59026a225dc14.1493490791.instance",
"instance": "mc-5902260d6b88e"
}
}
}
}
}
},
"/support/fetchtickets": {
"put": {
"tags": [
"Tickets"
],
"summary": "List all tickets",
"description": "Lists support tickets for the authenticated account.",
"operationId": "support-fetchtickets",
"x-aries-daemon": "support",
"x-aries-command": "fetchtickets",
"parameters": [],
"responses": {
"200": {
"description": "Successful Aries response",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"status": "success",
"tickets": null,
"endPoint": "aries-production-59c48bc84-hpqw4"
}
}
}
}
},
"security": [
{
"keyHeader": [],
"secretHeader": []
}
],
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"limit": 15
}
}
}
}
}
},
"/support/openticket": {
"put": {
"tags": [
"Tickets"
],
"summary": "Create new ticket",
"description": "Opens a new support ticket.",
"operationId": "support-openticket",
"x-aries-daemon": "support",
"x-aries-command": "openticket",
"parameters": [],
"responses": {
"200": {
"description": "Successful Aries response",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"status": "success",
"includedLogs": false,
"ticketID": 210244,
"otherID": 414921,
"endPoint": "aries-production-59c48bc84-hpqw4"
}
}
}
}
},
"security": [
{
"keyHeader": [],
"secretHeader": []
}
],
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"subject": "Ticket subject",
"content": "Ticket content",
"dept": "technicalsupport"
}
}
}
}
}
},
"/support/viewticket": {
"put": {
"tags": [
"Tickets"
],
"summary": "View ticket",
"description": "Returns a single support ticket and its replies.",
"operationId": "support-viewticket",
"x-aries-daemon": "support",
"x-aries-command": "viewticket",
"parameters": [],
"responses": {
"200": {
"description": "Successful Aries response",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"ticketid": "210244",
"tid": "414921",
"deptname": "Technical Support",
"subject": "Ticket subject",
"status": "success",
"priority": "Low",
"ticketStatus": "Open",
"replies": {
"reply": [
{
"name": "First Last",
"message": "<p>Ticket message</p>",
"plain": "Ticket message"
}
]
},
"endPoint": "aries-production-59c48bc84-hpqw4"
}
}
}
}
},
"security": [
{
"keyHeader": [],
"secretHeader": []
}
],
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"id": "210244"
}
}
}
}
}
},
"/support/replyticket": {
"put": {
"tags": [
"Tickets"
],
"summary": "Reply to ticket",
"description": "Adds a reply to an existing support ticket.",
"operationId": "support-replyticket",
"x-aries-daemon": "support",
"x-aries-command": "replyticket",
"parameters": [],
"responses": {
"200": {
"description": "Successful Aries response",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"status": "success",
"endPoint": "aries-production-59c48bc84-hpqw4"
}
}
}
}
},
"security": [
{
"keyHeader": [],
"secretHeader": []
}
],
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"id": "210244",
"content": "Ticket reply content"
}
}
}
}
}
},
"/billing/domainlist": {
"get": {
"tags": [
"Domains"
],
"summary": "List domains",
"description": "Lists domain zones for the authenticated account.",
"operationId": "billing-domainlist",
"x-aries-daemon": "billing",
"x-aries-command": "domainlist",
"parameters": [],
"responses": {
"200": {
"description": "Successful Aries response",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"status": "success",
"message": "Domain zones listed",
"zones": [
{
"id": 180,
"records": 3,
"name": "domain.tld"
}
],
"endPoint": "aries-production-59c48bc84-hpqw4"
}
}
}
}
},
"security": [
{
"keyHeader": [],
"secretHeader": []
}
]
}
},
"/billing/availabletld": {
"get": {
"tags": [
"Domains"
],
"summary": "List available TLDs",
"description": "Lists available TLDs and prices.",
"operationId": "billing-availabletld",
"x-aries-daemon": "billing",
"x-aries-command": "availabletld",
"parameters": [],
"responses": {
"200": {
"description": "Successful Aries response",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"status": "success",
"message": "Available TLD's attached.",
"TLDs": {
"com": {
"year": 9.99
},
"net": {
"year": 9.99
},
"org": {
"year": 9.99
}
},
"currency": {
"exchange_rate": "1.00000",
"prefix": "GBP",
"suffix": null,
"code": "GBP"
},
"endPoint": "aries-production-59c48bc84-hpqw4"
}
}
}
}
},
"security": [
{
"keyHeader": [],
"secretHeader": []
}
]
}
},
"/billing/domainlookup": {
"put": {
"tags": [
"Domains"
],
"summary": "Check domain availability",
"description": "Checks availability for a domain name.",
"operationId": "billing-domainlookup",
"x-aries-daemon": "billing",
"x-aries-command": "domainlookup",
"parameters": [],
"responses": {
"200": {
"description": "Successful Aries response",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"status": "success",
"whois": "WHOIS response text",
"available": false,
"endPoint": "aries-production-59c48bc84-hpqw4"
}
}
}
}
},
"security": [
{
"keyHeader": [],
"secretHeader": []
}
],
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"name": "test.com"
}
}
}
}
}
},
"/domain/view": {
"put": {
"tags": [
"Domains"
],
"summary": "Request domain records",
"description": "Returns DNS records for a domain zone.",
"operationId": "domain-view",
"x-aries-daemon": "domain",
"x-aries-command": "view",
"parameters": [],
"responses": {
"200": {
"description": "Successful Aries response",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"status": "success",
"message": "Records contained within zone for 'domain.tld'.",
"zone": "domain.tld",
"records": [
{
"id": 1409,
"name": "domain.tld",
"type": "SOA",
"ttl": 86400
}
],
"endPoint": "aries-production-59c48bc84-hpqw4"
}
}
}
}
},
"security": [
{
"keyHeader": [],
"secretHeader": []
}
],
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"domain": "domain.tld",
"id": "191"
}
}
}
}
}
},
"/domain/add": {
"put": {
"tags": [
"Domains"
],
"summary": "Add domain record",
"description": "Adds a DNS record to a domain zone.",
"operationId": "domain-add",
"x-aries-daemon": "domain",
"x-aries-command": "add",
"parameters": [],
"responses": {
"200": {
"description": "Successful Aries response",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"status": "success",
"message": "The record 'test' for zone 'domain.tld' has been updated.",
"endPoint": "aries-production-59c48bc84-hpqw4"
}
}
}
}
},
"security": [
{
"keyHeader": [],
"secretHeader": []
}
],
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"domain": "NotApplicable",
"id": "191",
"record": {
"name": "test",
"type": "A",
"content": "127.0.0.1",
"ttl": "3600"
}
}
}
}
}
}
},
"/domain/edit": {
"put": {
"tags": [
"Domains"
],
"summary": "Edit domain record",
"description": "Updates a DNS record in a domain zone.",
"operationId": "domain-edit",
"x-aries-daemon": "domain",
"x-aries-command": "edit",
"parameters": [],
"responses": {
"200": {
"description": "Successful Aries response",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"status": "success",
"message": "The record 'www.domain.tld' for zone 'domain.tld' has been updated.",
"endPoint": "aries-production-59c48bc84-hpqw4"
}
}
}
}
},
"security": [
{
"keyHeader": [],
"secretHeader": []
}
],
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"domain": "NotApplicable",
"id": "190",
"record": {
"id": "1412",
"name": "www.domain.tld",
"type": "CNAME",
"content": "other.record",
"ttl": "120"
}
}
}
}
}
}
},
"/domain/delete": {
"put": {
"tags": [
"Domains"
],
"summary": "Remove domain record",
"description": "Removes a DNS record from a domain zone.",
"operationId": "domain-delete",
"x-aries-daemon": "domain",
"x-aries-command": "delete",
"parameters": [],
"responses": {
"200": {
"description": "Successful Aries response",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"status": "success",
"message": "Successfully removed this record from the zone.",
"endPoint": "aries-production-59c48bc84-hpqw4"
}
}
}
}
},
"security": [
{
"keyHeader": [],
"secretHeader": []
}
],
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"domain": "NotApplicable",
"id": "191",
"record": {
"id": "1412"
}
}
}
}
}
}
},
"/billing/domainorder": {
"put": {
"tags": [
"Domains"
],
"summary": "Purchase domain",
"description": "Orders a domain through billing.",
"operationId": "billing-domainorder",
"x-aries-daemon": "billing",
"x-aries-command": "domainorder",
"parameters": [],
"responses": {
"200": {
"description": "Successful Aries response",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"orderid": 155076,
"productids": "",
"addonids": "",
"domainids": "1005",
"invoiceid": 298762,
"status": "success",
"endPoint": "aries-production-59c48bc84-hpqw4"
}
}
}
}
},
"security": [
{
"keyHeader": [],
"secretHeader": []
}
],
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"name": "domain.tld"
}
}
}
}
}
},
"/domain/create": {
"put": {
"tags": [
"Domains"
],
"summary": "Create domain zone",
"description": "Creates a DNS zone for a domain.",
"operationId": "domain-create",
"x-aries-daemon": "domain",
"x-aries-command": "create",
"parameters": [],
"responses": {
"200": {
"description": "Successful Aries response",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"status": "success",
"message": "Zone created 'domain.tld'.",
"endPoint": "aries-production-59c48bc84-hpqw4"
}
}
}
}
},
"security": [
{
"keyHeader": [],
"secretHeader": []
}
],
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"domain": "domain.tld"
}
}
}
}
}
},
"/billing/fetchinvoices": {
"put": {
"tags": [
"Billing"
],
"summary": "Get invoice list",
"description": "Lists invoices, optionally filtered by status.",
"operationId": "billing-fetchinvoices",
"x-aries-daemon": "billing",
"x-aries-command": "fetchinvoices",
"parameters": [],
"responses": {
"200": {
"description": "Successful Aries response",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"totalresults": "1",
"startnumber": 0,
"numreturned": 1,
"invoices": {
"invoice": [
{
"id": "298762",
"date": "2017-04-27",
"duedate": "2017-05-02",
"total": "11.99",
"status": "Unpaid",
"currencycode": "GBP"
}
]
},
"status": "success",
"endPoint": "aries-production-59c48bc84-hpqw4"
}
}
}
}
},
"security": [
{
"keyHeader": [],
"secretHeader": []
}
],
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"status": "Paid/Unpaid",
"count": 3
}
}
}
}
}
},
"/billing/details": {
"get": {
"tags": [
"Billing"
],
"summary": "Get billing details",
"description": "Returns billing profile details.",
"operationId": "billing-details",
"x-aries-daemon": "billing",
"x-aries-command": "details",
"parameters": [],
"responses": {
"200": {
"description": "Successful Aries response",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"uuid": "d7aed30d-e1e1-4680-80d3-c505cbd1a222",
"firstname": "First",
"lastname": "Last",
"fullname": "First Last",
"country": "GB",
"currency": {
"exchange_rate": "1.00000",
"prefix": "GBP",
"suffix": null,
"code": "GBP"
},
"credit": "0.00",
"endPoint": "aries-production-59c48bc84-hpqw4"
}
}
}
}
},
"security": [
{
"keyHeader": [],
"secretHeader": []
}
]
}
},
"/billing/availableupgrades": {
"get": {
"tags": [
"Billing"
],
"summary": "Get available server upgrades",
"description": "Lists available upgrade and downgrade products.",
"operationId": "billing-availableupgrades",
"x-aries-daemon": "billing",
"x-aries-command": "availableupgrades",
"parameters": [],
"responses": {
"200": {
"description": "Successful Aries response",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"status": "success",
"products": {
"32": {
"id": "32",
"name": "Magma Cube",
"Monthly": 6.99,
"proRata": 0,
"Current": false,
"Currency": {
"code": "GBP"
}
}
},
"endPoint": "aries-production-59c48bc84-hpqw4"
}
}
}
}
},
"security": [
{
"keyHeader": [],
"secretHeader": []
}
]
}
},
"/billing/upgrade": {
"put": {
"tags": [
"Billing"
],
"summary": "Upgrade or downgrade server",
"description": "Changes the server package.\n\nThe Apiary source had pacakge; the Aries code reads package.",
"operationId": "billing-upgrade",
"x-aries-daemon": "billing",
"x-aries-command": "upgrade",
"parameters": [],
"responses": {
"200": {
"description": "Successful Aries response",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"status": "success",
"endPoint": "aries-production-59c48bc84-hpqw4"
}
}
}
}
},
"security": [
{
"keyHeader": [],
"secretHeader": []
}
],
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"package": "49",
"promocode": ""
}
}
}
}
}
},
"/billing/iscancelled": {
"get": {
"tags": [
"Billing"
],
"summary": "Get cancelled status",
"description": "Checks whether a cancellation request exists.\n\nThe command is spelled iscancelled in Aries.",
"operationId": "billing-iscancelled",
"x-aries-daemon": "billing",
"x-aries-command": "iscancelled",
"parameters": [],
"responses": {
"200": {
"description": "Successful Aries response",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"status": "success",
"message": "No cancellation request has been received.",
"cancelled": false,
"endPoint": "aries-production-59c48bc84-hpqw4"
}
}
}
}
},
"security": [
{
"keyHeader": [],
"secretHeader": []
}
]
}
},
"/billing/playmentslist": {
"put": {
"tags": [
"Billing"
],
"summary": "Get playments list",
"description": "Lists received Playments.",
"operationId": "billing-playmentslist",
"x-aries-daemon": "billing",
"x-aries-command": "playmentslist",
"parameters": [],
"responses": {
"200": {
"description": "Successful Aries response",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"status": "success",
"message": "A list of received playments is included.",
"payments": [],
"endPoint": "aries-production-59c48bc84-hpqw4"
}
}
}
}
},
"security": [
{
"keyHeader": [],
"secretHeader": []
}
],
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"count": 100
}
}
}
}
}
},
"/billing/credit": {
"get": {
"tags": [
"Billing"
],
"summary": "Get current credit",
"description": "Returns current account credit.",
"operationId": "billing-credit",
"x-aries-daemon": "billing",
"x-aries-command": "credit",
"parameters": [],
"responses": {
"200": {
"description": "Successful Aries response",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"status": "success",
"credit": 0,
"message": "You have 0 available credit on your account.",
"endPoint": "aries-production-59c48bc84-hpqw4"
}
}
}
}
},
"security": [
{
"keyHeader": [],
"secretHeader": []
}
]
}
},
"/billing/spinupminigame": {
"put": {
"tags": [
"Billing"
],
"summary": "Spin up minigame server",
"description": "Creates a temporary minigame server.",
"operationId": "billing-spinupminigame",
"x-aries-daemon": "billing",
"x-aries-command": "spinupminigame",
"parameters": [],
"responses": {
"200": {
"description": "Successful Aries response",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"status": "success",
"ip": "123.123.123.5",
"port": 1234,
"rootpass": "password",
"readytime": 42.235509872437,
"node": "mdn172",
"cost": 0,
"uuid": "5903950ae9287",
"endPoint": "aries-production-59c48bc84-hpqw4"
}
}
}
}
},
"security": [
{
"keyHeader": [],
"secretHeader": []
}
],
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"ram": 1,
"game": "custom",
"time": "1",
"custom": "http://www.creeperrepo.net/mg-templates/paintball18.zip"
}
}
}
}
}
},
"/billing/extendminigame": {
"put": {
"tags": [
"Billing"
],
"summary": "Extend minigame server",
"description": "Extends the lifetime of a temporary minigame server.",
"operationId": "billing-extendminigame",
"x-aries-daemon": "billing",
"x-aries-command": "extendminigame",
"parameters": [],
"responses": {
"200": {
"description": "Successful Aries response",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"status": "success",
"cost": 0,
"endtime": 1493414229,
"uuid": "5903950ae9287",
"endPoint": "aries-production-59c48bc84-hpqw4"
}
}
}
}
},
"security": [
{
"keyHeader": [],
"secretHeader": []
}
],
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"uuid": "5903950ae9287"
}
}
}
}
}
},
"/billing/spindownminigame": {
"put": {
"tags": [
"Billing"
],
"summary": "Spin down minigame server",
"description": "Stops a temporary minigame server.",
"operationId": "billing-spindownminigame",
"x-aries-daemon": "billing",
"x-aries-command": "spindownminigame",
"parameters": [],
"responses": {
"200": {
"description": "Successful Aries response",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"status": "success",
"message": "Credit has been applied to your account.",
"amount": 0,
"endPoint": "aries-production-59c48bc84-hpqw4"
}
}
}
}
},
"security": [
{
"keyHeader": [],
"secretHeader": []
}
],
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"uuid": "5903950ae9287"
}
}
}
}
}
},
"/billing/timerminigame": {
"put": {
"tags": [
"Billing"
],
"summary": "Get minigame time remaining",
"description": "Returns remaining lifetime for a temporary minigame server.",
"operationId": "billing-timerminigame",
"x-aries-daemon": "billing",
"x-aries-command": "timerminigame",
"parameters": [],
"responses": {
"200": {
"description": "Successful Aries response",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"status": "success",
"uuid": "597ba4d453112",
"remaining": 3512,
"endPoint": "aries-production-59c48bc84-hpqw4"
}
}
}
}
},
"security": [
{
"keyHeader": [],
"secretHeader": []
}
],
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"uuid": "597ba4d453112"
}
}
}
}
}
},
"/filemanager/listdirectory": {
"put": {
"tags": [
"File manager"
],
"summary": "List directory",
"description": "Lists files and directories at a path.",
"operationId": "filemanager-listdirectory",
"x-aries-daemon": "filemanager",
"x-aries-command": "listdirectory",
"parameters": [],
"responses": {
"200": {
"description": "Successful Aries response",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"status": "success",
"tree": [
{
"file": true,
"name": "BEClient.so",
"path": "/unturned/ut-instances/ut-5902260d6b88e/BattlEye",
"mime": "application/octet-stream"
}
],
"endPoint": "aries-production-59c48bc84-hpqw4"
}
}
}
}
},
"security": [
{
"keyHeader": [],
"secretHeader": []
}
],
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"path": "/unturned/ut-instances/ut-5902260d6b88e/BattlEye"
}
}
}
}
}
},
"/filemanager/readfile": {
"put": {
"tags": [
"File manager"
],
"summary": "Read file",
"description": "Reads a file and returns its contents.",
"operationId": "filemanager-readfile",
"x-aries-daemon": "filemanager",
"x-aries-command": "readfile",
"parameters": [],
"responses": {
"200": {
"description": "Successful Aries response",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"status": "success",
"bytesRead": 2758,
"data": "File contents",
"endPoint": "aries-production-59c48bc84-hpqw4"
}
}
}
}
},
"security": [
{
"keyHeader": [],
"secretHeader": []
}
],
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"filename": "/unturned/ut-instances/ut-5902260d6b88e/BattlEye/EULA.txt"
}
}
}
}
}
},
"/filemanager/writefile": {
"put": {
"tags": [
"File manager"
],
"summary": "Write file",
"description": "Writes full contents to a file.",
"operationId": "filemanager-writefile",
"x-aries-daemon": "filemanager",
"x-aries-command": "writefile",
"parameters": [],
"responses": {
"200": {
"description": "Successful Aries response",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"status": "success",
"bytesWritten": 17,
"file": "/home/minecraft/unturned/ut-instances/ut-5902260d6b88e/BattlEye/EULA.txt",
"endPoint": "aries-production-59c48bc84-hpqw4"
}
}
}
}
},
"security": [
{
"keyHeader": [],
"secretHeader": []
}
],
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"filename": "/unturned/ut-instances/ut-5902260d6b88e/BattlEye/EULA.txt",
"contents": "New file contents"
}
}
}
}
}
},
"/filemanager/destroy": {
"put": {
"tags": [
"File manager"
],
"summary": "Delete file",
"description": "Marks a file or directory for deletion.",
"operationId": "filemanager-destroy",
"x-aries-daemon": "filemanager",
"x-aries-command": "destroy",
"parameters": [],
"responses": {
"200": {
"description": "Successful Aries response",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"status": "success",
"message": "File or Directory has been marked for deletion",
"endPoint": "aries-production-59c48bc84-hpqw4"
}
}
}
}
},
"security": [
{
"keyHeader": [],
"secretHeader": []
}
],
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"path": "/unturned/ut-instances/ut-5902260d6b88e/BattlEye/EULA.txt"
}
}
}
}
}
},
"/filemanager/renamefile": {
"put": {
"tags": [
"File manager"
],
"summary": "Rename or move file",
"description": "Renames or moves a file.",
"operationId": "filemanager-renamefile",
"x-aries-daemon": "filemanager",
"x-aries-command": "renamefile",
"parameters": [],
"responses": {
"200": {
"description": "Successful Aries response",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"status": "success",
"output": "",
"endPoint": "aries-production-59c48bc84-hpqw4"
}
}
}
}
},
"security": [
{
"keyHeader": [],
"secretHeader": []
}
],
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"filename": "/unturned/ut-instances/ut-5902260d6b88e/BattlEye/EULA.txt",
"newname": "/unturned/ut-instances/ut-5902260d6b88e/BattlEye/EULA2.txt"
}
}
}
}
}
},
"/filemanager/unzipfile": {
"put": {
"tags": [
"File manager"
],
"summary": "Extract zip file",
"description": "Extracts a zip archive on the server.",
"operationId": "filemanager-unzipfile",
"x-aries-daemon": "filemanager",
"x-aries-command": "unzipfile",
"parameters": [],
"responses": {
"200": {
"description": "Successful Aries response",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"status": "success",
"flatten": false,
"time": null,
"endPoint": "aries-production-59c48bc84-hpqw4"
}
}
}
}
},
"security": [
{
"keyHeader": [],
"secretHeader": []
}
],
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"path": "/unturned/ut-instances/ut-5902260d6b88e/",
"filename": "my.zip"
}
}
}
}
}
},
"/filemanager/untarballfile": {
"put": {
"tags": [
"File manager"
],
"summary": "Extract gz file",
"description": "Extracts a gzip or tarball archive on the server.",
"operationId": "filemanager-untarballfile",
"x-aries-daemon": "filemanager",
"x-aries-command": "untarballfile",
"parameters": [],
"responses": {
"200": {
"description": "Successful Aries response",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"status": "success",
"time": null,
"endPoint": "aries-production-59c48bc84-hpqw4"
}
}
}
}
},
"security": [
{
"keyHeader": [],
"secretHeader": []
}
],
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"path": "/unturned/ut-instances/ut-5902260d6b88e/",
"filename": "my.gz"
}
}
}
}
}
},
"/filemanager/proxyfile": {
"put": {
"tags": [
"File manager"
],
"summary": "Download file",
"description": "Streams a file download.",
"operationId": "filemanager-proxyfile",
"x-aries-daemon": "filemanager",
"x-aries-command": "proxyfile",
"parameters": [],
"responses": {
"200": {
"description": "Successful Aries response",
"content": {
"application/zip": {
"schema": {
"type": "string"
},
"example": "Binary file stream"
}
}
}
},
"security": [
{
"keyHeader": [],
"secretHeader": []
}
],
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"filename": "/unturned/ut-instances/ut-5902260d6b88e/myfile.zip"
}
}
}
}
}
},
"/accesscontrol/list": {
"get": {
"tags": [
"Access control"
],
"summary": "Get list of keys",
"description": "Lists API keys for the server.",
"operationId": "accesscontrol-list",
"x-aries-daemon": "accesscontrol",
"x-aries-command": "list",
"parameters": [],
"responses": {
"200": {
"description": "Successful Aries response",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"status": "success",
"keys": [
{
"secret": "secret-value",
"permissions": []
}
],
"endPoint": "aries-production-59c48bc84-hpqw4"
}
}
}
}
},
"security": [
{
"keyHeader": [],
"secretHeader": []
}
]
}
},
"/accesscontrol/createcredentials": {
"get": {
"tags": [
"Access control"
],
"summary": "Create new API key",
"description": "Creates a new API key and secret.",
"operationId": "accesscontrol-createcredentials",
"x-aries-daemon": "accesscontrol",
"x-aries-command": "createcredentials",
"parameters": [],
"responses": {
"200": {
"description": "Successful Aries response",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"status": "success",
"message": "Successfully created new API credentials.",
"secret": "secret-value",
"endPoint": "aries-production-59c48bc84-hpqw4"
}
}
}
}
},
"security": [
{
"keyHeader": [],
"secretHeader": []
}
]
}
},
"/accesscontrol/grantpermission": {
"put": {
"tags": [
"Access control"
],
"summary": "Add permission",
"description": "Grants one or more permissions to an API key.",
"operationId": "accesscontrol-grantpermission",
"x-aries-daemon": "accesscontrol",
"x-aries-command": "grantpermission",
"parameters": [],
"responses": {
"200": {
"description": "Successful Aries response",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"status": "success",
"message": "Access control has been updated.",
"endPoint": "aries-production-59c48bc84-hpqw4"
}
}
}
}
},
"security": [
{
"keyHeader": [],
"secretHeader": []
}
],
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"daemon": "os",
"command": [
"commandToGrant"
]
}
}
}
}
}
},
"/accesscontrol/revokepermission": {
"put": {
"tags": [
"Access control"
],
"summary": "Revoke permission",
"description": "Revokes one or more permissions from an API key.",
"operationId": "accesscontrol-revokepermission",
"x-aries-daemon": "accesscontrol",
"x-aries-command": "revokepermission",
"parameters": [],
"responses": {
"200": {
"description": "Successful Aries response",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"status": "success",
"message": "Access control has been updated.",
"endPoint": "aries-production-59c48bc84-hpqw4"
}
}
}
}
},
"security": [
{
"keyHeader": [],
"secretHeader": []
}
],
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"daemon": "os",
"command": [
"commandToRevoke"
]
}
}
}
}
}
},
"/saveguard/listarchives": {
"put": {
"tags": [
"SaveGuard"
],
"summary": "List restore points",
"description": "Lists SaveGuard restore points for a service or service instance.\n\nThe instance field is required when listing restore points for an instanced service; omit it for single-instance services.",
"operationId": "saveguard-listarchives",
"x-aries-daemon": "saveguard",
"x-aries-command": "listarchives",
"parameters": [],
"responses": {
"200": {
"description": "Successful Aries response",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"status": "success",
"message": "List archives call successful",
"archives": [
{
"name": "minecraft-mc-59026a225dc14-2026-06-11T09:00:00",
"time": "2026-06-11T09:00:00.000000"
}
],
"endPoint": "aries-production-59c48bc84-hpqw4"
}
}
}
}
},
"security": [
{
"keyHeader": [],
"secretHeader": []
}
],
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"id": "mc",
"instance": "mc-59026a225dc14"
}
}
}
}
}
},
"/saveguard/listcontents": {
"put": {
"tags": [
"SaveGuard"
],
"summary": "List restore point contents",
"description": "Lists files contained in a SaveGuard restore point.",
"operationId": "saveguard-listcontents",
"x-aries-daemon": "saveguard",
"x-aries-command": "listcontents",
"parameters": [],
"responses": {
"200": {
"description": "Successful Aries response",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"status": "success",
"message": "List contents call successful",
"contents": [
{
"path": "home/minecraft/world/level.dat",
"type": "file",
"size": 4421,
"mtime": "2026-06-11T09:00:00.000000"
}
],
"endPoint": "aries-production-59c48bc84-hpqw4"
}
}
}
}
},
"security": [
{
"keyHeader": [],
"secretHeader": []
}
],
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"archiveName": "minecraft-mc-59026a225dc14-2026-06-11T09:00:00"
}
}
}
}
}
},
"/saveguard/diff": {
"put": {
"tags": [
"SaveGuard"
],
"summary": "Compare restore points",
"description": "Compares two SaveGuard restore points and returns changed paths.",
"operationId": "saveguard-diff",
"x-aries-daemon": "saveguard",
"x-aries-command": "diff",
"parameters": [],
"responses": {
"200": {
"description": "Successful Aries response",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"status": "success",
"message": "Diff call successful",
"diff": [
{
"path": "home/minecraft/world/level.dat",
"changes": [
{
"type": "modified"
}
]
}
],
"endPoint": "aries-production-59c48bc84-hpqw4"
}
}
}
}
},
"security": [
{
"keyHeader": [],
"secretHeader": []
}
],
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"archiveName": "minecraft-mc-59026a225dc14-2026-06-11T09:00:00",
"archiveName2": "minecraft-mc-59026a225dc14-oob-2026-06-11T10:00:00"
}
}
}
}
}
},
"/saveguard/restore": {
"put": {
"tags": [
"SaveGuard"
],
"summary": "Restore restore point",
"description": "Restores a SaveGuard restore point.",
"operationId": "saveguard-restore",
"x-aries-daemon": "saveguard",
"x-aries-command": "restore",
"parameters": [],
"responses": {
"200": {
"description": "Successful Aries response",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"status": "success",
"message": "Restored backup",
"endPoint": "aries-production-59c48bc84-hpqw4"
}
}
}
}
},
"security": [
{
"keyHeader": [],
"secretHeader": []
}
],
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"archiveName": "minecraft-mc-59026a225dc14-2026-06-11T09:00:00"
}
}
}
}
}
},
"/saveguard/optin": {
"put": {
"tags": [
"SaveGuard"
],
"summary": "Opt in service",
"description": "Adds a service or service instance path to SaveGuard protection.\n\nSaveGuard is generally enabled automatically when a service becomes eligible; opt-in is only needed for explicit enrollment flows.",
"operationId": "saveguard-optin",
"x-aries-daemon": "saveguard",
"x-aries-command": "optin",
"parameters": [],
"responses": {
"200": {
"description": "Successful Aries response",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"status": "success",
"message": "Opted in successfully",
"path": "/home/minecraft/mc-instances/mc-59026a225dc14",
"endPoint": "aries-production-59c48bc84-hpqw4"
}
}
}
}
},
"security": [
{
"keyHeader": [],
"secretHeader": []
}
],
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"id": "mc",
"instance": "mc-59026a225dc14"
}
}
}
}
}
},
"/saveguard/optout": {
"put": {
"tags": [
"SaveGuard"
],
"summary": "Opt out service",
"description": "Removes a service or service instance path from SaveGuard protection.",
"operationId": "saveguard-optout",
"x-aries-daemon": "saveguard",
"x-aries-command": "optout",
"parameters": [],
"responses": {
"200": {
"description": "Successful Aries response",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"status": "success",
"message": "Opted out successfully",
"endPoint": "aries-production-59c48bc84-hpqw4"
}
}
}
}
},
"security": [
{
"keyHeader": [],
"secretHeader": []
}
],
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"id": "mc",
"instance": "mc-59026a225dc14"
}
}
}
}
}
},
"/saveguard/isenrolled": {
"put": {
"tags": [
"SaveGuard"
],
"summary": "Check enrollment",
"description": "Checks whether SaveGuard is enabled on the server.",
"operationId": "saveguard-isenrolled",
"x-aries-daemon": "saveguard",
"x-aries-command": "isenrolled",
"parameters": [],
"responses": {
"200": {
"description": "Successful Aries response",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"status": "success",
"message": "Your service has been enrolled in SaveGuard",
"endPoint": "aries-production-59c48bc84-hpqw4"
}
}
}
}
},
"security": [
{
"keyHeader": [],
"secretHeader": []
}
],
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/scheduler/list": {
"get": {
"tags": [
"Scheduler"
],
"summary": "List scheduled tasks",
"description": "Lists scheduled tasks.",
"operationId": "scheduler-list",
"x-aries-daemon": "scheduler",
"x-aries-command": "list",
"parameters": [],
"responses": {
"200": {
"description": "Successful Aries response",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"status": "success",
"schedule": [],
"endPoint": "aries-production-59c48bc84-hpqw4"
}
}
}
}
},
"security": [
{
"keyHeader": [],
"secretHeader": []
}
]
}
},
"/scheduler/edit": {
"put": {
"tags": [
"Scheduler"
],
"summary": "Add or edit scheduled task",
"description": "Creates or updates a scheduled task.\n\nThe id field is only needed when editing an existing task.",
"operationId": "scheduler-edit",
"x-aries-daemon": "scheduler",
"x-aries-command": "edit",
"parameters": [],
"responses": {
"200": {
"description": "Successful Aries response",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"status": "success",
"message": "Task has been scheduled",
"id": "task-590340ba4d18c",
"endPoint": "aries-production-59c48bc84-hpqw4"
}
}
}
}
},
"security": [
{
"keyHeader": [],
"secretHeader": []
}
],
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"game": "mc",
"command": "restart",
"when": "0 */3 * * *",
"data": {
"instance": "mc-59026a225dc14"
},
"id": "task-5903405e4a86b"
}
}
}
}
}
},
"/scheduler/remove": {
"put": {
"tags": [
"Scheduler"
],
"summary": "Delete scheduled task",
"description": "Deletes a scheduled task.",
"operationId": "scheduler-remove",
"x-aries-daemon": "scheduler",
"x-aries-command": "remove",
"parameters": [],
"responses": {
"200": {
"description": "Successful Aries response",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"status": "success",
"message": "Task has been removed",
"endPoint": "aries-production-59c48bc84-hpqw4"
}
}
}
}
},
"security": [
{
"keyHeader": [],
"secretHeader": []
}
],
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"id": "task-5903405e4a86b"
}
}
}
}
}
},
"/api/listnotitargets": {
"get": {
"tags": [
"API utilities"
],
"summary": "List notification targets",
"description": "Lists configured notification targets.",
"operationId": "api-listnotitargets",
"x-aries-daemon": "api",
"x-aries-command": "listnotitargets",
"parameters": [],
"responses": {
"200": {
"description": "Successful Aries response",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"status": "success",
"targets": [
{
"id": 1,
"target": "slackwebhookurl",
"type": "slack"
}
],
"endPoint": "aries-production-59c48bc84-hpqw4"
}
}
}
}
},
"security": [
{
"keyHeader": [],
"secretHeader": []
}
]
}
},
"/api/addnotitarget": {
"put": {
"tags": [
"API utilities"
],
"summary": "Add notification target",
"description": "Adds a notification target.",
"operationId": "api-addnotitarget",
"x-aries-daemon": "api",
"x-aries-command": "addnotitarget",
"parameters": [],
"responses": {
"200": {
"description": "Successful Aries response",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"status": "success",
"message": "Added notification target."
}
}
}
}
},
"security": [
{
"keyHeader": [],
"secretHeader": []
}
],
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"type": "slack",
"target": "webhookurl"
}
}
}
}
}
},
"/api/removenotitarget": {
"put": {
"tags": [
"API utilities"
],
"summary": "Remove notification target",
"description": "Removes a notification target.",
"operationId": "api-removenotitarget",
"x-aries-daemon": "api",
"x-aries-command": "removenotitarget",
"parameters": [],
"responses": {
"200": {
"description": "Successful Aries response",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"status": "success",
"message": "Removed notification target."
}
}
}
}
},
"security": [
{
"keyHeader": [],
"secretHeader": []
}
],
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"id": 1
}
}
}
}
}
},
"/api/logging": {
"put": {
"tags": [
"API utilities"
],
"summary": "Get API logs",
"description": "Returns recent API log lines.",
"operationId": "api-logging",
"x-aries-daemon": "api",
"x-aries-command": "logging",
"parameters": [],
"responses": {
"200": {
"description": "Successful Aries response",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"status": "success",
"lines": [
{
"timestamp": "1493385214",
"service": "backup",
"command": "create",
"status": "Success",
"ip": "127.0.0.1",
"notes": "Your backup has been completed."
}
],
"endPoint": "aries-production-59c48bc84-hpqw4"
}
}
}
}
},
"security": [
{
"keyHeader": [],
"secretHeader": []
}
],
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"start": 0,
"limit": 100,
"requests": false
}
}
}
}
}
},
"/api/alerts": {
"get": {
"tags": [
"API utilities"
],
"summary": "Get alerts",
"description": "Returns active API alerts.",
"operationId": "api-alerts",
"x-aries-daemon": "api",
"x-aries-command": "alerts",
"parameters": [],
"responses": {
"200": {
"description": "Successful Aries response",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"status": "success",
"alerts": [],
"endPoint": "aries-production-59c48bc84-hpqw4"
}
}
}
}
},
"security": [
{
"keyHeader": [],
"secretHeader": []
}
]
}
},
"/api/health": {
"get": {
"tags": [
"API utilities"
],
"summary": "Check API health",
"description": "Checks API endpoint health.",
"operationId": "api-health",
"x-aries-daemon": "api",
"x-aries-command": "health",
"parameters": [],
"responses": {
"200": {
"description": "Successful Aries response",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"status": "success",
"message": "API end point is currently healthy.",
"endPoint": "aries-production-59c48bc84-hpqw4"
}
}
}
}
}
}
},
"/api/endpoints": {
"get": {
"tags": [
"API utilities"
],
"summary": "Get API endpoints",
"description": "Lists API endpoint locations.",
"operationId": "api-endpoints",
"x-aries-daemon": "api",
"x-aries-command": "endpoints",
"parameters": [],
"responses": {
"200": {
"description": "Successful Aries response",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"Grantham": "185.57.191.130",
"Maidenhead": "78.129.201.23",
"Seattle": "198.23.149.146",
"Buffalo": "198.23.140.130",
"Atlanta": "69.31.134.154",
"Staging": "87.117.245.3",
"endPoint": "aries-production-59c48bc84-hpqw4"
}
}
}
}
}
}
},
"/minetogether/list": {
"put": {
"tags": [
"MineTogether"
],
"summary": "Get servers",
"description": "Lists MineTogether servers for a CurseForge project.",
"operationId": "minetogether-list",
"x-aries-daemon": "minetogether",
"x-aries-command": "list",
"parameters": [],
"responses": {
"200": {
"description": "Successful Aries response",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": [
{
"id": 1,
"name": "Server name",
"invite": false,
"project": 0,
"ip": "127.0.0.1",
"api_version": 2,
"expected_players": 0,
"location": {
"country": "United States",
"country_code": "US",
"city": "Buffalo",
"continent": "North America",
"subdivision": "New York"
},
"uptime": 120398,
"port": 25565
}
]
}
}
}
},
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"projectid": 283861,
"hash": "unique-client-hash"
}
}
}
}
}
},
"/minetogether/update": {
"put": {
"tags": [
"MineTogether"
],
"summary": "Update server",
"description": "Publishes or updates a MineTogether server listing.",
"operationId": "minetogether-update",
"x-aries-daemon": "minetogether",
"x-aries-command": "update",
"parameters": [],
"responses": {
"200": {
"description": "Successful Aries response",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"status": "success",
"message": "Server information updated",
"id": "1",
"endPoint": "aries-production-59c48bc84-hpqw4"
}
}
}
}
},
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"name": "Server Name",
"port": 25565,
"ip": "play.example.com",
"projectid": 283861
}
}
}
}
}
},
"/minetogether/invite": {
"put": {
"tags": [
"MineTogether"
],
"summary": "Invite to server",
"description": "Creates an invite link between a client hash and a listed server.",
"operationId": "minetogether-invite",
"x-aries-daemon": "minetogether",
"x-aries-command": "invite",
"parameters": [],
"responses": {
"200": {
"description": "Successful Aries response",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"status": "success",
"message": "Server information updated",
"id": "1",
"endPoint": "aries-production-59c48bc84-hpqw4"
}
}
}
}
},
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"id": 1,
"hash": "unique-client-hash"
}
}
}
}
}
},
"/minetogether/revokeinvite": {
"put": {
"tags": [
"MineTogether"
],
"summary": "Revoke invite",
"description": "Revokes an active MineTogether invite for a client hash.",
"operationId": "minetogether-revokeinvite",
"x-aries-daemon": "minetogether",
"x-aries-command": "revokeinvite",
"parameters": [],
"responses": {
"200": {
"description": "Successful Aries response",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"status": "success",
"message": "Server information updated",
"id": "1",
"endPoint": "aries-production-59c48bc84-hpqw4"
}
}
}
}
},
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"id": 1,
"hash": "unique-client-hash"
}
}
}
}
}
}
},
"tags": [
{
"name": "Server",
"description": "Host machine status and operating system actions."
},
{
"name": "Services",
"description": "Game service catalogue, install, lifecycle, console, and player requests."
},
{
"name": "Instances",
"description": "Instance actions for services that support named instances, especially Minecraft and Unturned."
},
{
"name": "Tickets",
"description": "Support ticket list, create, view, and reply requests."
},
{
"name": "Domains",
"description": "Domain availability, orders, zones, and DNS record management."
},
{
"name": "Billing",
"description": "Account billing, invoices, upgrades, credit, cancellation, and minigame server requests."
},
{
"name": "File manager",
"description": "Server file browsing, reading, writing, moving, extracting, and downloading."
},
{
"name": "Access control",
"description": "API key management and permission grants."
},
{
"name": "SaveGuard",
"description": "Automatic restore point listing, comparison, restore, and enrollment requests."
},
{
"name": "Scheduler",
"description": "Scheduled task list, edit, and delete requests."
},
{
"name": "API utilities",
"description": "Notification targets, logs, health, alerts, and endpoint discovery."
},
{
"name": "MineTogether",
"description": "Public MineTogether server listing and invite requests."
}
]
}