Back to top

exaroton API

exaroton offers a public API that allows you to integrate your server into your programs and apps. Currently, only some basic features can be used via the API.

Packages and libraries

Official libraries

To easily access our API, you can use on of these libraries maintained by exaroton:

Community libraries

There are also several community-maintained libraries for different languages. These libraries are not maintained by exaroton and may not be feature complete, but can still be useful to get started:

You can also use our OpenAPI spec to generate clients for a large variety of programming languages.

Authentication

To authenticate your requests, you need a valid API token. This token can be generated in your exaroton account settings and needs to be sent in the Authorization HTTP header with every request you make.

Authorization: Bearer {token}

Websocket API

The websocket API allows a constant connection to our websocket service to receive events in real time without polling (e.g. trying to get the server status every few seconds).

You can use our Node.js library as a reference implementation.

https://api.exaroton.com/v1/servers/{server}/websocket

Basic messages

All messages received from or sent to the websocket are JSON strings. Every JSON object has a type property, and may additionally have a data and a stream property.

ready

{"type":"ready","data":"6L5WWSK73YnWGHQE"}

Sent after opening a websocket connection. data is the ID of the server you connected to. Before this message is received, no messages should be sent to the websocket.

connected

{"type":"connected"}

Sent when a connection to a running game server is established.

disconnected

{"type":"disconnected","data":"invalid-status"}

Sent when a connection to a game server failed or was lost. data includes the reason for the disconnect.

keep-alive

{"type":"keep-alive"}

Sent when if no other messages were sent for a longer period of time. This message can be ignored.

Streams

Messages that include a stream property are a part of a specific data stream. There are 5 different data streams available in our WebSocket API:

status

By default, you are always subscribed to server status changes. The only message type in this stream is status

status

{
  "stream": "status",
  "type": "status",
  "data": {
    "id": "EwYiY9IAMtQBTb6U",
    "name": "example",
    "address": "example.exaroton.me",
    "motd": "Welcome to the server of example!",
    "status": 2,
    "players": {
      "max": 20,
      "count": 0,
      "list": []
    },
    "host": "gibberfish.exaroton.host",
    "port": 48249,
    "software": {
      "id": "kb4p09ABvLjxzedx",
      "name": "Vanilla",
      "version": "1.16.5"
    },
    "shared": false
  }
}

The data field of this message is a regular API server object.

console

The console stream can be used to receive a live feed of the server’s console output. Note that this is the server’s raw console output, so it might contain both ANSI escape codes and control characters.

You can subscribe to the console stream by sending a start message while the server is running:

{"stream":"console","type":"start","data":{"tail":0}}

The tail option can be used to receive up to 500 lines from the previous console output.

You can unsubscribe by sending a stop message:

{"stream":"console","type":"stop"}

Additional to receiving console output, this stream can also be used as a faster way of sending commands to the server:

{"stream":"console","type":"command","data":"say Hello World!"}

started

A started messages is sent when the stream was started successfully.

{"stream":"console","type":"started"}

line

Console line messages include a line of console output.

{"stream":"console","type":"line","data":"[14:20:56] [Server thread/INFO]: [Server] test"}

tick

The tick stream provides information about the servers current in-game tick speed. Note that this stream is only available for Minecraft Java Edition 1.16+.

You can subscribe to the tick stream by sending a start message while the server is online:

{"stream":"tick","type":"start"}

You can unsubscribe by sending a stop message:

{"stream":"tick","type":"stop"}

started

A started messages is sent when the stream was started successfully.

{"stream":"console","type":"started"}

tick

tick messages include the current average tick time (in ms).

{"stream":"tick","type":"tick","data":{"averageTickTime":8.7218612}}

stats

The stats stream provides information about server stats (currently only memory usage).

You can subscribe to the stats stream by sending a start message while the server is online:

{"stream":"stats","type":"start"}

You can unsubscribe by sending a stop message:

{"stream":"stats","type":"stop"}

started

A started messages is sent when the stream was started successfully.

{"stream":"stats","type":"started"}

stats

stats messages include the current memory usage.

{"stream":"stats","type":"stats","data":{"memory":{"percent":38.49,"usage":1983938560}}}

heap

The heap stream is a much more accurate way of determining a server’s RAM usage. It is, however, only availabe for Java-based server software.

You can subscribe to the heap stream by sending a start message while the server is online:

{"stream":"heap","type":"start"}

You can unsubscribe by sending a stop message:

{"stream":"heap","type":"stop"}

started

A started messages is sent when the stream was started successfully.

{"stream":"heap","type":"started"}

heap

heap messages include the current memory usage.

{"stream":"heap","type":"heap","data":{"usage":1225721600}}

management

The management stream can be used to interact with the server using the Minecraft server management protocol introduced in 1.21.9. This protocol allows controlling various server settings without restarting the server and notifies clients of events happening on the server. Configuring the management server in the server.properties is not necessary, as this is automatically handled by exaroton.

You can subscribe to the management stream by sending a start message while the server is running:

{"stream":"management","type":"start"}

You can unsubscribe by sending a stop message:

{"stream":"management","type":"stop"}

Management requests can be sent by sending a request message. A request consists of the method you would like to call, its optional parameters and a unique id to identify the response.

{"stream":"management","type":"request","data":{"id":"unique-id","method":"minecraft:server/status", "params":{}}}

started

A started messages is sent when the stream was started successfully.

{"stream":"management","type":"started"}

response

Responses to request messages have the same id provided by the client and the response data from the server.

{"stream":"management","type":"response","data":{"id":"unique-id","data":{"started":true,"version":{"name":"1.21.9 Release Candidate 1","protocol":1073742097}}}}

notification

Notifications are sent by the server when certain events happen. The notification type is included in the name property.

{"stream":"management","type":"notification","data":{"name":"minecraft:notification/allowlist/added","data":[{"id":"22c777bb-e823-4ab8-b17b-acd3eef0b597","name":"exaroton"}]}}

Server status

Servers can have different numeric status codes. Depending on a server’s status, only certain features might be available.

0  = OFFLINE
1  = ONLINE
2  = STARTING
3  = STOPPING
4  = RESTARTING
5  = SAVING
6  = LOADING
7  = CRASHED
8  = PENDING
9  = TRANSFERRING
10 = PREPARING

Resource Group

Account

Get account info
GET/account/

Example URI

GET https://api.exaroton.com/v1/account/
Request
HideShow
Headers
Authorization: Bearer {token}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "error": null,
  "data": {
    "id": "EwYiY9IAMtQBTb6s",
    "name": "example",
    "email": "[email protected]",
    "maxServers": 10,
    "verified": true,
    "credits": 42
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean"
    },
    "error": {
      "type": [
        "string",
        "null"
      ]
    },
    "data": {
      "type": [
        "object",
        "null"
      ],
      "properties": {
        "id": {
          "type": "string",
          "description": "Unique account ID"
        },
        "name": {
          "type": "string"
        },
        "email": {
          "type": "string"
        },
        "maxServers": {
          "type": "number",
          "description": "Maximum number of servers this account can own"
        },
        "verified": {
          "type": "boolean"
        },
        "credits": {
          "type": "number"
        }
      }
    }
  }
}

Get account transactions
GET/account/transactions/{?page}

Returns a page of the transactions of your account (20 per page), newest first with active transactions before all others. credits are seen from the perspective of your account: positive for income, negative for usage.

Example URI

GET https://api.exaroton.com/v1/account/transactions/?page=1
URI Parameters
HideShow
page
number (optional) Example: 1

Page of the list, starting at 1. Pages after the last page are empty.

Request
HideShow
Headers
Authorization: Bearer {token}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "error": null,
  "data": {
    "page": 1,
    "lastPage": 2,
    "total": 21,
    "items": [
      {
        "id": "Tr4nS4cT10nId123",
        "type": "run",
        "credits": -1.5,
        "rate": 1,
        "interval": 3600,
        "amount": 4,
        "active": false,
        "paid": true,
        "startTime": 1763247600,
        "endTime": 1763251200,
        "account": "EwYiY9IAMtQBTb6s",
        "pool": "",
        "server": "EwYiY9IAMtQBTb6U"
      }
    ]
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean"
    },
    "error": {
      "type": [
        "string",
        "null"
      ]
    },
    "data": {
      "type": [
        "object",
        "null"
      ],
      "properties": {
        "page": {
          "type": "number",
          "description": "The requested page"
        },
        "lastPage": {
          "type": "number",
          "description": "The last page with items (at least 1)"
        },
        "total": {
          "type": "number",
          "description": "Total number of items in all pages"
        },
        "items": {
          "type": "array"
        }
      }
    }
  }
}

Servers

List servers
GET/servers/

Example URI

GET https://api.exaroton.com/v1/servers/
Request
HideShow
Headers
Authorization: Bearer {api-token}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "error": null,
  "data": [
    {
      "id": "EwYiY9IAMtQBTb6U",
      "name": "example",
      "address": "example.exaroton.me",
      "motd": "Welcome to the server of example!",
      "status": 0,
      "host": null,
      "port": null,
      "players": {
        "max": 20,
        "count": 0,
        "list": []
      },
      "software": {
        "id": "kb4p09ABvLjxzedx",
        "name": "Vanilla",
        "version": "1.20.4",
        "type": "vanilla",
        "launcher": "CurseForge"
      },
      "shared": false,
      "permissions": [],
      "region": "eu"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean"
    },
    "error": {
      "type": [
        "string",
        "null"
      ]
    },
    "data": {
      "type": [
        "array",
        "null"
      ]
    }
  }
}

Create a server
POST/servers/

Creates a new server owned by your account. If your account has reached its server limit (see maxServers in /account/), the request fails with status code 413.

Example URI

