Limits and Usage

Limits on this key

GET /limits returns the quotas for the key you sent: pending and concurrent scans, monthly request budget, list sizes, schedule count, and whether rules or webhooks are enabled. Read it before you size a scan. A scan's request_count is how many requests that scan uses from the monthly budget. Fingerprinting doubles it.

GET/v3/limits

Limits for the current key

API reference

GET/v3/limits/jwt

Limits attached to this key

API reference

curl -sS "https://api.efflux.io/v3/limits" \
  -H "Authorization: Bearer $EFFLUX_TOKEN"

A quota failure is a problem body whose type points at /v3/limits. A 429 is a separate response. See API Conventions.

Usage

GET/v3/info/usage

Usage over time

API reference

Query	Meaning
`by_day`	Break the window into days
`months`	How many months to include
`tenant_summary`	Roll up the tenant when your key allows it

curl -sS "https://api.efflux.io/v3/info/usage?months=1&by_day=true" \
  -H "Authorization: Bearer $EFFLUX_TOKEN"

The usage list defaults to limit 100 (max 1000). The same numbers are what the Usage page in the app charts: scans, requests, surveys, captures, permutations, tasks, and searches.