Skip to content

Settings

Read and update the server-wide library pagination, search, and upload settings.

Updated View as Markdown

These are the install’s shared settings — see the Library section in Profiles & Access for what they control. A profile’s own name, color, and password are edited through PATCH /api/profiles/:id, not here.

GET /api/settings

GETAny session

Returns the current settings.

Response

{
  "settings": {
    "recipesPerPage": 50,
    "searchResultLimit": 10,
    "imageMaxSizeMb": 10
  }
}

PATCH /api/settings

PATCHAdmin only

Updates one or more settings. All fields optional — only send what’s changing.

Request body

Field Type Notes
recipesPerPage integer 10–500 How many recipes the Library and Favorites grids show per page
searchResultLimit integer 1–100 How many results the search dialog shows before “keep typing to narrow it down”
imageMaxSizeMb integer 1–100 Largest photo accepted by uploads (hero image or step photo), in MB

Response: { "settings": PublicAppSettings }, or 400 if a field is outside its allowed range.

Navigation

Type to search…

↑↓ navigate↵ selectEsc close