Library

Updates an existing Library with new name, folders, and/or type.

Changed on

Any folder or type change will invoke a scan.

post/api/Library/update

Request

  • Base URL
    http://localhost:5000
  • URL
    http://localhost:5000/api/Library/update
  • Auth
    API key in header x-api-key

Request body

idinteger required
namestring required
type0 | 1 | 2 | 3 | 4 | 5 required

Members:

  • 0 — Manga
  • 1 — Comic (Flexible) (Comic)
  • 2 — Book
  • 3 — Image
  • 4 — Light Novel (LightNovel)
  • 5 — Comic (ComicVine)
foldersstring[] required
folderWatchMode0 | 1 | 2 | 3

Members:

  • 0 — Off
  • 1 — Automatic
  • 2 — File Watcher (FileWatcher)
  • 3 — Polling
includeInDashboardboolean required
includeInSearchboolean required
manageCollectionsboolean required
manageReadingListsboolean required
allowScrobblingboolean required
allowMetadataMatchingboolean required
enableMetadataboolean required
removePrefixForSortNameboolean required
inheritWebLinksFromFirstChapterboolean required
defaultLanguagestring nullable
metadataProvider2 | 3 | 4

Members:

  • 2 — Hardcover
  • 3 — Mangabaka
  • 4 — ComicBookRoundup
fileGroupTypesFileTypeGroup[] required
excludePatternsstring[] required

Response

OK

Changes

    • warning

      removed the request property (media type: application/json)

    • warning

      removed the request property (media type: text/json)

    • warning

      removed the request property (media type: application/*+json)

    • info

      added the new optional request property (media type: application/json)

    • info

      added the new optional request property (media type: text/json)

    • info

      added the new optional request property (media type: application/*+json)

    • info

      added the new optional request property (media type: application/json)

    • info

      added the new optional request property (media type: text/json)

    • info

      added the new optional request property (media type: application/*+json)