on api get

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

on api get v10.3.2

Exposes GET URI on /api/

Out pins 1
  • On Request
    execute_function
register get

On API GET registers the uri at startup; the uri pin takes a fixed value. Wiring its function pin creates the execute handler block, whose flow runs the handler and whose connection pin feeds reply in JSON.

Studio canvas example for the On API GET block: registering a GET 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