Skip to content
Flow Like logo Flow Like Docs

Register REST Function Node

Web/REST

Register REST Function

Registers referenced Flow functions as handlers for a REST path.

rest_register_functionweb
Inputs3
Outputs1
Security exposure10/10
Packageweb

Ratings

Scores range from 0 to 10. Higher values mean more impact, exposure, or operational weight.

No score metadata has been set for this node yet.

Input Pins

3

Config

Struct
config_in

REST server config

RestServerConfigRestServerConfig10 fields
hoststringrequired
portinteger:uint16required
format uint16min 0max 65535
timeout_secondsinteger:uint64
format uint64default 0min 0
max_connectionsinteger:uint32
format uint32default 128min 0
max_body_bytesinteger:uint
format uintdefault 10485760min 0
tlsTlsConfig
default {"secure":false,"certificate":null,"ca_...
secureboolean
default false
certificateanyOf (2)
default null
variant 1TlsCertificatevariant
certificate_pemstringrequired
private_key_pemstringrequired
variant 2nullvariant
ca_certificate_pemstring | null
default null
server_namestring | null
default null
accept_invalid_certificatesboolean
default false
authRestAuthConfig
default {"type":"none"}
variant 1objectvariant
typeconstrequired
const "none"
variant 2objectvariant
headerstringrequired
keystringrequired
typeconstrequired
const "api_key"
variant 3objectvariant
tokenstringrequired
typeconstrequired
const "bearer_token"
variant 4objectvariant
usernamestringrequired
passwordstringrequired
typeconstrequired
const "basic_auth"
variant 5objectvariant
secretstringrequired
signature_headerstring
default "x-signature"
timestamp_headerstring
default "x-timestamp"
max_skew_secondsinteger:uint64
format uint64default 300min 0
typeconstrequired
const "hmac_sha256"
+1 more fields
function_routesArray<RestFunctionRoute>
default []
itemsRestFunctionRoutearray item
pathstringrequired
methodsArray<string>
default []
itemsstringarray item
function_refsArray<string>
default []
itemsstringarray item
file_routesArray<RestFileRoute>
default []
itemsRestFileRoutearray item
pathstringrequired
flow_pathFlowPathrequired
pathstringrequired
store_refstringrequired
cache_store_refstring | null
directoryboolean
default false
content_typestring | null
default null
openapi_routesArray<RestOpenApiRoute>
default []
itemsRestOpenApiRoutearray item
pathstringrequired
ui_pathstring | null
default null
Schema enforced

Path

String
path

HTTP route path

Method

String
method

Allowed HTTP method. ANY accepts all methods.

RestRouteMethodRestRouteMethod0 fields
No named fields in this schema.
Default ANY
Schema enforcedGETPOSTPUTPATCHANY

Output Pins

1

Config

Struct
config_out

Updated config

RestServerConfigRestServerConfig10 fields
hoststringrequired
portinteger:uint16required
format uint16min 0max 65535
timeout_secondsinteger:uint64
format uint64default 0min 0
max_connectionsinteger:uint32
format uint32default 128min 0
max_body_bytesinteger:uint
format uintdefault 10485760min 0
tlsTlsConfig
default {"secure":false,"certificate":null,"ca_...
secureboolean
default false
certificateanyOf (2)
default null
variant 1TlsCertificatevariant
certificate_pemstringrequired
private_key_pemstringrequired
variant 2nullvariant
ca_certificate_pemstring | null
default null
server_namestring | null
default null
accept_invalid_certificatesboolean
default false
authRestAuthConfig
default {"type":"none"}
variant 1objectvariant
typeconstrequired
const "none"
variant 2objectvariant
headerstringrequired
keystringrequired
typeconstrequired
const "api_key"
variant 3objectvariant
tokenstringrequired
typeconstrequired
const "bearer_token"
variant 4objectvariant
usernamestringrequired
passwordstringrequired
typeconstrequired
const "basic_auth"
variant 5objectvariant
secretstringrequired
signature_headerstring
default "x-signature"
timestamp_headerstring
default "x-timestamp"
max_skew_secondsinteger:uint64
format uint64default 300min 0
typeconstrequired
const "hmac_sha256"
+1 more fields
function_routesArray<RestFunctionRoute>
default []
itemsRestFunctionRoutearray item
pathstringrequired
methodsArray<string>
default []
itemsstringarray item
function_refsArray<string>
default []
itemsstringarray item
file_routesArray<RestFileRoute>
default []
itemsRestFileRoutearray item
pathstringrequired
flow_pathFlowPathrequired
pathstringrequired
store_refstringrequired
cache_store_refstring | null
directoryboolean
default false
content_typestring | null
default null
openapi_routesArray<RestOpenApiRoute>
default []
itemsRestOpenApiRoutearray item
pathstringrequired
ui_pathstring | null
default null
Schema enforced

Node Info

Internal name
rest_register_function
Category
Web/REST
Version
3
Function references
Can reference functions