v38

latestOpenAPI 3.0.3AGPL-3.0raw.githubusercontent.com2026-08-022461333.9 MB

Catalogs

Create a catalog

Create a new catalog.

put/catalogs

Query parameters

namestring

pathstring

type'local' | 'beets' | 'remote' | 'subsonic' | 'seafile' | 'beetsremote'

media_typestring

file_patternstring

folder_patternstring

usernamestring

passwordstring

Deprecated: for privacy, send this in a form or JSON request body instead of the query string (query values land in server/proxy logs and browser history). Query-string support will be removed in API9.

Request body

namestring required

pathstring required

type'local' | 'beets' | 'remote' | 'subsonic' | 'seafile' | 'beetsremote'

media_typestring

file_patternstring

folder_patternstring

usernamestring

passwordstring

Deprecated: for privacy, send this in a form or JSON request body instead of the query string (query values land in server/proxy logs and browser history). Query-string support will be removed in API9.

Response

Catalog object

idstring required

namestring nullable required

typestring nullable required

gather_typesstring nullable required

enabledboolean required

last_addinteger required

last_cleaninteger nullable required

last_updateinteger required

pathstring required

rename_patternstring nullable required

sort_patternstring nullable required