API for custom panels and reselling

Sample response

{
  "name": "Můj panel",
  "key": "shk_a1b2c3d4_…",
  "scopes": [
    "services:read",
    "services:power"
  ],
  "serviceIds": [],
  "allowedIps": [
    "203.0.113.10"
  ],
  "expiresAt": null,
  "createdAt": "2026-10-01T08:00:00.000Z"
}

Possible errors

• 401invalid_key The key is invalid, expired or revoked.

Sample response

{
  "id": "clx9k2m4p0000cus01abcdef",
  "email": "[email protected]",
  "firstName": "Jan",
  "lastName": "Novák",
  "companyName": null,
  "ico": null,
  "dic": null,
  "country": "CZ",
  "emailVerified": true,
  "createdAt": "2026-03-12T09:30:00.000Z"
}

Possible errors

• 401invalid_key The key's account wasn't found.

Query parameters

Sample response

{
  "at": "2026-11-07T10:00:00.000Z",
  "ttlMs": 2500,
  "truncated": false,
  "services": [
    {
      "serviceId": "clx9k2m4p0000svc01abcdef",
      "sampledAt": "2026-11-07T09:59:58.000Z",
      "kind": "vps",
      "state": "ok",
      "power": "running",
      "cpuPercent": 12.5,
      "cpuAt": "2026-11-07T09:59:00.000Z",
      "memUsedMib": 1536,
      "memTotalMib": 4096,
      "uptimeSeconds": 864000,
      "cpuSeries": [
        {
          "t": 1794045540000,
          "v": 11.2
        },
        {
          "t": 1794045600000,
          "v": 12.5
        }
      ]
    },
    {
      "serviceId": "clx9k2m4p0001svc02abcdef",
      "sampledAt": "2026-11-07T09:59:58.000Z",
      "kind": "game",
      "state": "ok",
      "power": "running",
      "cpuPercent": 34.1,
      "memUsedMib": 2900,
      "memTotalMib": 6144,
      "uptimeSeconds": 7200,
      "players": {
        "state": "ok",
        "online": 5,
        "max": 20,
        "at": "2026-11-07T09:55:00.000Z",
        "stale": false
      }
    },
    {
      "serviceId": "clx9k2m4p0002svc03abcdef",
      "sampledAt": "2026-11-07T09:59:58.000Z",
      "kind": "domain",
      "state": "ok",
      "expiresOn": "2027-05-01"
    },
    {
      "serviceId": "clx9k2m4p0003svc04abcdef",
      "sampledAt": "2026-11-07T09:59:58.000Z",
      "kind": "vps",
      "state": "unavailable",
      "reason": "provider"
    }
  ]
}

Possible errors

• 404not_found The key is restricted to selected services and ids contains another service.
• 429rate_limited Limit of 40 requests per minute exceeded.
• 503unavailable The service list can't be loaded right now. Try again in a few seconds.

Query parameters

Sample response

{
  "data": [
    {
      "id": "clx9k2m4p0000svc01abcdef",
      "name": "VPS Start",
      "type": "VPS",
      "kind": "vps",
      "status": "ACTIVE",
      "role": "owner",
      "plan": "vps-start",
      "address": "203.0.113.25",
      "priceCzk": 249,
      "currency": "CZK",
      "expiresAt": "2026-12-01T00:00:00.000Z",
      "createdAt": "2026-06-01T10:00:00.000Z"
    },
    {
      "id": "clx9k2m4p0001svc02abcdef",
      "name": "Minecraft server",
      "type": "GAME_SERVER",
      "kind": "game",
      "status": "ACTIVE",
      "role": "member",
      "permissions": [
        "power",
        "console"
      ],
      "plan": null,
      "address": "mc.example.com",
      "priceCzk": null,
      "currency": "CZK",
      "expiresAt": "2026-11-20T00:00:00.000Z",
      "createdAt": "2026-08-15T12:00:00.000Z"
    }
  ]
}

Query parameters

Sample response

{
  "data": {
    "id": "clx9k2m4p0000svc01abcdef",
    "name": "VPS Start",
    "type": "VPS",
    "kind": "vps",
    "status": "ACTIVE",
    "role": "owner",
    "plan": "vps-start",
    "address": "203.0.113.25",
    "priceCzk": 249,
    "currency": "CZK",
    "expiresAt": "2026-12-01T00:00:00.000Z",
    "createdAt": "2026-06-01T10:00:00.000Z"
  }
}

Possible errors

• 404 The service doesn't exist, isn't yours, or the key has no access to it.
• 400 This kind of service isn't supported by the API.
• 403mfa_required The owner of the shared service requires two-factor authentication, which isn't enabled on your account.

Request body (JSON)

Sample body

{
  "mode": "vnc"
}

Sample response

{
  "token": "eyJhbGciOi…example",
  "password": "example-rfb-ticket"
}

Possible errors

• 400 For a VPS, mode is missing or invalid.
• 403 Missing Console permission on a shared service.
• 404 Service not found or it has no console.
• 409 The service isn't active or the VPS is locked (backup restore).
• 412NOT_PROVISIONED The server isn't ready yet.
• 429 More than 10 tokens per minute.

Query parameters

Sample response

{
  "result": {
    "v": 1,
    "kind": "mc",
    "findings": [
      {
        "id": "mc.oom",
        "sev": "critical",
        "p": {
          "heapMb": 2048
        },
        "evidence": [
          {
            "line": 412,
            "text": "java.lang.OutOfMemoryError: Java heap space"
          }
        ],
        "fix": {
          "type": "recalc-memory"
        },
        "alt": [
          {
            "type": "upgrade"
          }
        ]
      }
    ],
    "rootCause": {
      "cls": "java.lang.OutOfMemoryError",
      "msg": "Java heap space",
      "line": 412
    },
    "stats": {
      "lines": 1830,
      "truncated": false,
      "ms": 42,
      "timedOut": false,
      "crashReport": false
    }
  },
  "sources": [
    {
      "kind": "log",
      "name": "logs/latest.log",
      "mtime": 1762508000,
      "truncated": false
    }
  ]
}

Possible errors

• 400bad-request Invalid parameter. Code bad-name: this file can't be analysed.
• 403forbidden Missing Console or Files permission on a shared service.
• 404no-source No log found, the server may not have run yet.
• 412not-ready The server isn't ready yet.
• 413too-large The log is too large to analyse (over 16 MiB).
• 429rate Rate limit exceeded. Code busy: other servers are being analysed right now.
• 502failed The log couldn't be loaded.

Query parameters

Sample response

{
  "detection": {
    "mysql": {
      "installed": true,
      "listening": true
    },
    "postgres": {
      "installed": false,
      "listening": false
    },
    "os": {
      "id": "debian",
      "like": "",
      "name": "Debian GNU/Linux 12 (bookworm)"
    },
    "canAutoInstall": true,
    "install": {
      "running": false,
      "engine": null,
      "exitCode": null,
      "logTail": null
    }
  },
  "config": {
    "engine": "mysql",
    "port": 3306,
    "username": "stormhost_panel",
    "auto": true
  },
  "overview": {
    "version": "10.11.6-MariaDB",
    "databases": [
      {
        "name": "shop",
        "sizeBytes": 5242880,
        "tables": 14,
        "system": false
      }
    ],
    "users": [
      {
        "name": "shop",
        "host": "localhost",
        "databases": [
          "shop"
        ],
        "system": false
      }
    ]
  },
  "connectError": null
}

Possible errors

• 403 Missing the Databases permission.
• 401AUTH_FAILED The VPS rejected the login credentials.
• 409HOST_KEY_CHANGED The VPS SSH key fingerprint changed (new one in presentedHostKey); confirm it with the trustHostKey action.
• 412NO_TARGET The VPS has no address or credentials yet (also NO_CREDENTIALS).
• 502UNREACHABLE The VPS is unreachable (also TIMEOUT, FAILED).

Request body (JSON)

Sample body

{
  "action": "createDatabase",
  "name": "shop",
  "createUser": true,
  "host": "localhost"
}

Sample response

{
  "ok": true,
  "username": "shop",
  "password": "<generated>"
}

Possible errors

• 400 Invalid request, reserved name, install already running, the system does not support automatic install, or an error from the database server.
• 412 The database server is not connected yet.
• 403 Missing the Databases permission.
• 500 Internal error (the response includes a ref for support).
• 401AUTH_FAILED The VPS rejected the login credentials.
• 409HOST_KEY_CHANGED The VPS SSH key fingerprint changed (new one in presentedHostKey); confirm it with the trustHostKey action.
• 412NO_TARGET The VPS has no address or credentials yet (also NO_CREDENTIALS).
• 502UNREACHABLE The VPS is unreachable (also TIMEOUT, FAILED).

Query parameters

Sample response

{
  "columns": [
    "id",
    "name",
    "created_at"
  ],
  "rows": [
    [
      "1",
      "Alice",
      "2026-10-01 12:00:00"
    ],
    [
      "2",
      "Bob",
      "2026-10-03 08:30:00"
    ]
  ],
  "page": 0,
  "pageSize": 50,
  "total": 2
}

Possible errors

• 400 Invalid name or an error from the database server.
• 412 The database server is not connected yet.
• 403 Missing the Databases permission.
• 401AUTH_FAILED The VPS rejected the login credentials.
• 409HOST_KEY_CHANGED The VPS SSH key fingerprint changed (new one in presentedHostKey); confirm it with the trustHostKey action.
• 412NO_TARGET The VPS has no address or credentials yet (also NO_CREDENTIALS).
• 502UNREACHABLE The VPS is unreachable (also TIMEOUT, FAILED).

Request body (JSON)

Sample body

{
  "db": "shop",
  "sql": "SELECT id, name FROM customers ORDER BY id LIMIT 10"
}

Sample response

{
  "columns": [
    "id",
    "name"
  ],
  "rows": [
    [
      "1",
      "Alice"
    ],
    [
      "2",
      "Bob"
    ]
  ],
  "rowCount": 2,
  "affectedRows": null,
  "truncated": false,
  "command": "SELECT",
  "durationMs": 7
}

Possible errors

• 400 Invalid request or an error from the database server.
• 412 The database server is not connected yet.
• 403 Missing the Databases permission.
• 429 At most 60 queries per minute.
• 401AUTH_FAILED The VPS rejected the login credentials.
• 409HOST_KEY_CHANGED The VPS SSH key fingerprint changed (new one in presentedHostKey); confirm it with the trustHostKey action.
• 412NO_TARGET The VPS has no address or credentials yet (also NO_CREDENTIALS).
• 502UNREACHABLE The VPS is unreachable (also TIMEOUT, FAILED).

Query parameters

Sample response

{
  "path": "/home/app",
  "entries": [
    {
      "name": "logs",
      "type": "dir",
      "size": 4096,
      "mtime": 1762500000,
      "mode": "drwxr-xr-x",
      "owner": "app",
      "group": "app"
    },
    {
      "name": "config.yml",
      "type": "file",
      "size": 1832,
      "mtime": 1762489123,
      "mode": "-rw-r--r--",
      "owner": "app",
      "group": "app"
    },
    {
      "name": "current",
      "type": "link",
      "size": 12,
      "mtime": 1762400000,
      "mode": "lrwxrwxrwx",
      "owner": "app",
      "group": "app",
      "linkTarget": "/srv/releases/42",
      "linkType": "dir"
    }
  ],
  "truncated": false,
  "access": {
    "host": "203.0.113.20",
    "port": 22,
    "username": "root",
    "customCredentials": false,
    "hasDefaultPassword": true,
    "hostKey": "SHA256:AbCdEfGhIjKlMnOpQrStUvWxYz0123456789abcdefg"
  }
}

Possible errors

• 400 Invalid path or SFTP error.
• 403 Missing the Files permission.
• 404 The folder does not exist on the game server.
• 401AUTH_FAILED The VPS rejected the login credentials.
• 409HOST_KEY_CHANGED The VPS SSH key fingerprint changed (new one in presentedHostKey); confirm it with the trustHostKey action.
• 412NO_TARGET The VPS has no address or credentials yet (also NO_CREDENTIALS).
• 502UNREACHABLE The VPS is unreachable (also TIMEOUT, FAILED).

Request body (JSON)

Sample body

{
  "action": "write",
  "path": "/server.properties",
  "content": "motd=Můj server\nmax-players=20\n"
}

Sample response

{
  "ok": true
}

Possible errors

• 400 Invalid request, path or name; system folders and /proc, /sys, /dev cannot be changed.
• 403 Only the owner can change credentials; or the Files permission is missing.
• 409 A file or folder with this name already exists.
• 409JOB_RUNNING A software change or modpack install is running on the Minecraft server.
• 409ARCHIVE_BUSY Another pack or unpack is running.
• 413 The write content is larger than 2 MB.
• 429 At most 10 packs and unpacks per 10 minutes.
• 401AUTH_FAILED The VPS rejected the login credentials.
• 409HOST_KEY_CHANGED The VPS SSH key fingerprint changed (new one in presentedHostKey); confirm it with the trustHostKey action.
• 412NO_TARGET The VPS has no address or credentials yet (also NO_CREDENTIALS).
• 502UNREACHABLE The VPS is unreachable (also TIMEOUT, FAILED).

