Warps

Base: /api/warps

Hytale's own warps, usable in game with /warp

Handler: WarpsHandler

Endpoints

GET /api/warps List warps POST /api/warps Create warp POST /api/warps/{name}/tp Teleport to warp DELETE /api/warps/{name} Delete warp

GET /api/warps

List warps

Returns all warps with world, position, rotation and creator, including warps created in game.

Response Example

[
  {
    "name": "spawn",
    "world": "default",
    "x": 10.0,
    "y": 64.0,
    "z": -3.0,
    "yaw": 90.0,
    "creator": "Admin",
    "created": "2026-01-01T00:00:00Z",
    "world_loaded": true
  }
]

cURL

curl -X GET 'http://localhost:5550/api/warps' \
  -H 'X-Admin-Token: YOUR_TOKEN'

Internal Behavior

Reads the warp registry of TeleportPlugin.

POST /api/warps

Create warp

Creates a warp at a player's position or at coordinates.

Request Body

Field	Type	Required	Description
`name`	string	Yes	Warp ID, 1 to 32 characters A-Z, a-z, 0-9, _ and -
`player`	string	No	Use the position and view direction of this online player
`world`	string	No	World for explicit coordinates, default first loaded world
`x`	number	No	Required without player
`y`	number	No	Required without player
`z`	number	No	Required without player
`replace`	boolean	No	Overwrite an existing warp, default false
`creator`	string	No	Creator label, default Panel

Response Example

{
  "success": true,
  "name": "spawn",
  "world": "default",
  "x": 10.0,
  "y": 64.0,
  "z": -3.0
}

cURL

curl -X POST 'http://localhost:5550/api/warps' \
  -H 'X-Admin-Token: YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{"name": "spawn_hub", "player": "Eranio"}'

Internal Behavior

Registers the warp with TeleportPlugin and saves its warps.json.

POST /api/warps/{name}/tp

Teleport to warp

Teleports an online player to the warp, also across worlds.

Parameters

Name	Type	Required	Description
`name`	string	Yes	Warp ID

Request Body

Field	Type	Required	Description
`player`	string	Yes	Online player

Response Example

{
  "success": true,
  "player": "Steve",
  "warp": "spawn",
  "world": "default"
}

cURL

curl -X POST 'http://localhost:5550/api/warps/spawn_hub/tp' \
  -H 'X-Admin-Token: YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{"player": "Eranio"}'

Internal Behavior

Adds an entry to the teleport history (/back) and a Teleport component.

DELETE /api/warps/{name}

Delete warp

Removes a warp.

Parameters

Name	Type	Required	Description
`name`	string	Yes	Warp ID

Response Example

{
  "success": true,
  "name": "spawn"
}

cURL

curl -X DELETE 'http://localhost:5550/api/warps/spawn_hub' \
  -H 'X-Admin-Token: YOUR_TOKEN'

Internal Behavior

Removes it from TeleportPlugin and saves.