banner

Read the site notice

Changed on
get/banner

Request

  • Base URL
    /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/banner
  • Auth
    API key in header X-API-KEY

Headers

X-Fieldsstring mask

An optional fields mask

Response

Success.

enabledboolean

Whether a maintenance notice should be displayed.

messagestring

The notice to display, as the administrator wrote it. May contain Markdown emphasis and links; it is never HTML.

Changes