Skip to main content

Services

os and service daemons

Game service catalogue, install, lifecycle, console, and player requests.

List available services​

GET
Authenticated

Lists services that can be installed on the server.

Request URLhttps://api.creeper.host/os/availableservices

Headers

Content-Type: application/json
key: {api-key}
secret: {api-secret}

Response 200

{
  "status": "success",
  "services": {
    "7dtd": {
      "id": "7dtd",
      "displayName": "7 Days to Die",
      "displayVersion": "Beta",
      "category": "Games",
      "requireWipe": true
    }
  },
  "endPoint": "aries-production-59c48bc84-hpqw4"
}

List installed services​

GET
Authenticated

Lists services currently installed on the server.

Request URLhttps://api.creeper.host/os/listservices

Headers

Content-Type: application/json
key: {api-key}
secret: {api-secret}

Response 200

{
  "status": "success",
  "services": {
    "unturned": {
      "id": "unturned",
      "displayName": "Unturned",
      "displayVersion": "Alpha",
      "category": "Games"
    },
    "mc": {
      "id": "mc",
      "displayName": "Minecraft",
      "displayVersion": "Release",
      "category": "Games"
    }
  },
  "endPoint": "aries-production-59c48bc84-hpqw4"
}

Install new service​

PUT
Authenticated

Installs a new service by service id.

Request URLhttps://api.creeper.host/os/installservice

Headers

Content-Type: application/json
key: {api-key}
secret: {api-secret}

Request body

{
  "id": "unturned"
}

Response 200

{
  "status": "success",
  "message": "The requested service is being installed."
}

Remove service​

GET
Authenticated

Uninstalls an installed service.

Request URLhttps://api.creeper.host/{daemon}/uninstall

Use the installed service name in the first path segment, for example mc, unturned, ark, or valheim.

Headers

Content-Type: application/json
key: {api-key}
secret: {api-secret}

Response 200

{
  "status": "success",
  "message": "This service has been removed.",
  "endPoint": "aries-production-59c48bc84-hpqw4"
}

Check service install status​

PUT
Authenticated

Checks whether a service is still installing.

Request URLhttps://api.creeper.host/{daemon}/installing

Use the installed service name in the first path segment, for example mc, unturned, ark, or valheim.

The instance field is required when the target service uses named instances; omit it for single-instance services.

Headers

Content-Type: application/json
key: {api-key}
secret: {api-secret}

Request body

{
  "instance": "mc-59026a225dc14"
}

Response 200

{
  "status": "success",
  "installing": true,
  "endPoint": "aries-production-59c48bc84-hpqw4"
}

Check service install progress​

GET
Authenticated

Returns progress text for a service install.

Request URLhttps://api.creeper.host/{daemon}/progress

Use the installed service name in the first path segment, for example mc, unturned, ark, or valheim.

Headers

Content-Type: application/json
key: {api-key}
secret: {api-secret}

Response 200

{
  "status": "success",
  "message": "Loading installation scripts...",
  "progress": "0%",
  "log": "latest",
  "endPoint": "aries-production-59c48bc84-hpqw4"
}

Get service versions​

GET
Authenticated

Lists installable versions for a service.

Request URLhttps://api.creeper.host/{daemon}/versions

Use the installed service name in the first path segment, for example mc, unturned, ark, or valheim.

Headers

Content-Type: application/json
key: {api-key}
secret: {api-secret}

Response 200

{
  "status": "success",
  "versions": {
    "7385": {
      "id": 7385,
      "displayName": "RocketMod",
      "displayVersion": "Latest",
      "requireWipe": false
    }
  },
  "total": 1,
  "endPoint": "aries-production-59c48bc84-hpqw4"
}

Install service version​

PUT
Authenticated

Installs a specific service version.

Request URLhttps://api.creeper.host/{daemon}/install

Use the installed service name in the first path segment, for example mc, unturned, ark, or valheim.

Headers

