Skip to content

Protect your applications and APIs across any infrastructure. See the product now →

Open wallarm.com

Wallarm Documentation Wallarm Scanner overview

Initializing search

Free Trial Free Trial

Product guides
Open source: API Firewall
API docs
FAQ
Demo videos

Wallarm Documentation

Product guides
Product guides

Version 3.6 Version 3.4 Version 3.2 Version 2.18 ⚠
- Home
- About Wallarm
  About Wallarm
  
  Version 3.6 Version 3.4 Version 3.2 Version 2.18 ⚠
  - How Wallarm API Security works
  - Detecting attacks
  - Detecting vulnerabilities
  - Discovering API structure
  - Attack and vulnerability types
  - Data management policies
    Data management policies
    
    Version 3.6 Version 3.4 Version 3.2 Version 2.18 ⚠
    
    Security model of shared responsibility for clients' data
    
    Data retention policy
  - Wallarm API Security subscription plans
  - Wallarm API Security deployment and maintenance best practices
- Quick start
- Administrator Guide
  Administrator Guide
  
  Version 3.6 Version 3.4 Version 3.2 Version 2.18 ⚠
  - Introduction to the administrator guide
  - Installation
    Installation
    
    Version 3.6 Version 3.4 Version 3.2 Version 2.18 ⚠
    
    Deployment options
    
    NGINX
    NGINX
    
    Version 3.6 Version 3.4 Version 3.2 Version 2.18 ⚠
    
    NGINX installation options overview
    
    Installing as a dynamic module for NGINX stable
    
    Installing as a dynamic module for NGINX from Debian/CentOS repositories
    
    Installing as a dynamic module for NGINX Plus
    
    Running Docker NGINX‑based image
    
    Kubernetes
    Kubernetes
    
    Version 3.6 Version 3.4 Version 3.2 Version 2.18 ⚠
    
    Installing NGINX Ingress Controller with integrated Wallarm services
    
    Installing Wallarm as the sidecar container
    Installing Wallarm as the sidecar container
    
    Version 3.6 Version 3.4 Version 3.2 Version 2.18 ⚠
    
    How it works
    
    Kubernetes deployment based on Helm charts
    
    Kubernetes deployment based on manifests
    
    Cloud platforms
    Cloud platforms
    
    Version 3.6 Version 3.4 Version 3.2 Version 2.18 ⚠
    
    Amazon AWS
    Amazon AWS
    
    Version 3.6 Version 3.4 Version 3.2 Version 2.18 ⚠
    
    AWS Marketplace image deployment
    AWS Marketplace image deployment
    
    Version 3.6 Version 3.4 Version 3.2 Version 2.18 ⚠
    
    Creating and configuring an AMI with the Wallarm node
    
    Creating an Amazon Machine Image
    
    Deploying Wallarm node using Terraform
    Deploying Wallarm node using Terraform
    
    Version 3.6 Version 3.4 Version 3.2 Version 2.18 ⚠
    
    Introduction to using Terraform for the filtering node deployment
    
    Quick start with Terraform example code
    
    Description of example Terraform code
    
    Setting up filtering node auto scaling
    Setting up filtering node auto scaling
    
    Version 3.6 Version 3.4 Version 3.2 Version 2.18 ⚠
    
    Overview of the filtering node auto scaling configuration on AWS
    
    Setting up filtering node auto scaling
    
    Setting up incoming request balancing on AWS
    
    Deployment of the Wallarm node Docker image to AWS
    
    Installation of the filtering node from DEB or RPM packages on AWS
    
    Google Cloud Platform
    Google Cloud Platform
    
    Version 3.6 Version 3.4 Version 3.2 Version 2.18 ⚠
    
    GCP Marketplace image deployment
    GCP Marketplace image deployment
    
    Version 3.6 Version 3.4 Version 3.2 Version 2.18 ⚠
    
    Creating and configuring a GCP instance with the Wallarm node
    
    Creating an image with the Wallarm filtering node
    
    Setting up filtering node auto scaling
    Setting up filtering node auto scaling
    
    Version 3.6 Version 3.4 Version 3.2 Version 2.18 ⚠
    
    Overview of the filtering node auto scaling configuration on GCP
    
    Creating a filtering node instance template on GCP
    
    Creating a managed instance group with enabled auto scaling
    
    Setting up incoming request balancing on GCP
    
    Deployment of the Wallarm node Docker image to GCP
    
    Installation of the filtering node from DEB or RPM packages on GCP
    
    Microsoft Azure
    Microsoft Azure
    
    Version 3.6 Version 3.4 Version 3.2 Version 2.18 ⚠
    
    Deployment of the Wallarm node Docker image to Azure
    
    Installation of the filtering node from DEB or RPM packages on Azure
    
    Alibaba Cloud
    Alibaba Cloud
    
    Version 3.6 Version 3.4 Version 3.2 Version 2.18 ⚠
    
    Deployment of the Wallarm node Docker image to Alibaba Cloud
    
    Installation of the filtering node from DEB or RPM packages on Alibaba Cloud
    
    Deployment of the filtering node to the private clouds
    
    Installing on the Kong platform
    
    Running Docker Envoy‑based image
    
    Separate postanalytics module installation
    
    Checking the filtering node operation
    
    Deploying the multi‑tenant node
    Deploying the multi‑tenant node
    
    Version 3.6 Version 3.4 Version 3.2 Version 2.18 ⚠
    
    Multitenancy overview
    
    Creating tenant accounts in Wallarm Console
    
    Deploying and configuring multi-tenant node
    
    Deploying Wallarm CDN node
  - Configuration
    Configuration
    
    Version 3.6 Version 3.4 Version 3.2 Version 2.18 ⚠
    
    Configuration options for the NGINX‑based Wallarm node
    
    Configuration options for the Envoy‑based Wallarm node
    
    Filtration mode configuration
    
    Configuration of the blocking page and error code
    
    Configuration of the Statistics Service
    
    Configuration of brute force protection
    
    Fine‑tuning of Wallarm Ingress Controller
    Fine‑tuning of Wallarm Ingress Controller
    
    Version 3.6 Version 3.4 Version 3.2 Version 2.18 ⚠
    
    Configuration Parameters
    
    Best Practices in Wallarm Ingress Controller Configuration
    Best Practices in Wallarm Ingress Controller Configuration
    
    Version 3.6 Version 3.4 Version 3.2 Version 2.18 ⚠
    
    Proper Reporting of End‑user Public IP Address
    
    High Availability Considerations
    
    Ingress Controller Monitoring
    
    Allocating Resources for Wallarm Node
    
    Analyzing Mirrored Traffic with NGINX
    
    Configuration of Filter Node for Separated Customer Environments
    Configuration of Filter Node for Separated Customer Environments
    
    Version 3.6 Version 3.4 Version 3.2 Version 2.18 ⚠
    
    How Filtering Node Works in Separated Environments
    
    Recommendations on Configuring the Filter Node for Separated Environments
    
    Access to Wallarm API via Proxy
    
    Identifying an original client IP address if using a proxy or load balancer
    
    Filtering node and Wallarm Cloud synchronization configuration
    
    Working with Filter Node Logs
    
    Configuring dynamic DNS resolution in NGINX
    
    Using Single Sign‑On (SSO)
    Using Single Sign‑On (SSO)
    
    Version 3.6 Version 3.4 Version 3.2 Version 2.18 ⚠
    
    Overview of integration with the SAML SSO solution
    
    Connecting SSO with G Suite
    Connecting SSO with G Suite
    
    Version 3.6 Version 3.4 Version 3.2 Version 2.18 ⚠
    
    Overview of Steps for Connecting SSO with G Suite
    
    Step 1: Generating Parameters on the Wallarm Side (G Suite)
    
    Step 2: Creating and Configuring an Application in G Suite
    
    Step 3: Transferring G Suite Metadata to the Wallarm Setup Wizard
    
    Step 4: Allowing Access to the Wallarm Application on the G Suite Side
    
    Connecting SSO with Okta
    Connecting SSO with Okta
    
    Version 3.6 Version 3.4 Version 3.2 Version 2.18 ⚠
    
    Overview of Steps for Connecting SSO with Okta
    
    Step 1: Generating Parameters on the Wallarm Side (Okta)
    
    Step 2: Creating and Configuring an Application in Okta
    
    Step 3: Transferring Okta Metadata to the Wallarm Setup Wizard
    
    Step 4: Allowing Access to the Wallarm Application on the Okta Side
    
    Configuring SSO Authentication for Users
    
    Changing the Configured SSO Authentication
  - Monitoring & Failover
    Monitoring & Failover
    
    Version 3.6 Version 3.4 Version 3.2 Version 2.18 ⚠
    
    Configuring a Failover Method
    
    Using a Mirrored Wallarm Repository
    Using a Mirrored Wallarm Repository
    
    Version 3.6 Version 3.4 Version 3.2 Version 2.18 ⚠
    
    How to Mirror the Wallarm Repository for CentOS
    
    How to Install Wallarm Packages from the Local JFrog Artifactory Repository for CentOS
    
    Monitoring the Filter Node
    Monitoring the Filter Node
    
    Version 3.6 Version 3.4 Version 3.2 Version 2.18 ⚠
    
    Introduction to the filtering node monitoring
    
    How to Fetch Metrics
    
    Available Metrics
    
    Examples of Exporting and Working with Metrics
    Examples of Exporting and Working with Metrics
    
    Version 3.6 Version 3.4 Version 3.2 Version 2.18 ⚠
    
    Grafana
    Grafana
    
    Version 3.6 Version 3.4 Version 3.2 Version 2.18 ⚠
    
    Exporting Metrics to InfluxDB via the `collectd` Network Plugin
    
    Exporting Metrics to Graphite via the `collectd` Write Plugin
    
    Working with the Filter Node Metrics in Grafana
    
    Nagios
    Nagios
    
    Version 3.6 Version 3.4 Version 3.2 Version 2.18 ⚠
    
    Exporting Metrics to Nagios via the `collectd-nagios` Utility
    
    Working with the Filter Node Metrics in Nagios
    
    Zabbix
    Zabbix
    
    Version 3.6 Version 3.4 Version 3.2 Version 2.18 ⚠
    
    Exporting Metrics to Zabbix via the `collectd-nagios` Utility
    
    Working with the Filter Node in Zabbix
  - Operations
    Operations
    
    Version 3.6 Version 3.4 Version 3.2 Version 2.18 ⚠
    
    Configuring SELinux
    
    Wallarm User Acceptance Testing Checklist
    
    Learning the amount of requests per month handled by the application
  - Support of the Scanner Operation
    Support of the Scanner Operation
    
    Version 3.6 Version 3.4 Version 3.2 Version 2.18 ⚠
    
    Best practices for configuring the Active threat verification feature
    
    Scanner Addresses
    Scanner Addresses
    
    Version 3.6 Version 3.4 Version 3.2 Version 2.18 ⚠
    
    Scanner Addresses for EU Cloud
    
    Scanner Addresses for US Cloud
    
    Contacting Wallarm Support to Stop the Resource Scanner
