PUT /v1/security/firewall/config

Set the firewall configuration to provided rules and settings. Creates or overwrite the existing firewall configuration.

Servers

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Query parameters

Name Type Required Description
projectId String Yes
teamId String No

The Team identifier to perform the request on behalf of.

slug String No

The Team slug to perform the request on behalf of.

Request body fields

Name Type Required Description
ips[] Array No
ips[].id String No
ips[].notes String No
ips[].action String Yes

Possible values:

  • "deny"
  • "log"
  • "challenge"
  • "bypass"
ips[].hostname String Yes
ips[].ip String Yes
rules[] Array No
rules[].id String No
rules[].name String Yes
rules[].description String No
rules[].active Boolean Yes
rules[].action Object Yes
rules[].action.mitigate Object No
rules[].action.mitigate.actionDuration String No
rules[].action.mitigate.bypassSystem Boolean No
rules[].action.mitigate.action String Yes

Possible values:

  • "log"
  • "deny"
  • "challenge"
  • "bypass"
  • "rate_limit"
  • "redirect"
rules[].action.mitigate.rateLimit No
rules[].action.mitigate.redirect No
rules[].conditionGroup[] Array Yes
rules[].conditionGroup[].conditions[] Array Yes
rules[].conditionGroup[].conditions[].neg Boolean No
rules[].conditionGroup[].conditions[].key String No
rules[].conditionGroup[].conditions[].op String Yes

Possible values:

  • "gt"
  • "gte"
  • "eq"
  • "lt"
  • "nex"
  • "sub"
  • "pre"
  • "ninc"
  • "suf"
  • "inc"
  • "lte"
  • "neq"
  • "re"
  • "ex"
rules[].conditionGroup[].conditions[].type String Yes

Possible values:

  • "protocol"
  • "raw_path"
  • "method"
  • "ip_address"
  • "geo_as_number"
  • "path"
  • "region"
  • "host"
  • "geo_country_region"
  • "ja4_digest"
  • "rate_limit_api_id"
  • "geo_city"
  • "cookie"
  • "scheme"
  • "geo_continent"
  • "geo_country"
  • "target_path"
  • "environment"
  • "query"
  • "header"
  • "user_agent"
  • "ja3_digest"
rules[].conditionGroup[].conditions[].value No
managedRules Object No
crs Object No
crs.gen Object No
crs.gen.active Boolean Yes
crs.gen.action String Yes

Possible values:

  • "deny"
  • "log"
crs.lfi Object No
crs.lfi.active Boolean Yes
crs.lfi.action String Yes

Possible values:

  • "deny"
  • "log"
crs.sqli Object No
crs.sqli.active Boolean Yes
crs.sqli.action String Yes

Possible values:

  • "deny"
  • "log"
crs.sd Object No
crs.sd.active Boolean Yes
crs.sd.action String Yes

Possible values:

  • "deny"
  • "log"
crs.java Object No
crs.java.active Boolean Yes
crs.java.action String Yes

Possible values:

  • "deny"
  • "log"
crs.rce Object No
crs.rce.active Boolean Yes
crs.rce.action String Yes

Possible values:

  • "deny"
  • "log"
crs.sf Object No
crs.sf.active Boolean Yes
crs.sf.action String Yes

Possible values:

  • "deny"
  • "log"
crs.ma Object No
crs.ma.active Boolean Yes
crs.ma.action String Yes

Possible values:

  • "deny"
  • "log"
crs.rfi Object No
crs.rfi.active Boolean Yes
crs.rfi.action String Yes

Possible values:

  • "deny"
  • "log"
crs.php Object No
crs.php.active Boolean Yes
crs.php.action String Yes

Possible values:

  • "deny"
  • "log"
crs.xss Object No
crs.xss.active Boolean Yes
crs.xss.action String Yes

Possible values:

  • "deny"
  • "log"
firewallEnabled Boolean Yes

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.