hosting
GET /v1/sites/{siteId}/firewall
Get a site's own firewall, the platform rules beneath it, and its flood status.
Authentication
Send an API key as a bearer token. The key must carry the sites.view permission; a key without it is refused with 403, not 404.
This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.
Try it
Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.
curl -X GET https://api.zinndigital.com/v1/sites/{siteId}/firewall \
-H "Authorization: Bearer zdk_live_…"Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console
Details
The customer's own rules (login, xmlrpc, rule_sets, trusted, admin_trusted_only, challenge_until), the always-on platform rules (platform_rules, keys only — not editable), whether the newest save is live on the server (apply_state), and the flood guard's protection now (flood) and recently (recent_floods). 404 for a site that is not the caller's or is not on one of our servers. Requires sites.view.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
siteId (path) | Uuid | Yes | Site ID (UUIDv7). |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
site_id | string | Yes | — |
login | string<standard, strict> | Yes | Login attempts per visitor per 5 minutes — standard 10 (the platform floor), strict 5. |
xmlrpc | string<limited, blocked> | Yes | limited: XML-RPC answers under the login limit; blocked: refused outright. |
rule_sets | string<block_author_scans, block_php_in_uploads, block_info_files, block_aggressive_bots>[] | Yes | — |
available_rule_sets | string[] | Yes | — |
trusted | string[] | Yes | Addresses never challenged and exempt from the site's own rule sets. |
admin_trusted_only | boolean | Yes | Only trusted addresses may reach the login page and wp-admin. |
challenge_until | object | Yes | The customer's own "check every visitor" mode runs until then; null is off. |
platform_rules | string[] | Yes | Always-on platform rules (keys). Not editable. |
apply_state | string<applied, pending, failed> | Yes | — |
applied_at | object | Yes | — |
apply_error | string | Yes | — |
flood | SiteFirewallFlood | null | Yes | — |
recent_floods | SiteFirewallFlood[] | Yes | — |
Errors this endpoint can return
401 · 403 · 404 · 429