Query parameters

Sample response

{
  "path": "/server.properties",
  "content": "motd=Můj server\nmax-players=20\n",
  "eol": "lf",
  "bom": false
}

Possible errors

• 400 Invalid path, not a regular file, or /proc, /sys, /dev on a VPS.
• 413TOO_LARGE as=text: the file is larger than 1 MB.
• 415BINARY as=text: the file is not UTF-8 text.
• 403 Missing the Files permission.
• 401AUTH_FAILED The VPS rejected the login credentials.
• 409HOST_KEY_CHANGED The VPS SSH key fingerprint changed (new one in presentedHostKey); confirm it with the trustHostKey action.
• 412NO_TARGET The VPS has no address or credentials yet (also NO_CREDENTIALS).
• 502UNREACHABLE The VPS is unreachable (also TIMEOUT, FAILED).

Query parameters

Sample response

{
  "ok": true,
  "status": {
    "status": "ACTIVE",
    "details": {
      "vmStatus": "running",
      "gameState": null,
      "cpuPercent": 12.4,
      "memUsedMib": 1840,
      "memTotalMib": 4096,
      "diskUsedGb": 18.2,
      "diskTotalGb": 60,
      "netinMbps": 0.42,
      "netoutMbps": 1.1,
      "uptimeSeconds": 86400,
      "diskVolumes": [
        {
          "mountpoint": "/",
          "usedBytes": 19542261760,
          "totalBytes": 64424509440
        }
      ],
      "netInBps": 420000,
      "netOutBps": 1100000,
      "diskReadBytesPerSec": 0,
      "diskWriteBytesPerSec": 24576
    }
  }
}

Possible errors

• 403mfa_required The service owner requires two-factor authentication for members.
• 404 Service not found.
• 429 More than 240 requests per minute.

Sample response

event: hello
data: {"v":1,"kind":"vps","intervalMs":1000,"serverNow":1762508460000}

event: sample
data: {"t":1762508461000,"power":"running","vmStatus":"running","gameState":null,"cpuPercent":8.3,"memUsedMib":1840,"memTotalMib":4096,"netInBps":420000,"netOutBps":1100000,"diskReadBytesPerSec":0,"diskWriteBytesPerSec":24576,"uptimeSeconds":86401}

event: end
data: {"reason":"rotate"}

Possible errors

• 403mfa_required The service owner requires two-factor authentication for members.
• 404 Service not found.
• 200 Other problems arrive as an end event with a reason: unsupported, busy (with retryInMs), revoked, inactive, moved, rotate.

Request body (JSON)

Sample body

{
  "name": "Survival server"
}

Sample response

{
  "name": "Survival server"
}

Possible errors

• 400invalid The name is longer than 60 characters or the body contains other fields.
• 404not_allowed The service doesn't belong to your account.

Query parameters

Sample response

{
  "view": {
    "canControl": true,
    "controlBlocked": null,
    "measuredAt": "2026-11-07T09:41:00.000Z",
    "stale": false,
    "outlets": [
      {
        "n": 3,
        "state": "on",
        "pending": false,
        "powerW": 120,
        "currentA": 0.52
      }
    ],
    "events": [
      {
        "id": "clx9k2m4p0001",
        "at": "2026-11-06T18:12:00.000Z",
        "kind": "command",
        "severity": "info",
        "outlet": 3,
        "action": "reboot",
        "result": "ok",
        "actorType": "customer",
        "actor": "vy",
        "serviceRef": "#A1B2C3",
        "message": "Restart zásuvky 3 — provedeno."
      }
    ],
    "eventsMore": false,
    "eventsAvailable": true
  }
}

Possible errors

• 400 The service is not rackhousing.
• 404 Service not found.

Request body (JSON)

Sample body

{
  "outlets": [
    3,
    4
  ],
  "command": "reboot"
}

Sample response

{
  "ok": true,
  "outlets": [
    {
      "n": 3,
      "state": "on",
      "pending": true
    },
    {
      "n": 4,
      "state": "on",
      "pending": true
    }
  ]
}

Possible errors

• 400not_yours An outlet does not belong to this service. Without a code: invalid request body.
• 403not_allowed Outlet control is not enabled for the service.
• 409inactive The service is not active. Code no_config: the PDU is not available right now.
• 429 Rate limit exceeded.
• 502pdu_failed The PDU did not carry out the command.

Sample response

{
  "view": {
    "contractedW": 500,
    "currentW": 212,
    "measuredAt": "2026-11-07T09:41:00.000Z",
    "stale": false,
    "monthKwh": 38.4,
    "lastMonthKwh": 151.2,
    "month": {
      "y": 2026,
      "m": 11,
      "days": 30,
      "today": 7
    },
    "daily": [
      5.1,
      5.3,
      5.4,
      5.6,
      5.5,
      5.7,
      5.8,
      null,
      null,
      null,
      null,
      null,
      null,
      null,
      null,
      null,
      null,
      null,
      null,
      null,
      null,
      null,
      null,
      null,
      null,
      null,
      null,
      null,
      null,
      null
    ],
    "outlets": [
      {
        "n": 3,
        "powerW": 120,
        "monthKwh": 21.6
      },
      {
        "n": 4,
        "powerW": 92,
        "monthKwh": 16.8
      }
    ]
  }
}

Possible errors

• 400 The service is not rackhousing.
• 404 The service does not exist or you have no access to it.

Request body (JSON)

Sample body

{
  "action": "restart"
}

Sample response

{
  "ok": true
}

Possible errors

• 400 action is missing or invalid.
• 404 Service not found, or power control is not available for it (e.g. rackhousing, web).
• 409 The service is not active, a server software change is running, or a backup restore is still running.
• 429 More than 5 requests per minute for the service.
• 502 The action failed, try again.

Sample response

{
  "view": {
    "site": "Praha",
    "rack": "R12",
    "unitRange": "U20–U21",
    "heightU": 2,
    "powerW": 500,
    "ports1g": 1,
    "ports10g": 1,
    "ports": [
      {
        "port": "port 3",
        "speed": "1g",
        "speedText": "1 Gbit",
        "status": "up"
      },
      {
        "port": "port 4",
        "speed": "10g",
        "speedText": "10 Gbit",
        "status": "down"
      }
    ],
    "ipv4": [
      {
        "address": "203.0.113.10",
        "prefix": 29,
        "gateway": "203.0.113.9"
      }
    ],
    "ipv6": "2001:db8:100::/48",
    "equipment": "1× server 2U",
    "polledAt": "2026-11-07T09:40:00.000Z"
  }
}

Possible errors

• 400 The service is not rackhousing.
• 404 Service not found.

Query parameters

Sample response

{
  "owner": true,
  "host": "203.0.113.40",
  "port": 2022,
  "username": "user.1a2b3c4d",
  "canSetPassword": true
}

Possible errors

• 404 SFTP isn't live yet, or the service wasn't found.
• 400 The service is neither a game server nor a bot.
• 502 The details couldn't be loaded.

Query parameters

Request body (JSON)

Sample body

{
  "action": "setPassword",
  "password": "example-Sftp-Pass-2026"
}

Sample response

{
  "ok": true,
  "username": "user.1a2b3c4d"
}

Possible errors

• 400weak_password The password doesn't meet the rules or the body is invalid.
• 403insufficient_scope The key lacks the services:secrets scope. Code not_owner: you are not the owner.
• 404 SFTP isn't live yet.
• 409admin_user Support will set up SFTP for this service. Other codes: email_mismatch, foreign_server, inactive.
• 429 More than 5 attempts per hour.
• 502failed The password couldn't be set. Code unavailable: the service isn't available right now.

Sample response

{
  "backups": [
    {
      "id": "Q2xP7rT0aN4mVb8sKe1wYg",
      "storageId": "h5Jd9LkQ2pWm0ZcR7tUv3A",
      "storageLabel": "Backup 1",
      "sizeBytes": 8589934592,
      "createdAt": 1762394400,
      "name": "vps-000001"
    }
  ],
  "storages": [
    {
      "id": "h5Jd9LkQ2pWm0ZcR7tUv3A",
      "label": "Backup 1",
      "enabled": true
    },
    {
      "id": "Xo3bN6qE8yTf1GsD4lHk9w",
      "label": "Backup 2",
      "enabled": false
    }
  ]
}

Possible errors

• 403 Missing Backups permission on a shared service.
• 409 The service isn't active, or a backup restore is running.
• 412NOT_PROVISIONED The VPS isn't ready yet.
• 429 More than 10 requests per minute.
• 502 Backups couldn't be loaded.

Request body (JSON)

Sample body

{
  "id": "Q2xP7rT0aN4mVb8sKe1wYg"
}

Sample response

{
  "ok": true,
  "pending": true,
  "message": "Obnova ze zálohy běží. VPS půjde zapnout, až skončí (u větších disků i několik minut)."
}

Possible errors

• 400 id is missing.
• 403 The backup doesn't belong to this service or no longer exists.
• 409 The service isn't active or another restore is already running.
• 429 More than 3 attempts per minute.
• 502 The restore couldn't be started or completed.

Sample response

{
  "available": false
}

Possible errors

• 400 The service is not a VPS.
• 409 The service isn't active.

Sample response

{
  "digest": "3f2a9c0d1e5b7a8c4d6e2f1a0b9c8d7e6f5a4b3c",
  "baseline": true,
  "enabled": true,
  "ipfilter": true,
  "macfilter": true,
  "policyIn": "DROP",
  "policyOut": "ACCEPT",
  "inboundDefault": "accept",
  "scannerBlock": true,
  "ipfilterEntries": [
    "203.0.113.25",
    "2001:db8:10::/64"
  ],
  "rules": [
    {
      "pos": 0,
      "managed": "censys",
      "type": "in",
      "action": "DROP",
      "proto": "",
      "dport": "",
      "sport": "",
      "source": "+dc/censys",
      "dest": "",
      "macro": "",
      "comment": "",
      "enable": true
    },
    {
      "pos": 1,
      "managed": null,
      "type": "in",
      "action": "DROP",
      "proto": "tcp",
      "dport": "3306",
      "sport": "",
      "source": "",
      "dest": "",
      "macro": "",
      "comment": "MySQL ven ne",
      "enable": true
    },
    {
      "pos": 2,
      "managed": "allowIn",
      "type": "in",
      "action": "ACCEPT",
      "proto": "",
      "dport": "",
      "sport": "",
      "source": "",
      "dest": "+guest/ipfilter-net0",
      "macro": "",
      "comment": "",
      "enable": true
    }
  ]
}

Possible errors

• 403 Missing Firewall permission on a shared service.
• 409 The service isn't active or the action can't be done right now.
• 412 The VPS isn't ready yet.
• 502 The firewall couldn't be loaded.

Request body (JSON)

Sample body

{
  "action": "add",
  "rule": {
    "type": "in",
    "action": "ACCEPT",
    "proto": "tcp",
    "dport": "22",
    "source": "198.51.100.0/24",
    "comment": "SSH z kanceláře"
  }
}

Sample response

{
  "ok": true,
  "firewall": {
    "digest": "9b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6f7a8b9c",
    "baseline": true,
    "enabled": true,
    "ipfilter": true,
    "macfilter": true,
    "policyIn": "DROP",
    "policyOut": "ACCEPT",
    "inboundDefault": "accept",
    "scannerBlock": true,
    "ipfilterEntries": [
      "203.0.113.25"
    ],
    "rules": []
  }
}

Possible errors

• 400 Invalid body or rule (port, address, protocol), or more than 50 custom rules.
• 403 A managed rule can't be changed, or the Firewall permission is missing.
• 409 The firewall changed meanwhile (reload digest), the service isn't active, a restore is running or the recommended setup can't be applied.
• 502 The change couldn't be saved.

Query parameters

Sample response

{
  "range": "day",
  "points": [
    {
      "t": 1762473600,
      "cpu": 6.2,
      "ram": 44.8,
      "netIn": 52000,
      "netOut": 138000,
      "diskRead": 0,
      "diskWrite": 20480
    }
  ],
  "cpuPeak": [
    {
      "t": 1762473600,
      "cpu": 31.5
    }
  ],
  "cpu": {
    "avg": 7.1,
    "max": 64.2
  },
  "transfer30d": {
    "inBytes": 18253611008,
    "outBytes": 42949672960
  },
  "transferMonth": {
    "inBytes": 4294967296,
    "outBytes": 9663676416
  }
}

Possible errors

• 400 The service is not a VPS.
• 409 The VPS is neither active nor suspended, or can't be verified right now.
• 429 More than 30 requests per minute.
• 502 Statistics can't be loaded right now.

Sample response

{
  "status": "ACTIVE",
  "phase": "finish",
  "active": true,
  "source": "reinstall",
  "restarting": false,
  "running": true,
  "reboot": true,
  "failed": false
}

Possible errors

• 400 The service is not a VPS.
• 404 Service not found.
• 429 More than 90 requests per minute.

Sample response

