⚠️ 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 Get rendering status

POST Toggle rendering on or off

POST Set game time of day

Health

GET Health check

Farmhands

GET Get all farmhand slots

DELETE Delete a farmhand by name

Settings

GET Get server settings

Cabins

GET Get cabin state and positions

Auth

GET Get authentication/password protection status

Roles

POST Grant admin role to a player

Architecture

Steam Auth

Networking Internals

Contributing

Development Setup

CI/CD Pipelines

Advanced

Building from Source

Decompiling

Get server status

GET

/status

Responses

Server status and game state

Content-Type

application/json

JSON

Samples

Edit this page on GitHub

Last updated:

Pager

Previous pageIntroduction

Next page GET Get connected players

Released under the MIT License.

Get server status​

Responses​

Samples​

Get server status

Responses

Samples