on api post

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

on api post v10.3.2

Exposes POST 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 POST /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 post

on api post works like the GET variant but also hands the handler a body pin: the execute block carries connection, params, query and body. The body goes through get fields before reply in JSON answers.

Studio canvas example for the on api post block: registering a POST endpoint.

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:

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