POST https://api.exaroton.com/v1/servers/
Request
HideShow
Headers
Content-Type: application/json
Authorization: Bearer {token}
Body
{
  "name": "example",
  "software": "wdZhC3v1udSOxR1d",
  "softwareType": "vanilla",
  "motd": "My cool server!",
  "timezone": "Europe/Berlin",
  "region": "eu"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "Preferred name to use for the server. If this is taken, a random name will be generated based on your input. For example the input `example` could result in the server address `example.exaroton.me` if it's available or `example-qf4H.exaroton.me` if it's not."
    },
    "software": {
      "type": "string",
      "description": "ID of the software to install on the server. See `/software/` for your options. You have to provide either this or `softwareType`. If both are set, this takes precedence."
    },
    "softwareType": {
      "type": "string",
      "description": "If you want to automatically select the latest version of a specific software type, you can use this instead of `software`. See `/software/` for your options."
    },
    "motd": {
      "type": "string",
      "description": "The MOTD of the server. If not set, a default MOTD will be generated for you."
    },
    "timezone": {
      "type": "string",
      "description": "The timezone to use for the server. This must be a valid IANA Time Zone identifier. Defaults to UTC if not set."
    },
    "region": {
      "type": "string",
      "description": "The region to create the server in (`eu` or `na`). If not set or invalid, the region is chosen automatically based on the timezone."
    }
  }
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "error": null,
  "data": {
    "id": "EwYiY9IAMtQBTb6U",
    "name": "example",
    "address": "example.exaroton.me",
    "motd": "Welcome to the server of example!",
    "status": 0,
    "host": null,
    "port": null,
    "players": {
      "max": 20,
      "count": 0,
      "list": []
    },
    "software": {
      "id": "kb4p09ABvLjxzedx",
      "name": "Vanilla",
      "version": "1.20.4",
      "type": "vanilla",
      "launcher": "CurseForge"
    },
    "shared": false,
    "permissions": [],
    "region": "eu"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean"
    },
    "error": {
      "type": [
        "string",
        "null"
      ]
    },
    "data": {
      "type": [
        "object",
        "null"
      ],
      "properties": {
        "id": {
          "type": "string",
          "description": "Unique server ID"
        },
        "name": {
          "type": "string",
          "description": "Server name"
        },
        "address": {
          "type": "string",
          "description": "Full server address (e.g. example.exaroton.me)"
        },
        "motd": {
          "type": "string"
        },
        "status": {
          "type": "number",
          "description": "0 = OFFLINE; 1 = ONLINE; 2 = STARTING; 3 = STOPPING; 4 = RESTARTING; 5 = SAVING; 6 = LOADING; 7 = CRASHED; 8 = PENDING; 9 = TRANSFERRING; 10 = PREPARING;"
        },
        "host": {
          "type": [
            "string",
            "null"
          ],
          "description": "Host machine the server is running on, only available if the server is online"
        },
        "port": {
          "type": [
            "number",
            "null"
          ],
          "description": "Port the server is listening on, only available if the server is online"
        },
        "players": {
          "type": "object",
          "properties": {
            "max": {
              "type": "number",
              "description": "Maximum player count (slots)"
            },
            "count": {
              "type": "number",
              "description": "Current player count"
            },
            "list": {
              "type": "array",
              "description": "Current player list (not always available)"
            }
          }
        },
        "software": {
          "type": [
            "object",
            "null"
          ],
          "properties": {
            "id": {
              "type": "string",
              "description": "Unique software ID"
            },
            "name": {
              "type": "string",
              "description": "Display name of the software"
            },
            "version": {
              "type": "string",
              "description": "Software version"
            },
            "type": {
              "type": "string",
              "description": "Software type"
            },
            "launcher": {
              "type": [
                "string",
                "null"
              ],
              "description": "Launcher this software belongs to, only set for modpacks/plugins that require a specific launcher"
            }
          },
          "description": "Information about the installed server software"
        },
        "shared": {
          "type": "boolean",
          "description": "Whether the server is accessed via the Share Access feature"
        },
        "permissions": {
          "type": [
            "array",
            "null"
          ],
          "description": "The permissions your account has on this server via the Share Access feature. Always `null` if you are the owner of the server."
        },
        "region": {
          "type": "string",
          "description": "ID of the region the server is located in (see `/regions/`)"
        }
      }
    }
  }
}

Get a server
GET/servers/{server}

Example URI

GET https://api.exaroton.com/v1/servers/server
URI Parameters
HideShow
server
ServerID (required) 

Unique server ID

Request
HideShow
Headers
Authorization: Bearer {token}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "error": null,
  "data": {
    "id": "EwYiY9IAMtQBTb6U",
    "name": "example",
    "address": "example.exaroton.me",
    "motd": "Welcome to the server of example!",
    "status": 0,
    "host": null,
    "port": null,
    "players": {
      "max": 20,
      "count": 0,
      "list": []
    },
    "software": {
      "id": "kb4p09ABvLjxzedx",
      "name": "Vanilla",
      "version": "1.20.4",
      "type": "vanilla",
      "launcher": "CurseForge"
    },
    "shared": false,
    "permissions": [],
    "region": "eu"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean"
    },
    "error": {
      "type": [
        "string",
        "null"
      ]
    },
    "data": {
      "type": [
        "object",
        "null"
      ],
      "properties": {
        "id": {
          "type": "string",
          "description": "Unique server ID"
        },
        "name": {
          "type": "string",
          "description": "Server name"
        },
        "address": {
          "type": "string",
          "description": "Full server address (e.g. example.exaroton.me)"
        },
        "motd": {
          "type": "string"
        },
        "status": {
          "type": "number",
          "description": "0 = OFFLINE; 1 = ONLINE; 2 = STARTING; 3 = STOPPING; 4 = RESTARTING; 5 = SAVING; 6 = LOADING; 7 = CRASHED; 8 = PENDING; 9 = TRANSFERRING; 10 = PREPARING;"
        },
        "host": {
          "type": [
            "string",
            "null"
          ],
          "description": "Host machine the server is running on, only available if the server is online"
        },
        "port": {
          "type": [
            "number",
            "null"
          ],
          "description": "Port the server is listening on, only available if the server is online"
        },
        "players": {
          "type": "object",
          "properties": {
            "max": {
              "type": "number",
              "description": "Maximum player count (slots)"
            },
            "count": {
              "type": "number",
              "description": "Current player count"
            },
            "list": {
              "type": "array",
              "description": "Current player list (not always available)"
            }
          }
        },
        "software": {
          "type": [
            "object",
            "null"
          ],
          "properties": {
            "id": {
              "type": "string",
              "description": "Unique software ID"
            },
            "name": {
              "type": "string",
              "description": "Display name of the software"
            },
            "version": {
              "type": "string",
              "description": "Software version"
            },
            "type": {
              "type": "string",
              "description": "Software type"
            },
            "launcher": {
              "type": [
                "string",
                "null"
              ],
              "description": "Launcher this software belongs to, only set for modpacks/plugins that require a specific launcher"
            }
          },
          "description": "Information about the installed server software"
        },
        "shared": {
          "type": "boolean",
          "description": "Whether the server is accessed via the Share Access feature"
        },
        "permissions": {
          "type": [
            "array",
            "null"
          ],
          "description": "The permissions your account has on this server via the Share Access feature. Always `null` if you are the owner of the server."
        },
        "region": {
          "type": "string",
          "description": "ID of the region the server is located in (see `/regions/`)"
        }
      }
    }
  }
}

Delete a server
DELETE/servers/{server}

Permanently deletes a server including all of its files. This is only possible for the owner of the server (not via Share Access) and only while the server is offline or crashed.

Example URI

DELETE https://api.exaroton.com/v1/servers/server
URI Parameters
HideShow
server
ServerID (required) 

Unique server ID

Request
HideShow
Headers
Authorization: Bearer {token}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "error": "Hello, world!",
  "data": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean"
    },
    "error": {
      "type": [
        "string",
        "null"
      ]
    },
    "data": {
      "type": [
        "string",
        "null"
      ]
    }
  }
}

Logs

Get a server log
GET/servers/{server}/logs/

Example URI

GET https://api.exaroton.com/v1/servers/server/logs/
URI Parameters
HideShow
server
ServerID (required) 

Unique server ID

Request
HideShow
Headers
Authorization: Bearer {token}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "error": "Hello, world!",
  "data": {
    "content": "[16:14:36] [main/INFO]: Environment: authHost='https://authserver.mojang.com',..."
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean"
    },
    "error": {
      "type": [
        "string",
        "null"
      ]
    },
    "data": {
      "type": [
        "object",
        "null"
      ],
      "properties": {
        "content": {
          "type": [
            "string",
            "null"
          ]
        }
      }
    }
  }
}

Upload a server log to mclo.gs
GET/servers/{server}/logs/share/

Example URI

GET https://api.exaroton.com/v1/servers/server/logs/share/
URI Parameters
HideShow
server
ServerID (required) 

Unique server ID

Request
HideShow
Headers
Authorization: Bearer {token}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "error": "Hello, world!",
  "data": {
    "id": "zCcf8T5",
    "url": "https://mclo.gs/zCcf8T5",
    "raw": "https://api.mclo.gs/1/raw/zCcf8T5"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean"
    },
    "error": {
      "type": [
        "string",
        "null"
      ]
    },
    "data": {
      "type": [
        "object",
        "null"
      ],
      "properties": {
        "id": {
          "type": "string"
        },
        "url": {
          "type": "string"
        },
        "raw": {
          "type": "string"
        }
      }
    }
  }
}

RAM

Get server RAM
GET/servers/{server}/options/ram/

Example URI

GET https://api.exaroton.com/v1/servers/server/options/ram/
URI Parameters
HideShow
server
ServerID (required) 

Unique server ID

Request
HideShow
Headers
Authorization: Bearer {token}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "error": "Hello, world!",
  "data": {
    "ram": 7
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean"
    },
    "error": {
      "type": [
        "string",
        "null"
      ]
    },
    "data": {
      "type": [
        "object",
        "null"
      ],
      "properties": {
        "ram": {
          "type": "number"
        }
      }
    }
  }
}

Change server RAM
POST/servers/{server}/options/ram/

Example URI

POST https://api.exaroton.com/v1/servers/server/options/ram/
URI Parameters
HideShow
server
ServerID (required) 

Unique server ID

Request
HideShow
Headers
Content-Type: application/json
Authorization: Bearer {token}
Body
{
  "ram": 8
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "ram": {
      "type": "number"
    }
  }
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "error": "Hello, world!",
  "data": {
    "ram": 7
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean"
    },
    "error": {
      "type": [
        "string",
        "null"
      ]
    },
    "data": {
      "type": [
        "object",
        "null"
      ],
      "properties": {
        "ram": {
          "type": "number"
        }
      }
    }
  }
}

MOTD

Get server MOTD
GET/servers/{server}/options/motd/

Example URI

GET https://api.exaroton.com/v1/servers/server/options/motd/
URI Parameters
HideShow
server
ServerID (required) 

Unique server ID

Request
HideShow
Headers
Authorization: Bearer {token}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "error": "Hello, world!",
  "data": {
    "motd": "\"Welcome to my server!\""
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean"
    },
    "error": {
      "type": [
        "string",
        "null"
      ]
    },
    "data": {
      "type": [
        "object",
        "null"
      ],
      "properties": {
        "motd": {
          "type": "string"
        }
      }
    }
  }
}

Change server MOTD
POST/servers/{server}/options/motd/

Example URI

POST https://api.exaroton.com/v1/servers/server/options/motd/
URI Parameters
HideShow
server
ServerID (required) 

Unique server ID

Request
HideShow
Headers
Content-Type: application/json
Authorization: Bearer {token}
Body
{
  "motd": "\"Welcome to my server!\""
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "motd": {
      "type": "string"
    }
  }
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "error": "Hello, world!",
  "data": {
    "motd": "\"Welcome to my server!\""
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean"
    },
    "error": {
      "type": [
        "string",
        "null"
      ]
    },
    "data": {
      "type": [
        "object",
        "null"
      ],
      "properties": {
        "motd": {
          "type": "string"
        }
      }
    }
  }
}

Properties

Server properties such as auto stop are returned and changed as a map of property name to value. Only properties that are available for the server (depending on its software and features) are included. Changing auto-update requires the software permission, all other properties require the options permission (only relevant for servers accessed via Share Access). Properties your account isn’t allowed to change are not returned.

Available properties:

  • autostop (boolean) - Stop the server automatically when no players are online

  • autostop-time (number) - Minutes without players after which the server stops (3 to 1440)

  • autostart (boolean) - Start the server automatically when a player joins

  • autostart-type (string) - Which players can start the server: any, whitelisted or ops (only the types supported by the server)

  • launcher-autostart (boolean), launcher-autostart-type (string) - The same for players joining via the launcher

  • enable-lobby (boolean) - Show a lobby to players joining the offline server

  • auto-update (string) - Update the server software automatically: never, ask or always

  • force-upgrade (boolean) - Upgrade the world to the current version when the server starts

Get server properties
GET/servers/{server}/options/properties/

Example URI

GET https://api.exaroton.com/v1/servers/server/options/properties/
URI Parameters
HideShow
server
ServerID (required) 

Unique server ID

Request
HideShow
Headers
Authorization: Bearer {token}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "error": "Hello, world!",
  "data": {
    "autostop": true,
    "autostop-time": 10,
    "enable-lobby": true,
    "auto-update": "ask"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean"
    },
    "error": {
      "type": [
        "string",
        "null"
      ]
    },
    "data": {
      "type": [
        "object",
        "null"
      ],
      "properties": {
        "autostop": {
          "type": "boolean"
        },
        "autostop-time": {
          "type": "number"
        },
        "enable-lobby": {
          "type": "boolean"
        },
        "auto-update": {
          "type": "string"
        }
      }
    }
  }
}

Change server properties
POST/servers/{server}/options/properties/

Properties that are not included in the request body are not changed. Either all properties are changed or none: if any property is unknown, not available for this server or has an invalid value, the request fails with status code 400, and if your account is missing the permission for any property, it fails with status code 403. Returns all properties after the change. PUT is accepted as well.

Example URI

POST https://api.exaroton.com/v1/servers/server/options/properties/
URI Parameters
HideShow
server
ServerID (required) 

Unique server ID

Request
HideShow
Headers
Content-Type: application/json
Authorization: Bearer {token}
Body
{
  "autostop": true,
  "autostop-time": 30
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "autostop": {
      "type": "boolean"
    },
    "autostop-time": {
      "type": "number"
    }
  }
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "error": "Hello, world!",
  "data": {
    "autostop": true,
    "autostop-time": 10,
    "enable-lobby": true,
    "auto-update": "ask"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean"
    },
    "error": {
      "type": [
        "string",
        "null"
      ]
    },
    "data": {
      "type": [
        "object",
        "null"
      ],
      "properties": {
        "autostop": {
          "type": "boolean"
        },
        "autostop-time": {
          "type": "number"
        },
        "enable-lobby": {
          "type": "boolean"
        },
        "auto-update": {
          "type": "string"
        }
      }
    }
  }
}

Server actions

Start a server
GET/servers/{server}/start/

Example URI

GET https://api.exaroton.com/v1/servers/server/start/
URI Parameters
HideShow
server
ServerID (required) 

Unique server ID

Request
HideShow
Headers
Authorization: Bearer {token}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "error": "Hello, world!",
  "data": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean"
    },
    "error": {
      "type": [
        "string",
        "null"
      ]
    },
    "data": {
      "type": [
        "string",
        "null"
      ]
    }
  }
}

Start a server with own credits
POST/servers/{server}/start/

When starting a server that you have shared access to, you can use your own credits to pay for the server by setting the useOwnCredits attribute to true.

Example URI

POST https://api.exaroton.com/v1/servers/server/start/
URI Parameters
HideShow
server
ServerID (required) 

Unique server ID

Request
HideShow
Headers
Authorization: Bearer {token}
Body
{
  "useOwnCredits": true
}
Schema
{
  "type": "object",
  "properties": {
    "useOwnCredits": {
      "type": "boolean"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "error": "Hello, world!",
  "data": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean"
    },
    "error": {
      "type": [
        "string",
        "null"
      ]
    },
    "data": {
      "type": [
        "string",
        "null"
      ]
    }
  }
}

Stop a server
GET/servers/{server}/stop/

Example URI

GET https://api.exaroton.com/v1/servers/server/stop/
URI Parameters
HideShow
server
ServerID (required) 

Unique server ID

Request
HideShow
Headers
Authorization: Bearer {token}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "error": "Hello, world!",
  "data": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean"
    },
    "error": {
      "type": [
        "string",
        "null"
      ]
    },
    "data": {
      "type": [
        "string",
        "null"
      ]
    }
  }
}

Restart a server
GET/servers/{server}/restart/

Example URI

GET https://api.exaroton.com/v1/servers/server/restart/
URI Parameters
HideShow
server
ServerID (required) 

Unique server ID

Request
HideShow
Headers
Authorization: Bearer {token}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "error": "Hello, world!",
  "data": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean"
    },
    "error": {
      "type": [
        "string",
        "null"
      ]
    },
    "data": {
      "type": [
        "string",
        "null"
      ]
    }
  }
}

Execute a server command
POST/servers/{server}/command/

Example URI

POST https://api.exaroton.com/v1/servers/server/command/
URI Parameters
HideShow
server
ServerID (required) 

Unique server ID

Request
HideShow
Headers
Content-Type: application/json
Authorization: Bearer {token}
Body
{
  "command": "say Hello World"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "command": {
      "type": "string"
    }
  }
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "error": "Hello, world!",
  "data": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean"
    },
    "error": {
      "type": [
        "string",
        "null"
      ]
    },
    "data": {
      "type": [
        "string",
        "null"
      ]
    }
  }
}

Extend server stop timer
POST/servers/{server}/extend-time/

Example URI

POST https://api.exaroton.com/v1/servers/server/extend-time/
URI Parameters
HideShow
server
ServerID (required) 

Unique server ID

Request
HideShow
Headers
Authorization: Bearer {token}
Body
{
  "time": 60
}
Schema
{
  "type": "object",
  "properties": {
    "time": {
      "type": "number",
      "description": "Additional time in seconds to add to the stop timer"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "error": "Hello, world!",
  "data": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean"
    },
    "error": {
      "type": [
        "string",
        "null"
      ]
    },
    "data": {
      "type": [
        "string",
        "null"
      ]
    }
  }
}

Transfer a server to another region
POST/servers/{server}/transfer/

Transfers an offline (or crashed) server to another region (see /regions/). Requires the options permission. The transfer runs asynchronously: the returned server has the status 9 (TRANSFERRING) while its files are copied, afterwards it returns to its previous status with the new region. Poll the server (or use the websocket status stream) to see when the transfer is done. Transferring to the region the server is already in returns the unchanged server. Fails with status code 400 if the region is invalid or the server is not offline, and with status code 503 if a transfer is temporarily not possible.

Example URI

POST https://api.exaroton.com/v1/servers/server/transfer/
URI Parameters
HideShow
server
ServerID (required) 

Unique server ID

