Plan a status page
plan_status_pageUse this when the user wants a public status page for their customers, made from one of their sites or empty. Returns a suggested address (with free alternatives when one is taken), the branding found on the site, the components the page would show grouped as the editor groups them, what the plan allows (components per page, custom domains), and the decisions for the user: the address, which of the site's services to show, and whether to publish. Saves the plan and changes nothing in the account. Not for another company's status: use check_service_status.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | The page's name, if the user gave one. | |
| slug | No | The page's address, if the user gave one: the part before .status.flarewarden.com. | |
| answers | No | The user's answers, by decision id: name, slug, dependencies (ids to show), publish (true once the user confirms creating the public page). | |
| plan_id | No | An earlier plan_status_page plan, to answer its decisions. | |
| from_site | No | The site to make the page from, by id, name or part of its URL. Leave out for an empty page. | |
| brand_color | No | The user's brand colour as #rrggbb, if they gave one: the page's colours are made from it instead of the colour found on the site. A page made from a site only. | |
| accept_recommended | No | True when the user asked FlareWarden to choose. It never publishes: that needs the user's yes. |