Homarr
Apps

Get an app

GET/api/apps/{id}

Return an app by ID. Signed-in users can access all apps; anonymous access is limited to apps placed on public boards. Missing or inaccessible apps return not found.

Authorization

apikey
ApiKey<token>

API key which can be obtained in the Homarr administration dashboard

In: header

Path Parameters

id*string

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/apps/string"
{  "id": "string",  "name": "string",  "description": "string",  "iconUrl": "string",  "href": "string",  "pingUrl": "string"}

List selectable apps

Return app IDs, names, icons, descriptions, destination URLs, and ping URLs for selection controls. Requires authentication.

Update an app

Update an app by ID. Requires app-modify-all permission. Supply all required app fields; an empty pingUrl clears the custom ping URL. Changing href invalidates linked integration caches.