---
title: "on api patch · RUAL Documentation"
description: "Exposes URI on /api/"
canonical: https://docs.rual.nl/block-types/http%20connection/on_startup_register_uri_patch
language: en
---

[Cluster](https://docs.rual.nl/cluster)

[Blocks](https://docs.rual.nl/block-types)

[Interfaces](https://docs.rual.nl/interfaces)

[Blueprints](https://docs.rual.nl/blueprints)

[Tutorials](https://docs.rual.nl/tutorials)

[Home automation](https://docs.rual.nl/home-automation)

[Examples](https://docs.rual.nl/examples)

[Reference](https://docs.rual.nl/reference)

[Architecture](https://docs.rual.nl/architecture)

[Troubleshooting](https://docs.rual.nl/troubleshooting)

Other

# on api patch

This block is part of the [`http connection`](https://docs.rual.nl/block-types/http%20connection) group and was last modified in core [`v10.3.2`](https://docs.rual.nl/core-versions/100302).

Exposes URI on /api/

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

Default `false`

- 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](https://docs.rual.nl/block-types/http%2520connection/on_startup_register_uri_patch): a [function trigger](https://docs.rual.nl/block-types/globals/trigger_custom_function) starts the flow; [value](https://docs.rual.nl/block-types/value/value_default) feeds the `uri` pin; the function out pin wires to an [execute](https://docs.rual.nl/block-types/function%2520execution/function_custom_execute_from_trigger) block.

[![Studio canvas example for the on api patch block: typical wiring for on api patch.](https://docs.rual.nl/canvas-examples/on_startup_register_uri_patch.png)](https://docs.rual.nl/canvas-examples/on_startup_register_uri_patch.png?v=3)

## Commonly used with

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

- [execute](https://docs.rual.nl/block-types/function%20execution/function_custom_execute_from_trigger): this block feeds into it. Executes the given funcion and waits for it to be executed.

## Version history

Introduced in [`v10.3.2`](https://docs.rual.nl/core-versions/100302).

- [Back to `http connection`](https://docs.rual.nl/block-types/http%20connection): Return to the main group to view all sub-groups

- [Back to `api`](https://docs.rual.nl/block-types/http%20connection?group=api): Return to the group to view all blocks within this group

Was this page helpful? [Tell us what to improve](https://docs.rual.nl/support) · RUAL Docs is an integral component of the [RUAL ecosystem](https://rual.nl)