{
  "available": true,
  "catalog": [
    {
      "id": "clx9a0iso0001",
      "kind": "catalog",
      "name": "Debian 13 netinst",
      "osFamily": "debian",
      "sizeBytes": 754974720,
      "createdAt": "2026-10-20T08:00:00.000Z",
      "lastUsedAt": null,
      "expiresAt": null
    }
  ],
  "own": [
    {
      "id": "clx9a0iso0002",
      "kind": "custom",
      "name": "Rescue tools",
      "osFamily": null,
      "sizeBytes": 524288000,
      "createdAt": "2026-11-02T12:00:00.000Z",
      "lastUsedAt": "2026-11-03T09:00:00.000Z",
      "expiresAt": "2026-12-03T09:00:00.000Z"
    }
  ],
  "limits": {
    "count": 2,
    "maxBytes": 10737418240,
    "retentionDays": 30
  },
  "status": {
    "attached": false,
    "bootFromIso": false,
    "isoId": null,
    "name": null
  },
  "job": null
}

Possible errors

• 400 The service is not a VPS.
• 403 You are not the service owner.
• 409 The service isn't active.

Request body (JSON)

Sample body

{
  "action": "attach",
  "isoId": "clx9a0iso0001",
  "boot": true
}

Sample response

{
  "ok": true,
  "job": {
    "id": "clx9r1t7w0004",
    "kind": "iso",
    "state": "running",
    "step": null,
    "startedAt": "2026-11-07T10:00:00.000Z",
    "updatedAt": "2026-11-07T10:00:00.000Z"
  }
}

Possible errors

• 400url The link can't be used (not HTTPS, non-public network, over 10 GB, no size, not a file). Other codes: limit, attached; without a code, invalid action.
• 404not_found ISO not found.
• 409unavailable ISOs aren't available right now. Without a code: another action is running on the VPS.
• 429 More than 10 ISOs added per day.
• 502 The action failed.

Sample response

{
  "enabled": true,
  "scope": "location",
  "maxNetworks": 5,
  "maxMembers": 20,
  "priceCzk": null,
  "networks": [
    {
      "id": "clx9p7net0001",
      "name": "zalohy",
      "cidr": "10.20.0.0/24",
      "prefix": 24,
      "createdAt": "2026-10-18T08:00:00.000Z",
      "members": [
        {
          "serviceId": "clx9svc000001",
          "shortId": "#000001",
          "ipv4": "203.0.113.25",
          "address": "10.20.0.1",
          "state": "active",
          "isThis": true,
          "own": true
        }
      ],
      "me": {
        "address": "10.20.0.1",
        "mac": "BC:24:11:00:00:01",
        "nicIndex": 1,
        "state": "active",
        "cloudInit": false,
        "failed": false
      },
      "canDelete": false
    }
  ]
}

Possible errors

• 403 You are not the service owner.
• 409 The service isn't active.
• 503unavailable Private networks aren't available right now.

Request body (JSON)

Sample body

{
  "action": "attach",
  "networkId": "clx9p7net0001",
  "address": "10.20.0.5"
}

Sample response

{
  "ok": true,
  "address": "10.20.0.5",
  "mac": "BC:24:11:00:00:05",
  "pendingRestart": true,
  "view": {
    "enabled": true,
    "scope": "location",
    "maxNetworks": 5,
    "maxMembers": 20,
    "priceCzk": null,
    "networks": []
  }
}

Possible errors

• 400invalid_request Invalid body. Other codes: name_invalid, cidr_invalid, address_invalid, address_outside, address_reserved.
• 404network_not_found Network not found. Code not_member: the VPS isn't in the network.
• 409firewall_required Apply the recommended firewall setup first. Other codes: cidr_overlap, limit_networks, limit_members, address_taken, network_full, not_empty, detaching, other_location, other_node, no_slot, vm_locked, disabled, no_vlan.
• 412vm_not_ready The VPS isn't ready yet.
• 502apply_failed The change couldn't be completed.
• 503unavailable Private networks aren't available right now.

Sample response

{
  "configured": true,
  "error": null,
  "entries": [
    {
      "ip": "203.0.113.25",
      "family": 4,
      "current": "mail.example.com",
      "default": "25.113.0.203.example.net",
      "custom": "mail.example.com"
    },
    {
      "ip": "2001:db8:10::2",
      "family": 6,
      "current": null,
      "default": "vps.example.net",
      "custom": null
    }
  ],
  "ranges": [
    {
      "cidr": "2001:db8:10::/64",
      "family": 6
    }
  ],
  "vmIpv6": "2001:db8:10::2"
}

Possible errors

• 400 The service is not a VPS.
• 403 Missing Network permission on a shared service.
• 409 The service isn't active.

Request body (JSON)

Sample body

{
  "ip": "203.0.113.25",
  "hostname": "mail.example.com"
}

Sample response

{
  "ok": true,
  "ip": "203.0.113.25",
  "ptr": "mail.example.com",
  "isDefault": false
}

Possible errors

• 400 Invalid host name, reverse or reserved domain, or more than 32 custom records.
• 403 The IP address doesn't belong to this service, or the Network permission is missing.
• 502 rDNS couldn't be saved right now.

Sample response

{
  "options": [
    {
      "key": "ubuntu-2404",
      "label": "Ubuntu 24.04 LTS"
    },
    {
      "key": "debian-13",
      "label": "Debian 13"
    }
  ],
  "job": {
    "id": "clx9r1t7w0002",
    "kind": "reinstall",
    "state": "done",
    "step": null,
    "startedAt": "2026-11-01T10:00:00.000Z",
    "updatedAt": "2026-11-01T10:06:12.000Z",
    "finishedAt": "2026-11-01T10:06:12.000Z",
    "error": null
  },
  "os": "ubuntu-2404",
  "reinstalledAt": "2026-11-01T10:06:12.000Z"
}

Possible errors

• 400 The service is not a VPS.
• 403 You are not the service owner.
• 409 The service isn't active.

Request body (JSON)

Sample body

{
  "os": "debian-13",
  "sshKeys": "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIExampleKeyExampleKeyExampleKeyExample user@laptop"
}

Sample response

{
  "started": true,
  "password": "example-Root-Pass-123",
  "job": {
    "id": "clx9r1t7w0003",
    "kind": "reinstall",
    "state": "running",
    "step": null,
    "startedAt": "2026-11-07T10:00:00.000Z",
    "updatedAt": "2026-11-07T10:00:00.000Z"
  }
}

Possible errors

• 400 Missing or invalid system, invalid SSH key or more than 10 keys.
• 403insufficient_scope The key lacks the services:secrets scope, or you are not the owner.
• 409 Another action is running, the VPS is in rescue mode, the node is busy or reinstall is unavailable.
• 429 The reinstall has already run 3 times in the last 24 hours.
• 502 The reinstall couldn't be started.

Sample response

{
  "password": "example-Root-Pass-789"
}

Possible errors

• 403insufficient_scope The key lacks the services:secrets scope. Without a code: missing permission on a shared service.
• 404 Service not found or no password is stored for it.
• 429 More than 5 reveals in 10 minutes.
• 503 The password can't be shown right now, try again.

Query parameters

Sample response

{
  "available": false,
  "reason": "stopped",
  "message": "VPS je vypnutá. Heslo jde nastavit jen u běžící VPS."
}

Possible errors

• 400 The service is not a VPS.
• 403 Missing Secrets permission on a shared service.
• 409 The service isn't active.

Query parameters

Sample response

{
  "password": "example-Root-Pass-456"
}

Possible errors

• 403insufficient_scope The key lacks the services:secrets scope. Without a code: missing permission on a shared service.
• 409 The password can't be set right now; field reason: agent_down, stopped, rescue, command_disabled, not_configured, no_permission or busy.
• 429 Limit of 3 per hour or 10 per day exceeded.
• 502 The agent didn't set the password, the old one still works (reason failed or unavailable).

Query parameters

Sample response

{
  "settings": {
    "enabled": true,
    "email": true,
    "discord": {
      "hint": "discord.com/api/webhooks/…ab12",
      "disabled": false
    },
    "events": {
      "crash": true,
      "down": true,
      "recovered": true,
      "cleanExit": false,
      "node": true
    },
    "includeLog": true,
    "updatedAt": "2026-11-02T18:20:00.000Z"
  },
  "history": [
    {
      "id": "alr_01",
      "at": "2026-11-06T21:14:03.000Z",
      "kind": "crash",
      "exitCode": 137,
      "oom": true,
      "reason": null,
      "cause": null,
      "suppressed": null,
      "channels": {
        "email": "sent",
        "discord": "sent"
      },
      "extra": 0,
      "downtimeMin": null
    }
  ]
}

Possible errors

• 403 Only for the service owner.

Query parameters

Request body (JSON)

Sample body

{
  "action": "save",
  "enabled": true,
  "email": true,
  "events": {
    "crash": true,
    "down": true,
    "recovered": true,
    "cleanExit": false,
    "node": true
  },
  "includeLog": true
}

Sample response

{
  "ok": true,
  "settings": {
    "enabled": true,
    "email": true,
    "discord": null,
    "events": {
      "crash": true,
      "down": true,
      "recovered": true,
      "cleanExit": false,
      "node": true
    },
    "includeLog": true,
    "updatedAt": "2026-11-07T10:05:00.000Z"
  }
}

Possible errors

• 400bad-request Invalid body or extra fields.
• 400webhook The address is not a Discord webhook.
• 400test-failed The test message could not be delivered.
• 400no-webhook test: no webhook is saved.
• 400no-channel Enabled monitoring needs e-mail or a webhook.
• 429rate A test message can be sent once a minute and 5 times an hour.
• 500failed The settings could not be saved.
• 403 Only for the service owner.

Query parameters

Sample response

{
  "allocations": [
    {
      "id": 1201,
      "ip": "203.0.113.10",
      "port": 25565,
      "notes": null,
      "primary": true
    },
    {
      "id": 1202,
      "ip": "203.0.113.10",
      "port": 25566,
      "notes": "Dynmap",
      "primary": false
    }
  ],
  "limit": 3,
  "sftp": {
    "ip": "203.0.113.10",
    "port": 2022
  }
}

Possible errors

• 400 The section is missing or unknown.
• 403 Missing permission for this section (Network, Databases, Backups or Settings).
• 412 The server is not available in the game panel yet.

Request body (JSON)

Sample body

{
  "action": "setVariable",
  "key": "MAX_PLAYERS",
  "value": "32"
}

Sample response

{
  "ok": true,
  "value": "32"
}

Possible errors

• 400 Invalid request body or database name.
• 400CONTROL_CHARS The variable value contains control characters.
• 403 Missing permission for the action; reinstall also needs Files and Power.
• 403SECRETS_REQUIRED A secret variable can only be changed by the owner or a member with the Secrets permission.
• 403FILES_REQUIRED The Discord bot code source can only be changed with the Files permission.
• 404 The backup does not exist.
• 409MANAGED_VARIABLE The variable is managed by StormHost and cannot be changed.
• 409MC_MANAGED_VARIABLE For Minecraft this variable is set in the Software tab.
• 409PROTECTED_ARGUMENT Free arguments must not override protected parameters (e.g. RCON).
• 409JOB_RUNNING A software change is running on the Minecraft server.
• 409PORT_LIMIT The package has no free port left.
• 409NO_FREE_PORT There is no free port on the node right now.
• 412 The server is not available in the game panel yet.

Query parameters

Sample response

Binární soubor (Content-Type: application/gzip, Content-Disposition: attachment; filename="backup-….tar.gz")

Possible errors

• 400 The uuid is missing or invalid.
• 403 Missing the Backups or Files permission.
• 404 The backup does not exist.
• 502 The backup could not be downloaded from the game panel.
• 429 At most 10 downloads per minute.

Query parameters

Sample response

{
  "schedules": [
    {
      "id": 41,
      "name": "Denní restart",
      "cron": {
        "minute": "0",
        "hour": "5",
        "dom": "*",
        "month": "*",
        "dow": "*"
      },
      "target": {
        "minute": "0",
        "hour": "5",
        "dom": "*",
        "month": "*",
        "dow": "*"
      },
      "active": true,
      "onlyWhenOnline": false,
      "processing": false,
      "stuck": false,
      "lastRunAt": "2026-11-07T04:00:00.000Z",
      "nextRunAt": "2026-11-08T04:00:00.000Z",
      "kind": "restart",
      "preset": {
        "kind": "restart",
        "repeat": {
          "kind": "daily",
          "time": "05:00"
        },
        "countdown": {
          "m5": true,
          "m1": true,
          "s10": true
        }
      },
      "origin": "portal",
      "author": "you",
      "lastResult": "ok",
      "lastResultCause": null,
      "allowed": true
    }
  ],
  "panelZone": {
    "expected": "Europe/Prague",
    "detected": "Europe/Prague",
    "ok": true,
    "preview": "Europe/Prague"
  },
  "backupSlots": 1,
  "canBackup": true,
  "backupAddonPriceCzk": 120,
  "game": "minecraft",
  "countdown": true,
  "mcVersion": "1.21.4",
  "isOwner": true,
  "permissions": {
    "console": true,
    "power": true,
    "backups": true
  },
  "limits": {
    "maxSchedules": 10,
    "nameMax": 60,
    "commandMax": 256,
    "messageMax": 100,
    "hourSteps": [
      1,
      2,
      3,
      4,
      6,
      8,
      12
    ]
  }
}

Possible errors

• 403 Missing the Settings permission.
• 412 The server is not available in the game panel yet.

