Skip to content

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

Open wallarm.com

Wallarm Documentation Changelog & news

Initializing search

Try for free Try for free

Product guides
Open source: API Firewall
Security testing: FAST
API docs
FAQ
Demo videos
Changelog & news

Wallarm Documentation

Product guides
Product guides

Version 4.6 Version 4.4 Version 4.2 Version 4.0 ⚠
- Home
- How Wallarm Works
  How Wallarm Works
  
  Version 4.6 Version 4.4 Version 4.2 Version 4.0 ⚠
  - Wallarm platform overview
  - Detecting attacks
  - Detecting vulnerabilities
  - Discovering API inventory
  - API Leaks Remediation
  - API Abuse Prevention
  - Attack and vulnerability types
  - Data management policies
    Data management policies
    
    Version 4.6 Version 4.4 Version 4.2 Version 4.0 ⚠
    
    Security model of shared responsibility for clients' data
    
    Data retention policy
  - Wallarm subscription plans
  - Wallarm solution deployment and maintenance best practices
- Quick Start
- Deployment
  Deployment
  
  Version 4.6 Version 4.4 Version 4.2 Version 4.0 ⚠
  - Deployment Options
  - Out-of-Band
    Out-of-Band
    
    Version 4.6 Version 4.4 Version 4.2 Version 4.0 ⚠
    
    Overview
    
    Mirroring by Web Servers
    Mirroring by Web Servers
    
    Version 4.6 Version 4.4 Version 4.2 Version 4.0 ⚠
    
    Overview
    
    AWS Terraform Module
    
    AWS AMI
    
    GCP Machine Image
    
    Mirroring by Cloud Platforms
    Mirroring by Cloud Platforms
    
    Version 4.6 Version 4.4 Version 4.2 Version 4.0 ⚠
    
    AWS VPC Mirroring
  - Public Clouds
    Public Clouds
    
    Version 4.6 Version 4.4 Version 4.2 Version 4.0 ⚠
    
    Amazon Web Services
    Amazon Web Services
    
    Version 4.6 Version 4.4 Version 4.2 Version 4.0 ⚠
    
    AMI
    
    ECS
    
    Terraform Module
    Terraform Module
    
    Version 4.6 Version 4.4 Version 4.2 Version 4.0 ⚠
    
    Proxy in AWS VPC
    
    Proxy for Amazon API Gateway
    
    OOB for Web Server Mirroring
    
    OOB for AWS VPC Mirroring
    
    Google Cloud
    Google Cloud
    
    Version 4.6 Version 4.4 Version 4.2 Version 4.0 ⚠
    
    Machine Image
    
    GCE
    
    Microsoft Azure
    Microsoft Azure
    
    Version 4.6 Version 4.4 Version 4.2 Version 4.0 ⚠
    
    Azure Container Instances
    
    Alibaba Cloud
    Alibaba Cloud
    
    Version 4.6 Version 4.4 Version 4.2 Version 4.0 ⚠
    
    ECS
  - CDN
  - Kubernetes
    Kubernetes
    
    Version 4.6 Version 4.4 Version 4.2 Version 4.0 ⚠
    
    Ingress
    Ingress
    
    Version 4.6 Version 4.4 Version 4.2 Version 4.0 ⚠
    
    NGINX Ingress Controller
    
    Kong Ingress Controller
    Kong Ingress Controller
    
    Version 4.6 Version 4.4 Version 4.2 Version 4.0 ⚠
    
    Deploy
    
    Customization
    
    Sidecar
    Sidecar
    
    Version 4.6 Version 4.4 Version 4.2 Version 4.0 ⚠
    
    Deploy
    
    Customization
    
    Helm Chart Values
    
    Pod's Annotations
  - Packages
    Packages
    
    Version 4.6 Version 4.4 Version 4.2 Version 4.0 ⚠
    
    Docker Image (NGINX)
    
    Docker Image (Envoy)
    
    Linux Packages for NGINX
    
    Linux Packages for NGINX Plus
    
    Linux Packages for NGINX Distro
    
    AWS AMI
    
    GCP Machine Image
    
    Terraform Module for AWS
  - Additional
    Additional
    
    Version 4.6 Version 4.4 Version 4.2 Version 4.0 ⚠
    
    Chaining Wallarm and Ingress Controllers
    
    Auto Scaling
    Auto Scaling
    
    Version 4.6 Version 4.4 Version 4.2 Version 4.0 ⚠
    
    Amazon Web Services
    Amazon Web Services
    
    Version 4.6 Version 4.4 Version 4.2 Version 4.0 ⚠
    
    Overview
    
    Creating an Amazon Machine Image
    
    Setting up Filtering Node Auto Scaling
    
    Setting up Incoming Request Balancing
    
    Google Cloud Platform
    Google Cloud Platform
    
    Version 4.6 Version 4.4 Version 4.2 Version 4.0 ⚠
    
    Overview
    
    Creating an Image with the Wallarm Filtering Node
    
    Creating a Filtering Node Instance Template
    
    Creating a Managed Instance Group with Enabled Auto Scaling
    
    Setting up Incoming Request Balancing
    
    Specification of the Wallarm cloud-init Script
    
    Wallarm Deployment to Private Clouds
    
    Separate Postanalytics Module Installation
    
    Multi‑Tenant Node
    Multi‑Tenant Node
    
    Version 4.6 Version 4.4 Version 4.2 Version 4.0 ⚠
    
    Multitenancy overview
    
    Creating tenant accounts in Wallarm Console
    
    Deploying and configuring multi-tenant node
