Create BurrowGuard site
create_burrowguard_siteCreate a BurrowGuard site for a form. Free. Returns the public site_key for the page and the secret, once: write the secret straight to the app's environment as GROUNDMAIL_BURROWGUARD_SECRET, never into source code, and do not repeat it in chat. Then add the script and beside the email field, and call POST /burrowguard/verify from the server. Install: https://docs.groundmail.dev/burrowguard
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | A label for this form, for example "Sign-up form" | |
| watch_only | No | Run every check and show what would be blocked, without blocking anyone: verify always answers success. Good for the first week on a live form | |
| allowed_hostnames | No | Hostnames the form runs on. Include localhost while building. Required unless email_checks_only is true. | |
| email_checks_only | No | For a form already behind a captcha: no script, tag or box, and verify takes just the email. allowed_hostnames can then be left out | |
| block_free_webmail | No | For B2B forms: turn away Gmail, Outlook and other personal addresses | |
| allow_data_center_ips | No | Let through visitors on hosting and cloud networks |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | Site id | |
| name | Yes | Label for this form | |
| secret | Yes | Site secret (gm_bg_…), returned once. Put it in the app environment as GROUNDMAIL_BURROWGUARD_SECRET | |
| site_key | Yes | Public site key (gm_site_…): goes in the page | |
| created_at | No | Created at (ISO 8601) | |
| watch_only | No | Every check runs and is recorded, and verify always answers success | |
| last_check_at | No | When this site last had a check (ISO 8601) | |
| allowed_hostnames | Yes | Hostnames the form runs on | |
| email_checks_only | No | No script or token: verify takes the email and runs the address checks only | |
| block_free_webmail | No | Turns away personal addresses such as Gmail and Outlook | |
| allow_data_center_ips | No | Lets through visitors on hosting and cloud networks |