Filters, rules and taint

Get es-python's web protection settings

Returns the web protection settings stored in one scope (machine query param = a machine public_id, '' or absent = your account) and the values that apply where a setting is not stored there: the defaults for the account, the account's values for a machine. Keys: client (header or ip), client_header (a header name), client_proxies (1-16), request_context (on/off), rate (on/off), rate.limit (1-1000000 requests), rate.window (1-86400 seconds), rate.action (block or report), block (on/off: refuse the addresses on your blocked clients list), check.smuggling, check.reflect, check.redirect, check.host, check.cards, check.headers (on/off), hosts (your host names, comma separated, for check.host), routes (on/off: keep the route inventory), and, on the account only, autoblock (off, attacks or severe) and autoblock.hours (1-720). A stored value of "" means not set in this scope. can_block is false when your plan has no Raise: blocking settings then cannot be saved, and inherited values show them downgraded to report-only.

This is a read: a read-only API key may call it.

get/api/web_protection/

Request

  • Base URL: https://eyalsec.com
  • URL: https://eyalsec.com/api/web_protection/
  • Auth: one of:
    • API key in header X-API-Key
    • API key in cookie __Host-es2session

Query parameters

machinestring

Machine public_id to scope to; omit for your account.

Response

OK. For example:

{
  "settings": {"rate": "on", "rate.limit": "", "client_header": "X-Real-IP", …one entry for every key},
  "inherited": {"rate": "off", "rate.limit": "100", "client_header": "X-Forwarded-For", …},
  "can_block": true
}
object required

Changes

No recorded changes to this operation across all 1 revision of this API.