AMampache
Catalogs

Create a catalog

Changed on

Create a new catalog.

put/catalogs

Request

  • Base URL
    https://develop.ampache.dev/rest/8/json
  • URL
    https://develop.ampache.dev/rest/8/json/catalogs
  • Auth
    • HTTP bearer
    • or API key in header auth
    • or API key in query parameter auth

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 is retained for backward compatibility.

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 is retained for backward compatibility.

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

Changes

  • e8e6b266ea29Revision changes
    • info

      api operation id catalogCreate was added

    • info

      added optional request body

    • info

      the query request parameter name became optional

    • info

      the query request parameter path became optional

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

  • 2ff18e50dcc1Revision changes
    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status