Request
HideShow
Headers
Content-Type: application/json
Authorization: Bearer {token}
Body
{
  "region": "na"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "region": {
      "type": "string",
      "description": "ID of the region to transfer the server to"
    }
  }
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "error": null,
  "data": {
    "id": "EwYiY9IAMtQBTb6U",
    "name": "example",
    "address": "example.exaroton.me",
    "motd": "Welcome to the server of example!",
    "status": 0,
    "host": null,
    "port": null,
    "players": {
      "max": 20,
      "count": 0,
      "list": []
    },
    "software": {
      "id": "kb4p09ABvLjxzedx",
      "name": "Vanilla",
      "version": "1.20.4",
      "type": "vanilla",
      "launcher": "CurseForge"
    },
    "shared": false,
    "permissions": [],
    "region": "eu"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean"
    },
    "error": {
      "type": [
        "string",
        "null"
      ]
    },
    "data": {
      "type": [
        "object",
        "null"
      ],
      "properties": {
        "id": {
          "type": "string",
          "description": "Unique server ID"
        },
        "name": {
          "type": "string",
          "description": "Server name"
        },
        "address": {
          "type": "string",
          "description": "Full server address (e.g. example.exaroton.me)"
        },
        "motd": {
          "type": "string"
        },
        "status": {
          "type": "number",
          "description": "0 = OFFLINE; 1 = ONLINE; 2 = STARTING; 3 = STOPPING; 4 = RESTARTING; 5 = SAVING; 6 = LOADING; 7 = CRASHED; 8 = PENDING; 9 = TRANSFERRING; 10 = PREPARING;"
        },
        "host": {
          "type": [
            "string",
            "null"
          ],
          "description": "Host machine the server is running on, only available if the server is online"
        },
        "port": {
          "type": [
            "number",
            "null"
          ],
          "description": "Port the server is listening on, only available if the server is online"
        },
        "players": {
          "type": "object",
          "properties": {
            "max": {
              "type": "number",
              "description": "Maximum player count (slots)"
            },
            "count": {
              "type": "number",
              "description": "Current player count"
            },
            "list": {
              "type": "array",
              "description": "Current player list (not always available)"
            }
          }
        },
        "software": {
          "type": [
            "object",
            "null"
          ],
          "properties": {
            "id": {
              "type": "string",
              "description": "Unique software ID"
            },
            "name": {
              "type": "string",
              "description": "Display name of the software"
            },
            "version": {
              "type": "string",
              "description": "Software version"
            },
            "type": {
              "type": "string",
              "description": "Software type"
            },
            "launcher": {
              "type": [
                "string",
                "null"
              ],
              "description": "Launcher this software belongs to, only set for modpacks/plugins that require a specific launcher"
            }
          },
          "description": "Information about the installed server software"
        },
        "shared": {
          "type": "boolean",
          "description": "Whether the server is accessed via the Share Access feature"
        },
        "permissions": {
          "type": [
            "array",
            "null"
          ],
          "description": "The permissions your account has on this server via the Share Access feature. Always `null` if you are the owner of the server."
        },
        "region": {
          "type": "string",
          "description": "ID of the region the server is located in (see `/regions/`)"
        }
      }
    }
  }
}

Get available player lists

Get available player lists
GET/servers/{server}/playerlists/

Example URI

GET https://api.exaroton.com/v1/servers/server/playerlists/
URI Parameters
HideShow
server
ServerID (required) 

Unique server ID

Request
HideShow
Headers
Authorization: Bearer {token}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "error": "Hello, world!",
  "data": [
    "whitelist",
    "ops",
    "banned"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean"
    },
    "error": {
      "type": [
        "string",
        "null"
      ]
    },
    "data": {
      "type": "array",
      "description": "players, banned-ips (array[string], nullable)"
    }
  }
}

Player lists

A player list is a list of players such as the whitelist, ops or bans. Player list entries are usually usernames, but might be something else, e.g. IPs in the banned-ips list. All player list operations are storage operations that might take a while, so try to reduce the amount of requests and combine actions when possible (e.g. adding/deleting multiple entries at once). Player lists are also cached and might not immediately return new results when changed through other methods.

Get player list contents
GET/servers/{server}/playerlists/{list}/

Example URI

GET https://api.exaroton.com/v1/servers/server/playerlists/list/
URI Parameters
HideShow
server
ServerID (required) 

Unique server ID

list
string (required) 

Player list name

Request
HideShow
Headers
Authorization: Bearer {token}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "error": "Hello, world!",
  "data": [
    "exaroton",
    "example"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean"
    },
    "error": {
      "type": [
        "string",
        "null"
      ]
    },
    "data": {
      "type": [
        "array",
        "null"
      ]
    }
  }
}

Add entries to player list
PUT/servers/{server}/playerlists/{list}/

Example URI

PUT https://api.exaroton.com/v1/servers/server/playerlists/list/
URI Parameters
HideShow
server
ServerID (required) 

Unique server ID

list
string (required) 

Player list name

Request
HideShow
Headers
Authorization: Bearer {token}
Body
{
  "entries": [
    "player"
  ]
}
Schema
{
  "type": "object",
  "properties": {
    "entries": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "error": "Hello, world!",
  "data": [
    "exaroton",
    "example",
    "player"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean"
    },
    "error": {
      "type": [
        "string",
        "null"
      ]
    },
    "data": {
      "type": [
        "array",
        "null"
      ]
    }
  }
}

Remove entries from player list
DELETE/servers/{server}/playerlists/{list}/

Example URI

DELETE https://api.exaroton.com/v1/servers/server/playerlists/list/
URI Parameters
HideShow
server
ServerID (required) 

Unique server ID

list
string (required) 

Player list name

Request
HideShow
Headers
Authorization: Bearer {token}
Body
{
  "entries": [
    "player"
  ]
}
Schema
{
  "type": "object",
  "properties": {
    "entries": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "error": "Hello, world!",
  "data": [
    "exaroton",
    "example"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean"
    },
    "error": {
      "type": [
        "string",
        "null"
      ]
    },
    "data": {
      "type": [
        "array",
        "null"
      ]
    }
  }
}

File info

Get file information
GET/servers/{server}/files/info/{path}/

Example URI

GET https://api.exaroton.com/v1/servers/server/files/info/path/
URI Parameters
HideShow
server
ServerID (required) 

Unique server ID

path
string (required) 

File path

Request
HideShow
Headers
Authorization: Bearer {token}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "error": null,
  "data": {
    "path": "world/playerdata",
    "name": "playerdata",
    "isTextFile": false,
    "isConfigFile": false,
    "isDirectory": true,
    "isLog": false,
    "isReadable": false,
    "isWritable": false,
    "size": 4096,
    "children": [
      {}
    ]
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean"
    },
    "error": {
      "type": [
        "string",
        "null"
      ]
    },
    "data": {
      "type": [
        "object",
        "null"
      ],
      "properties": {
        "path": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "isTextFile": {
          "type": "boolean"
        },
        "isConfigFile": {
          "type": "boolean"
        },
        "isDirectory": {
          "type": "boolean"
        },
        "isLog": {
          "type": "boolean"
        },
        "isReadable": {
          "type": "boolean"
        },
        "isWritable": {
          "type": "boolean"
        },
        "size": {
          "type": "number"
        },
        "children": {
          "type": [
            "array",
            "null"
          ]
        }
      }
    }
  }
}

File data

Get file data
GET/servers/{server}/files/data/{path}/

Example URI

GET https://api.exaroton.com/v1/servers/server/files/data/path/
URI Parameters
HideShow
server
ServerID (required) 

Unique server ID

path
string (required) 

File path

Request
HideShow
Headers
Authorization: Bearer {token}
Response  200
HideShow
Headers
Content-Type: application/octet-stream

Write file data
PUT/servers/{server}/files/data/{path}/

Files are written with a simple PUT request. If the destination file already exists, it will be overwritten, otherwise a new file will be created. Directories can be created by sending a write request with the inode/directory content type.

Example URI

PUT https://api.exaroton.com/v1/servers/server/files/data/path/
URI Parameters
HideShow
server
ServerID (required) 

Unique server ID

path
string (required) 

File path

Request
HideShow
Headers
Content-Type: application/octet-stream
Authorization: Bearer {token}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "error": "Hello, world!",
  "data": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean"
    },
    "error": {
      "type": [
        "string",
        "null"
      ]
    },
    "data": {
      "type": [
        "string",
        "null"
      ]
    }
  }
}

Delete a file
DELETE/servers/{server}/files/data/{path}/

Example URI

DELETE https://api.exaroton.com/v1/servers/server/files/data/path/
URI Parameters
HideShow
server
ServerID (required) 

Unique server ID

path
string (required) 

File path

Request
HideShow
Headers
Authorization: Bearer {token}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "error": "Hello, world!",
  "data": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean"
    },
    "error": {
      "type": [
        "string",
        "null"
      ]
    },
    "data": {
      "type": [
        "string",
        "null"
      ]
    }
  }
}

Config files

Get config options
GET/servers/{server}/files/config/{path}/

Each config option has a key, a label, a type and a value. Possible types are string, integer, float, boolean, multiselect, select. Additionally, multiselect and select options have an options array. The value of multiselect options is an array of strings. Integer and float options have min, max and step values (each can be null). Select options can only have a value from the options array, while multiselect options can also have custom values.

Example URI

GET https://api.exaroton.com/v1/servers/server/files/config/path/
URI Parameters
HideShow
server
ServerID (required) 

Unique server ID

path
string (required) 

File path

Request
HideShow
Headers
Authorization: Bearer {token}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "error": null,
  "data": [
    {
      "key": "gamemode",
      "value": "survival",
      "label": "Gamemode",
      "type": "select",
      "options": [
        "survival",
        "creative",
        "adventure",
        "spectator"
      ],
      "min": null,
      "max": null,
      "step": null
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean"
    },
    "error": {
      "type": [
        "string",
        "null"
      ]
    },
    "data": {
      "type": [
        "array",
        "null"
      ]
    }
  }
}

Update config options
POST/servers/{server}/files/config/{path}/

Config options to update can be sent as a JSON object in the request body.

Example URI

POST https://api.exaroton.com/v1/servers/server/files/config/path/
URI Parameters
HideShow
server
ServerID (required) 

Unique server ID

path
string (required) 

File path

Request
HideShow
Headers
Content-Type: application/json
Authorization: Bearer {token}
Body
{
  "key1": "value1",
  "key2": "value2"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "key1": {
      "type": "string"
    },
    "key2": {
      "type": "string"
    }
  }
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "error": null,
  "data": [
    {
      "key": "gamemode",
      "value": "survival",
      "label": "Gamemode",
      "type": "select",
      "options": [
        "survival",
        "creative",
        "adventure",
        "spectator"
      ],
      "min": null,
      "max": null,
      "step": null
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean"
    },
    "error": {
      "type": [
        "string",
        "null"
      ]
    },
    "data": {
      "type": [
        "array",
        "null"
      ]
    }
  }
}

Server software

Get server software details
GET/servers/{server}/software/{software}/

Returns details about the given software, including whether installing it on this server would require a reinstall (which deletes all existing server files).

Example URI

GET https://api.exaroton.com/v1/servers/server/software/software/
URI Parameters
HideShow
server
ServerID (required) 

Unique server ID

software
string (required) 

Unique software ID

