Skip to content

pipe

Transfers HTTP/HTTPS/WebSocket/TUNNEL request/response data streams to the plugin for processing.

Rule Syntax

txt
pattern pipe://plugin-name(pipeValue) [filters...]

(pipeValue) is optional and can be obtained via req.originalReq.pipeValue in the plugin hook.

ParametersDescriptionDetailed Documentation
patternAn expression that matches the request URLMatching Pattern Documentation
plugin-name(pipeValue)Plugin name + optional parameters
filtersOptional filters, supporting matching:
• Request URL/Method/Headers/Content
• Response Status Code/Headers
Filters Documentation

Configuration Example

txt
tunnel://wwww.example.com pipe://test
tunnel://test-tunnel.example.com pipe://test-pipe-tunnel(abc)

wss://test-ws.example.com/path pipe://test-pipe-ws

https://www.example.com/path pipe://test-pipe-http(123)

For specific usage, refer to Plugin Development Documentation