on api patch

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

on api patch 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 PATCH /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.

register patch

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

Studio canvas example for the on api patch block: typical wiring for on api patch.

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.

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