Skip to content
PL

Routes and domain verification

Creating and updating routes and retrieving DNS instructions.

Operations

Method Path Role
GET /v1/orgs/{org}/routes member
POST /v1/orgs/{org}/routes admin; 201
GET /v1/orgs/{org}/routes/{id} member
PUT /v1/orgs/{org}/routes/{id} admin
DELETE /v1/orgs/{org}/routes/{id} admin; 204
GET /v1/orgs/{org}/routes/{id}/dns member
POST /v1/orgs/{org}/routes/{id}/verify admin

Create a route

Send this object to POST /v1/orgs/{org}/routes. Replace PROFILE_UUID, POOL_UUID and the sample address with real values for your organisation.

{
  "name": "Survival",
  "domains": ["mc.example.com"],
  "backends": [{"address": "192.0.2.10:25565", "weight": 1}],
  "balancing": "round_robin",
  "profileId": "PROFILE_UUID",
  "ipListIds": [],
  "branding": {},
  "target": {"kind": "pool", "id": "POOL_UUID"},
  "enabled": true
}

domains contains hostnames without schemes or ports. Each backend has an address including a port and a weight. target.kind is pool or dedicated; its ID must refer to an available resource. balancing selects a supported algorithm, such as round_robin or least_players.

Update

PUT takes the complete route configuration, not a partial patch. Fetch the current route and deliberately construct the update. GET returns domain state objects; PUT expects domain name strings.

Disabling enabled stops serving the route. Confirm the correct resource ID before deleting a route or changing its domains.

Verification

A new domain may have verified: false. Show DNS instructions and run verification after creation. A 201 response does not mean the server is ready to receive traffic.