- User Guide
  User Guide
  
  Version 3.6 Version 3.4 Version 3.2 Version 2.18 ⚠
  - Introduction to the User Guide
  - Dashboards
    Dashboards
    
    Version 3.6 Version 3.4 Version 3.2 Version 2.18 ⚠
    
    Dashboards Overview
    
    API Security Dashboard
    
    Scanner Dashboard
  - Events
    Events
    
    Version 3.6 Version 3.4 Version 3.2 Version 2.18 ⚠
    
    Checking Events
    
    Analyzing Attacks
    
    Working with False Attacks
    
    Verifying Attacks
  - Vulnerabilities
    Vulnerabilities
    
    Version 3.6 Version 3.4 Version 3.2 Version 2.18 ⚠
    
    Checking Vulnerabilities
    
    Analyzing Vulnerabilities
    
    Closing and Opening Vulnerabilities
    
    Rechecking Vulnerabilities
    
    Working with False Vulnerabilities
  - Search and Filters
    Search and Filters
    
    Version 3.6 Version 3.4 Version 3.2 Version 2.18 ⚠
    
    Using Search and Filters
    
    Creating a Custom Report
  - Scanner
    Scanner
    
    Version 3.6 Version 3.4 Version 3.2 Version 2.18 ⚠
    
    Scanner Overview
    
    Working with the Scope
    
    Reserved Domains
    
    Scanner Settings
    Scanner Settings
    
    Version 3.6 Version 3.4 Version 3.2 Version 2.18 ⚠
    
    General Scanner Settings
    
    Configuring Scanner Modules
  - Nodes
    Nodes
    
    Version 3.6 Version 3.4 Version 3.2 Version 2.18 ⚠
    
    Filtering nodes overview
    
    Regular filtering nodes
    
    Cloud filtering nodes
    
    CDN filtering nodes
  - Rules
    Rules
    
    Version 3.6 Version 3.4 Version 3.2 Version 2.18 ⚠
    
    Application Profile Rules
    
    Inspecting Application Profile Rules
    
    Adding Rules in the Application Profile
    
    Building and unloading of a custom ruleset
    
    Analyzing and Parsing Requests
    
    Available rule types
    Available rule types
    
    Version 3.6 Version 3.4 Version 3.2 Version 2.18 ⚠
    
    Managing request parsers
    
    Setting response headers
    
    Filtration mode rule
    
    Rules for Data Masking
    
    Customizing the module for active threat verification
    
    Virtual Patching
    
    User‑Defined Detection Rules
    
    Ignoring certain attack types
    
    Ignoring attack signs in the binary data
  - Triggers
    Triggers
    
    Version 3.6 Version 3.4 Version 3.2 Version 2.18 ⚠
    
    Working with triggers
    
    Trigger examples
  - IP lists
    IP lists
    
    Version 3.6 Version 3.4 Version 3.2 Version 2.18 ⚠
    
    Types and core logic of IP lists
    
    IP address whitelist
    
    IP address greylist
    
    IP address blacklist
  - Settings
    Settings
    
    Version 3.6 Version 3.4 Version 3.2 Version 2.18 ⚠
    
    Profile
    
    General
    
    Subscriptions
    
    Applications
    
    Users
    
    Activity Log
    
    Integrations
    Integrations
    
    Version 3.6 Version 3.4 Version 3.2 Version 2.18 ⚠
    
    Integrations Overview
    
    Email Report
    
    Slack
    
    Telegram
    
    Microsoft Teams
    
    Opsgenie
    
    InsightConnect
    
    PagerDuty
    
    Splunk
    
    Sumo Logic
    
    Webhook
    Webhook
    
    Version 3.6 Version 3.4 Version 3.2 Version 2.18 ⚠
    
    Webhook Integration Overview
    
    Examples
    Examples
    
    Version 3.6 Version 3.4 Version 3.2 Version 2.18 ⚠
    
    IBM QRadar via Fluentd
    
    IBM QRadar via Logstash
    
    Splunk Enterprise via Fluentd
    
    Splunk Enterprise via Logstash
    
    Micro Focus ArcSight Logger via Fluentd
    
    Micro Focus ArcSight Logger via Logstash
  - Using single sign‑on to Wallarm portal
