on api put

This block is part of the http connection group and was last modified in core v10.3.2.

on api put execute_function v10.3.2

Exposes URI on /api/

In pins 1

lowercase body condition
If set to true, we'll automatically lowercase all JSON root-body keys. userName will become username.
Default false

Out pins 1

On Request execute_function

Startup registration block, not a flow executor: at startup (and on every save) it registers PUT /api/{version}/{uri} and wires it to the function connected to the On Request outpin, which receives connection, params, query and body pins per request. Version defaults to v1; the lower_keys pin lowercases all root-level JSON body keys (userName -> username). A route without any scope is LOCKED with 403 : not public; use *public to expose it. An *ip:<entry> scope admits callers by client address: a CIDR (*ip:203.0.113.0/24), an IP (*ip:203.0.113.3) or a hostname whose A/AAAA records list the allowed addresses (*ip:gateways.example.com, re-resolved hourly; a name that never resolved admits nobody).

register put

A typical wiring for on api put: a function trigger starts the flow; value feeds the uri pin; the function out pin wires to an execute block.

Commonly used with

In production blueprints, this block is most often wired together with:

execute: this block feeds into it. Executes the given funcion and waits for it to be executed.

Used in these guides

These documentation pages use or explain this block:

Creating a REST API

Version history

Introduced in v10.3.2.

Back to http connection Return to the main group to view all sub-groups Back to api Return to the group to view all blocks within this group