---
title: "Read the site notice"
method: GET
path: "/banner"
tags: ["banner"]
---

# Read the site notice

`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-Fields` string, mask

## Response `200`

Success.

- Banner
  - `enabled` boolean: Whether a maintenance notice should be displayed.
  - `message` string: The notice to display, as the administrator wrote it. May contain Markdown emphasis and links; it is never HTML.

## Changes

- **2026-09-11** `81405840063e`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/vulnerability-lookup/apis/vulnerability-lookup-api/changes/banner/get.md)

---

[API](https://skmtc.dev/vulnerability-lookup/apis/vulnerability-lookup-api.md) - [All operations](https://skmtc.dev/vulnerability-lookup/apis/vulnerability-lookup-api/llms.txt) - [OpenAPI document](https://skmtc.dev/vulnerability-lookup/apis/vulnerability-lookup-api/revisions/b4dedf027493?raw)