Skip to main content

Parameters

See plugin common configurations for configuration options available to all plugins.

  • bypass_missing

    boolean


    default: false


    If true, bypass the user agent restriction check when the User-Agent header is missing.

  • allowlist

    array[string]


    List of user agents to allow. Support regular expressions.

    At least one of the allowlist and denylist should be configured, but they cannot be configured at the same time.

  • denylist

    array[string]


    List of user agents to deny. Support regular expressions.

    At least one of the allowlist and denylist should be configured, but they cannot be configured at the same time.

  • message

    string


    default: Not allowed


    Message returned when the user agent is denied access.


API7.ai Logo

API Management for Modern Architectures with Edge, API Gateway, Kubernetes, and Service Mesh.

Product

API7 Cloud

SOC2 Type IIISO 27001HIPAAGDPRRed Herring

Copyright © APISEVEN PTE. LTD 2019 – 2024. Apache, Apache APISIX, APISIX, and associated open source project names are trademarks of the

Apache Software Foundation