Request body (JSON)

Sample body

{
  "action": "create",
  "name": "Noční restart",
  "preset": {
    "kind": "restart",
    "repeat": {
      "kind": "daily",
      "time": "04:30"
    },
    "countdown": {
      "m5": true,
      "m1": true,
      "s10": false
    },
    "message": "Server se za chvíli restartuje."
  }
}

Sample response

{
  "ok": true,
  "id": 42
}

Possible errors

• 400INVALID The schedule is not filled in correctly.
• 400GAP The schedule would run too often.
• 400BACKUP_ACK ack: true is missing for a backup schedule.
• 400COMMAND_FORBIDDEN The command would stop or restart the server; use the restart or power preset.
• 403FORBIDDEN Missing permission for the schedule (Console, Power or Backups depending on tasks).
• 404NOT_FOUND The schedule does not exist.
• 409LIMIT The server already has 10 schedules.
• 409BACKUP_SLOTS Scheduled backups need the backup add-on.
• 409BACKUP_EXISTS A backup schedule already exists.
• 409NOT_EDITABLE The schedule was created outside the portal; it can only be disabled or deleted.
• 409PANEL_TZ Schedules at a specific time cannot be set right now, only hourly repeats.
• 409SUSPENDED The server is suspended.
• 409JOB_RUNNING A software change is running on the Minecraft server.
• 429RATE A schedule can be run at most once a minute.
• 502PARTIAL The schedule was not saved completely and stays disabled.

Query parameters

Sample response

{
  "view": {
    "state": {
      "mode": "live",
      "open": true,
      "checkoutOpen": true
    },
    "usable": true,
    "shop": {
      "id": "shp_3k9d",
      "slug": "muj-server",
      "title": "Můj server",
      "status": "active",
      "sellerName": "Jan Novák",
      "sellerIco": null,
      "sellerEmail": "[email protected]",
      "sellerAddress": null,
      "playerTerms": null,
      "termsVersion": "2026-10-29",
      "termsAcceptedAt": "2026-11-01T09:00:00.000Z",
      "termsCurrent": true,
      "suspendedReason": null,
      "createdAt": "2026-11-01T09:00:00.000Z"
    },
    "items": [
      {
        "id": "itm_8f2a",
        "title": "VIP na 30 dní",
        "description": "Barevné jméno a /fly",
        "priceCzk": 99,
        "category": "Ranky",
        "durationDays": 30,
        "commandsBuy": [
          "lp user {player} parent addtemp vip 30d"
        ],
        "commandsExpire": [],
        "active": true,
        "sortOrder": 0,
        "breakdown": null
      }
    ],
    "rates": null,
    "termsVersion": "2026-10-29",
    "summary": [
      {
        "month": "2026-11",
        "count": 3,
        "priceHaler": 29700,
        "commissionHaler": 1485,
        "feeHaler": 1020,
        "creditHaler": 27195
      }
    ]
  }
}

Possible errors

• 400not_minecraft The VIP shop is only for Minecraft servers.
• 404disabled The VIP shop is not available for the account right now.
• 503disabled The VIP shop is not ready yet.
• 500failed The action failed.
• 403 Only for the service owner.

Query parameters

Request body (JSON)

Sample body

{
  "action": "saveItem",
  "title": "VIP na 30 dní",
  "priceCzk": 99,
  "category": "Ranky",
  "durationDays": 30,
  "commandsBuy": [
    "lp user {player} parent addtemp vip 30d"
  ],
  "commandsExpire": [],
  "active": true
}

Sample response

{
  "ok": true,
  "item": {
    "id": "itm_8f2a",
    "title": "VIP na 30 dní",
    "description": null,
    "priceCzk": 99,
    "category": "Ranky",
    "durationDays": 30,
    "commandsBuy": [
      "lp user {player} parent addtemp vip 30d"
    ],
    "commandsExpire": [],
    "active": true,
    "sortOrder": 0,
    "breakdown": null
  }
}

Possible errors

• 400bad Invalid request or unknown action.
• 400 Invalid field; the code and field say which, e.g. slug, title, seller_email, terms, item_price, command_denied.
• 404no_shop The service has no shop yet.
• 404item_not_found The item does not exist.
• 409slug_taken The shop address is taken.
• 409suspended The shop is suspended by the operator.
• 409items_max The shop already has 50 items.
• 400not_minecraft The VIP shop is only for Minecraft servers.
• 500failed The action failed.
• 403 Only for the service owner.

Query parameters

Sample response

{
  "sales": [
    {
      "id": "sal_51c0",
      "number": "VIP-2026-000123",
      "createdAt": "2026-11-05T19:02:11.000Z",
      "paidAt": "2026-11-05T19:03:40.000Z",
      "state": "paid",
      "refundState": null,
      "test": false,
      "itemTitle": "VIP na 30 dní",
      "durationDays": 30,
      "playerName": "Steve_42",
      "buyerEmail": "[email protected]",
      "priceHaler": 9900,
      "commissionHaler": 495,
      "feeHaler": 340,
      "creditHaler": 9065,
      "reversedHaler": null,
      "deliveries": [
        {
          "id": "dlv_77aa",
          "kind": "purchase",
          "state": "done",
          "attempts": 1,
          "nextAttemptAt": null,
          "doneAt": "2026-11-05T19:03:52.000Z",
          "lastErrorCode": null,
          "sent": 1,
          "total": 1
        }
      ]
    }
  ]
}

Possible errors

• 404no_shop The service has no shop yet.
• 400not_minecraft The VIP shop is only for Minecraft servers.
• 500failed The action failed.
• 403 Only for the service owner.

Query parameters

Request body (JSON)

Sample body

{
  "action": "retry",
  "deliveryId": "dlv_77aa"
}

Sample response

{
  "ok": true,
  "state": "done",
  "code": null
}

Possible errors

• 400bad Invalid request.
• 404no_shop The service has no shop yet.
• 404delivery_not_found The delivery does not exist.
• 409delivery_state The delivery cannot be retried right now.
• 429rate At most 10 attempts per minute.
• 400not_minecraft The VIP shop is only for Minecraft servers.
• 500failed The action failed.
• 403 Only for the service owner.

Query parameters

Sample response

{
  "version": "1.21.4",
  "world": "world",
  "worldValid": true,
  "worldExists": true,
  "power": "running",
  "busy": null,
  "items": [
    {
      "name": "example-pack.zip",
      "kind": "zip",
      "size": 48211,
      "mtime": 1730970000,
      "source": "modrinth",
      "title": "Example Pack",
      "versionName": "1.2.0",
      "projectId": "AbCdEf12",
      "enabled": true,
      "compat": "ok"
    }
  ],
  "evidenceBroken": false,
  "canConsole": true,
  "maxUploadMb": 50
}

Possible errors

• 409NOT_IMPORTED The server software is not set yet, use minecraft/software first.
• 412NO_PANEL The server is not available in the game panel right now.
• 429 Too many requests, try again shortly.

Request body (JSON)

Sample body

{
  "action": "install",
  "projectId": "AbCdEf12",
  "versionId": "XyZ98765"
}

Sample response

{
  "ok": true,
  "file": "example-pack.zip",
  "replaced": null,
  "needsReload": true,
  "packFormat": "61",
  "compat": "ok"
}

Possible errors

• 400INVALID Invalid request body.
• 403FORBIDDEN `reload` without the Console permission on a shared service.
• 404NO_SUCH_PACK No datapack with this name in the world.
• 409NAME_TAKEN A datapack with the same name already exists, remove it first.
• 409TOO_MANY The world already has 100 datapacks.
• 409NOT_RUNNING The server is not running, start it and try again.
• 409JOB Another change or add-on installation is running on the server.
• 422INCOMPATIBLE This datapack version does not match the server version.
• 422NO_PACK_MCMETA The file is not a valid datapack (pack.mcmeta missing).
• 429RATE_LIMITED Limit: install and remove 20 per 10 minutes, `reload` 10 per 10 minutes.

Query parameters

Sample response

{
  "enabled": true,
  "zone": "play.example.com",
  "ttl": 300,
  "nameMin": 3,
  "nameMax": 32,
  "current": {
    "name": "mujserver",
    "fqdn": "mujserver.play.example.com",
    "zone": "play.example.com",
    "ip": "203.0.113.10",
    "port": 25565,
    "recordType": "A",
    "srvName": "_minecraft._tcp.mujserver.play.example.com",
    "createdAt": "2026-11-07T10:15:00.000Z",
    "updatedAt": null,
    "records": {
      "address": "ok",
      "srv": "ok"
    }
  },
  "allocation": {
    "ip": "203.0.113.10",
    "alias": null,
    "port": 25565
  },
  "directAddress": "203.0.113.10:25565",
  "allocationError": null,
  "allocationErrorCode": null,
  "recordsError": null,
  "recordsErrorCode": null,
  "resynced": false,
  "canManage": true
}

Possible errors

• 400NOT_MINECRAFT The service is not a Minecraft server.
• 503PANEL Server management is temporarily unavailable.
• 500SETUP_FAILED Could not complete, try again later.

Query parameters

Request body (JSON)

Sample body

{
  "action": "create",
  "name": "mujserver"
}

Sample response

{
  "ok": true,
  "current": {
    "name": "mujserver",
    "fqdn": "mujserver.play.example.com",
    "zone": "play.example.com",
    "ip": "203.0.113.10",
    "port": 25565,
    "recordType": "A",
    "srvName": "_minecraft._tcp.mujserver.play.example.com",
    "createdAt": "2026-11-07T10:15:00.000Z",
    "updatedAt": null,
    "records": {
      "address": "ok",
      "srv": "ok"
    }
  }
}

Possible errors

• 400INVALID Invalid request body.
• 400INVALID_NAME The name does not meet the rules.
• 400RESERVED The name is reserved.
• 400SAME_NAME The server already has this address.
• 404NONE The server has no custom address.
• 409TAKEN The address is taken.
• 409EXISTS The server already has a custom address, use `rename`.
• 409NO_ALLOCATION The server has no default port.
• 409NOT_PUBLIC The default server address is not public.
• 412NO_PANEL_LINK The server is not available in the game panel right now.
• 429RATE_LIMITED Change limit exceeded, try again later.
• 503DISABLED Custom addresses are not available right now.
• 502DNS Writing the DNS records failed.

Sample response

{
  "accepted": false,
  "acceptedAt": null,
  "url": "https://aka.ms/MinecraftEULA"
}

Possible errors

• 412 The server is not available in the game panel right now (message `panel.unavailable` in `msg`).
• 429 Too many requests, try again shortly.

Request body (JSON)

Sample body

{
  "accept": true,
  "start": true
}

Sample response

{
  "ok": true,
  "accepted": true,
  "acceptedAt": "2026-11-07T10:15:00.000Z",
  "started": true,
  "startError": null,
  "startErrorMsg": null
}

Possible errors

• 400 `accept: true` is missing.
• 403 `start` without the Power permission.
• 409 A change (job) is running on the server.
• 412 The server is not available in the game panel right now (message `panel.unavailable` in `msg`).

Query parameters

Sample response

{
  "version": "1.21.4",
  "world": "world",
  "worldValid": true,
  "power": "running",
  "busy": null,
  "perDimension": true,
  "source": "file",
  "fileAt": "2026-11-07T10:15:00.000Z",
  "pending": [],
  "rules": [
    {
      "id": "minecraft:keep_inventory",
      "name": "keepInventory",
      "type": "bool",
      "min": null,
      "max": null,
      "group": "players",
      "common": true,
      "label": "Keep inventory after death",
      "value": false,
      "default": false
    }
  ]
}

Possible errors

• 409NOT_IMPORTED The server software is not set yet, use minecraft/software first.
• 412NO_PANEL The server is not available in the game panel right now.
• 413FILE_TOO_LARGE The rules file is too large.
• 422FILE_CORRUPT The rules file is corrupted.
• 429 Too many requests, try again shortly.

Request body (JSON)

Sample body

{
  "rules": {
    "minecraft:keep_inventory": true,
    "minecraft:spawn_radius": 0
  },
  "allDimensions": true
}

Sample response

{
  "ok": true,
  "world": "world",
  "results": [
    {
      "id": "minecraft:keep_inventory",
      "status": "set"
    },
    {
      "id": "minecraft:spawn_radius",
      "status": "unchanged"
    }
  ]
}

Possible errors

• 400INVALID Invalid request body.
• 400NO_CHANGES `rules` is empty.
• 400UNKNOWN_RULE The rule does not exist in the server version (field `rule`).
• 400INVALID_VALUE Invalid rule value (field `rule`).
• 409NOT_RUNNING The server is not running, start it and try again.
• 409NOT_IMPORTED The server software is not set yet, use minecraft/software first.
• 409JOB Another change or add-on installation is running on the server.
• 429CONSOLE_BUSY The server console is busy.
• 412NO_PANEL The server is not available in the game panel right now.

Sample response