- Upgrading and Migrating
  Upgrading and Migrating
  
  Version 3.6 Version 3.4 Version 3.2 Version 2.18 ⚠
  - What is new in Wallarm node 3.6
  - Filtering node versioning policy
  - Recommendations for a safe node upgrade process
  - Filtering node upgrade instructions
    Filtering node upgrade instructions
    
    Version 3.6 Version 3.4 Version 3.2 Version 2.18 ⚠
    
    Upgrading Wallarm NGINX modules
    
    Upgrading the postanalytics module
    
    Upgrading the Wallarm Docker NGINX- or Envoy-based image
    
    Upgrading NGINX Ingress controller with integrated Wallarm modules
    
    Upgrading the cloud node image
    
    Upgrading Wallarm CDN node
  - Upgrading Wallarm node 2.18 and lower
    Upgrading Wallarm node 2.18 and lower
    
    Version 3.6 Version 3.4 Version 3.2 Version 2.18 ⚠
    
    What is new in Wallarm node (if upgrading node 2.18 or lower)
    
    Upgrading Wallarm NGINX modules 2.18 or lower
    
    Upgrading the postanalytics module 2.18 or lower
    
    Upgrading the Docker NGINX- or Envoy-based image of Wallarm node 2.18 or lower
    
    Upgrading NGINX Ingress controller with integrated Wallarm modules 2.18 or lower
    
    Upgrading the cloud node image 2.18 or lower
    
    Migrating whitelists and blacklists from Wallarm node 2.18 and lower to 3.x
