BrightSite

Create a media folder for organizing uploaded files

create_media_folder

Create a CMS page. Assign a layout_id to wrap with shared header/nav/footer. Both live and staged fields start with the same content. Call publish_page to make it appear on the live site.

create_page

Create a URL redirect (301 permanent or 302 temporary). Source path is relative (e.g. /old-page), target can be relative or absolute URL.

create_redirect

Create a staging site by cloning the account's live site (content + media). Runs synchronously and returns the new staging site (with its `preview_url`). Once created, author into it by passing `site: "staging"` (or the returned site ID) to any content tool — create_page, update_page, update_layout, update_global_code, request_upload, etc. — then staging_diff to review and promote_staging to make it live. The live site is untouched until you promote. Plan-gated — fails if staging isn't available on the account's plan or the staging limit is reached, or if a staging site already exists. `name` is optional and must be unique among the account's sites; when omitted it defaults to "{live site name} (Staging)". Note: the returned `preview_url` requires a logged-in org member — unauthenticated requests (e.g. a headless screenshot without the session cookie) get a 404 by design, so the staging host's existence isn't revealed.

create_staging_site

Delete a blog post

delete_post

Delete a reusable component. Builtin components (navigation/footer/cookie_consent) cannot be deleted.

delete_component

Delete a custom team role. Blocked while any member is assigned to it — reassign those members first (update_member_role).

delete_org_role

Delete a documentation page. Refused if the page has children — move or delete them first. Deleting never cascades, because a silent subtree delete destroys content.

delete_doc_page

Delete an error page

delete_error_page

Delete a form

delete_form

Delete a page layout

delete_layout

Delete a media file. Removes both the DB record and the underlying storage. Refuses if the file is referenced anywhere (template usages, post feature/og images, page og images, site logo/icon) — remove all references first, then retry. There is no force option; the user must clear references manually so they don't leave dangling references behind.

delete_file

Delete a media folder. Refuses if the folder contains any files or subfolders — empty the folder first by moving or deleting its contents, then retry. There is no force/recursive option.

delete_media_folder

Delete a CMS page

delete_page

Delete a URL redirect

delete_redirect

Permanently delete the account's staging site and its content without promoting. Frees the staging slot. The live site is unaffected.

discard_staging_site

Duplicate an entity. Creates a copy with a unique slug and "(Copy)" appended to the title/name — or "(Copy 1)", "(Copy 2)" and so on if that name is already taken. Staged and live fields are synced. Pages and posts are created as unpublished drafts; components, layouts and forms have no status field, so the copy simply exists unattached. Supports: page, post, component, layout, form. (Error pages, global_code, and blog design singletons are not duplicable.)

duplicate

Get the DNS records a customer must create at their DNS provider for one of the account's custom domains — the CNAME pair pointing the domain at BrightSite plus the two _acme-challenge CNAMEs that let SSL certificates issue and renew automatically. Useful when a domain is stuck in provisioning or its ssl_status is pending/failed. Not needed for domains on BrightSite-managed DNS (managed_dns: true), where records are created automatically.

get_dns_instructions

Get the account's Google Reviews widget settings: connection status, the connected Google Business location, the widget's display config (layout, theme, colors, card style, min rating, reviews-per-page), the 'Review us on Google' call-to-action, and the last sync. The widget is placed on pages via the `reviews()` (review wall) and `review_badge()` (compact rating badge) template helpers, sharing one connection + theme. If `connected` is false, the account owner must connect Google in a browser first (see the returned instructions).

get_google_reviews_settings

Check whether the account's Google Business Profile is connected and how many reviews are synced. Use this before configuring the widget or telling the user to connect. When not connected, returns `connect_instructions` describing the one-time browser step.

get_google_reviews_status

Get site analytics. Choose a metric: - summary: unique visitors, page views, sessions, bounce rate, avg session duration, views/visit - top_pages: most-viewed pages (uses `limit`) - top_referrers: top traffic sources (uses `limit`) - top_utm_sources: top first-touch campaign sources from utm_source (uses `limit`) - top_campaigns: top (source, medium, campaign) tuples from UTM params (uses `limit`) - visits_over_time: time series of views + unique visitors (uses `interval`) - device_breakdown: desktop / mobile / tablet - browser_breakdown: Chrome / Safari / Firefox / etc. - country_breakdown: visitor countries - active_visitors: currently active visitors (last 5 minutes; ignores period)

get_analytics

Get the blog listing page design (the index page that shows all posts). Returns both live and staged fields.

get_blog_listing_design

Get a blog post by ID. Returns both live (content/excerpt) and staged (content_staged/excerpt_staged) fields.

get_post

Get the blog post card design (how each post appears in the listing grid). Returns both live and staged fields.

get_blog_post_card_design

Get the blog post template (the layout that wraps individual blog posts). Returns both live and staged fields. There is only one per site — no ID needed.

get_blog_template

Get the blog related posts design (the 'Keep reading' block shown at the bottom of a post when related posts are selected). Returns both live and staged fields.

get_blog_related_posts_design

Get blog-wide settings: whether the blog is enabled, the listing URL, posts-per-page, comment/social/SEO toggles, layout assignments, and display options. There is only one record per site — no ID needed.

get_blog_settings

Get a reusable component by ID. Returns both live and staged content fields.

get_component

Get a documentation page by ID. Returns both live (content) and staged (content_staged) fields.

get_doc_page

Get the docs article design — the HEEx skin wrapped around every individual documentation page's body. Returns both live and staged fields.

get_docs_article_design

Get the docs landing page design — the page served at the docs base_url itself, listing the documentation. Returns both live and staged fields.

get_docs_index_design

Get the documentation settings: whether docs are switched on, the URL prefix they live under, how the docs index describes itself for search and social sharing, and which navigation elements are shown.

get_docs_settings

Get an error page by ID. Returns both live and staged content fields.

get_error_page

Get a form by ID. Returns both live and staged content fields.

get_form

Get global CSS, JavaScript, and Tailwind theme config that applies to all pages and layouts. Returns both live and staged fields. Update with update_global_code, then publish_global_code to push live.

get_global_code

Get a page layout by ID. Returns both live and staged content fields.

get_layout

Get a CMS page by ID. Returns both live (heex/css/js) and staged (heex_staged/css_staged/js_staged) content. Staged fields contain unpublished edits.

get_page

Get site identity and structured data settings. Includes site title, tagline, business info (type, description, phone, email, address, coordinates), social profiles, opening hours, and price range. These fields power the site-wide Organization/LocalBusiness JSON-LD that's emitted on every page. For per-page schema (FAQPage, Article, Product, raw JSON-LD), see the `structured_data_staged` param on update_page.

get_site_identity

Get the account's staging status: whether a staging site exists, the live and staging sites, and whether the most recent promotion can be undone by restoring the previous site.

get_staging_status

Get the account's analytics, tag-management, and search-console integration IDs: Google Analytics 4 (GA4), Google Tag Manager (GTM), Facebook Pixel, and Google/Bing site-verification codes. These are account-scoped (one set per account, shared across all of the account's sites and preserved across staging→live promotes) and are injected into the `<head>` of every published page. Tracking is suppressed on staging previews and in non-production environments, so it only fires on the live site.

get_tracking_settings