{
  "job": {
    "id": "k3j9x2m1q8",
    "kind": "switch",
    "status": "running",
    "step": "install",
    "log": [
      {
        "at": "2026-11-07T10:15:00.000Z",
        "key": "job.log.installing",
        "params": {
          "label": "Paper 1.21.4"
        }
      }
    ],
    "startedAt": "2026-11-07T10:15:00.000Z",
    "updatedAt": "2026-11-07T10:16:10.000Z",
    "error": null,
    "errorMsg": null,
    "progress": {
      "done": 42,
      "total": 168,
      "unit": "files",
      "bytesDone": null,
      "bytesTotal": null
    },
    "from": {
      "type": "paper",
      "version": "1.21.1",
      "build": "130"
    },
    "target": {
      "type": "paper",
      "version": "1.21.4",
      "build": "232"
    },
    "destructive": true,
    "finishedAt": null
  },
  "active": true
}

Possible errors

• 429 Too many requests, try again shortly.

Request body (JSON)

Sample body

{
  "action": "dismiss",
  "jobId": "k3j9x2m1q8"
}

Sample response

{
  "ok": true
}

Possible errors

• 400 Invalid request body (message key in `msg`).
• 409 The job is still running or is no longer the latest one.

Query parameters

Sample response

{
  "installed": null,
  "aside": null,
  "recovering": false,
  "server": {
    "type": "fabric",
    "version": "1.21.1",
    "memoryMib": 8192
  },
  "perms": {
    "install": true,
    "rollback": true,
    "deleteAside": true,
    "wipe": true,
    "replaceBackup": true
  },
  "queue": {
    "active": 0,
    "waiting": 0,
    "limit": 2
  },
  "limits": {
    "uploadMaxMb": 95,
    "serverFileMaxMb": 1024,
    "serverMb": 3072,
    "files": 30000
  }
}

Possible errors

• 400 Invalid project, version, upload or mode (message key in `msg`).
• 429 Too many requests, try again shortly.

Request body (JSON)

Sample body

{
  "action": "install",
  "origin": "modrinth",
  "projectId": "AbCdEf12",
  "versionId": "XyZ98765",
  "mode": "all",
  "acceptEula": true
}

Sample response

{
  "ok": true,
  "job": {
    "id": "k3j9x2m1q8",
    "kind": "modpack",
    "status": "queued",
    "step": "queued",
    "log": [],
    "startedAt": "2026-11-07T10:15:00.000Z",
    "updatedAt": "2026-11-07T10:15:00.000Z",
    "error": null,
    "errorMsg": null,
    "progress": null
  },
  "warnings": []
}

Possible errors

• 400 Invalid request body (message key in `msg`).
• 403 Settings, Files and Power permissions are missing (message key in `msg`).
• 403WIPE_OWNER Only the owner may use `wipe`.
• 403BACKUP_PERMISSION `replaceBackup` without the Backups permission.
• 409JOB_RUNNING Another job is already running on the server.
• 409ADDON_RUNNING A plugin or mod installation is in progress.
• 409QUEUE_FULL The install queue is full, try again later.
• 409DISK Not enough disk space on the server (`details.freeMb`, `details.needMb`).
• 409DOWNGRADE The modpack uses an older Minecraft version, confirm with `confirmDowngrade`.
• 422LOADER The modpack loader cannot be installed right now.
• 429 Install limit exceeded (hourly per service or daily per customer).

Query parameters

Sample response

{
  "enabled": true,
  "collecting": true,
  "range": "24h",
  "canToggle": true,
  "bucketSec": 300,
  "points": [
    {
      "t": 1730973600000,
      "peak": 4,
      "avg": 2.5,
      "slots": 20,
      "state": "up"
    }
  ],
  "average": 2.1,
  "peak": {
    "online": 6,
    "at": "2026-11-07T10:15:00.000Z"
  },
  "record": {
    "online": 14,
    "at": "2026-10-20T19:40:00.000Z"
  },
  "last": {
    "at": "2026-11-07T10:15:00.000Z",
    "online": 3,
    "max": 20
  }
}

Possible errors

• 503unavailable The player chart is not available yet.
• 502ERROR The chart could not be loaded.
• 429 Too many requests, try again shortly.

Request body (JSON)

Sample body

{
  "enabled": false
}

Sample response

{
  "ok": true,
  "enabled": false,
  "deleted": 2016
}

Possible errors

• 400INVALID Invalid request body.
• 503unavailable The player chart is not available yet.
• 429 Too many requests, try again shortly.

Query parameters

Sample response

{
  "power": "running",
  "busy": null,
  "canConsole": true,
  "version": "1.21.4",
  "settings": {
    "whitelist": true,
    "enforceWhitelist": false,
    "onlineMode": true,
    "opLevel": 4,
    "propsMissing": false
  },
  "propsInvalid": false,
  "floodgatePrefix": null,
  "online": {
    "online": 1,
    "max": 20,
    "players": [
      {
        "name": "Steve",
        "uuid": "0f3c1e2a-4b5d-4c6e-8f70-1a2b3c4d5e6f"
      }
    ],
    "truncated": false,
    "source": "console",
    "at": "2026-11-07T10:15:00.000Z"
  },
  "onlineError": null,
  "onlineErrorMsg": null,
  "lists": {
    "whitelist": {
      "status": "ok",
      "entries": [
        {
          "uuid": "0f3c1e2a-4b5d-4c6e-8f70-1a2b3c4d5e6f",
          "name": "Steve"
        }
      ]
    },
    "ops": {
      "status": "ok",
      "entries": [
        {
          "uuid": "0f3c1e2a-4b5d-4c6e-8f70-1a2b3c4d5e6f",
          "name": "Steve",
          "level": 4,
          "bypassesPlayerLimit": false
        }
      ]
    },
    "bans": {
      "status": "absent",
      "entries": []
    },
    "ipBans": {
      "status": "absent",
      "entries": []
    }
  },
  "known": [],
  "owner": true
}

Possible errors

• 400INVALID_NICK Invalid nickname in `lookup`.
• 403FORBIDDEN `lookup` without the Console permission.
• 503MOJANG_BUSY Mojang lookup is unavailable now, try again in a minute.
• 412 The server is not available in the game panel right now (message `panel.unavailable` in `msg`).
• 429 Too many requests, try again shortly.

Request body (JSON)

Sample body

{
  "action": "op",
  "nick": "Steve",
  "level": 4
}

Sample response

{
  "ok": true,
  "mode": "command",
  "result": "done",
  "player": {
    "name": "Steve",
    "uuid": "0f3c1e2a-4b5d-4c6e-8f70-1a2b3c4d5e6f"
  }
}

Possible errors

• 400INVALID Invalid request body.
• 400INVALID_NICK Invalid nickname or UUID.
• 400INVALID_REASON Invalid reason.
• 400INVALID_IP Invalid IP address.
• 409NOT_RUNNING The action needs a running server (e.g. `kick`).
• 409PLAYER_OFFLINE The player is not online.
• 409NO_FLOODGATE `bedrock-*` actions need Floodgate.
• 409CONFLICT The file changed in the meantime, try again.
• 409JOB Another change is running on the server.
• 422PLAYER_UNKNOWN No player with this nickname exists.
• 429RATE_LIMITED Change limit exceeded, try again later.
• 503MOJANG_BUSY Mojang lookup is unavailable now.

Query parameters

Sample response

{
  "context": {
    "type": "paper",
    "kind": "plugins",
    "gameVersion": "1.21.4",
    "versionKnown": true,
    "versionSource": "metadata",
    "dir": "/plugins"
  },
  "sources": [
    "modrinth",
    "hangar"
  ],
  "maxBytes": 104857600,
  "items": [
    {
      "file": "ExamplePlugin-1.2.0.jar",
      "filename": "ExamplePlugin-1.2.0.jar",
      "enabled": true,
      "size": 512000,
      "modifiedAt": 1730970000,
      "managed": true,
      "source": "modrinth",
      "projectId": "AbCdEf12",
      "title": "Example Plugin",
      "icon": null,
      "url": "https://modrinth.com/plugin/example-plugin",
      "versionId": "XyZ98765",
      "versionName": "1.2.0",
      "publishedAt": "2026-11-07T10:15:00.000Z",
      "installedAt": "2026-11-07T10:15:00.000Z",
      "installedByYou": true,
      "dependencyOf": null,
      "unverified": true,
      "fromModpack": null,
      "dataFolder": "ExamplePlugin"
    }
  ],
  "dataFolders": [
    "ExamplePlugin"
  ],
  "folderExists": true,
  "changedAt": "2026-11-07T10:15:00.000Z",
  "restartRequired": true,
  "serverState": "running",
  "jobRunning": false,
  "op": null
}

Possible errors

• 400BAD_REQUEST Unknown source, project or version.
• 400UNSUPPORTED_TYPE The server type supports neither plugins nor mods (Vanilla).
• 404OP_NOT_FOUND The operation does not exist or has expired.
• 429RATE_LIMITED Catalogue query limit: 60 per minute.
• 502SOURCE_ERROR The catalogue is not responding.

Request body (JSON)

Sample body

{
  "action": "install",
  "source": "modrinth",
  "project": "example-plugin",
  "dependencies": true
}

Sample response

{
  "ok": true,
  "op": {
    "id": "3f1c2a7e-9b4d-4e21-8c3a-5d6e7f809a1b",
    "action": "install",
    "status": "done",
    "step": "Hotovo",
    "stepMsg": {
      "key": "plugin.step.done"
    },
    "startedAt": "2026-11-07T10:15:00.000Z",
    "finishedAt": "2026-11-07T10:15:12.000Z",
    "result": {
      "installed": [
        {
          "file": "ExamplePlugin-1.2.0.jar",
          "title": "Example Plugin",
          "versionName": "1.2.0",
          "role": "target"
        }
      ],
      "removed": [],
      "skipped": [],
      "missing": []
    },
    "error": null,
    "errorMsg": null,
    "code": null,
    "data": null
  },
  "result": {
    "installed": [
      {
        "file": "ExamplePlugin-1.2.0.jar",
        "title": "Example Plugin",
        "versionName": "1.2.0",
        "role": "target"
      }
    ],
    "removed": [],
    "skipped": [],
    "missing": []
  }
}

Possible errors

• 400BAD_REQUEST Invalid request body or project/version reference.
• 404NOT_FOUND File or project not found.
• 404NO_VERSION No compatible version.
• 409JOB_RUNNING Another change is running on the server.
• 409INSTALLING The server is being installed.
• 409EXISTS The file already exists, use `replace`.
• 409UP_TO_DATE The file is already up to date.
• 413TOO_LARGE The file is larger than 100 MB.
• 422INCOMPATIBLE The version does not fit this server.
• 422EXTERNAL The project can only be downloaded from the author's page.
• 429RATE_LIMITED Limit of 20 changes per 10 minutes.
• 502SOURCE_ERROR The catalogue is not responding.

Query parameters

Sample response

{
  "locked": [
    "server-ip",
    "server-port",
    "query.port"
  ],
  "secretKeys": [
    "rcon.password",
    "management-server-secret",
    "management-server-tls-keystore-password"
  ],
  "privilegedKeys": [
    "enable-rcon",
    "rcon.port",
    "management-server-enabled",
    "management-server-host",
    "management-server-port",
    "management-server-tls-enabled",
    "management-server-tls-keystore",
    "management-server-allowed-origins"
  ],
  "allocationPorts": [
    25565,
    25566
  ],
  "canSecrets": true,
  "canPower": true,
  "jobActive": false,
  "exists": true,
  "etag": "9b1f0c2d4e6a8b0c1d2e3f4a5b6c7d8e9f0a1b2c",
  "raw": "motd=A Minecraft Server\nmax-players=20\nrcon.password=********\n",
  "entries": [
    {
      "key": "motd",
      "value": "A Minecraft Server"
    },
    {
      "key": "max-players",
      "value": "20"
    },
    {
      "key": "rcon.password",
      "value": "********"
    }
  ]
}

Possible errors

• 400 Unknown key in `reveal`.
• 403 `reveal` without the Secrets permission.
• 422 The file is too large or not text.
• 412 The server is not available in the game panel right now (message `panel.unavailable` in `msg`).
• 429 Too many requests, try again shortly.

Request body (JSON)

Sample body

{
  "etag": "9b1f0c2d4e6a8b0c1d2e3f4a5b6c7d8e9f0a1b2c",
  "fields": {
    "motd": "Vítejte",
    "max-players": 30
  },
  "restart": true
}

Sample response

{
  "ok": true,
  "unchanged": false,
  "etag": "0c1d2e3f4a5b6c7d8e9f0a1b2c9b1f0c2d4e6a8b",
  "changed": [
    "motd",
    "max-players"
  ],
  "restored": [],
  "restarted": true,
  "restartError": null,
  "restartErrorMsg": null
}

Possible errors

• 400 Invalid request body (message key in `msg`).
• 400UNKNOWN_KEY The key cannot be changed via `fields` (field `key`).
• 400LOCKED The key is locked (field `key`).
• 400INVALID Invalid key value (field `key`).
• 400RAW_INVALID The file text is too long or contains forbidden characters.
• 403SECRETS Changing a secret or remote management without the Secrets permission.
• 403 `restart` without the Power permission.
• 409CONFLICT The file changed meanwhile, fetch a new `etag`.
• 409NO_FILE The file does not exist, send `create: true`.
• 409 A change (job) is running on the server.
• 412 The server is not available in the game panel right now (message `panel.unavailable` in `msg`).