- Administrator Guide
  Administrator Guide
  
  Version 4.6 Version 4.4 Version 4.2 Version 4.0 ⚠
  - Configuration
    Configuration
    
    Version 4.6 Version 4.4 Version 4.2 Version 4.0 ⚠
    
    Configuration options for the NGINX‑based Wallarm node
    
    Configuration options for the Envoy‑based Wallarm node
    
    Configuration of filtration mode
    
    Configuration of the blocking page and error code
    
    Configuration of the Statistics Service
    
    Configuration of brute force protection
    
    Configuration of BOLA (IDOR) protection
    
    DDoS protection
    
    Fine‑tuning of Wallarm Ingress Controller
    Fine‑tuning of Wallarm Ingress Controller
    
    Version 4.6 Version 4.4 Version 4.2 Version 4.0 ⚠
    
    Configuration Parameters
    
    Best Practices in NGINX-based Wallarm Ingress Controller Configuration
    Best Practices in NGINX-based Wallarm Ingress Controller Configuration
    
    Version 4.6 Version 4.4 Version 4.2 Version 4.0 ⚠
    
    Proper Reporting of End‑user Public IP Address
    
    High Availability Considerations
    
    Ingress Controller Monitoring
    
    Allocating Resources for Wallarm Node
    
    Configuration of Filter Node for Separated Customer Environments
    Configuration of Filter Node for Separated Customer Environments
    
    Version 4.6 Version 4.4 Version 4.2 Version 4.0 ⚠
    
    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
    
    Configuring synchronization between Wallarm node and Cloud
    
    Configuring access to files needed for node operation
    
    Working with Filter Node Logs
    
    Configuring dynamic DNS resolution in NGINX
    
    Using Single Sign‑On (SSO)
    Using Single Sign‑On (SSO)
    
    Version 4.6 Version 4.4 Version 4.2 Version 4.0 ⚠
    
    Overview of integration with the SAML SSO solution
    
    Connecting SSO with G Suite
    Connecting SSO with G Suite
    
    Version 4.6 Version 4.4 Version 4.2 Version 4.0 ⚠
    
    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 4.6 Version 4.4 Version 4.2 Version 4.0 ⚠
    
    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 4.6 Version 4.4 Version 4.2 Version 4.0 ⚠
    
    Checking the filtering node operation
    
    Configuring a Failover Method
    
    Using a Mirrored Wallarm Repository
    Using a Mirrored Wallarm Repository
    
    Version 4.6 Version 4.4 Version 4.2 Version 4.0 ⚠
    
    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 4.6 Version 4.4 Version 4.2 Version 4.0 ⚠
    
    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 4.6 Version 4.4 Version 4.2 Version 4.0 ⚠
    
    Grafana
    Grafana
    
    Version 4.6 Version 4.4 Version 4.2 Version 4.0 ⚠
    
    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 4.6 Version 4.4 Version 4.2 Version 4.0 ⚠
    
    Exporting Metrics to Nagios via the `collectd-nagios` Utility
    
    Working with the Filter Node Metrics in Nagios
    
    Zabbix
    Zabbix
    
    Version 4.6 Version 4.4 Version 4.2 Version 4.0 ⚠
    
    Exporting Metrics to Zabbix via the `collectd-nagios` Utility
    
    Working with the Filter Node in Zabbix
  - Operations
    Operations
    
    Version 4.6 Version 4.4 Version 4.2 Version 4.0 ⚠
    
    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 4.6 Version 4.4 Version 4.2 Version 4.0 ⚠
    
    Best practices for configuring the Active threat verification feature
    
    Scanner Addresses
    Scanner Addresses
    
    Version 4.6 Version 4.4 Version 4.2 Version 4.0 ⚠
    
    Scanner Addresses for EU Cloud
    
    Scanner Addresses for US Cloud
    
    Contacting Wallarm Support to Stop the Resource Scanner
  - Managing Wallarm using Terraform
