Mini Shell

rules disable:
  help: Add a new rule to the disabled rules list
  return_type: NullAgentResponse
  cli:
    users:
      - root
  type: dict
  schema:
    id:
      help: ID number of the rule provided by the firewall plugin.
      type: string
      required: true
    plugin:
      help: Firewall plugin name. Can be one of the following [modsec | ossec | lfd]
      type: string
      required: true
      allowed:
        - ossec
        - modsec
        - lfd
        - cphulk
    domains:
      help: List of domains to disable a rule for. Can only be used with modsec type.
      type: list
      schema:
        type: string
    name:
      help: Name of the added rule or details of the rule from ModSecurity or OSSEC.
      type: string
      required: true

rules enable:
  help: Remove a rule from the disabled rules list
  return_type: NullAgentResponse
  cli:
    users:
      - root
  type: dict
  schema:
    id:
      help: ID number of the rule provided by the firewall plugin.
      type: string
      required: true
    plugin:
      help: Firewall plugin name. Can be one of the following [modsec | ossec | lfd]
      type: string
      required: true
      allowed:
        - ossec
        - modsec
        - lfd
        - cphulk

rules list-disabled:
  help: Display the list of the disabled rules
  cli:
    users:
      - root
  type: dict
  return_type: BlockedRulesAgentResponse
  schema:
    limit:
      type: integer
      default: 100
    offset:
      type: integer
      default: 0
    order_by:
      type: list
      schema:
        type: order_by
        coerce: order_by
      nullable: true

rules update-app-specific-rules:
  help: Allows to update WAF ruleset configurator immediately (generally, executed by cron)
  cli:
    users:
      - root
    require_rpc: any

rules update-shared-disabled-rules:
  help: Force reload modsec disabled rules config
  cli:
    users:
      - root