Query parameters

Sample response

{
  "state": {
    "type": "paper",
    "version": "1.21.4",
    "build": "232",
    "loaderVersion": null,
    "javaMajor": 21,
    "launch": {
      "kind": "jar",
      "file": "server.jar"
    },
    "history": [],
    "importedAt": null,
    "installedAt": "2026-11-07T10:15:00.000Z"
  },
  "job": null,
  "jobActive": false,
  "server": {
    "memoryMib": 8192,
    "diskMib": 40960,
    "javaMajor": 21,
    "imageOfficial": true,
    "busy": null
  },
  "panelError": null,
  "clientError": null,
  "backups": {
    "used": 1,
    "limit": 3
  },
  "diskFreeMb": 35200,
  "diskFreeUnknown": false,
  "eula": {
    "accepted": true,
    "acceptedAt": "2026-11-07T10:15:00.000Z"
  },
  "importSuggestion": null,
  "perms": {
    "change": true,
    "import": true,
    "eula": true,
    "power": true,
    "skipBackup": true
  },
  "types": [
    "paper",
    "purpur",
    "folia",
    "vanilla",
    "fabric",
    "forge",
    "neoforge"
  ]
}

Possible errors

• 400 Unknown type, version or build (message key in `msg`).
• 422 The version or build cannot be found.
• 502 The version source is not responding.
• 412 The server is not available in the game panel right now (message `panel.unavailable` in `msg`).
• 429 Too many requests, try again shortly.

Request body (JSON)

Sample body

{
  "action": "switch",
  "type": "paper",
  "version": "1.21.4",
  "mode": "keep",
  "acceptEula": true
}

Sample response

{
  "ok": true,
  "job": {
    "id": "k3j9x2m1q8",
    "kind": "switch",
    "status": "queued",
    "step": "queued",
    "log": [],
    "startedAt": "2026-11-07T10:15:00.000Z",
    "updatedAt": "2026-11-07T10:15:00.000Z",
    "error": null,
    "errorMsg": null,
    "progress": null
  },
  "warnings": []
}

Possible errors

• 400 Invalid request body (message key in `msg`).
• 403 A change needs the Settings, Files and Power permissions.
• 403SKIP_BACKUP_OWNER Only the owner may use `skipBackup`.
• 409JOB_RUNNING Another job is already running on the server.
• 409ADDON_RUNNING A plugin or mod installation is in progress.
• 409BACKUP_SLOT Backup slots are full.
• 409BACKUP_DISABLED The service has no backups; the change only works with `skipBackup`.
• 409DISK Not enough disk space (`details.freeMb`, `details.needMb`).
• 409DOWNGRADE Older version, confirm with `confirmDowngrade`.
• 409UNKNOWN_VERSION The current version is unknown, confirm with `confirmDowngrade`.
• 409NOT_IMPORTED `reinstall` without known software, use `import` or `switch` first.
• 409INSTALLING The server is installing or restoring a backup.
• 422NEED_BUILD `import`: for Forge and NeoForge provide `build`.
• 429 At most 3 changes per hour.

Query parameters

Sample response

{
  "type": "paper",
  "imported": true,
  "javaMajor": 21,
  "arch": "x86_64",
  "envPrefix": true,
  "memoryMib": 8192,
  "launch": {
    "kind": "jar",
    "file": "server.jar"
  },
  "command": "java -Xms6656M -Xmx6656M -XX:+UseG1GC -jar server.jar nogui",
  "heapMb": 6656,
  "addons": 12,
  "modpack": false,
  "presets": [
    {
      "preset": "standard",
      "heapMb": 6656,
      "isDefault": true,
      "vectors": true
    },
    {
      "preset": "zgc",
      "heapMb": 5888,
      "isDefault": false,
      "vectors": true
    },
    {
      "preset": "none",
      "heapMb": 6656,
      "isDefault": false,
      "vectors": true
    }
  ],
  "defaultPreset": "standard",
  "vectors": true,
  "memory": null,
  "stored": {
    "preset": "standard",
    "heapMb": 6656,
    "memoryMib": 8192,
    "vectors": true,
    "extraFlags": [],
    "appliedAt": "2026-11-07T10:15:00.000Z",
    "custom": false,
    "hasPrevious": true,
    "check": null
  },
  "lastSync": null,
  "managed": true,
  "matchesStored": true,
  "drifted": false,
  "needsSync": false,
  "busy": null,
  "jobActive": false,
  "canPower": true,
  "canExtraFlags": true,
  "canJava": true
}

Possible errors

• 502 The game panel is not responding.
• 429 Too many requests, try again shortly.

Request body (JSON)

Sample body

{
  "preset": "standard",
  "extraFlags": [],
  "restart": true
}

Sample response

{
  "ok": true,
  "command": "java -Xms6656M -Xmx6656M -XX:+UseG1GC -jar server.jar nogui",
  "heapMb": 6656,
  "preset": "standard",
  "restarted": true,
  "restartError": null,
  "restartErrorMsg": null
}

Possible errors

• 400 Invalid request body (message key in `msg`).
• 403EXTRA_FLAGS_PERMISSION New custom flags without the Power permission (field `token`).
• 403 `restart` or `java` without the required permissions.
• 409NEED_IMPORT The server software is not set.
• 409NO_MEMORY_LIMIT The server has no memory limit.
• 409CHANGED The startup changed meanwhile.
• 409 A software change or install is running.
• 422PRESET The preset does not fit this Java.
• 422EXTRA_FLAGS Forbidden flag (field `token`).
• 422TOO_OLD `java`: the version is too old for the Minecraft version.
• 422NO_IMAGE `java`: no image for this Java.
• 429 Limit: preset changes 10 per hour, Java switches 3 per hour.

Sample response

{
  "running": true,
  "state": "running",
  "version": "1.21.4",
  "era": "components",
  "eraKnown": true,
  "plugins": {
    "essentials": true,
    "luckperms": true,
    "tab": false
  }
}

Possible errors

• 412 The server is not available in the game panel right now (message `panel.unavailable` in `msg`).
• 429 Too many requests, try again shortly.

Request body (JSON)

Sample body

{
  "action": "lp-prefix",
  "target": "vip",
  "targetKind": "group",
  "priority": 50,
  "doc": {
    "segments": [
      {
        "text": "[VIP] ",
        "fill": {
          "kind": "solid",
          "color": "#ffaa00"
        },
        "bold": true
      }
    ]
  }
}

Sample response

{
  "ok": true,
  "command": "lp group vip meta setprefix 50 \"&#FFAA00&l[VIP] \"",
  "warnings": [],
  "delivered": null
}

Possible errors

• 400INVALID Invalid request body.
• 400TARGET Invalid player or group.
• 400PRIORITY Priority must be an integer 0–1000.
• 400EMPTY The text is empty.
• 400TOO_LONG The text is too long (nick up to 64 characters, others 256).
• 400TOO_MANY_PARTS The text has too many coloured parts.
• 409JOB A change (job) is running on the server.
• 409 The server is not running.
• 429RATE_LIMITED Change limit exceeded, try again later.
• 412 The server is not available in the game panel right now (message `panel.unavailable` in `msg`).

Sample response

{
  "active": "world",
  "activeValid": true,
  "worlds": [
    {
      "name": "world",
      "active": true,
      "exists": true,
      "extraFolders": [],
      "version": "1.21.4",
      "mtime": 1730970000,
      "seed": null,
      "createdAt": null
    },
    {
      "name": "creative",
      "active": false,
      "exists": true,
      "extraFolders": [],
      "version": "1.21.4",
      "mtime": 1730800000,
      "seed": "12345",
      "createdAt": "2026-11-01T18:00:00.000Z"
    }
  ],
  "unchecked": 0,
  "maxWorlds": 5,
  "exports": [
    {
      "id": "a1b2c3d4e5",
      "world": "world",
      "status": "ready",
      "createdAt": "2026-11-07T10:15:00.000Z",
      "expiresAt": "2026-11-07T12:15:00.000Z",
      "bytes": 104857600,
      "error": null,
      "errorMsg": null
    }
  ],
  "job": null,
  "jobOther": false,
  "backups": {
    "used": 1,
    "limit": 3,
    "free": true
  },
  "power": "running",
  "busy": null,
  "version": "1.21.4",
  "uploadMaxMb": 95,
  "canPower": true
}

Possible errors

• 412NO_PANEL The server is not available in the game panel right now.
• 429 Too many requests, try again shortly.

Request body (JSON)

Sample body

{
  "action": "reset",
  "old": "keep",
  "keepAs": "stary_svet",
  "seed": "",
  "levelType": "normal",
  "structures": true
}

Sample response

{
  "ok": true,
  "job": {
    "id": "k3j9x2m1q8",
    "kind": "world-reset",
    "status": "queued",
    "step": "queued",
    "log": [],
    "startedAt": "2026-11-07T10:15:00.000Z",
    "updatedAt": "2026-11-07T10:15:00.000Z",
    "error": null,
    "errorMsg": null,
    "progress": null
  }
}

Possible errors

• 400INVALID Invalid request body.
• 400BAD_NAME Invalid world name.
• 400RESERVED_NAME The name belongs to a server folder.
• 400BAD_SEED Invalid seed.
• 403FORBIDDEN The Power permission is missing.
• 404NO_SUCH_WORLD The world is not on the server.
• 409ACTIVE_WORLD The world is currently active.
• 409NAME_TAKEN A folder with this name already exists.
• 409TOO_MANY_WORLDS A server can have at most 5 worlds.
• 409NEEDS_CONFIRM The old world would be deleted without a backup, send `confirmNoBackup: true`.
• 409JOB_RUNNING Another change is already running on the server.
• 409EXPORT_RUNNING A world download is already being prepared.
• 409DISK Not enough disk space on the server.
• 409STATE The server is starting or stopping.
• 429RATE_LIMITED Change limit exceeded, try again later.
• 412NO_PANEL The server is not available in the game panel right now.

Query parameters

Sample response

HTTP/1.1 200 OK
Content-Type: application/zip
Content-Disposition: attachment; filename="world-2026-11-07.zip"

(binary archive)

Possible errors

• 400INVALID `id` is missing or invalid.
• 404EXPORT_GONE The download is no longer prepared, prepare it again.
• 429DOWNLOAD_BUSY A download is already in progress.
• 429RATE_LIMITED Too many downloads.
• 412NO_PANEL The server is not available in the game panel right now.

Request body (JSON)

Sample body

{
  "locale": "cs"
}

Sample response

{
  "ok": true
}

Possible errors

• 400invalid The request body contains an unknown field.
• 403 Only the domain owner can do this, not a member of a shared service.
• 404 The service doesn't exist, isn't yours, or the key has no access to it.
• 409inactive The domain isn't active yet.
• 429 Limit of 3 requests per hour exceeded.
• 503unavailable Sending is temporarily unavailable. Try again later.
• 422failed The registrar rejected the request.

Query parameters

Sample response

{
  "mode": "zone",
  "domain": "example.com",
  "host": "@",
  "kind": "vps",
  "records": [
    {
      "type": "A",
      "host": "@",
      "fqdn": "example.com",
      "value": "203.0.113.25",
      "ttl": 300
    },
    {
      "type": "AAAA",
      "host": "@",
      "fqdn": "example.com",
      "value": "2001:db8::25",
      "ttl": 300
    }
  ],
  "notes": [],
  "add": [
    {
      "type": "AAAA",
      "host": "@",
      "fqdn": "example.com",
      "value": "2001:db8::25",
      "ttl": 300
    }
  ],
  "replace": [
    {
      "type": "A",
      "host": "@",
      "fqdn": "example.com",
      "value": "198.51.100.7",
      "ttl": 3600
    }
  ],
  "unchanged": false,
  "withinLimit": true,
  "planHash": "3f9a0c1b2d4e5f60718293ab"
}

Possible errors

• 403 Only the domain owner can do this, not a member of a shared service.
• 404 The service doesn't exist, isn't yours, or the key has no access to it.
• 409inactive The domain isn't active yet.
• 400host Invalid name: use @ for the domain itself, or a subdomain made of letters, digits and hyphens.
• 404service The service doesn't exist, isn't yours, isn't active or can't be connected.
• 409no_address The service has no public address to point the domain to.
• 503unavailable The service address or DNS state can't be read right now.
• 429 Limit of 60 requests per 10 minutes exceeded.

Request body (JSON)

Sample body

{
  "serviceId": "clx9k2m4p0000svc01abcdef",
  "host": "@",
  "planHash": "3f9a0c1b2d4e5f60718293ab",
  "confirm": true
}

Sample response

{
  "ok": true,
  "mode": "zone",
  "domain": "example.com",
  "host": "@",
  "kind": "vps",
  "records": [
    {
      "type": "A",
      "host": "@",
      "fqdn": "example.com",
      "value": "203.0.113.25",
      "ttl": 300
    },
    {
      "type": "AAAA",
      "host": "@",
      "fqdn": "example.com",
      "value": "2001:db8::25",
      "ttl": 300
    }
  ],
  "notes": [],
  "add": [],
  "replace": [],
  "unchanged": true,
  "withinLimit": true,
  "planHash": "3f9a0c1b2d4e5f60718293ab"
}

Possible errors

