Skip to main content
GET
Fetch one Mode

Authorizations

Authorization
string
header
required

Token from the discovery file. Required on every endpoint except /health.

Path Parameters

id
string<uuid>
required

Response

200 - application/json

Mode payload

ok
boolean
mode
object

A key that is not listed here is IGNORED, on every platform. That is what makes the "Windows and Linux" keys below safe to send from a cross-platform client. The seven required keys are required on POST /modes only; a body missing one is refused on every platform with HTTP 200 and INVALID_REQUEST, naming the keys that are missing. A well-formed JSON object that is merely incomplete is a business failure, not a protocol failure — see the envelope rule in this document's introduction. A body that is not a JSON object, or that carries a value of the wrong type, is still the protocol failure that rule describes: HTTP 400.