Request
HideShow
Headers
Authorization: Bearer {token}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "error": "Hello, world!",
  "data": {
    "id": "kb4p09ABvLjxzedx",
    "name": "Vanilla",
    "version": "1.20.4",
    "type": "vanilla",
    "launcher": "CurseForge"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean"
    },
    "error": {
      "type": [
        "string",
        "null"
      ]
    },
    "data": {
      "type": [
        "object",
        "null"
      ],
      "properties": {
        "id": {
          "type": "string",
          "description": "Unique software ID"
        },
        "name": {
          "type": "string",
          "description": "Display name of the software"
        },
        "version": {
          "type": "string",
          "description": "Software version"
        },
        "type": {
          "type": "string",
          "description": "Software type"
        },
        "launcher": {
          "type": [
            "string",
            "null"
          ],
          "description": "Launcher this software belongs to, only set for modpacks/plugins that require a specific launcher"
        }
      }
    }
  }
}

Install a software on a server
POST/servers/{server}/software/{software}/

Installs the given software on the server. If switching to this software requires a reinstall (see the GET request above), you must set reinstall to true in the request body to confirm this - it will delete all existing server files.

Example URI

POST https://api.exaroton.com/v1/servers/server/software/software/
URI Parameters
HideShow
server
ServerID (required) 

Unique server ID

software
string (required) 

Unique software ID

Request
HideShow
Headers
Content-Type: application/json
Authorization: Bearer {token}
Body
{
  "reinstall": false
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "reinstall": {
      "type": "boolean",
      "description": "Confirms that a reinstall (deleting all server files) is allowed, if required"
    }
  }
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "error": "Hello, world!",
  "data": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean"
    },
    "error": {
      "type": [
        "string",
        "null"
      ]
    },
    "data": {
      "type": [
        "string",
        "null"
      ]
    }
  }
}

Backups

Backups are stored in backup accounts (cloud storage like Google Drive, Dropbox or OneDrive) that are linked to the server. Backup accounts can’t be linked via the API, link them in the exaroton panel. All backup endpoints require the backups permission.

Creating and restoring backups runs asynchronously after the response. Only one backup can be created or restored on a server at a time; running in the backup list is true while that happens.

List backups
GET/servers/{server}/backups/{?page}

Returns a page of the backups of the server in all of its linked backup accounts (20 per page), newest first.

Example URI

GET https://api.exaroton.com/v1/servers/server/backups/?page=1
URI Parameters
HideShow
server
ServerID (required) 

Unique server ID

page
number (optional) Example: 1

Page of the list, starting at 1. Pages after the last page are empty.

Request
HideShow
Headers
Authorization: Bearer {token}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "error": null,
  "data": {
    "page": 1,
    "lastPage": 2,
    "total": 21,
    "items": [
      {
        "id": "Xy7zAb3dEf6hIj9k",
        "name": "Before the update",
        "type": "manual",
        "status": "created",
        "server": "EwYiY9IAMtQBTb6U",
        "software": "kb4p09ABvLjxzedx",
        "size": 52428800,
        "created": 1763251200,
        "backupAccount": "Ab3dEf6hIj9kLm2n"
      }
    ],
    "running": false
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean"
    },
    "error": {
      "type": [
        "string",
        "null"
      ]
    },
    "data": {
      "type": [
        "object",
        "null"
      ],
      "properties": {
        "page": {
          "type": "number",
          "description": "The requested page"
        },
        "lastPage": {
          "type": "number",
          "description": "The last page with items (at least 1)"
        },
        "total": {
          "type": "number",
          "description": "Total number of items in all pages"
        },
        "items": {
          "type": "array"
        },
        "running": {
          "type": "boolean",
          "description": "Whether a backup is currently being created or restored on this server"
        }
      }
    }
  }
}

Create a backup
POST/servers/{server}/backups/

Starts creating a manual backup. The response contains the new backup with the status creating; poll the backup (or running in the backup list) to see when it is done. If creating the backup fails, the backup is deleted, so it is no longer found. Fails with status code 400 if no backup account is linked, the backup account doesn’t exist or isn’t linked to this server, the name is longer than 512 bytes or the server is busy (e.g. starting or stopping), with status code 409 if another backup is currently being created or restored on this server, and with status code 413 if there is not enough space in the backup account.

Example URI

POST https://api.exaroton.com/v1/servers/server/backups/
URI Parameters
HideShow
server
ServerID (required) 

Unique server ID

Request
HideShow
Headers
Content-Type: application/json
Authorization: Bearer {token}
Body
{
  "backupAccount": "Ab3dEf6hIj9kLm2n",
  "name": "Before the update"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "backupAccount": {
      "type": "string",
      "description": "ID of the backup account to store the backup in, defaults to the first backup account linked to the server"
    },
    "name": {
      "type": "string",
      "description": "Name of the backup, the default name is used if not set or empty"
    }
  }
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "error": null,
  "data": {
    "id": "Xy7zAb3dEf6hIj9k",
    "name": "Before the update",
    "type": "manual",
    "status": "created",
    "server": "EwYiY9IAMtQBTb6U",
    "software": "kb4p09ABvLjxzedx",
    "size": 52428800,
    "created": 1763251200,
    "backupAccount": "Ab3dEf6hIj9kLm2n"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean"
    },
    "error": {
      "type": [
        "string",
        "null"
      ]
    },
    "data": {
      "type": [
        "object",
        "null"
      ],
      "properties": {
        "id": {
          "type": "string",
          "description": "Unique backup ID"
        },
        "name": {
          "type": [
            "string",
            "null"
          ],
          "description": "Name of the backup, `null` if it has the default name"
        },
        "type": {
          "type": [
            "string",
            "null"
          ],
          "description": "`automatic` or `manual`"
        },
        "status": {
          "type": "string",
          "description": "`creating` while the backup is being created, `created` once it is done"
        },
        "server": {
          "type": "string",
          "description": "Unique ID of the server the backup was created from"
        },
        "software": {
          "type": [
            "string",
            "null"
          ],
          "description": "Unique ID of the software the server had when the backup was created"
        },
        "size": {
          "type": [
            "number",
            "null"
          ],
          "description": "Size in bytes"
        },
        "created": {
          "type": [
            "number",
            "null"
          ],
          "description": "Unix timestamp of when the backup was created"
        },
        "backupAccount": {
          "type": [
            "string",
            "null"
          ],
          "description": "Unique ID of the backup account the backup is stored in"
        }
      }
    }
  }
}

Backup

Get a backup
GET/servers/{server}/backups/{backup}/

Example URI

GET https://api.exaroton.com/v1/servers/server/backups/backup/
URI Parameters
HideShow
server
ServerID (required) 

Unique server ID

backup
string (required) 

Unique backup ID

Request
HideShow
Headers
Authorization: Bearer {token}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "error": null,
  "data": {
    "id": "Xy7zAb3dEf6hIj9k",
    "name": "Before the update",
    "type": "manual",
    "status": "created",
    "server": "EwYiY9IAMtQBTb6U",
    "software": "kb4p09ABvLjxzedx",
    "size": 52428800,
    "created": 1763251200,
    "backupAccount": "Ab3dEf6hIj9kLm2n"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean"
    },
    "error": {
      "type": [
        "string",
        "null"
      ]
    },
    "data": {
      "type": [
        "object",
        "null"
      ],
      "properties": {
        "id": {
          "type": "string",
          "description": "Unique backup ID"
        },
        "name": {
          "type": [
            "string",
            "null"
          ],
          "description": "Name of the backup, `null` if it has the default name"
        },
        "type": {
          "type": [
            "string",
            "null"
          ],
          "description": "`automatic` or `manual`"
        },
        "status": {
          "type": "string",
          "description": "`creating` while the backup is being created, `created` once it is done"
        },
        "server": {
          "type": "string",
          "description": "Unique ID of the server the backup was created from"
        },
        "software": {
          "type": [
            "string",
            "null"
          ],
          "description": "Unique ID of the software the server had when the backup was created"
        },
        "size": {
          "type": [
            "number",
            "null"
          ],
          "description": "Size in bytes"
        },
        "created": {
          "type": [
            "number",
            "null"
          ],
          "description": "Unix timestamp of when the backup was created"
        },
        "backupAccount": {
          "type": [
            "string",
            "null"
          ],
          "description": "Unique ID of the backup account the backup is stored in"
        }
      }
    }
  }
}

Rename a backup
PUT/servers/{server}/backups/{backup}/

An empty name resets the backup to the default name. Renaming an automatic backup turns it into a manual backup, so it is no longer deleted automatically. Not possible while the backup is being created. Fails with status code 400 if the name is longer than 512 bytes. PATCH is accepted as well.

Example URI

PUT https://api.exaroton.com/v1/servers/server/backups/backup/
URI Parameters
HideShow
server
ServerID (required) 

Unique server ID

backup
string (required) 

Unique backup ID

Request
HideShow
Headers
Content-Type: application/json
Authorization: Bearer {token}
Body
{
  "name": "Before the update"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "name": {
      "type": "string"
    }
  }
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "error": null,
  "data": {
    "id": "Xy7zAb3dEf6hIj9k",
    "name": "Before the update",
    "type": "manual",
    "status": "created",
    "server": "EwYiY9IAMtQBTb6U",
    "software": "kb4p09ABvLjxzedx",
    "size": 52428800,
    "created": 1763251200,
    "backupAccount": "Ab3dEf6hIj9kLm2n"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean"
    },
    "error": {
      "type": [
        "string",
        "null"
      ]
    },
    "data": {
      "type": [
        "object",
        "null"
      ],
      "properties": {
        "id": {
          "type": "string",
          "description": "Unique backup ID"
        },
        "name": {
          "type": [
            "string",
            "null"
          ],
          "description": "Name of the backup, `null` if it has the default name"
        },
        "type": {
          "type": [
            "string",
            "null"
          ],
          "description": "`automatic` or `manual`"
        },
        "status": {
          "type": "string",
          "description": "`creating` while the backup is being created, `created` once it is done"
        },
        "server": {
          "type": "string",
          "description": "Unique ID of the server the backup was created from"
        },
        "software": {
          "type": [
            "string",
            "null"
          ],
          "description": "Unique ID of the software the server had when the backup was created"
        },
        "size": {
          "type": [
            "number",
            "null"
          ],
          "description": "Size in bytes"
        },
        "created": {
          "type": [
            "number",
            "null"
          ],
          "description": "Unix timestamp of when the backup was created"
        },
        "backupAccount": {
          "type": [
            "string",
            "null"
          ],
          "description": "Unique ID of the backup account the backup is stored in"
        }
      }
    }
  }
}

