---
title: "on api get · RUAL Documentation"
description: "Exposes GET URI on /api/"
canonical: https://docs.rual.nl/block-types/http%20connection/on_startup_register_uri_get
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 get

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 GET URI on /api/

- On Request `execute_function`

Startup registration block, not a flow executor: at startup (and on every save) it registers GET /api/{version}/{uri} and wires it to the function connected to the On Request outpin, which receives connection, params and query pins per request. Version defaults to v1. A route without any scope is LOCKED with 403 : not public; use *public to expose it. If two blocks register the same method/version/URI, the later one wins.

| `register get` |
| --- |

[On API GET](https://docs.rual.nl/block-types/http%20connection/on_startup_register_uri_get) registers the uri at startup; the uri pin takes a fixed [value](https://docs.rual.nl/block-types/value/value_default). Wiring its function pin creates the [execute](https://docs.rual.nl/block-types/function%20execution/function_custom_execute_from_trigger) handler block, whose flow runs the handler and whose connection pin feeds [reply in JSON](https://docs.rual.nl/block-types/http%20connection/httpconnection_set_json).

[![Studio canvas example for the On API GET block: registering a GET endpoint.](https://docs.rual.nl/canvas-examples/on_startup_register_uri_get.png)](https://docs.rual.nl/canvas-examples/on_startup_register_uri_get.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.

## Used in these guides

These documentation pages use or explain this block:

- [Creating a REST API](https://docs.rual.nl/tutorials/rest-api)

- [Common Blueprint Patterns](https://docs.rual.nl/blueprints/common-patterns)

- [Block Templates, Combinations That Work](https://docs.rual.nl/block-types/block-templates)

- [Quickstart](https://docs.rual.nl/getting-started/quickstart)

- [Block Quick Reference](https://docs.rual.nl/reference/block-quick-reference)

- [API Guide: Working with RUAL APIs](https://docs.rual.nl/cluster/api-guide)

- [Build Your First API](https://docs.rual.nl/cluster/api-quickstart)

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

## 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)