OpenAPI JSON

API resource

Form Monitors

Form Monitors watch configured form URLs for submission availability. Use Form Monitors to list and inspect current form-monitor configuration, create monitors for accessible sites, change monitor settings, enable or disable selected monitors, and request immediate checks.

11 operations · Each operation has a stable reference URL.

GET

List form monitors

Lists form monitors across sites available to the authenticated account. `perPage` values above `100` are capped to `100`.

/monitoring/form-monitors
POST

Create form monitor

Creates one enabled form monitor for an accessible site and detected form URL. Get `form_id` from the List Site Forms API (`GET /sites/{site_id}/forms`) and use the returned form’s `id` as `form_monitor.form_id`.

/monitoring/form-monitors
GET

Show form monitor

Shows one form monitor available to the authenticated account.

/monitoring/form-monitors/{form_monitor_id}
POST

Update form monitor

Updates only the form monitor's `interval`. All other supplied fields, including `form_id`, `url`, `site_id`, `enabled`, `status`, and `state`, are ignored. The monitor must be enabled and the site's plan must allow form monitoring. A changed interval schedules configuration sync and publishes an update event. An unchanged interval returns the current monitor without persistence, sync, or an update event.

/monitoring/form-monitors/{form_monitor_id}/update
POST

Delete form monitors

Soft-deletes selected form monitors and reports immediate per-item outcomes. Successful deletions request configure sync.

/monitoring/form-monitors/delete
POST

Enable form monitors

Enables selected form monitors and reports immediate per-item outcomes. Successful enablement requests configure sync. Plan access is checked per item; unavailable plans return `plan_upgrade_required` in the HTTP 200 item errors while eligible items continue.

/monitoring/form-monitors/enable
POST

Disable form monitors

Disables selected form monitors and reports immediate per-item outcomes. Successful disablement requests configure sync. Disabling does not require Form Monitoring plan access.

/monitoring/form-monitors/disable
POST

Refresh form monitors

Requests immediate checks for selected form monitors and reports immediate per-item outcomes. A successful item means the request was accepted or skipped by cooldown rules, not that the check completed. Plan access is checked per item; unavailable plans return `plan_upgrade_required` in the HTTP 200 item errors while eligible items continue.

/monitoring/form-monitors/refresh
GET

List form monitor probes

Returns retained probe snapshots for one form monitor in your account.

/monitoring/form-monitors/{form_monitor_id}/probes
GET

List Site forms

List detected forms for this Site that have at least one unmonitored URL. Forms whose URLs are all monitored are excluded. Extra query parameters and body fields are ignored.

/sites/{site_id}/forms
POST

Refresh Site forms

Refresh all forms for this Site asynchronously. No inputs are required. Follow the returned task for status, then list forms again. Extra query parameters and body fields are ignored.

/sites/{site_id}/forms/refresh