Introduction

TrueTick Developer Platform

TrueTick is a Minecraft hosting platform built on a single principle: no hidden overselling. Every active server is guaranteed its allocated RAM and CPU. TPS and MSPT are real RCON measurements, not fabricated numbers — and you can read them straight from the API. When there's no data, you get an honest empty state, not green metrics pulled from thin air.

Who this API is for

  • AI agents and bots — automate server lifecycle (create, start, stop, hibernate) and read live health metrics (TPS, MSPT, players) to make data-driven decisions. See Agents.
  • Plugin and mod developers — provision isolated test servers, deploy jars, and run automated smoke tests over RCON. See Deploy a plugin.
  • Dashboard & SRE tooling — compose your own monitoring on the same data the TrueTick panel uses; wire Discord alerts, backups, and restores programmatically.

What the API gives you

CapabilityExample endpoint
Server CRUD + lifecyclePOST /v1/servers, POST /v1/servers/{id}:start, …:stop
Live metrics (TPS / MSPT / players)GET /v1/servers/{id}/metrics
Console (RCON)POST /v1/servers/{id}:command
Logs (snapshot + SSE stream)GET /v1/servers/{id}/logs, …/logs/stream
File manager (jail-scoped) + SFTPGET /v1/servers/{id}/files, …:enable-sftp
Backups (create / restore / delete)GET /v1/servers/{id}/backups
Mods & modpacksPOST /v1/servers/{id}/mods
Wallet & billing ledgerGET /v1/accounts/{id}/wallet, …/ledger
Multi-region capacityGET /v1/regions

Metered + scale-to-zero. You're billed only for actual runtime (GB-seconds). Idle servers hibernate automatically, and a player joining wakes them in ~12 s. A flat plan is available for always-on servers. See Billing and Lifecycle.

Key facts

  • Base URLhttps://api.truetick.gg (production).
  • Authentication — a ttk_ key in the x-api-key header, scoped to what you grant it. See Authentication.
  • 60 REST endpoints, rendered from the OpenAPI spec at /openapi.json in the API Reference.
  • Honest empty states — hibernated or stale metrics report live: false rather than cached-but-false numbers. See Honesty metrics.

Get started

  1. Sign up (opens in a new tab) and fund your wallet (new accounts get a small starting credit).
  2. Create a ttk_ key at Dashboard → API keys (opens in a new tab) with the scopes you need.
  3. Follow the Quickstart — create a server, wake it, run a command, read its logs in curl, the SDK, or the CLI.