Skip to main content

KomgaLibraryDto

Komga library DTO

Based on actual Komic traffic analysis - includes all fields observed in responses.

analyzeDimensionsboolean

Whether to analyze page dimensions

convertToCbzboolean

Whether to convert archives to CBZ

emptyTrashAfterScanboolean

Whether to empty trash after scan

hashFilesboolean

Whether to hash files for deduplication

hashKoreaderboolean

Whether to hash files for KOReader sync

hashPagesboolean

Whether to hash pages

idstringrequired

Library unique identifier (UUID as string)

importBarcodeIsbnboolean

Whether to import barcode/ISBN

importComicInfoBookboolean

Whether to import book info from ComicInfo.xml

importComicInfoCollectionboolean

Whether to import collection info from ComicInfo.xml

importComicInfoReadListboolean

Whether to import read list from ComicInfo.xml

importComicInfoSeriesboolean

Whether to import series info from ComicInfo.xml

importComicInfoSeriesAppendVolumeboolean

Whether to append volume to series name from ComicInfo

importEpubBookboolean

Whether to import EPUB book metadata

importEpubSeriesboolean

Whether to import EPUB series metadata

importLocalArtworkboolean

Whether to import local artwork

importMylarSeriesboolean

Whether to import Mylar series data

namestringrequired

Library display name

oneshotsDirectorystring | nullnullable

Directory path for oneshots (optional)

repairExtensionsboolean

Whether to repair file extensions

rootstringrequired

Root filesystem path

scanCbxboolean

Whether to scan CBZ/CBR files

scanDirectoryExclusionsstring[]

Directory exclusion patterns

scanEpubboolean

Whether to scan EPUB files

scanForceModifiedTimeboolean

Whether to force modified time for scan

scanIntervalstring

Scan interval (WEEKLY, DAILY, HOURLY, EVERY_6H, EVERY_12H, DISABLED)

scanOnStartupboolean

Whether to scan on startup

scanPdfboolean

Whether to scan PDF files

seriesCoverstring

Series cover selection strategy (FIRST, FIRST_UNREAD_OR_FIRST, FIRST_UNREAD_OR_LAST, LAST)

unavailableboolean

Whether library is unavailable (path doesn't exist)

KomgaLibraryDto
{
  "analyzeDimensions": true,
  "convertToCbz": true,
  "emptyTrashAfterScan": true,
  "hashFiles": true,
  "hashKoreader": true,
  "hashPages": true,
  "id": "string",
  "importBarcodeIsbn": true,
  "importComicInfoBook": true,
  "importComicInfoCollection": true,
  "importComicInfoReadList": true,
  "importComicInfoSeries": true,
  "importComicInfoSeriesAppendVolume": true,
  "importEpubBook": true,
  "importEpubSeries": true,
  "importLocalArtwork": true,
  "importMylarSeries": true,
  "name": "string",
  "oneshotsDirectory": "string",
  "repairExtensions": true,
  "root": "string",
  "scanCbx": true,
  "scanDirectoryExclusions": [
    "string"
  ],
  "scanEpub": true,
  "scanForceModifiedTime": true,
  "scanInterval": "string",
  "scanOnStartup": true,
  "scanPdf": true,
  "seriesCover": "string",
  "unavailable": true
}