Delete a backup
DELETE/servers/{server}/backups/{backup}/

Deletes the backup from its backup account. Not possible while the backup is being created. If the backup account is no longer authenticated, it is unlinked from the server and the request fails with status code 400; link it again in the exaroton panel.

Example URI

DELETE https://api.exaroton.com/v1/servers/server/backups/backup/
URI Parameters
HideShow
server
ServerID (required) 

Unique server ID

backup
string (required) 

Unique backup ID

Request
HideShow
Headers
Authorization: Bearer {token}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "error": "Hello, world!",
  "data": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean"
    },
    "error": {
      "type": [
        "string",
        "null"
      ]
    },
    "data": {
      "type": [
        "string",
        "null"
      ]
    }
  }
}

Restore a backup
POST/servers/{server}/backups/{backup}/restore/

Starts restoring the backup to the server, replacing its current files. The server has to be offline (or crashed) and the backup has to have the status created. The response contains the backup; poll running in the backup list to see when the restore is done and don’t start the server before that. Fails with status code 409 if another backup is currently being created or restored on this server, and with status code 403 if the server’s owner is in the free trial and the backup belongs to another account.

Example URI

POST https://api.exaroton.com/v1/servers/server/backups/backup/restore/
URI Parameters
HideShow
server
ServerID (required) 

Unique server ID

backup
string (required) 

Unique backup ID

Request
HideShow
Headers
Authorization: Bearer {token}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "error": null,
  "data": {
    "id": "Xy7zAb3dEf6hIj9k",
    "name": "Before the update",
    "type": "manual",
    "status": "created",
    "server": "EwYiY9IAMtQBTb6U",
    "software": "kb4p09ABvLjxzedx",
    "size": 52428800,
    "created": 1763251200,
    "backupAccount": "Ab3dEf6hIj9kLm2n"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean"
    },
    "error": {
      "type": [
        "string",
        "null"
      ]
    },
    "data": {
      "type": [
        "object",
        "null"
      ],
      "properties": {
        "id": {
          "type": "string",
          "description": "Unique backup ID"
        },
        "name": {
          "type": [
            "string",
            "null"
          ],
          "description": "Name of the backup, `null` if it has the default name"
        },
        "type": {
          "type": [
            "string",
            "null"
          ],
          "description": "`automatic` or `manual`"
        },
        "status": {
          "type": "string",
          "description": "`creating` while the backup is being created, `created` once it is done"
        },
        "server": {
          "type": "string",
          "description": "Unique ID of the server the backup was created from"
        },
        "software": {
          "type": [
            "string",
            "null"
          ],
          "description": "Unique ID of the software the server had when the backup was created"
        },
        "size": {
          "type": [
            "number",
            "null"
          ],
          "description": "Size in bytes"
        },
        "created": {
          "type": [
            "number",
            "null"
          ],
          "description": "Unix timestamp of when the backup was created"
        },
        "backupAccount": {
          "type": [
            "string",
            "null"
          ],
          "description": "Unique ID of the backup account the backup is stored in"
        }
      }
    }
  }
}

Backup accounts

List backup accounts
GET/servers/{server}/backup-accounts/

Returns the backup accounts linked to the server, in the server’s order. Backups are created in the first one by default. Backup accounts can only be linked in the exaroton panel.

Example URI

GET https://api.exaroton.com/v1/servers/server/backup-accounts/
URI Parameters
HideShow
server
ServerID (required) 

Unique server ID

Request
HideShow
Headers
Authorization: Bearer {token}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "error": "Hello, world!",
  "data": [
    {
      "id": "Ab3dEf6hIj9kLm2n",
      "name": "[email protected]",
      "provider": "google-drive",
      "storage": {
        "used": 1073741824,
        "limit": 16106127360
      }
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean"
    },
    "error": {
      "type": [
        "string",
        "null"
      ]
    },
    "data": {
      "type": [
        "array",
        "null"
      ]
    }
  }
}

Backup settings

Settings of the automatic backups of the server.

Get automatic backup settings
GET/servers/{server}/backup-settings/

Example URI

GET https://api.exaroton.com/v1/servers/server/backup-settings/
URI Parameters
HideShow
server
ServerID (required) 

Unique server ID

Request
HideShow
Headers
Authorization: Bearer {token}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "error": "Hello, world!",
  "data": {
    "enabled": true,
    "limit": 5,
    "interval": 86400,
    "failed": 0
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean"
    },
    "error": {
      "type": [
        "string",
        "null"
      ]
    },
    "data": {
      "type": [
        "object",
        "null"
      ],
      "properties": {
        "enabled": {
          "type": "boolean",
          "description": "Whether automatic backups are enabled"
        },
        "limit": {
          "type": "number",
          "description": "How many automatic backups are kept"
        },
        "interval": {
          "type": "number",
          "description": "Interval between automatic backups in seconds"
        },
        "failed": {
          "type": "number",
          "description": "Number of automatic backups that failed in a row since the last successful one"
        }
      }
    }
  }
}

Change automatic backup settings
POST/servers/{server}/backup-settings/

Settings that are not included in the request body are kept. If any value is invalid, the request fails with status code 400 and nothing is changed. PUT is accepted as well.

Example URI

POST https://api.exaroton.com/v1/servers/server/backup-settings/
URI Parameters
HideShow
server
ServerID (required) 

Unique server ID

Request
HideShow
Headers
Content-Type: application/json
Authorization: Bearer {token}
Body
{
  "enabled": true,
  "limit": 10,
  "interval": 43200
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "enabled": {
      "type": "boolean",
      "description": "Whether automatic backups are enabled"
    },
    "limit": {
      "type": "number",
      "description": "How many automatic backups are kept (2 to 1000)"
    },
    "interval": {
      "type": "number",
      "description": "Interval between automatic backups in seconds: `21600`, `43200`, `86400` or `172800`"
    }
  }
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "error": "Hello, world!",
  "data": {
    "enabled": true,
    "limit": 5,
    "interval": 86400,
    "failed": 0
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean"
    },
    "error": {
      "type": [
        "string",
        "null"
      ]
    },
    "data": {
      "type": [
        "object",
        "null"
      ],
      "properties": {
        "enabled": {
          "type": "boolean",
          "description": "Whether automatic backups are enabled"
        },
        "limit": {
          "type": "number",
          "description": "How many automatic backups are kept"
        },
        "interval": {
          "type": "number",
          "description": "Interval between automatic backups in seconds"
        },
        "failed": {
          "type": "number",
          "description": "Number of automatic backups that failed in a row since the last successful one"
        }
      }
    }
  }
}

Domains

Custom domains for a server. To link a domain, set its NS records at your DNS provider to the nameservers listed in nameservers. All domain endpoints require the domains permission.

List custom domains
GET/servers/{server}/domains/

Example URI

GET https://api.exaroton.com/v1/servers/server/domains/
URI Parameters
HideShow
server
ServerID (required) 

Unique server ID

Request
HideShow
Headers
Authorization: Bearer {token}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "error": "Hello, world!",
  "data": [
    {
      "id": "Pq4rSt7uVw0xYz3a",
      "domain": "play.example.com",
      "status": "linked",
      "protocol": "https",
      "port": 80,
      "checkedTime": 1763251200,
      "createdTime": 1763251200,
      "nameservers": [
        "galileo.exaroton.com",
        "columbus.exaroton.com"
      ]
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean"
    },
    "error": {
      "type": [
        "string",
        "null"
      ]
    },
    "data": {
      "type": [
        "array",
        "null"
      ]
    }
  }
}

Add a custom domain
POST/servers/{server}/domains/

Adds a custom domain to the server (up to 10 per server). If the NS records of the domain already point to the nameservers, the domain is linked immediately, otherwise it stays pending until it is checked again. Fails with status code 400 if the domain is invalid, already in use or the server has too many domains.

Example URI

POST https://api.exaroton.com/v1/servers/server/domains/
URI Parameters
HideShow
server
ServerID (required) 

Unique server ID

Request
HideShow
Headers
Content-Type: application/json
Authorization: Bearer {token}
Body
{
  "domain": "play.example.com"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "domain": {
      "type": "string"
    }
  }
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "error": "Hello, world!",
  "data": {
    "id": "Pq4rSt7uVw0xYz3a",
    "domain": "play.example.com",
    "status": "linked",
    "protocol": "https",
    "port": 80,
    "checkedTime": 1763251200,
    "createdTime": 1763251200,
    "nameservers": [
      "galileo.exaroton.com",
      "columbus.exaroton.com"
    ]
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean"
    },
    "error": {
      "type": [
        "string",
        "null"
      ]
    },
    "data": {
      "type": [
        "object",
        "null"
      ],
      "properties": {
        "id": {
          "type": "string",
          "description": "Unique custom domain ID"
        },
        "domain": {
          "type": "string"
        },
        "status": {
          "type": "string",
          "description": "`pending` until the domain was checked successfully for the first time, `linked` if its NS records pointed to the nameservers on the last check, `unlinked` if they didn't"
        },
        "protocol": {
          "type": "string"
        },
        "port": {
          "type": "number"
        },
        "checkedTime": {
          "type": [
            "number",
            "null"
          ],
          "description": "Unix timestamp of the last check"
        },
        "createdTime": {
          "type": [
            "number",
            "null"
          ],
          "description": "Unix timestamp of when the domain was added"
        },
        "nameservers": {
          "type": "array",
          "description": "The nameservers the NS records of the domain have to point to"
        }
      }
    }
  }
}

Domain

Get a custom domain
GET/servers/{server}/domains/{domain}/

Example URI

GET https://api.exaroton.com/v1/servers/server/domains/domain/
URI Parameters
HideShow
server
ServerID (required) 

