Skip to main content

API Key Authentication Policy



Be sure to read about policies

"name": "my-api-key-auth-inbound-policy",
"policyType": "api-key-auth-inbound",
"handler": {
"export": "ApiAuthKeyInboundPolicy",
"module": "$import(@zuplo/runtime)",
"options": {
"allowUnauthenticatedRequests": false
  • 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 api-key-auth-inbound.
  • handler/export The name of the exported type. Value should be ApiAuthKeyInboundPolicy.
  • handler/module the module containing the policy. Value should be $import(@zuplo/runtime).
  • handler/options The options for this policy: