getfirewallconfigresponsebody.md

GetFirewallConfigResponseBody

If the firewall configuration includes a custom managed ruleset, it will include a crs item that has the following values: sd: Scanner Detection ma: Multipart Attack lfi: Local File Inclusion Attack rfi: Remote File Inclusion Attack rce: Remote Execution Attack php: PHP Attack gen: Generic Attack xss: XSS Attack sqli: SQL Injection Attack sf: Session Fixation Attack java: Java Attack

Example Usage

import { GetFirewallConfigResponseBody } from "@vercel/sdk/models/getfirewallconfigop.js";

let value: GetFirewallConfigResponseBody = {
  ownerId: "<id>",
  projectKey: "<value>",
  id: "<id>",
  version: 5092.12,
  updatedAt: "1744826109504",
  firewallEnabled: false,
  crs: {
    sd: {
      active: false,
      action: "deny",
    },
    ma: {
      active: false,
      action: "deny",
    },
    lfi: {
      active: false,
      action: "deny",
    },
    rfi: {
      active: false,
      action: "deny",
    },
    rce: {
      active: false,
      action: "log",
    },
    php: {
      active: false,
      action: "deny",
    },
    gen: {
      active: false,
      action: "log",
    },
    xss: {
      active: false,
      action: "deny",
    },
    sqli: {
      active: false,
      action: "log",
    },
    sf: {
      active: false,
      action: "log",
    },
    java: {
      active: false,
      action: "log",
    },
  },
  rules: [
    {
      id: "<id>",
      name: "<value>",
      active: false,
      conditionGroup: [
        {
          conditions: [
            {
              type: "host",
              op: "gt",
            },
          ],
        },
      ],
      action: {},
    },
  ],
  ips: [
    {
      id: "<id>",
      hostname: "vast-zen.net",
      ip: "2e19:ddd0:ccfc:9b0b:d351:aa32:ef81:fb58",
      action: "challenge",
    },
  ],
  changes: [
    {},
  ],
};

Fields

Field	Type	Required	Description
ownerId	string	✔️	N/A
projectKey	string	✔️	N/A
id	string	✔️	N/A
version	number	✔️	N/A
updatedAt	string	✔️	N/A
firewallEnabled	boolean	✔️	N/A
crs	models.Crs	✔️	Custom Ruleset
rules	models.GetFirewallConfigRules[]	✔️	N/A
ips	models.Ips[]	✔️	N/A
changes	models.Changes[]	✔️	N/A
managedRules	Record<string, models.ManagedRules>	➖	N/A