- User Guide
  User Guide
  
  Version 4.6 Version 4.4 Version 4.2 Version 4.0 ⚠
  - Introduction to the User Guide
  - Dashboards
    Dashboards
    
    Version 4.6 Version 4.4 Version 4.2 Version 4.0 ⚠
    
    Threat Prevention
    
    API Discovery
    
    OWASP API Security Top 10
  - Events
    Events
    
    Version 4.6 Version 4.4 Version 4.2 Version 4.0 ⚠
    
    Checking Events
    
    Analyzing Attacks
    
    Working with False Attacks
    
    Verifying Attacks
  - Vulnerabilities
  - API Discovery
  - API Specifications
  - API Leaks
  - Search and Filters
    Search and Filters
    
    Version 4.6 Version 4.4 Version 4.2 Version 4.0 ⚠
    
    Using Search and Filters
    
    Creating a Custom Report
  - Scanner
  - Nodes
    Nodes
    
    Version 4.6 Version 4.4 Version 4.2 Version 4.0 ⚠
    
    Wallarm nodes
    
    CDN filtering nodes
  - Rules
    Rules
    
    Version 4.6 Version 4.4 Version 4.2 Version 4.0 ⚠
    
    Application Profile Rules
    
    Inspecting Application Profile Rules
    
    Adding Rules in the Application Profile
    
    Building and unloading of a custom ruleset
    
    Custom ruleset backup and restore
    
    Analyzing and Parsing Requests
    
    Available rule types
    Available rule types
    
    Version 4.6 Version 4.4 Version 4.2 Version 4.0 ⚠
    
    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
    
    The overlimit_res attack detection fine‑tuning
    
    Setting rate limit
  - Triggers
    Triggers
    
    Version 4.6 Version 4.4 Version 4.2 Version 4.0 ⚠
    
    Working with triggers
    
    Trigger examples
  - IP lists
    IP lists
    
    Version 4.6 Version 4.4 Version 4.2 Version 4.0 ⚠
    
    Types and core logic of IP lists
    
    IP address allowlist
    
    IP address graylist
    
    IP address denylist
  - API Abuse Prevention profile management
  - BOLA protection
  - Integrations
    Integrations
    
    Version 4.6 Version 4.4 Version 4.2 Version 4.0 ⚠
    
    Integrations Overview
    
    Email Report
    
    Slack
    
    Telegram
    
    Microsoft Teams
    
    InsightConnect
    
    Opsgenie
    
    PagerDuty
    
    Jira
    
    ServiceNow
    
    Sumo Logic
    
    Splunk
    
    Datadog
    
    Microsoft Sentinel
    
    Fluentd
    
    Logstash
    
    Webhook
    
    Amazon S3
    
    Examples of integrations via intermediate data collectors
    Examples of integrations via intermediate data collectors
    
    Version 4.6 Version 4.4 Version 4.2 Version 4.0 ⚠
    
    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
    
    Datadog via Fluentd/Logstash
  - Settings
    Settings
    
    Version 4.6 Version 4.4 Version 4.2 Version 4.0 ⚠
    
    Profile
    
    General
    
    Subscriptions
    
    Applications
    
    Users
    
    API tokens
    
    Activity Log
  - Using single sign‑on to Wallarm portal
- Upgrading and Migrating
  Upgrading and Migrating
  
  Version 4.6 Version 4.4 Version 4.2 Version 4.0 ⚠
  - What is new in Wallarm node 4.6
  - Filtering node versioning policy
  - Recommendations for a safe node upgrade process
  - Filtering node upgrade instructions
    Filtering node upgrade instructions
    
    Version 4.6 Version 4.4 Version 4.2 Version 4.0 ⚠
    
    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 Kong Ingress controller with integrated Wallarm modules
    
    Upgrading Wallarm Sidecar proxy
    
    Upgrading the cloud node image
    
    Upgrading Wallarm CDN node
    
    Upgrading the multi‑tenant node
  - Upgrading EOL Wallarm nodes (3.6 and lower)
    Upgrading EOL Wallarm nodes (3.6 and lower)
    
    Version 4.6 Version 4.4 Version 4.2 Version 4.0 ⚠
    
    What is new in Wallarm node (if upgrading an EOL node)
    
    Upgrading EOL Wallarm NGINX modules
    
    Upgrading the EOL postanalytics module
    
    Upgrading an EOL Docker NGINX- or Envoy-based image
    
    Upgrading EOL NGINX Ingress controller with integrated Wallarm modules
    
    Upgrading an EOL cloud node image
    
    Upgrading the EOL multi‑tenant node
    
    Migrating allowlists and denylists from EOL Wallarm node
  - Inventory of node artifact versions
- Appendix
  Appendix
  
  Version 4.6 Version 4.4 Version 4.2 Version 4.0 ⚠
  - Glossary
Open source: API Firewall
Open source: API Firewall

Version 4.6 Version 4.4 Version 4.2 Version 4.0 ⚠
Security testing: FAST
API docs
API docs

Version 4.6 Version 4.4 Version 4.2 Version 4.0 ⚠
- Wallarm API overview
- Wallarm API request examples
FAQ
FAQ

Version 4.6 Version 4.4 Version 4.2 Version 4.0 ⚠
Demo videos
Demo videos

Version 4.6 Version 4.4 Version 4.2 Version 4.0 ⚠
Changelog & news

Changelog & news¶

Wallarm service status:

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