For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
LogoLogo
HUMAN DashboardHUMAN WebsiteRequest a Demo
Product GuidesEnforcer GuidesMobile SDKAPI ReferenceCustomer support
Login
Product GuidesEnforcer GuidesMobile SDKAPI ReferenceCustomer support
  • General
    • About Enforcers
    • Support first-party HUMAN calls
    • Deploy Tool
    • Troubleshoot Enforcer configurations
  • Enforcer frameworks
    • Akamai ESI
    • Apache - C Module
    • ASP.NET
    • Callout Enforcer
    • Envoy Proxy
    • F5 BIGIP
    • Fastly JavaScript Compute@Edge
    • Google Cloud Platform (GCP) Callout Enforcer
    • Kong Plugin
    • NGINX - C Module
    • NGINX - LUA Module
    • PHP
    • Python
    • Ruby
      • Changelog
      • Installation
      • Configuration
      • Additional Information
    • Salesforce Commerce Cloud Cartridge
  • About Enforcers
  • Support first-party HUMAN calls
  • Deploy Tool
  • Troubleshoot Enforcer configurations
  • Akamai EdgeWorker changelog
  • Installation
  • Manual installation
  • Configuration
  • API
  • Upgrading
  • Supported Features
  • Install the Akamai EdgeWorker Enforcer
  • Configuration Options
  • Upgrading the Enforcer
  • Akamai ESI
  • Akamai ESI changelog
  • Installation
  • Configuration
  • First Party Configuration
  • Apache - C Module
  • Apache changelog
  • Module Configuration
  • Configuration Options
  • First Party Configuration
  • Apigee Edge changelog
  • Installation
  • Configuration
  • ASP.NET
  • ASP.NET changelog
  • Configuration
  • Changelog
  • Installation
  • API
  • Configuration
  • Changelog
  • Installation
  • Configuration
  • AWS Lambda@Edge changelog
  • Installation
  • Manual installation
  • API
  • Configuration
  • Upgrading
  • Supported Features
  • Installing the Enforcer
  • Configuration Options
  • Upgrading the Enforcer
  • Changelog
  • Install the Azure Front Door Enforcer
  • Manually install the Azure Front Door Enforcer
  • API
  • Configuration
  • Callout Enforcer
  • Changelog
  • Supported Features
  • Envoy configuration
  • Enforcer Configuration
  • Advanced Configuration
  • Docker Image
  • Complete Example
  • Cloudflare Worker changelog
  • Installation
  • Installation with Terraform
  • Manual installation
  • Deploy the Cloudflare Enforcer for Shopify applications
  • API
  • Configuration
  • Configuration (v5 and Below)
  • Upgrading to Version 6
  • Changelog
  • Installation
  • API
  • Configuration
  • Changelog
  • Installation
  • API
  • Configuration
  • Envoy Proxy
  • Changelog
  • Installation
  • Configuration Options
  • First Party Configuration
  • F5 BIGIP
  • Changelog
  • Installation
  • First Party Integration
  • Configuration
  • Configurational Classes
  • Advanced Customization
  • Troubleshooting
  • Fastly JavaScript Compute@Edge
  • Changelog
  • Installation
  • API
  • Configuration
  • Fastly Rust Compute@Edge changelog
  • Supported Features
  • Installation
  • Configuration
  • Changelog
  • Installation
  • Manual installation
  • Configuration
  • How it works
  • Upgrade to V12
  • Installation
  • Configuration
  • How It Works
  • Upgrade to V11
  • Installation
  • Configuration
  • How It Works
  • Upgrade to V10
  • Installing the Enforcer
  • GraphQL Support
  • Sensitive GraphQL Operations
  • Basic Configuration
  • Customized Subroutines
  • Additional Activity Handler
  • Advanced Blocking Response
  • Creating and Configuring the Edge-Dictionary
  • Custom CSS
  • Custom First Party Sensor Endpoint
  • Custom Logo
  • Custom JS Script
  • Custom Parameters
  • Filter Requests
  • Filter by HTTP Method
  • Filter by Route
  • Filter by Extension
  • Filter by IP
  • Filter by User Agent
  • Data Enrichment
  • First Party
  • First Party Snippet
  • Enforced Routes
  • Login Credentials Extraction
  • Modify First Party Response
  • Module Context Object
  • Module Enabled
  • Module Mode
  • Monitored Routes
  • Returning A Custom Block Page
  • Sensitive Routes
  • Test Block Flow on Monitoring Mode - Bypass Monitor Header
  • Upgrading the Enforcer
  • Changelog
  • Installation
  • API
  • Configuration
  • Installing the Enforcer
  • Supported Features
  • Configuration Options
  • Upgrading the Enforcer
  • Google Cloud Platform (GCP) Callout Enforcer
  • Integrate the GCP Callout Enforcer
  • HAProxy changelog
  • Supported Software Versions
  • Supported Features
  • Installation
  • Configuration
  • Java changelog
  • Installation
  • Configuration
  • Upgrading
  • Kong Plugin
  • Changelog
  • NGINX Gateway Fabric with the HUMAN Enforcer
  • NGINX Gateway Fabric Enforcer configurations
  • Ingress NGINX controller
  • Ingress NGINX Enforcer configuration options
  • Changelog
  • Installation
  • Configuration options
  • Changelog
  • Installation
  • Configuration options
  • Changelog
  • Installation (Next.js 16)
  • Installation (Next.js 15 and lower)
  • Configuration
  • NGINX - C Module
  • NGINX changelog
  • Supported Features
  • Installation
  • Module Configuration
  • Configuration Options
  • Enrichment
  • First Party Configuration
  • Nginx Docker Image
  • Ingress NGINX Controller with HUMAN Enforcer
  • NGINX - LUA Module
  • Changelog
  • Supported Features
  • Installing the Enforcer
  • Configuration Options
  • Upgrading the Enforcer
  • HUMAN Plugin Configuration
  • First Party Configuration
  • Enrichment
  • Changelog
  • Installation
  • API
  • Configuration
  • Configuration Options (7.9.0 and below)
  • Upgrading to Version 8
  • PHP
  • Changelog
  • Upgrading
  • Configuration Options
  • Advanced Configuration
  • Python
  • Changelog
  • Installation
  • Required Configuration
  • Configuration Options
  • Upgrading
  • First Party Configuration
  • Ruby
  • Changelog
  • Installation
  • Configuration
  • Additional Information
  • Salesforce Commerce Cloud Cartridge
  • Changelog
  • Importing the Cartridge
  • Registering the Cartridge
  • Importing Metadata and Services
  • Configuring the Cartridge
  • Using the Cartridge
  • SCAPI Protection Considerations
  • Upgrading
  • Customized Block Page
  • Configuration options
  • First Party
  • Varnish changelog
  • Supported Software Versions
  • Installation
  • Configuration Options
  • Enforcer Configuration
  • Example configuration
