Skip to content

ENG-284: document private StatusPageV3 configuration #492

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
checkly-rca-bot-angie wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

ENG-284: document private StatusPageV3 configuration #492

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions constructs/status-page-v3.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
</ResponseField>

<ResponseField name="isPrivate" type="boolean" default="false">
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,
})
```
</ResponseField>

## 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:
Expand Down
Loading