Documentation Workshop API reference Blog Community About us

OpenAPI

Homarr API reference

Browse request parameters and response schemas, enter your Homarr instance’s full URL in Server URL, then review examples or send a test request from your browser.

Manage apps

List apps with pagination List all apps Create an app Search apps List selectable apps Get an app Update an app Delete an app

Build dashboards

List accessible boards Create a board Duplicate a board Rename a board Change board visibility Delete a board Set your desktop home board Set your mobile home board Read board settings Update board settings Save dashboard layouts Reset a dashboard layout Save dashboard content Add an item to a board Move or resize one board item

Inspect Homarr

Get server information

Manage invitations

List user invitations Create a user invitation Delete a user invitation

Configure the instance

Get global board settings Update global board settings

Manage users and preferences

List all users Create a user Set a profile image List selectable users Search users Get user preferences Update user preferences Get a user Delete a user Update a user profile Change a user password Change user home boards Change the default search engine Update search preferences Change your color scheme Change widget context menu behavior Update header preferences Change DuckDuckGo bang behavior Change the first day of the week

Manage trusted certificates

Inspect a named custom root CA certificate Ensure a named custom root CA certificate without overwriting

Connect integrations

Proxy an integration API request using saved credentials Test a saved integration using stored credentials