settings

Get Maintenance Mode

Changed on

Report whether new dashboard sign-ins are frozen.

get/api/v1/settings/maintenance-mode

Request

  • The document declares no server URL.
  • Auth: one of:
    • API key in header Otari-Key
    • API key in header x-api-key

Response

Successful Response

enabledboolean required

When true, POST /api/v1/auth/session refuses every credential with 503 so nobody starts a new dashboard session during a redeploy. Sessions already issued keep working, and the management API and the data plane are unaffected: a caller presenting the master key or an API key through the header is never frozen out.

Changes