Authorization

POST /authorization/maintenance

Sets whether or not maintenance mode is enabled

This endpoint requires the permission "authorization.maintenance.write".

Request

  • Base URL
    http://localhost:9000/api
  • URL
    http://localhost:9000/api/authorization/maintenance
  • Auth
    none declared. Required headers: Authorization

Query parameters

enabledboolean required

If "true", maintenance mode will be enabled; if "false", maintenance mode will be disabled.

Headers

Authorizationstring required

The client's authorization, which the server resolves to an identity. Currently supports Biome JWT (if Biome credentials is enabled), Cylinder JWT, and OAuth2 bearer tokens.

SplinterProtocolVersioninteger
Example:2

The protocol version which the client can understand. If not provided, the node will respond using its latest protocol version.

Response

Successfully checked maintenance mode

Changes

No recorded changes to this operation across all 69 revisions of this API.