Unique server ID

domain
string (required) 

Unique custom domain ID

Request
HideShow
Headers
Authorization: Bearer {token}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "error": "Hello, world!",
  "data": {
    "id": "Pq4rSt7uVw0xYz3a",
    "domain": "play.example.com",
    "status": "linked",
    "protocol": "https",
    "port": 80,
    "checkedTime": 1763251200,
    "createdTime": 1763251200,
    "nameservers": [
      "galileo.exaroton.com",
      "columbus.exaroton.com"
    ]
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean"
    },
    "error": {
      "type": [
        "string",
        "null"
      ]
    },
    "data": {
      "type": [
        "object",
        "null"
      ],
      "properties": {
        "id": {
          "type": "string",
          "description": "Unique custom domain ID"
        },
        "domain": {
          "type": "string"
        },
        "status": {
          "type": "string",
          "description": "`pending` until the domain was checked successfully for the first time, `linked` if its NS records pointed to the nameservers on the last check, `unlinked` if they didn't"
        },
        "protocol": {
          "type": "string"
        },
        "port": {
          "type": "number"
        },
        "checkedTime": {
          "type": [
            "number",
            "null"
          ],
          "description": "Unix timestamp of the last check"
        },
        "createdTime": {
          "type": [
            "number",
            "null"
          ],
          "description": "Unix timestamp of when the domain was added"
        },
        "nameservers": {
          "type": "array",
          "description": "The nameservers the NS records of the domain have to point to"
        }
      }
    }
  }
}

Change a custom domain
PUT/servers/{server}/domains/{domain}/

Changes the protocol and/or port of the domain. Values that are not included are kept, but at least one has to be set. PATCH is accepted as well.

Example URI

PUT https://api.exaroton.com/v1/servers/server/domains/domain/
URI Parameters
HideShow
server
ServerID (required) 

Unique server ID

domain
string (required) 

Unique custom domain ID

Request
HideShow
Headers
Content-Type: application/json
Authorization: Bearer {token}
Body
{
  "protocol": "https",
  "port": 8080
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "protocol": {
      "type": "string",
      "description": "Currently only `https`"
    },
    "port": {
      "type": "number",
      "description": "Port from 1 to 65535"
    }
  }
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "error": "Hello, world!",
  "data": {
    "id": "Pq4rSt7uVw0xYz3a",
    "domain": "play.example.com",
    "status": "linked",
    "protocol": "https",
    "port": 80,
    "checkedTime": 1763251200,
    "createdTime": 1763251200,
    "nameservers": [
      "galileo.exaroton.com",
      "columbus.exaroton.com"
    ]
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean"
    },
    "error": {
      "type": [
        "string",
        "null"
      ]
    },
    "data": {
      "type": [
        "object",
        "null"
      ],
      "properties": {
        "id": {
          "type": "string",
          "description": "Unique custom domain ID"
        },
        "domain": {
          "type": "string"
        },
        "status": {
          "type": "string",
          "description": "`pending` until the domain was checked successfully for the first time, `linked` if its NS records pointed to the nameservers on the last check, `unlinked` if they didn't"
        },
        "protocol": {
          "type": "string"
        },
        "port": {
          "type": "number"
        },
        "checkedTime": {
          "type": [
            "number",
            "null"
          ],
          "description": "Unix timestamp of the last check"
        },
        "createdTime": {
          "type": [
            "number",
            "null"
          ],
          "description": "Unix timestamp of when the domain was added"
        },
        "nameservers": {
          "type": "array",
          "description": "The nameservers the NS records of the domain have to point to"
        }
      }
    }
  }
}

Remove a custom domain
DELETE/servers/{server}/domains/{domain}/

Example URI

DELETE https://api.exaroton.com/v1/servers/server/domains/domain/
URI Parameters
HideShow
server
ServerID (required) 

Unique server ID

domain
string (required) 

Unique custom domain ID

Request
HideShow
Headers
Authorization: Bearer {token}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "error": "Hello, world!",
  "data": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean"
    },
    "error": {
      "type": [
        "string",
        "null"
      ]
    },
    "data": {
      "type": [
        "string",
        "null"
      ]
    }
  }
}

Check a custom domain
POST/servers/{server}/domains/{domain}/check/

Checks again whether the NS records of a domain that isn’t linked yet point to the nameservers and returns the domain with its updated status. A domain is checked at most every 10 seconds, more frequent requests return the domain unchanged. Linked domains are not checked again.

Example URI

POST https://api.exaroton.com/v1/servers/server/domains/domain/check/
URI Parameters
HideShow
server
ServerID (required) 

Unique server ID

domain
string (required) 

Unique custom domain ID

Request
HideShow
Headers
Authorization: Bearer {token}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "error": "Hello, world!",
  "data": {
    "id": "Pq4rSt7uVw0xYz3a",
    "domain": "play.example.com",
    "status": "linked",
    "protocol": "https",
    "port": 80,
    "checkedTime": 1763251200,
    "createdTime": 1763251200,
    "nameservers": [
      "galileo.exaroton.com",
      "columbus.exaroton.com"
    ]
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean"
    },
    "error": {
      "type": [
        "string",
        "null"
      ]
    },
    "data": {
      "type": [
        "object",
        "null"
      ],
      "properties": {
        "id": {
          "type": "string",
          "description": "Unique custom domain ID"
        },
        "domain": {
          "type": "string"
        },
        "status": {
          "type": "string",
          "description": "`pending` until the domain was checked successfully for the first time, `linked` if its NS records pointed to the nameservers on the last check, `unlinked` if they didn't"
        },
        "protocol": {
          "type": "string"
        },
        "port": {
          "type": "number"
        },
        "checkedTime": {
          "type": [
            "number",
            "null"
          ],
          "description": "Unix timestamp of the last check"
        },
        "createdTime": {
          "type": [
            "number",
            "null"
          ],
          "description": "Unix timestamp of when the domain was added"
        },
        "nameservers": {
          "type": "array",
          "description": "The nameservers the NS records of the domain have to point to"
        }
      }
    }
  }
}

Share Access

The accounts a server is shared with via the Share Access feature. All access endpoints require the access permission.

Available permissions: server, stop, console, log, options, reinstall, domains, software, players, files, addons, worlds, backups, transactions, duplicate, access. Some permissions require others: stop requires server, reinstall and domains require options, and access requires all other permissions.

List accounts with access
GET/servers/{server}/access/

Returns the accounts the server is shared with, without the owner.

Example URI

GET https://api.exaroton.com/v1/servers/server/access/
URI Parameters
HideShow
server
ServerID (required) 

Unique server ID

Request
HideShow
Headers
Authorization: Bearer {token}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "error": null,
  "data": [
    {
      "id": "Hj8kLm2nPq4rSt7u",
      "account": {
        "id": "EwYiY9IAMtQBTb6s",
        "name": "example"
      },
      "permissions": [
        "server",
        "stop"
      ]
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean"
    },
    "error": {
      "type": [
        "string",
        "null"
      ]
    },
    "data": {
      "type": [
        "array",
        "null"
      ]
    }
  }
}

Share a server with an account
POST/servers/{server}/access/

Fails with status code 400 if the account doesn’t exist or the permissions are invalid, with status code 409 if the server is already shared with this account (change its permissions instead), and with status code 413 if too many servers are already shared with this account.

Example URI

POST https://api.exaroton.com/v1/servers/server/access/
URI Parameters
HideShow
server
ServerID (required) 

Unique server ID

Request
HideShow
Headers
Content-Type: application/json
Authorization: Bearer {token}
Body
{
  "username": "example",
  "permissions": [
    "server",
    "stop"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "username": {
      "type": "string",
      "description": "Name of the exaroton account to share the server with"
    },
    "permissions": {
      "type": "array",
      "description": "Permissions of the account, defaults to `server`"
    }
  }
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "error": null,
  "data": {
    "id": "Hj8kLm2nPq4rSt7u",
    "account": {
      "id": "EwYiY9IAMtQBTb6s",
      "name": "example"
    },
    "permissions": [
      "server",
      "stop"
    ]
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean"
    },
    "error": {
      "type": [
        "string",
        "null"
      ]
    },
    "data": {
      "type": [
        "object",
        "null"
      ],
      "properties": {
        "id": {
          "type": "string",
          "description": "Unique access ID"
        },
        "account": {
          "type": "object",
          "properties": {
            "id": {
              "type": "string",
              "description": "Unique account ID"
            },
            "name": {
              "type": "string",
              "description": "Account name"
            }
          }
        },
        "permissions": {
          "type": "array",
          "description": "Permissions of the account on the server"
        }
      }
    }
  }
}

Access

Get an account's access
GET/servers/{server}/access/{access}/

Example URI

GET https://api.exaroton.com/v1/servers/server/access/access/
URI Parameters
HideShow
server
ServerID (required) 

Unique server ID

access
string (required) 

Unique access ID

Request
HideShow
Headers
Authorization: Bearer {token}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "error": null,
  "data": {
    "id": "Hj8kLm2nPq4rSt7u",
    "account": {
      "id": "EwYiY9IAMtQBTb6s",
      "name": "example"
    },
    "permissions": [
      "server",
      "stop"
    ]
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean"
    },
    "error": {
      "type": [
        "string",
        "null"
      ]
    },
    "data": {
      "type": [
        "object",
        "null"
      ],
      "properties": {
        "id": {
          "type": "string",
          "description": "Unique access ID"
        },
        "account": {
          "type": "object",
          "properties": {
            "id": {
              "type": "string",
              "description": "Unique account ID"
            },
            "name": {
              "type": "string",
              "description": "Account name"
            }
          }
        },
        "permissions": {
          "type": "array",
          "description": "Permissions of the account on the server"
        }
      }
    }
  }
}

Change an account's permissions
PUT/servers/{server}/access/{access}/

Replaces the permissions of the account. An account that is running the server with its own credits keeps the permissions server and stop until the server is offline, and an account that has a backup account linked to the server keeps the permission backups; removing them fails with status code 400. PATCH is accepted as well.

Example URI

PUT https://api.exaroton.com/v1/servers/server/access/access/
URI Parameters
HideShow
server
ServerID (required) 

Unique server ID

access
string (required) 

Unique access ID

Request
HideShow
Headers
Content-Type: application/json
Authorization: Bearer {token}
Body
{
  "permissions": [
    "server",
    "stop",
    "log"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "permissions": {
      "type": "array"
    }
  }
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "error": null,
  "data": {
    "id": "Hj8kLm2nPq4rSt7u",
    "account": {
      "id": "EwYiY9IAMtQBTb6s",
      "name": "example"
    },
    "permissions": [
      "server",
      "stop"
    ]
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean"
    },
    "error": {
      "type": [
        "string",
        "null"
      ]
    },
    "data": {
      "type": [
        "object",
        "null"
      ],
      "properties": {
        "id": {
          "type": "string",
          "description": "Unique access ID"
        },
        "account": {
          "type": "object",
          "properties": {
            "id": {
              "type": "string",
              "description": "Unique account ID"
            },
            "name": {
              "type": "string",
              "description": "Account name"
            }
          }
        },
        "permissions": {
          "type": "array",
          "description": "Permissions of the account on the server"
        }
      }
    }
  }
}

Remove an account's access
DELETE/servers/{server}/access/{access}/

Fails with status code 400 while the account is running the server with its own credits or has a backup account linked to the server.

Example URI

DELETE https://api.exaroton.com/v1/servers/server/access/access/
URI Parameters
HideShow
server
ServerID (required) 

Unique server ID

access
string (required) 

Unique access ID

Request
HideShow
Headers
Authorization: Bearer {token}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "error": "Hello, world!",
  "data": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean"
    },
    "error": {
      "type": [
        "string",
        "null"
      ]
    },
    "data": {
      "type": [
        "string",
        "null"
      ]
    }
  }
}

Server transactions
GET/servers/{server}/transactions/{?page}

Returns a page of the transactions of the server (20 per page), newest first with active transactions before all others. credits are seen from the perspective of the server. Requires the transactions permission.

Example URI

GET https://api.exaroton.com/v1/servers/server/transactions/?page=1
URI Parameters
HideShow
server
ServerID (required) 

Unique server ID

page
number (optional) Example: 1

Page of the list, starting at 1. Pages after the last page are empty.

Request
HideShow
Headers
Authorization: Bearer {token}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "error": null,
  "data": {
    "page": 1,
    "lastPage": 2,
    "total": 21,
    "items": [
      {
        "id": "Tr4nS4cT10nId123",
        "type": "run",
        "credits": -1.5,
        "rate": 1,
        "interval": 3600,
        "amount": 4,
        "active": false,
        "paid": true,
        "startTime": 1763247600,
        "endTime": 1763251200,
        "account": "EwYiY9IAMtQBTb6s",
        "pool": "",
        "server": "EwYiY9IAMtQBTb6U"
      }
    ]
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean"
    },
    "error": {
      "type": [
        "string",
        "null"
      ]
    },
    "data": {
      "type": [
        "object",
        "null"
      ],
      "properties": {
        "page": {
          "type": "number",
          "description": "The requested page"
        },
        "lastPage": {
          "type": "number",
          "description": "The last page with items (at least 1)"
        },
        "total": {
          "type": "number",
          "description": "Total number of items in all pages"
        },
        "items": {
          "type": "array"
        }
      }
    }
  }
}

Credit Pools

List credit pools
GET/billing/pools/

Example URI

GET https://api.exaroton.com/v1/billing/pools/
Request
HideShow
Headers
Authorization: Bearer {token}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "error": null,
  "data": [
    {
      "id": "X4iJREgqBGFSBtn0",
      "name": "example",
      "credits": 42,
      "servers": 1,
      "owner": "X4iJREgqBGFSBtn0",
      "isOwner": true,
      "members": 1,
      "ownShare": 1,
      "ownCredits": 42
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean"
    },
    "error": {
      "type": [
        "string",
        "null"
      ]
    },
    "data": {
      "type": [
        "array",
        "null"
      ]
    }
  }
}

Get a credit pool
GET/billing/pools/{pool}

Example URI

GET https://api.exaroton.com/v1/billing/pools/pool
URI Parameters
HideShow
pool
PoolID (required) 

Unique pool ID

Request
HideShow
Headers
Authorization: Bearer {token}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "error": null,
  "data": {
    "id": "X4iJREgqBGFSBtn0",
    "name": "example",
    "credits": 42,
    "servers": 1,
    "owner": "X4iJREgqBGFSBtn0",
    "isOwner": true,
    "members": 1,
    "ownShare": 1,
    "ownCredits": 42
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean"
    },
    "error": {
      "type": [
        "string",
        "null"
      ]
    },
    "data": {
      "type": [
        "object",
        "null"
      ],
      "properties": {
        "id": {
          "type": "string",
          "description": "Unique pool ID"
        },
        "name": {
          "type": "string",
          "description": "Pool name"
        },
        "credits": {
          "type": "number",
          "description": "Pool credits"
        },
        "servers": {
          "type": "number",
          "description": "Number of servers in the pool"
        },
        "owner": {
          "type": "string",
          "description": "Unique account ID of the pool owner"
        },
        "isOwner": {
          "type": "boolean",
          "description": "Whether the current user is the owner of the pool"
        },
        "members": {
          "type": "number",
          "description": "Number of members in the pool"
        },
        "ownShare": {
          "type": "number",
          "description": "Share of the credits in this pool that are owned by the current user"
        },
        "ownCredits": {
          "type": "number",
          "description": "Number of credits in the pool that are owned by the current user"
        }
      }
    }
  }
}

List pool members
GET/billing/pools/{pool}/members/

Example URI

GET https://api.exaroton.com/v1/billing/pools/pool/members/
URI Parameters
HideShow
pool
PoolID (required) 

Unique pool ID

Request
HideShow
Headers
Authorization: Bearer {token}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "error": null,
  "data": [
    {
      "account": "X4iJREgqBGFSBtn0",
      "name": "example",
      "share": 1,
      "credits": 42,
      "isOwner": true
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean"
    },
    "error": {
      "type": [
        "string",
        "null"
      ]
    },
    "data": {
      "type": [
        "array",
        "null"
      ]
    }
  }
}

List pool servers
GET/billing/pools/{pool}/servers/

Example URI

GET https://api.exaroton.com/v1/billing/pools/pool/servers/
URI Parameters
HideShow
pool
PoolID (required) 

Unique pool ID

Request
HideShow
Headers
Authorization: Bearer {token}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "error": null,
  "data": [
    {
      "id": "EwYiY9IAMtQBTb6U",
      "name": "example",
      "address": "example.exaroton.me",
      "motd": "Welcome to the server of example!",
      "status": 0,
      "host": null,
      "port": null,
      "players": {
        "max": 20,
        "count": 0,
        "list": []
      },
      "software": {
        "id": "kb4p09ABvLjxzedx",
        "name": "Vanilla",
        "version": "1.20.4",
        "type": "vanilla",
        "launcher": "CurseForge"
      },
      "shared": false,
      "permissions": [],
      "region": "eu"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean"
    },
    "error": {
      "type": [
        "string",
        "null"
      ]
    },
    "data": {
      "type": [
        "array",
        "null"
      ]
    }
  }
}

List pool transactions
GET/billing/pools/{pool}/transactions/{?page}

Returns a page of the transactions of a credit pool you are a member of (20 per page), newest first with active transactions before all others. credits are seen from the perspective of the credit pool.

Example URI

GET https://api.exaroton.com/v1/billing/pools/pool/transactions/?page=1
URI Parameters
HideShow
pool
PoolID (required) 

Unique pool ID

page
number (optional) Example: 1

Page of the list, starting at 1. Pages after the last page are empty.

Request
HideShow
Headers
Authorization: Bearer {token}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "error": null,
  "data": {
    "page": 1,
    "lastPage": 2,
    "total": 21,
    "items": [
      {
        "id": "Tr4nS4cT10nId123",
        "type": "run",
        "credits": -1.5,
        "rate": 1,
        "interval": 3600,
        "amount": 4,
        "active": false,
        "paid": true,
        "startTime": 1763247600,
        "endTime": 1763251200,
        "account": "EwYiY9IAMtQBTb6s",
        "pool": "",
        "server": "EwYiY9IAMtQBTb6U"
      }
    ]
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean"
    },
    "error": {
      "type": [
        "string",
        "null"
      ]
    },
    "data": {
      "type": [
        "object",
        "null"
      ],
      "properties": {
        "page": {
          "type": "number",
          "description": "The requested page"
        },
        "lastPage": {
          "type": "number",
          "description": "The last page with items (at least 1)"
        },
        "total": {
          "type": "number",
          "description": "Total number of items in all pages"
        },
        "items": {
          "type": "array"
        }
      }
    }
  }
}

Regions

List regions
GET/regions/

Returns the regions servers can be located in. Use the id as region when creating or transferring a server.

Example URI

GET https://api.exaroton.com/v1/regions/
Request
HideShow
Headers
Authorization: Bearer {token}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "error": "Hello, world!",
  "data": [
    {
      "id": "eu",
      "name": "Europe"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean"
    },
    "error": {
      "type": [
        "string",
        "null"
      ]
    },
    "data": {
      "type": [
        "array",
        "null"
      ]
    }
  }
}

Software

List available software
GET/software{?type,launcher}

Example URI

GET https://api.exaroton.com/v1/software?type=&launcher=
URI Parameters
HideShow
type
string (optional) 

Only show software options of a specific software type, e.g. vanilla

launcher
string (optional) 

Filter modpacks by their launcher, e.g. CurseForge

Request
HideShow
Headers
Authorization: Bearer {token}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "error": "Hello, world!",
  "data": [
    {
      "id": "kb4p09ABvLjxzedx",
      "name": "Vanilla",
      "version": "1.20.4",
      "type": "vanilla",
      "launcher": "CurseForge"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean"
    },
    "error": {
      "type": [
        "string",
        "null"
      ]
    },
    "data": {
      "type": [
        "array",
        "null"
      ]
    }
  }
}

Generated by aglio on 17 Nov 2026