REST Server Node

R

Web/REST

REST Server

Starts a REST server from a composed config. Function routes and files are registered on the config before this node runs.

rest_serverwebLong running

Inputs2

Outputs4

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

2

Execute

Execution

exec_in

Start server

Config

Struct

config

REST server config

SchemaRestServerConfigRestServerConfigRestServerConfig10 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

Output Pins

4

On Listening

Execution

on_listening

Fires when the server is ready

Local Addr

String

local_addr

Bound address

On Close

Execution

on_close

Fires when the server stops

Error

Execution

exec_error

Fires if the server cannot start

Node Info

Internal name

rest_server

Category

Web/REST

Version

3