Content-Type: application/json
key: {api-key}
secret: {api-secret}

Request body

{
  "id": "versionID",
  "instance": "mc-59026a225dc14"
}

Response 200

{
  "status": "success",
  "message": "Your requested software is currently installing...",
  "result": "",
  "id": "mc-59026a225dc14-590345e9d52f5",
  "endPoint": "aries-production-59c48bc84-hpqw4"
}

Start game service​

PUT
Authenticated

Starts a game service.

Request URLhttps://api.creeper.host/{daemon}/startserver

Use the installed service name in the first path segment, for example mc, unturned, ark, or valheim.

Headers

Content-Type: application/json
key: {api-key}
secret: {api-secret}

Request body

{
  "instance": "ut-5902260d6b88e"
}

Response 200

{
  "status": "success",
  "pid": 0,
  "message": "Server has been started.",
  "code": 1,
  "endPoint": "aries-production-59c48bc84-hpqw4"
}

Stop game service​

PUT
Authenticated

Stops a game service.

Request URLhttps://api.creeper.host/{daemon}/stopserver

Use the installed service name in the first path segment, for example mc, unturned, ark, or valheim.

Headers

Content-Type: application/json
key: {api-key}
secret: {api-secret}

Request body

{
  "instance": "ut-5902260d6b88e"
}

Response 200

{
  "status": "success",
  "keptlogs": false,
  "message": "Server has been stopped.",
  "code": 4,
  "endPoint": "aries-production-59c48bc84-hpqw4"
}

Restart game service​

PUT
Authenticated

Restarts a game service.

Request URLhttps://api.creeper.host/{daemon}/restartserver

Use the installed service name in the first path segment, for example mc, unturned, ark, or valheim.

Headers

Content-Type: application/json
key: {api-key}
secret: {api-secret}

Request body

{
  "instance": "ut-5902260d6b88e"
}

Response 200

{
  "status": "success",
  "message": "This service has been started.",
  "stop": {
    "status": "success",
    "message": "This service has been stopped."
  },
  "endPoint": "aries-production-59c48bc84-hpqw4"
}

Get server console​

PUT
Authenticated

Reads recent console lines for a game service.

Request URLhttps://api.creeper.host/{daemon}/readconsole

Use the installed service name in the first path segment, for example mc, unturned, ark, or valheim.

Headers

Content-Type: application/json
key: {api-key}
secret: {api-secret}

Request body

{
  "lines": 50,
  "format": true,
  "type": "normal",
  "instance": "ut-5902260d6b88e"
}

Response 200

{
  "status": "success",
  "log": "<formatted console output>",
  "count": 50,
  "raw": [
    [
      "Apr 28 00:03:00 Loading level: 100%"
    ]
  ],
  "endPoint": "aries-production-59c48bc84-hpqw4"
}

Send command to console​

PUT
Authenticated

Writes a command to a game service console.

Request URLhttps://api.creeper.host/{daemon}/writeconsole

Use the installed service name in the first path segment, for example mc, unturned, ark, or valheim.

Headers

Content-Type: application/json
key: {api-key}
secret: {api-secret}

Request body

{
  "command": "Command to send",
  "instance": "ut-5902260d6b88e"
}

Response 200

{
  "status": "success",
  "command": "Command to send",
  "message": null,
  "endPoint": "aries-production-59c48bc84-hpqw4"
}

Get player list​

PUT
Authenticated

Lists players for a game service.

Request URLhttps://api.creeper.host/{daemon}/players

Use the installed service name in the first path segment, for example mc, unturned, ark, or valheim.

Headers

Content-Type: application/json
key: {api-key}
secret: {api-secret}

Request body

{
  "instance": "mc-59026a225dc14"
}

Response 200

{
  "status": "success",
  "method": "logScrape",
  "players": [],
  "endPoint": "aries-production-59c48bc84-hpqw4"
}
Wiki offerGet 10% off