From 9e3b0d228c8bcd65e7dd3f2394e1f6aa25247ea1 Mon Sep 17 00:00:00 2001 From: "checkly-rca-bot-angie[bot]" <266841500+checkly-rca-bot-angie[bot]@users.noreply.github.com> Date: Wed, 2 Sep 2026 02:02:39 +0000 Subject: [PATCH] docs: document private StatusPageV3 configuration --- constructs/status-page-v3.mdx | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/constructs/status-page-v3.mdx b/constructs/status-page-v3.mdx index d924e488..879cfbe3 100644 --- a/constructs/status-page-v3.mdx +++ b/constructs/status-page-v3.mdx @@ -166,6 +166,20 @@ Google Analytics tag ID (e.g. `G-XXXXXXXXXX`) embedded on the public page. Whether search engines may index the public page. + +Protect the status page with a generated password. This requires the Communicate Team add-on. + +When a deployment enables password protection, the Checkly CLI prints the generated password once. Store it securely: Checkly does not retain the plaintext password and it cannot be retrieved later. An unchanged redeployment does not rotate the password. + +```ts highlight={4} +new StatusPageV3("company-status", { + name: "Company Status", + url: "company-status", + isPrivate: true, +}) +``` + + ## Referencing an existing page Use `StatusPageV3.fromId()` to attach components and automation rules declared in code to a page created in the UI, without managing the page itself: