Library

Return a specific library

Changed on

If the user is not an admin, only id, type, and name will be returned (Kavita.Models.DTOs.LiteLibraryDto)

get/api/Library

Request

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

Query parameters

libraryIdinteger

Response

OK

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

Members:

  • 0 — Manga
  • 1 — Comic (Flexible) (Comic)
  • 2 — Book
  • 3 — Image
  • 4 — Light Novel (LightNovel)
  • 5 — Comic (ComicVine)
lastScannedstring date-time
coverImagestring nullable
folderWatchMode0 | 1 | 2 | 3

Members:

  • 0 — Off
  • 1 — Automatic
  • 2 — File Watcher (FileWatcher)
  • 3 — Polling
includeInDashboardboolean
includeInRecommendedboolean
manageCollectionsboolean
manageReadingListsboolean
includeInSearchboolean
allowScrobblingboolean
foldersstring[] nullable
collapseSeriesRelationshipsboolean
libraryFileTypesFileTypeGroup[] nullable
excludePatternsstring[] nullable
allowMetadataMatchingboolean
enableMetadataboolean
removePrefixForSortNameboolean
inheritWebLinksFromFirstChapterboolean
defaultLanguagestring nullable
metadataProvider2 | 3 | 4

Members:

  • 2 — Hardcover
  • 3 — Mangabaka
  • 4 — ComicBookRoundup

Changes

    • warning

      removed the optional property from the response with the status (media type: text/plain)

    • warning

      removed the optional property from the response with the status (media type: application/json)

    • warning

      removed the optional property from the response with the status (media type: text/json)

    • info

      added the optional property to the response with the status (media type: text/plain)

    • info

      added the optional property to the response with the status (media type: application/json)

    • info

      added the optional property to the response with the status (media type: text/json)

    • info

      added the optional property to the response with the status (media type: text/plain)

    • info

      added the optional property to the response with the status (media type: application/json)

    • info

      added the optional property to the response with the status (media type: text/json)