Skip to content
mxHeadless
REST API gateway for headless frontends on MODX 3. Resources, objects, OpenAPI, API keys, and OAuth
  1. Extras
  2. mxHeadless
  3. Configuration
  4. Limits

Limits

Rate limit

KeyDefault
mxheadless_rate_limit_enabledtrue
mxheadless_rate_limit_max_requests120
mxheadless_rate_limit_window_seconds60

Account key: IP (after trusted proxies) + identity. Response headers: X-RateLimit-Limit, Remaining, Reset. Exhaustion → 429 rate_limited.

Per-key: rate_limit_max / rate_limit_window on API key or OAuth client.

Input

KeyDefault
mxheadless_max_body_bytes1048576 (1 MB)
mxheadless_max_uri_bytes2048

Query

KeyDefault
mxheadless_max_limit100
mxheadless_max_offset100000
mxheadless_max_fields50
mxheadless_max_include_relations10
mxheadless_max_include_depth2

List default limit=20. page and offset together → 422.