Quota Policy

Enforce quota policies on requests.

Paid Add On

This policy is only available as a paid add-on. If you would like to try this please reach out to us:


The configuration shows how to configure the policy in the 'policies.json' document.

{ "name": "my-quota-inbound-policy", "policyType": "quota-inbound", "handler": { "export": "QuotaInboundPolicy", "module": "$import(@zuplo/runtime)", "options": { "allowRequestsOverQuota": false } } }

Policy Configuration

  • name <string> - The name of your policy instance. This is used as a reference in your routes.
  • policyType <string> - The identifier of the policy. This is used by the Zuplo UI. Value should be quota-inbound.
  • handler.export <string> - The name of the exported type. Value should be QuotaInboundPolicy.
  • handler.module <string> - The module containing the policy. Value should be $import(@zuplo/runtime).
  • handler.options <object> - The options for this policy. See Policy Options below.

Policy Options

The options for this policy are specified below. All properties are optional unless specifically marked as required.

  • allowRequestsOverQuota <boolean> -
    Indicates if requests over quota should be allowed or not.
    Defaults to false.

Using the Policy

Read more about how policies work

Request Size Limit