- Appendix
  Appendix
  
  Version 3.6 Version 3.4 Version 3.2 Version 2.18 ⚠
  - Glossary
Open source: API Firewall
Open source: API Firewall

Version 3.6 Version 3.4 Version 3.2 Version 2.18 ⚠
API docs
API docs

Version 3.6 Version 3.4 Version 3.2 Version 2.18 ⚠
- Wallarm API overview
- Wallarm API request examples
FAQ
FAQ

Version 3.6 Version 3.4 Version 3.2 Version 2.18 ⚠
Demo videos
Demo videos

Version 3.6 Version 3.4 Version 3.2 Version 2.18 ⚠
- Wallarm API Security overview and deployment options
- Inspecting events detected by the Wallarm filtering node
- Wallarm Scanner overview Wallarm Scanner overview
  Table of contents
  - Wallarm Scanner overview
  - Configuring Wallarm Scanner
- Notifications and reactions to events detected by Wallarm
- Wallarm FAST overview and integration options

Table of contents

Wallarm Scanner overview
Configuring Wallarm Scanner

Wallarm Scanner overview¶

Wallarm Scanner overview¶

Related documentation articles

Scanner overview
Configuring Scanner

Configuring Wallarm Scanner¶

Related documentation articles

Scanner overview
Configuring Scanner

Wallarm service status:

Terms of services | Privacy policy | Cookie policy | 2022 © Wallarm Inc.