⚠️ The latest release is unstable. Use preview builds instead

Main Navigation Home Players Admins Features Developers Community

Appearance

Sidebar Navigation

Developers

Overview

REST API

Introduction

Server

GET Get server status

GET Get connected players

GET Get invite code

GET Long-poll server status

GET Long-poll connected players

GET Get render rate

POST Set server render rate

GET Capture a screenshot of the game

POST Set game time of day

POST Adjust game clock speed

POST Create a new game with specified settings

POST Re-read server-settings.json and reload the active world (no restart)

Diagnostics

GET Live game-engine state snapshot (test harness)

GET Per-handler request timing averages

GET Performance stats

Health

GET Health check

GET Long-poll health

Farmhands

GET Long-poll farmhand slots

GET Get all farmhand slots

DELETE Delete a farmhand by name or player ID

Settings

GET Get server settings

Cabins

GET Get cabin state and positions

Auth

GET Get authentication/password protection status

POST Set auth timeout in seconds

Roles

POST Grant admin role to a player

Docs

GET OpenAPI specification

GET API documentation UI

Architecture

Steam Auth

Networking Internals

Game Engine Reference

Mod Architecture

Festival Handling

Events Schema

Testing

E2E Testing

Test Harness Reference

Remote Host Setup

Manual Festival Testing

Test Failure Runbook

CI Log Masking Runbook

Contributing

Development Setup

CI/CD Pipelines

Advanced

Building from Source

Code Navigation (Serena)

Decompiling

Client Manipulation Techniques

Last built:

OpenAPI specification

GET

/swagger/v1/swagger.json

Responses

Success

Samples

Edit this page on GitHub

Last updated:

Pager

Previous page POST Grant admin role to a player

Next page GET API documentation UI

Released under the MIT License. Not affiliated with or endorsed by ConcernedApe LLC.

OpenAPI specification​

Responses​

Samples​

OpenAPI specification

Responses

Samples