• 400invalid A required field is missing or malformed.
• 403 Only the domain owner can do this, not a member of a shared service.
• 404 The service doesn't exist, isn't yours, or the key has no access to it.
• 409inactive The domain isn't active yet.
• 400host Invalid name: use @ for the domain itself, or a subdomain made of letters, digits and hyphens.
• 404service The service doesn't exist, isn't yours, isn't active or can't be connected.
• 409no_address The service has no public address to point the domain to.
• 503unavailable The service address or DNS state can't be read right now.
• 409manual The domain doesn't use our DNS. Set the records up with your DNS provider.
• 409changed The zone has changed since GET. The response contains the new plan in the plan field.
• 409confirm The plan replaces existing records and confirm: true is missing. The response contains the plan in the plan field.
• 409limit The zone would exceed the 200-record limit.
• 429 Limit of 60 DNS changes per 10 minutes (shared with DNS record writes) exceeded.

Query parameters

Sample response

{
  "zone": "example.com",
  "unicode": "example.com",
  "records": [
    {
      "id": "a1b2c3d4e5f60718293a",
      "type": "A",
      "host": "@",
      "ttl": 3600,
      "value": "203.0.113.25",
      "fields": {
        "host": "@",
        "ttl": "3600",
        "address": "203.0.113.25"
      }
    },
    {
      "id": "b2c3d4e5f60718293a4b",
      "type": "MX",
      "host": "@",
      "ttl": 3600,
      "value": "10 mail.example.com",
      "fields": {
        "host": "@",
        "ttl": "3600",
        "preference": "10",
        "exchange": "mail.example.com"
      }
    },
    {
      "id": "c3d4e5f60718293a4b5c",
      "type": "TXT",
      "host": "@",
      "ttl": 3600,
      "value": "v=spf1 mx -all",
      "fields": {
        "host": "@",
        "ttl": "3600",
        "text": "v=spf1 mx -all"
      }
    }
  ],
  "nameservers": [
    "ns1.stormhost.eu",
    "ns2.stormhost.eu"
  ],
  "count": 3,
  "limit": 200,
  "delegated": true
}

Possible errors

• 403 Only the domain owner can do this, not a member of a shared service.
• 404 The service doesn't exist, isn't yours, or the key has no access to it.
• 400 The service isn't a domain.
• 409inactive The domain isn't active yet.
• 409no_zone The domain has no zone on our DNS. Create it via domain/zone or switch the nameservers to ours.
• 503unavailable The DNS server isn't responding right now. Try again later.
• 422failed The change couldn't be made.

Request body (JSON)

Sample body

{
  "record": {
    "type": "MX",
    "host": "@",
    "ttl": "3600",
    "preference": "10",
    "exchange": "mail.example.com"
  }
}

Sample response

{
  "ok": true,
  "id": "b2c3d4e5f60718293a4b",
  "zone": "example.com",
  "unicode": "example.com",
  "records": [
    {
      "id": "a1b2c3d4e5f60718293a",
      "type": "A",
      "host": "@",
      "ttl": 3600,
      "value": "203.0.113.25",
      "fields": {
        "host": "@",
        "ttl": "3600",
        "address": "203.0.113.25"
      }
    },
    {
      "id": "b2c3d4e5f60718293a4b",
      "type": "MX",
      "host": "@",
      "ttl": 3600,
      "value": "10 mail.example.com",
      "fields": {
        "host": "@",
        "ttl": "3600",
        "preference": "10",
        "exchange": "mail.example.com"
      }
    },
    {
      "id": "c3d4e5f60718293a4b5c",
      "type": "TXT",
      "host": "@",
      "ttl": 3600,
      "value": "v=spf1 mx -all",
      "fields": {
        "host": "@",
        "ttl": "3600",
        "text": "v=spf1 mx -all"
      }
    }
  ],
  "nameservers": [
    "ns1.stormhost.eu",
    "ns2.stormhost.eu"
  ],
  "count": 3,
  "limit": 200,
  "delegated": true
}

Possible errors

• 400 The record failed validation. The code field says why (e.g. type, host, host_zone, cname_apex, srv_host, ipv4, ipv6, target, text, ttl, caa_flags, caa_tag, caa_value, cname_conflict, duplicate, limit) and field says which field is affected.
• 403 Only the domain owner can do this, not a member of a shared service.
• 404 The service doesn't exist, isn't yours, or the key has no access to it.
• 400 The service isn't a domain.
• 409inactive The domain isn't active yet.
• 409no_zone The domain has no zone on our DNS. Create it via domain/zone or switch the nameservers to ours.
• 503unavailable The DNS server isn't responding right now. Try again later.
• 422failed The change couldn't be made.
• 429 Limit of 60 changes per 10 minutes exceeded.

Request body (JSON)

Sample body

{
  "id": "a1b2c3d4e5f60718293a",
  "record": {
    "address": "203.0.113.26",
    "ttl": "600"
  }
}

Sample response

{
  "ok": true,
  "id": "d4e5f60718293a4b5c6d",
  "zone": "example.com",
  "unicode": "example.com",
  "records": [
    {
      "id": "a1b2c3d4e5f60718293a",
      "type": "A",
      "host": "@",
      "ttl": 3600,
      "value": "203.0.113.25",
      "fields": {
        "host": "@",
        "ttl": "3600",
        "address": "203.0.113.25"
      }
    },
    {
      "id": "b2c3d4e5f60718293a4b",
      "type": "MX",
      "host": "@",
      "ttl": 3600,
      "value": "10 mail.example.com",
      "fields": {
        "host": "@",
        "ttl": "3600",
        "preference": "10",
        "exchange": "mail.example.com"
      }
    },
    {
      "id": "c3d4e5f60718293a4b5c",
      "type": "TXT",
      "host": "@",
      "ttl": 3600,
      "value": "v=spf1 mx -all",
      "fields": {
        "host": "@",
        "ttl": "3600",
        "text": "v=spf1 mx -all"
      }
    }
  ],
  "nameservers": [
    "ns1.stormhost.eu",
    "ns2.stormhost.eu"
  ],
  "count": 3,
  "limit": 200,
  "delegated": true
}

Possible errors

• 400 The record failed validation. The code field says why (e.g. type, host, host_zone, cname_apex, srv_host, ipv4, ipv6, target, text, ttl, caa_flags, caa_tag, caa_value, cname_conflict, duplicate, limit) and field says which field is affected.
• 404not_found No record with this ID in the zone (it may have changed in the meantime).
• 403 Only the domain owner can do this, not a member of a shared service.
• 404 The service doesn't exist, isn't yours, or the key has no access to it.
• 400 The service isn't a domain.
• 409inactive The domain isn't active yet.
• 409no_zone The domain has no zone on our DNS. Create it via domain/zone or switch the nameservers to ours.
• 503unavailable The DNS server isn't responding right now. Try again later.
• 422failed The change couldn't be made.
• 429 Limit of 60 changes per 10 minutes exceeded.

Request body (JSON)

Sample body

{
  "id": "c3d4e5f60718293a4b5c"
}

Sample response

{
  "ok": true,
  "zone": "example.com",
  "unicode": "example.com",
  "records": [
    {
      "id": "a1b2c3d4e5f60718293a",
      "type": "A",
      "host": "@",
      "ttl": 3600,
      "value": "203.0.113.25",
      "fields": {
        "host": "@",
        "ttl": "3600",
        "address": "203.0.113.25"
      }
    },
    {
      "id": "b2c3d4e5f60718293a4b",
      "type": "MX",
      "host": "@",
      "ttl": 3600,
      "value": "10 mail.example.com",
      "fields": {
        "host": "@",
        "ttl": "3600",
        "preference": "10",
        "exchange": "mail.example.com"
      }
    },
    {
      "id": "c3d4e5f60718293a4b5c",
      "type": "TXT",
      "host": "@",
      "ttl": 3600,
      "value": "v=spf1 mx -all",
      "fields": {
        "host": "@",
        "ttl": "3600",
        "text": "v=spf1 mx -all"
      }
    }
  ],
  "nameservers": [
    "ns1.stormhost.eu",
    "ns2.stormhost.eu"
  ],
  "count": 3,
  "limit": 200,
  "delegated": true
}

Possible errors

• 400invalid The id is missing or malformed.
• 404not_found No record with this ID in the zone.
• 403 Only the domain owner can do this, not a member of a shared service.
• 404 The service doesn't exist, isn't yours, or the key has no access to it.
• 400 The service isn't a domain.
• 409inactive The domain isn't active yet.
• 409no_zone The domain has no zone on our DNS. Create it via domain/zone or switch the nameservers to ours.
• 503unavailable The DNS server isn't responding right now. Try again later.
• 422failed The change couldn't be made.
• 429 Limit of 60 changes per 10 minutes exceeded.

Request body (JSON)

Sample body

{
  "mode": "custom",
  "nameservers": [
    {
      "name": "ns1.example.com",
      "ipv4": "203.0.113.53"
    },
    {
      "name": "ns2.example.net"
    }
  ]
}

Sample response

{
  "ok": true,
  "mode": "custom",
  "nsset": null,
  "nameservers": [
    "ns1.example.com",
    "ns2.example.net"
  ]
}

Possible errors

• 400invalid Invalid request body (e.g. unknown mode).
• 400ns_count custom needs 2 to 6 distinct servers.
• 400ns_name Invalid server name. The index field says which one.
• 400ns_glue A server inside the domain needs an IPv4 or IPv6 address.
• 400ns_ip Invalid server IP address.
• 400ns_ours The custom servers are only ours. Use mode ours.
• 403 Only the domain owner can do this, not a member of a shared service.
• 404 The service doesn't exist, isn't yours, or the key has no access to it.
• 409inactive The domain isn't active yet.
• 429 Limit of 10 changes per 10 minutes exceeded.
• 503unavailable The registry or DNS server is unavailable right now. Try again later.
• 422failed The registry rejected the change.

Request body (JSON)

Sample body

{
  "locale": "cs"
}

Sample response

{
  "ok": true
}

Possible errors

• 400invalid The request body contains an unknown field.
• 403 Only the domain owner can do this, not a member of a shared service.
• 404 The service doesn't exist, isn't yours, or the key has no access to it.
• 409inactive The domain isn't active yet.
• 429 Limit of 10 requests per 10 minutes exceeded.
• 503not_ready DNS for domains isn't ready right now. Try again later.
• 422failed The zone couldn't be created.

Query parameters

Sample response

{
  "available": true,
  "balanceCzk": 450,
  "bonusCzk": 50,
  "nonRefundableCzk": 0,
  "refundableCzk": 400,
  "pending": [
    {
      "orderId": "clx9k2m4p0001ord02abcdef",
      "invoiceId": "clx9k2m4p0001inv02abcdef",
      "number": "DK-2026-0007",
      "amountCzk": 200,
      "dueAt": "2026-11-14T23:59:59.000Z",
      "createdAt": "2026-11-06T12:00:00.000Z",
      "paymentStarted": false
    }
  ],
  "history": {
    "items": [
      {
        "id": "clx9k2m4p0000ctx01abcdef",
        "seq": 2,
        "type": "SPEND",
        "kind": null,
        "amountCzk": -249,
        "balanceAfterCzk": 450,
        "createdAt": "2026-11-02T10:15:00.000Z",
        "invoiceId": "clx9k2m4p0000inv01abcdef",
        "invoiceNumber": "2026-0042",
        "orderId": "clx9k2m4p0000ord01abcdef",
        "note": null,
        "refundRequestId": null
      },
      {
        "id": "clx9k2m4p0000ctx00abcdef",
        "seq": 1,
        "type": "TOPUP",
        "kind": null,
        "amountCzk": 699,
        "balanceAfterCzk": 699,
        "createdAt": "2026-10-20T08:00:00.000Z",
        "invoiceId": "clx9k2m4p0000inv00abcdef",
        "invoiceNumber": "DK-2026-0005",
        "orderId": "clx9k2m4p0000ord00abcdef",
        "note": null,
        "refundRequestId": null
      }
    ],
    "page": 1,
    "pages": 1,
    "total": 2
  }
}

Possible errors

• 429rate_limited Limit of 60 requests per minute exceeded.

Request body (JSON)

Sample body

{
  "invoiceId": "clx9k2m4p0000inv01abcdef",
  "expectedAmountCzk": 249
}

Sample response

{
  "ok": true,
  "orderId": "clx9k2m4p0000ord01abcdef",
  "amountCzk": 249,
  "balanceCzk": 201,
  "next": "/cs/order/clx9k2m4p0000ord01abcdef?credit=paid"
}

Possible errors