HUMAN DashboardHUMAN WebsiteRequest a Demo
On this page
  • August 17, 2022
  • Version 2.3.2
  • April 11, 2022
  • Version 2.3.1
  • April 10, 2022
  • Version 2.3.0
  • September 27, 2020
  • Version 2.2.1
  • September 15, 2020
  • Version 2.2.0
  • September 1, 2020
  • Version 2.1.0
  • July 24, 2020
  • Version 2.0.0
  • March 18, 2018
  • Version 1.4.0
  • July 27, 2017
  • Version 1.3.0
  • June 4, 2017
  • Version 1.2.0
  • Version 1.1.0
Enforcer frameworksRuby

Changelog

August 17, 2022
August 17, 2022

April 11, 2022
April 11, 2022

April 10, 2022
April 10, 2022

September 27, 2020
September 27, 2020

September 15, 2020
September 15, 2020

September 1, 2020
September 1, 2020

July 24, 2020
July 24, 2020

March 18, 2018
March 18, 2018

July 27, 2017
July 27, 2017

June 4, 2017
June 4, 2017
Older posts
Next
Built with
Login

Version 2.3.2

Changed

  • Removed dependency on Active Support
  • Replaced eval() calls with JSON.parse() for improved security
  • Small spec alignment changes (risk_api and block activities)

Version 2.3.1

Fixed

  • URLs with query params did not render properly on new block page

Version 2.3.0

Added

  • Custom logo in block JSON response

Changed

  • Updated block page to use new template

Version 2.2.1

Fixed

  • bypass_monitor_header type validation

Version 2.2.0

Added

  • First Party

Version 2.1.0

Added

  • Added option to set a different PX configuration on each request
  • Added types validation on configuration fields

Fixed

  • New cookie logic for mobile requests
  • Renamed api_connect_timeout to api_timeout_conncection on default configuration
  • Removed unsupported configuration fields:
    • max_buffer_len
    • local_proxy
  • Send cookie_origin only if there is a cookie

Version 2.0.0

Added

  • Added fields to Block Activity:
    • simulated_block
    • http_version
    • http_method
    • risk_rtt
    • px_orig_cookie
  • Added fields to page_requested activity:
    • pass_reason
    • risk_rtt
    • px_orig_cookie
  • Added px_orig_cookie field to risk_api in case of cookie_decryption_failed
  • Added support for captcha v2
  • Added support for Advanced Blocking Response
  • Added support for whitelise routes
  • Added support for bypass monitor header
  • Added support for extracting vid from _pxvid cookie
  • Added support for rate limit
  • Added risk_cookie_max_iterations configuration

Fixed

  • Updated dependencies
  • Updated sample site dockerfile
  • Fixed monitor mode
  • Fixed send_page_activities and send_block_activities configurations
  • Updated risk to v3
  • Refactored ip header extraction
  • Renamed block_uuid field to client_uuid
  • Renamed perimeterx_server_host configuration to backend_url
  • Updated risk_response handling: pass the request if risk_response.status is -1
  • Forcing HTTP header values to be UTF-8

Version 1.4.0

Fixed

  • Incorrect assignment for s2s_call_reason
  • Fixed empty token result correct s2s reason

Added

  • Added support to captcha API v2
  • Mobile SDK support for special tokens 1/2/3

Version 1.3.0

Added

  • Sending client_uuid on page_requested activities
  • Supporting mobile sdk

Fixed

  • Using request.env instead of env

Version 1.2.0

Fixed

  • Default timeouts for post API requests
  • Fixed Dockerfile

Changed

  • Removed httpclient and instead using typhoeus

Added

  • Using concurrent-ruby for async post requests

Version 1.1.0

Added

  • Added support for sensitive routes