Skip to main content

Actions

Traffic Policy actions enable you to modify the behavior of traffic flowing through your endpoints. The following actions are available for use on your endpoints:

TypeDescriptionSupported Phases
add-headersAdd custom headers to incoming requests or outgoing responses.on_http_request, on_http_response
basic-authEnforce HTTP Basic Authentication in front of your endpoints.on_http_request
circuit-breakerRejects requests when your upstream service becomes overloaded.on_http_request
compress-responseCompress HTTP response bodies from your upstream server.on_http_request, on_http_response
custom-responseSend a predefined custom response directly to the client.on_http_request, on_http_response
denyBlock incoming traffic to an endpoint.on_http_request, on_tcp_connect
forward-internalForward traffic to an endpoint within the same ngrok account.on_http_request, on_tcp_connect
jwt-validationValidate JSON Web Tokens (JWT).on_http_request
logAdd metadata to events for logging and monitoring.on_http_request, on_http_response, on_tcp_connect
rate-limitRate limit traffic to your upstream servers.on_http_request
redirectRedirect users through URL transformations using regular expressions.on_http_request
remove-headersRemove headers from incoming requests or outgoing responses.on_http_request, on_http_response
restrict-ipsAllow or deny traffic based on source IP.on_http_request, on_tcp_connect
url-rewriteRewrite request URLs transparently using regular expressions.on_http_request
verify-webhookValidate incoming webhook signatures against a known secret to ensure authenticity.on_http_request