Skip to main content

Brown Out Policy

Set periods of downtime based on cron schedules. Useful for alerting users of impending deprecations.

Early Access

This policy is in private beta. If you would like to use this please reach out to us:


"name": "my-brown-out-inbound-policy",
"policyType": "brown-out-inbound",
"handler": {
"export": "BrownOutInbound",
"module": "$import(@zuplo/runtime)",
"options": {
"cronExpression": "0 23 * * ?",
"durationSeconds": 60
  • name the name of your policy instance. This is used as a reference in your routes.
  • policyType the identifier of the policy. This is used by the Zuplo UI. Value should be brown-out-inbound.
  • handler/export The name of the exported type. Value should be BrownOutInbound.
  • handler/module the module containing the policy. Value should be $import(@zuplo/runtime).
  • handler/options The options for this policy:
    • cronExpression

      The cron schedule for when this policy is enabled.

    • durationSeconds

      The length of time in seconds that the policy stays enabled after the scheduled time starts.

Read more about how policies work