Quickstart
Issue a key and make your first call.
1. Create a key
In the portal, go to Organisation → API keys and create one. Grant it only the abilities you need — see Abilities.
The plaintext key is shown once. Only a SHA-256 fingerprint is stored, so it cannot be recovered later; if you lose it, revoke it and create another.
Attack history and firewall abilities will not appear unless staff have enabled those endpoints for your organisation. See Activation.
2. Call something
Game servers need no activation, so it is the easiest thing to prove a key with:
curl https://one.terabit.io/api/v1/game-servers \
-H "Authorization: Bearer tbk_your_key_here"{
"data": [
{
"uuid": "3f2a1c9e-5b4d-4a8e-9c7f-1d2e3a4b5c6d",
"identifier": "a1b2c3d4",
"name": "Survival",
"service_id": 4821,
"provisioned": true,
"limits": { "memory": 8192, "cpu": 200, "disk": 51200 }
}
]
}The uuid is the id every other game-server route takes.
3. Read the live state
curl https://one.terabit.io/api/v1/game-servers/3f2a1c9e-5b4d-4a8e-9c7f-1d2e3a4b5c6d \
-H "Authorization: Bearer tbk_your_key_here"Same shape, plus state and resources fetched live from the node.
What to expect when it goes wrong
A 401 means no key reached us. A 403 means the key exists but is not allowed,
without saying which of four reasons applies — see Errors
for how to narrow it down.
Next
- Conventions — envelopes, pagination, ids and units
- Abilities — scoping a key to one job
- Guides — the three areas end to end