Homarr
Apps

Create an app

POST/api/apps

Create an app bookmark. Requires app-create permission. Returns the app, including its ID and the legacy appId field. An empty pingUrl disables the custom ping URL.

Authorization

apikey
ApiKey<token>

API key which can be obtained in the Homarr administration dashboard

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/api/apps" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "description": "string",    "iconUrl": "string",    "href": "string",    "pingUrl": "string"  }'
{  "appId": "string",  "id": "string",  "name": "string",  "description": "string",  "iconUrl": "string",  "href": "string",  "pingUrl": "string"}

List all apps

Return all apps ordered by name. Requires app-modify-all permission.

Search apps

Find apps whose names contain the query, ordered by name. Requires app-modify-all or board-modify-all permission; returns up to 100 results.