• 400invalid A required field is missing or malformed.
• 403locked The account is temporarily locked.
• 404invoice_not_found The invoice doesn't exist or isn't yours.
• 409insufficient Not enough credit. The response contains balanceCzk and neededCzk.
• 409amount_changed The amount has changed. The current one is in amountCzk.
• 409closed The invoice is already paid or cancelled.
• 409expired The proforma invoice expired after its due date.
• 409upgrade_expired The upgrade offer was valid only until the end of the service period and has been cancelled.
• 409gateway_open A payment gateway payment is open for the invoice. Send ackOpenGateway: true.
• 409payment_in_progress A gateway payment is in progress.
• 409paid_unreconciled A payment has already arrived but isn't matched yet.
• 409topup_not_payable A credit top-up invoice can't be paid with credit.
• 409not_payable The invoice doesn't belong to a payable order.
• 409capacity There's no free capacity for the ordered service right now.
• 409billing_profile_incomplete The account's billing details are missing. The response contains settingsUrl.
• 409foreign_eu_vat Orders from businesses in other EU countries are currently handled individually.
• 429rate_limited Limit of 10 attempts per minute exceeded.
• 503unavailable Credit isn't available right now.
• 503gateway_check_failed The gateway payment status can't be checked right now. Try again later.
• 503capacity_busy Capacity can't be checked right now. Try again shortly.

Query parameters

Sample response

{
  "data": [
    {
      "id": "clx9k2m4p0000inv01abcdef",
      "number": "2026-0042",
      "status": "PAID",
      "totalCzk": 249,
      "currency": "CZK",
      "items": [
        {
          "description": "VPS Start (1 měsíc)",
          "priceCzk": 249,
          "quantity": 1
        }
      ],
      "dueAt": "2026-11-14T23:59:59.000Z",
      "paidAt": "2026-11-02T10:15:00.000Z",
      "createdAt": "2026-11-01T08:00:00.000Z"
    }
  ]
}

Query parameters

Sample response

application/pdf (Content-Disposition: attachment; filename="faktura-2026-0042.pdf")

Possible errors

• 404not_found The invoice doesn't exist, isn't yours or isn't paid.
• 409preparing The invoice is still being issued. Try again later.
• 429rate_limited Limit of 20 downloads per minute exceeded.
• 503not_ready The PDF is being prepared. Try again in a few seconds (Retry-After header).
• 503unavailable The PDF can't be loaded right now. Try again later.

Query parameters

Sample response

application/pdf (Content-Disposition: attachment; filename="faktura-2026-0042.pdf")

Possible errors

• 404not_found The invoice or service doesn't exist, isn't yours, or you aren't the owner. The response is always the same.
• 429rate_limited Limit of 20 downloads per minute exceeded.
• 503not_ready The PDF is being prepared. Try again in a few seconds (Retry-After header).
• 503unavailable The PDF can't be loaded right now. Try again later.

Query parameters

Sample response

{
  "product": "minecraft",
  "productName": "Minecraft",
  "current": {
    "planLabel": "Minecraft 4 GB",
    "packageId": "mc-4gb",
    "legacy": false,
    "memoryMib": 4096,
    "diskMib": 30720,
    "cpu": 200,
    "databases": 1,
    "allocations": 2,
    "backups": 0
  },
  "backups": {
    "included": 0,
    "addon": 0,
    "grandfathered": 0,
    "addonAvailable": true,
    "addonPriceCzk": 120,
    "addonUnitCzk": 0,
    "maxAddon": 1
  },
  "monthlyCzk": 249,
  "period": {
    "start": "2026-11-01T00:00:00.000Z",
    "end": "2026-12-01T00:00:00.000Z",
    "remainingDays": 24,
    "periodDays": 30
  },
  "packages": [
    {
      "id": "mc-6gb",
      "name": "Minecraft 6 GB",
      "cores": 3,
      "cpuUnlimited": false,
      "ramGb": 6,
      "diskGb": 45,
      "ports": 3,
      "databases": 2,
      "includedBackups": 0,
      "priceCzk": 349,
      "recommended": true,
      "fits": true,
      "message": null
    }
  ],
  "options": [
    {
      "packageId": "mc-6gb",
      "addon": 0,
      "monthlyCzk": 349,
      "chargeCzk": 80,
      "after": {
        "memoryMib": 6144,
        "diskMib": 46080,
        "cpu": 300,
        "databases": 2,
        "allocations": 3,
        "backups": 0
      }
    }
  ],
  "effectiveAt": "2026-12-01T00:00:00.000Z",
  "lowerPackages": [],
  "downgradeOptions": [],
  "removeBackup": {
    "available": false
  },
  "downgradeBlocker": null,
  "customStartup": false,
  "scheduled": null,
  "lastChange": null,
  "nextPeriodPriceCzk": 249,
  "pendingOrder": null,
  "upgradeInProgress": false,
  "blocker": null,
  "restartPending": false,
  "recurringMaxCzk": null,
  "billingIncomplete": false,
  "customerType": "consumer"
}

Possible errors

• 403 Only for the service owner.
• 409unavailable The plan cannot be changed right now (unknown package or service state).
• 503 The game panel is not responding right now.

Request body (JSON)

Sample body

{
  "packageId": "mc-6gb",
  "backups": 0,
  "immediateStartRequested": true,
  "expectedChargeCzk": 80,
  "expectedMonthlyCzk": 349,
  "locale": "cs"
}

Sample response

{
  "orderId": "ord_7Hq2mX9pLk",
  "chargeCzk": 80,
  "monthlyToCzk": 349,
  "scheduledCancelled": false
}

Possible errors

• 400 Invalid request or a package that cannot be chosen.
• 400immediate_start_required A consumer must send immediateStartRequested: true.
• 403 Only for the service owner.
• 404none cancelScheduled: there is no scheduled change.
• 409billing_profile_incomplete The account billing details are incomplete.
• 409pending_order An unpaid upgrade order already exists (orderId in the response).
• 409upgrade_in_progress A paid upgrade is still being applied.
• 409price_changed The price has changed; the response includes newChargeCzk and newMonthlyCzk.
• 409capacity The bigger package does not fit on the server.
• 409does_not_fit scheduleDowngrade: the data does not fit into the smaller package (see reasons).
• 409transfer_pending The service is waiting for a transfer.
• 409refund_open A withdrawal or refund is open for the service.
• 409renewal_paid The next period is paid at the price of the scheduled smaller package.
• 409change_applying The smaller package is being applied right now.
• 409too_late cancelScheduled: the change has already taken effect.
• 503price_list_unavailable The price list cannot be loaded right now; nothing is charged.

Query parameters

Sample response

{
  "tier": "vps-performance",
  "tierName": "VPS Performance",
  "current": {
    "cores": 2,
    "ramGb": 4,
    "diskGb": 60,
    "ipv4": 1
  },
  "monthlyCzk": 390,
  "rates": {
    "perCore": 0,
    "perGbRam": 95,
    "perGbDisk": 0,
    "perIpv4": 60
  },
  "priceList": {
    "fp": "a1b2c3d4",
    "rates": {
      "perCore": 0,
      "perGbRam": 95,
      "perGbDisk": 0,
      "perIpv4": 60
    },
    "packages": [],
    "diskAddon": {
      "perGb": 2,
      "stepGb": 10
    }
  },
  "limits": {
    "max": {
      "cores": 16,
      "ramGb": 24,
      "diskGb": 500,
      "ipv4": 5
    },
    "staticMax": {
      "cores": 16,
      "ramGb": 32,
      "diskGb": 500,
      "ipv4": 5
    }
  },
  "capacity": "limited",
  "unavailable": null,
  "upgradeInProgress": false,
  "period": {
    "start": "2026-11-01T00:00:00.000Z",
    "end": "2026-12-01T00:00:00.000Z",
    "remainingDays": 24,
    "periodDays": 30
  },
  "pendingOrder": null,
  "pendingRestart": false,
  "ipv4Pending": 0,
  "recurringMaxCzk": null,
  "billingIncomplete": false,
  "customerType": "consumer"
}

Possible errors

• 400 The service is not a VPS.
• 403 You are not the service owner.
• 409 The service isn't active.

Request body (JSON)

Sample body

{
  "ramGb": 8,
  "diskGb": 100,
  "locale": "cs",
  "immediateStartRequested": true,
  "expectedChargeCzk": 312,
  "expectedMonthlyCzk": 780
}

Sample response

{
  "orderId": "clx9o4ord0001",
  "chargeCzk": 312,
  "monthlyToCzk": 780
}

Possible errors

• 400immediate_start_required The immediate start request is missing. Without a code: invalid values (field) or nothing moved up.
• 409pending_order An open order already exists (orderId). Other codes: billing_profile_incomplete, foreign_eu_vat, unavailable, transfer_pending, upgrade_in_progress, refund_open, renewal_payment, renewal_overdue, capacity.
• 409price_changed The price changed; new values in newChargeCzk and newMonthlyCzk, nothing was created.
• 503capacity_unknown Free capacity can't be checked right now. Code price_list_unavailable: the price list can't be loaded right now.

Query parameters

Sample response

{
  "serviceId": "clx9svc000001",
  "managed": true,
  "status": "awaiting_payment",
  "paidUntil": "2026-12-01T00:00:00.000Z",
  "owner": {
    "nextPayment": {
      "amountCzk": 390,
      "periodStart": "2026-12-01T00:00:00.000Z",
      "periodEnd": "2027-01-01T00:00:00.000Z",
      "issueAt": "2026-11-17T00:00:00.000Z",
      "dueAt": "2026-12-01T00:00:00.000Z",
      "method": "manual",
      "invoice": {
        "orderId": "clx9o4ord0002",
        "invoiceId": "clx9i5inv0002",
        "number": "ZF2026110042",
        "status": "PENDING",
        "payUrl": "/cs/order/clx9o4ord0002"
      }
    },
    "suspendAt": null,
    "terminateAt": null,
    "autoPay": {
      "credit": {
        "enabled": true,
        "globallyAllowed": true,
        "held": false,
        "balanceCzk": 120,
        "sufficient": false
      },
      "card": {
        "enabled": false,
        "available": false,
        "last4": null,
        "maxAmountCzk": null,
        "unavailableReason": null
      }
    },
    "endAtTermEnd": null,
    "canPay": true,
    "canExtendEarly": false,
    "canEndAtTermEnd": true,
    "history": []
  }
}

Possible errors

• 400 This service type has no renewal in the portal (e.g. rackhousing).
• 404not_found Service not found.

Request body (JSON)

Sample body

{
  "action": "pay",
  "locale": "cs"
}

Sample response

{
  "orderId": "clx9o4ord0003",
  "payUrl": "/cs/order/clx9o4ord0003",
  "created": true
}

Possible errors

• 400invalid Invalid body.
• 409not_allowed Renewal isn't possible right now. Other codes: not_managed, terminated, term_end, payment_started, failed.
• 429rate_limited More than 20 requests per hour.
• 503failed The request couldn't be issued right now.

Request body (JSON)

Sample body

{
  "endAtTermEnd": true,
  "locale": "cs"
}

Sample response

{
  "serviceId": "clx9svc000001",
  "managed": true,
  "status": "ending",
  "paidUntil": "2026-12-01T00:00:00.000Z",
  "owner": {
    "nextPayment": null,
    "suspendAt": null,
    "terminateAt": null,
    "autoPay": {
      "credit": {
        "enabled": true,
        "globallyAllowed": true,
        "held": false,
        "balanceCzk": 120,
        "sufficient": null
      },
      "card": {
        "enabled": false,
        "available": false,
        "last4": null,
        "maxAmountCzk": null,
        "unavailableReason": null
      }
    },
    "endAtTermEnd": {
      "requestedAt": "2026-11-07T10:00:00.000Z",
      "by": "customer",
      "termEnd": "2026-12-01T00:00:00.000Z"
    },
    "canPay": false,
    "canExtendEarly": false,
    "canEndAtTermEnd": false,
    "history": []
  }
}

Possible errors

• 400invalid Invalid body (fields other than allowed).
• 404not_allowed The service doesn't belong to your account.
• 409not_managed The service has no billing period set. Other codes: terminated, not_active, period_over, too_late, payment_started.
• 415 The body isn't application/json.

Query parameters

Sample response

{
  "current": {
    "tier": "starter",
    "name": "Starter",
    "storageGb": 10,
    "sites": 1
  },
  "monthlyCzk": 59,
  "period": {
    "start": "2026-11-01T00:00:00.000Z",
    "end": "2026-12-01T00:00:00.000Z",
    "remainingDays": 24,
    "periodDays": 30
  },
  "options": [
    {
      "tier": "business",
      "name": "Business",
      "storageGb": 30,
      "sites": 5,
      "priceCzk": 119,
      "monthlyCzk": 119,
      "chargeCzk": 48
    }
  ],
  "pendingOrder": null,
  "upgradeInProgress": false,
  "blocker": null,
  "recurringMaxCzk": null,
  "billingIncomplete": false,
  "customerType": "consumer"
}

Possible errors

• 409coming_soon A web hosting plan change can't be ordered online yet. Code unavailable: the plan can't be determined or the service doesn't allow an upgrade.
• 400 The service isn't web hosting.
• 403 You are not the service owner.

Request body (JSON)

Sample body

{
  "tier": "business",
  "locale": "cs",
  "immediateStartRequested": true
}

Sample response

{
  "orderId": "clx9o4ord0004",
  "chargeCzk": 48,
  "monthlyToCzk": 119
}

Possible errors

• 409coming_soon A plan change can't be ordered online yet. Other codes: price_changed, pending_order, billing_profile_incomplete, unavailable, unknown_current.
• 400downgrade A lower or the same plan isn't possible. Other codes: unknown_tier, immediate_start_required.
• 503price_list_unavailable The price list can't be loaded right now, nothing is charged.