Configuration via Environment Variables
Last updated
Was this helpful?
Use the AIKIDO_TOKEN env variable to set the token you generated in Aikido:
AIKIDO_TOKEN="token"You can use the AIKIDO_BLOCK env variable to enable blocking mode.
AIKIDO_BLOCK="true"You can also toggle between blocking mode and detection only mode in the dashboard. The environment variable will be used as starting mode. When the config is retrieved, Zen will switch to the configured mode from the dashboard.
You can use the AIKIDO_DISABLE env variable to disable Zen entirely. In the unlikely event that Zen causes problems, you can disable Zen without removing any code or environment variables (e.g. AIKIDO_TOKEN etc).
AIKIDO_DISABLE="true"You can use the AIKIDO_DEBUG env variable to output more information:
Whether certain packages are supported or not
Whether a token was detected
Whether Zen is running in detection only mode
You can use the AIKIDO_TRUST_PROXY env variable to trust proxies:
By default, trust proxy is enabled.
AIKIDO_INSTANCE_NAME sets a custom name for your application instance, useful when the hostname isn't descriptive enough (for example, in containerized or ephemeral environments). Defaults to the hostname.
Limits the number of request samples collected per route. Each sample contains:
Request body structure and type (for non-GraphQL requests)
Query parameters
Authentication methods used
These samples help analyze and document your API's structure, including the expected request format and authentication requirements.
Sets the maximum size (in MB) for incoming HTTP request bodies. This limit helps protect your application from memory exhaustion due to extremely large requests.
Last updated
Was this helpful?
Was this helpful?
AIKIDO_DEBUG="true"AIKIDO_TRUST_PROXY="false"AIKIDO_INSTANCE_NAME="custom-name"AIKIDO_MAX_API_DISCOVERY_SAMPLES="10"AIKIDO_MAX_BODY_SIZE_MB="10" # MB