Homarr

Custom API

CustomAPI

Renders an administrator-defined Custom JSX v2 widget with server-side API requests, options, and actions.

A Custom API widget renders a saved Custom Widget definition. The definition provides API sources, named requests, widget options, and safe JSX. Credentials remain encrypted on the server.

Adding the widget

Add the widget from the board's Add board content menu in edit mode.

Select a definition, configure its generated options, and choose a refresh interval.

Custom Widgets must be created under Management → Custom Widgets before they appear in the widget picker.

Permissions and requests

Each request declares its minimum board permission. Public boards may run queries for anonymous viewers, but actions require authentication. DELETE actions require full board permission and confirmation.

The refresh interval reruns load queries. Manual queries run through SubFetch; successful actions can invalidate their declared queries.

See Custom Widgets for authoring, network scopes, and security limits.

On this page