### GET /api/v1/client-settings/user/list Source: https://raw.githubusercontent.com/gotson/komga/refs/heads/master/komga/docs/openapi.json API endpoint for GET /api/v1/client-settings/user/list ```markdown ### Responses #### 200 - OK #### 400 - Bad Request **ValidationErrorResponse** - **violations** (array (Violation)) (required) Array items: - **fieldName** (string) - **message** (string) ### Example Usage ```bash curl -X GET "https://demo.komga.org/api/v1/client-settings/user/list" ``` ``` -------------------------------- ### GET /api/v1/settings Source: https://raw.githubusercontent.com/gotson/komga/refs/heads/master/komga/docs/openapi.json Required role: **ADMIN** ```markdown ### Responses #### 200 - OK **SettingsDto** - **deleteEmptyCollections** (boolean) (required) - **deleteEmptyReadLists** (boolean) (required) - **kepubifyPath** (object) (required) - **configurationSource** (string) (required) - **databaseSource** (string) (required) - **effectiveValue** (string) (required) - **koboPort** (integer (int32)) - **koboProxy** (boolean) (required) - **rememberMeDurationDays** (integer (int64)) (required) - **serverContextPath** (object) (required) - **serverPort** (object) (required) - **taskPoolSize** (integer (int32)) (required) - **thumbnailSize** (string (DEFAULT|MEDIUM|LARGE|XLARGE)) (required) ("DEFAULT"|"MEDIUM"|"LARGE"|"XLARGE") #### 400 - Bad Request **ValidationErrorResponse** - **violations** (array (Violation)) (required) Array items: - **fieldName** (string) - **message** (string) ### Example Usage ```bash curl -X GET "https://demo.komga.org/api/v1/settings" ``` ``` -------------------------------- ### GET /api/v1/books/{bookId}/manifest/epub Source: https://raw.githubusercontent.com/gotson/komga/refs/heads/master/komga/docs/openapi.json API endpoint for GET /api/v1/books/{bookId}/manifest/epub ```markdown ### Parameters - **bookId** (string, path, required) ### Responses #### 200 - OK **WPPublicationDto** - **context** (string) - **images** (array (WPLinkDto)) (required) Array items: - **height** (integer (int32)) - **href** (string) - **properties** (object) (required) - **rel** (string) - **templated** (boolean) - **title** (string) - **type** (string) - **width** (integer (int32)) - **landmarks** (array (WPLinkDto)) (required) Array items: - **links** (array (WPLinkDto)) (required) Array items: - **metadata** (object) (required) - **artist** (array (string)) (required) - **author** (array (string)) (required) - **belongsTo** (object) - **collection** (array (WPContributorDto)) (required) Array items: - **links** (array (WPLinkDto)) (required) Array items: - **name** (string) (required) - **position** (number (float)) - **series** (array (WPContributorDto)) (required) Array items: - **colorist** (array (string)) (required) - **conformsTo** (string) - **contributor** (array (string)) (required) - **description** (string) - **editor** (array (string)) (required) - **identifier** (string) - **illustrator** (array (string)) (required) - **inker** (array (string)) (required) - **language** (string) - **letterer** (array (string)) (required) - **modified** (string (date-time)) - **numberOfPages** (integer (int32)) - **penciler** (array (string)) (required) - **published** (string (date)) - **publisher** (array (string)) (required) - **readingProgression** (string (rtl|ltr|ttb|btt|auto)) ("rtl"|"ltr"|"ttb"|"btt"|"auto") - **rendition** (object) (required) - **sortAs** (string) - **subject** (array (string)) (required) - **subtitle** (string) - **title** (string) (required) - **translator** (array (string)) (required) - **type** (string) - **pageList** (array (WPLinkDto)) (required) Array items: - **readingOrder** (array (WPLinkDto)) (required) Array items: - **resources** (array (WPLinkDto)) (required) Array items: - **toc** (array (WPLinkDto)) (required) Array items: **WPPublicationDto** #### 400 - Bad Request **ValidationErrorResponse** - **violations** (array (Violation)) (required) Array items: - **fieldName** (string) - **message** (string) ### Example Usage ```bash curl -X GET "https://demo.komga.org/api/v1/books/{bookId}/manifest/epub" ``` ``` -------------------------------- ### GET /api/v1/releases Source: https://raw.githubusercontent.com/gotson/komga/refs/heads/master/komga/docs/openapi.json Required role: **ADMIN** ```markdown ### Responses #### 200 - OK - Array of ReleaseDto #### 400 - Bad Request **ValidationErrorResponse** - **violations** (array (Violation)) (required) Array items: - **fieldName** (string) - **message** (string) ### Example Usage ```bash curl -X GET "https://demo.komga.org/api/v1/releases" ``` ``` -------------------------------- ### GET /api/v1/books/{bookId}/manifest/pdf Source: https://raw.githubusercontent.com/gotson/komga/refs/heads/master/komga/docs/openapi.json API endpoint for GET /api/v1/books/{bookId}/manifest/pdf ```markdown ### Parameters - **bookId** (string, path, required) ### Responses #### 200 - OK **WPPublicationDto** - **context** (string) - **images** (array (WPLinkDto)) (required) Array items: - **height** (integer (int32)) - **href** (string) - **properties** (object) (required) - **rel** (string) - **templated** (boolean) - **title** (string) - **type** (string) - **width** (integer (int32)) - **landmarks** (array (WPLinkDto)) (required) Array items: - **links** (array (WPLinkDto)) (required) Array items: - **metadata** (object) (required) - **artist** (array (string)) (required) - **author** (array (string)) (required) - **belongsTo** (object) - **collection** (array (WPContributorDto)) (required) Array items: - **links** (array (WPLinkDto)) (required) Array items: - **name** (string) (required) - **position** (number (float)) - **series** (array (WPContributorDto)) (required) Array items: - **colorist** (array (string)) (required) - **conformsTo** (string) - **contributor** (array (string)) (required) - **description** (string) - **editor** (array (string)) (required) - **identifier** (string) - **illustrator** (array (string)) (required) - **inker** (array (string)) (required) - **language** (string) - **letterer** (array (string)) (required) - **modified** (string (date-time)) - **numberOfPages** (integer (int32)) - **penciler** (array (string)) (required) - **published** (string (date)) - **publisher** (array (string)) (required) - **readingProgression** (string (rtl|ltr|ttb|btt|auto)) ("rtl"|"ltr"|"ttb"|"btt"|"auto") - **rendition** (object) (required) - **sortAs** (string) - **subject** (array (string)) (required) - **subtitle** (string) - **title** (string) (required) - **translator** (array (string)) (required) - **type** (string) - **pageList** (array (WPLinkDto)) (required) Array items: - **readingOrder** (array (WPLinkDto)) (required) Array items: - **resources** (array (WPLinkDto)) (required) Array items: - **toc** (array (WPLinkDto)) (required) Array items: **WPPublicationDto** #### 400 - Bad Request **ValidationErrorResponse** - **violations** (array (Violation)) (required) Array items: - **fieldName** (string) - **message** (string) ### Example Usage ```bash curl -X GET "https://demo.komga.org/api/v1/books/{bookId}/manifest/pdf" ``` ``` -------------------------------- ### GET /api/v1/books/{bookId}/manifest Source: https://raw.githubusercontent.com/gotson/komga/refs/heads/master/komga/docs/openapi.json API endpoint for GET /api/v1/books/{bookId}/manifest ```markdown ### Parameters - **bookId** (string, path, required) ### Responses #### 200 - OK **WPPublicationDto** - **context** (string) - **images** (array (WPLinkDto)) (required) Array items: - **height** (integer (int32)) - **href** (string) - **properties** (object) (required) - **rel** (string) - **templated** (boolean) - **title** (string) - **type** (string) - **width** (integer (int32)) - **landmarks** (array (WPLinkDto)) (required) Array items: - **links** (array (WPLinkDto)) (required) Array items: - **metadata** (object) (required) - **artist** (array (string)) (required) - **author** (array (string)) (required) - **belongsTo** (object) - **collection** (array (WPContributorDto)) (required) Array items: - **links** (array (WPLinkDto)) (required) Array items: - **name** (string) (required) - **position** (number (float)) - **series** (array (WPContributorDto)) (required) Array items: - **colorist** (array (string)) (required) - **conformsTo** (string) - **contributor** (array (string)) (required) - **description** (string) - **editor** (array (string)) (required) - **identifier** (string) - **illustrator** (array (string)) (required) - **inker** (array (string)) (required) - **language** (string) - **letterer** (array (string)) (required) - **modified** (string (date-time)) - **numberOfPages** (integer (int32)) - **penciler** (array (string)) (required) - **published** (string (date)) - **publisher** (array (string)) (required) - **readingProgression** (string (rtl|ltr|ttb|btt|auto)) ("rtl"|"ltr"|"ttb"|"btt"|"auto") - **rendition** (object) (required) - **sortAs** (string) - **subject** (array (string)) (required) - **subtitle** (string) - **title** (string) (required) - **translator** (array (string)) (required) - **type** (string) - **pageList** (array (WPLinkDto)) (required) Array items: - **readingOrder** (array (WPLinkDto)) (required) Array items: - **resources** (array (WPLinkDto)) (required) Array items: - **toc** (array (WPLinkDto)) (required) Array items: **WPPublicationDto** **WPPublicationDto** #### 400 - Bad Request **ValidationErrorResponse** - **violations** (array (Violation)) (required) Array items: - **fieldName** (string) - **message** (string) ### Example Usage ```bash curl -X GET "https://demo.komga.org/api/v1/books/{bookId}/manifest" ``` ``` -------------------------------- ### GET /actuator/info Source: https://raw.githubusercontent.com/gotson/komga/refs/heads/master/komga/docs/openapi.json Required role: **ADMIN** ```markdown ### Responses #### 200 - OK ### Example Usage ```bash curl -X GET "https://demo.komga.org/actuator/info" ``` ``` -------------------------------- ### GET /api/v1/books/{bookId}/next Source: https://raw.githubusercontent.com/gotson/komga/refs/heads/master/komga/docs/openapi.json API endpoint for GET /api/v1/books/{bookId}/next ```markdown ### Parameters - **bookId** (string, path, required) ### Responses #### 200 - OK **BookDto** - **created** (string (date-time)) (required) - **deleted** (boolean) (required) - **fileHash** (string) (required) - **fileLastModified** (string (date-time)) (required) - **id** (string) (required) - **lastModified** (string (date-time)) (required) - **libraryId** (string) (required) - **media** (object) (required) - **comment** (string) (required) - **epubDivinaCompatible** (boolean) (required) - **epubIsKepub** (boolean) (required) - **mediaProfile** (string) (required) - **mediaType** (string) (required) - **pagesCount** (integer (int32)) (required) - **status** (string) (required) - **metadata** (object) (required) - **authors** (array (AuthorDto)) (required) Array items: - **name** (string) (required) - **role** (string) (required) - **authorsLock** (boolean) (required) - **created** (string (date-time)) (required) - **isbn** (string) (required) - **isbnLock** (boolean) (required) - **lastModified** (string (date-time)) (required) - **links** (array (WebLinkDto)) (required) Array items: - **label** (string) (required) - **url** (string) (required) - **linksLock** (boolean) (required) - **number** (string) (required) - **numberLock** (boolean) (required) - **numberSort** (number (float)) (required) - **numberSortLock** (boolean) (required) - **releaseDate** (string (date)) - **releaseDateLock** (boolean) (required) - **summary** (string) (required) - **summaryLock** (boolean) (required) - **tags** (array (string)) (required) - **tagsLock** (boolean) (required) - **title** (string) (required) - **titleLock** (boolean) (required) - **name** (string) (required) - **number** (integer (int32)) (required) - **oneshot** (boolean) (required) - **readProgress** (object) - **completed** (boolean) (required) - **created** (string (date-time)) (required) - **deviceId** (string) (required) - **deviceName** (string) (required) - **lastModified** (string (date-time)) (required) - **page** (integer (int32)) (required) - **readDate** (string (date-time)) (required) - **seriesId** (string) (required) - **seriesTitle** (string) (required) - **size** (string) (required) - **sizeBytes** (integer (int64)) (required) - **url** (string) (required) #### 400 - Bad Request **ValidationErrorResponse** - **violations** (array (Violation)) (required) Array items: - **fieldName** (string) - **message** (string) ### Example Usage ```bash curl -X GET "https://demo.komga.org/api/v1/books/{bookId}/next" ``` ``` -------------------------------- ### GET /api/v1/page-hashes/unknown Source: https://raw.githubusercontent.com/gotson/komga/refs/heads/master/komga/docs/openapi.json Required role: **ADMIN** ```markdown ### Parameters - **page** (integer, query, optional): Zero-based page index (0..N) - **size** (integer, query, optional): The size of the page to be returned - **sort** (array (string), query, optional): Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported. ### Responses #### 200 - OK **PagePageHashUnknownDto** - **content** (array (PageHashUnknownDto)) Array items: - **hash** (string) (required) - **matchCount** (integer (int32)) (required) - **size** (integer (int64)) - **empty** (boolean) - **first** (boolean) - **last** (boolean) - **number** (integer (int32)) - **numberOfElements** (integer (int32)) - **pageable** (object) - **offset** (integer (int64)) - **pageNumber** (integer (int32)) - **pageSize** (integer (int32)) - **paged** (boolean) - **sort** (object) - **empty** (boolean) - **sorted** (boolean) - **unsorted** (boolean) - **unpaged** (boolean) - **size** (integer (int32)) - **sort** (object) - **totalElements** (integer (int64)) - **totalPages** (integer (int32)) #### 400 - Bad Request **ValidationErrorResponse** - **violations** (array (Violation)) (required) Array items: - **fieldName** (string) - **message** (string) ### Example Usage ```bash curl -X GET "https://demo.komga.org/api/v1/page-hashes/unknown?page=0&size=0&sort=item1,item2" ``` ``` -------------------------------- ### GET /api/v1/books/{bookId}/manifest/divina Source: https://raw.githubusercontent.com/gotson/komga/refs/heads/master/komga/docs/openapi.json API endpoint for GET /api/v1/books/{bookId}/manifest/divina ```markdown ### Parameters - **bookId** (string, path, required) ### Responses #### 200 - OK **WPPublicationDto** - **context** (string) - **images** (array (WPLinkDto)) (required) Array items: - **height** (integer (int32)) - **href** (string) - **properties** (object) (required) - **rel** (string) - **templated** (boolean) - **title** (string) - **type** (string) - **width** (integer (int32)) - **landmarks** (array (WPLinkDto)) (required) Array items: - **links** (array (WPLinkDto)) (required) Array items: - **metadata** (object) (required) - **artist** (array (string)) (required) - **author** (array (string)) (required) - **belongsTo** (object) - **collection** (array (WPContributorDto)) (required) Array items: - **links** (array (WPLinkDto)) (required) Array items: - **name** (string) (required) - **position** (number (float)) - **series** (array (WPContributorDto)) (required) Array items: - **colorist** (array (string)) (required) - **conformsTo** (string) - **contributor** (array (string)) (required) - **description** (string) - **editor** (array (string)) (required) - **identifier** (string) - **illustrator** (array (string)) (required) - **inker** (array (string)) (required) - **language** (string) - **letterer** (array (string)) (required) - **modified** (string (date-time)) - **numberOfPages** (integer (int32)) - **penciler** (array (string)) (required) - **published** (string (date)) - **publisher** (array (string)) (required) - **readingProgression** (string (rtl|ltr|ttb|btt|auto)) ("rtl"|"ltr"|"ttb"|"btt"|"auto") - **rendition** (object) (required) - **sortAs** (string) - **subject** (array (string)) (required) - **subtitle** (string) - **title** (string) (required) - **translator** (array (string)) (required) - **type** (string) - **pageList** (array (WPLinkDto)) (required) Array items: - **readingOrder** (array (WPLinkDto)) (required) Array items: - **resources** (array (WPLinkDto)) (required) Array items: - **toc** (array (WPLinkDto)) (required) Array items: **WPPublicationDto** #### 400 - Bad Request **ValidationErrorResponse** - **violations** (array (Violation)) (required) Array items: - **fieldName** (string) - **message** (string) ### Example Usage ```bash curl -X GET "https://demo.komga.org/api/v1/books/{bookId}/manifest/divina" ``` ``` -------------------------------- ### GET /api/v1/page-hashes Source: https://raw.githubusercontent.com/gotson/komga/refs/heads/master/komga/docs/openapi.json Required role: **ADMIN** ```markdown ### Parameters - **action** (array (string (DELETE_AUTO|DELETE_MANUAL|IGNORE)), query, optional) - **page** (integer, query, optional): Zero-based page index (0..N) - **size** (integer, query, optional): The size of the page to be returned - **sort** (array (string), query, optional): Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported. ### Responses #### 200 - OK **PagePageHashKnownDto** - **content** (array (PageHashKnownDto)) Array items: - **action** (string (DELETE_AUTO|DELETE_MANUAL|IGNORE)) (required) ("DELETE_AUTO"|"DELETE_MANUAL"|"IGNORE") - **created** (string (date-time)) (required) - **deleteCount** (integer (int32)) (required) - **hash** (string) (required) - **lastModified** (string (date-time)) (required) - **matchCount** (integer (int32)) (required) - **size** (integer (int64)) - **empty** (boolean) - **first** (boolean) - **last** (boolean) - **number** (integer (int32)) - **numberOfElements** (integer (int32)) - **pageable** (object) - **offset** (integer (int64)) - **pageNumber** (integer (int32)) - **pageSize** (integer (int32)) - **paged** (boolean) - **sort** (object) - **empty** (boolean) - **sorted** (boolean) - **unsorted** (boolean) - **unpaged** (boolean) - **size** (integer (int32)) - **sort** (object) - **totalElements** (integer (int64)) - **totalPages** (integer (int32)) #### 400 - Bad Request **ValidationErrorResponse** - **violations** (array (Violation)) (required) Array items: - **fieldName** (string) - **message** (string) ### Example Usage ```bash curl -X GET "https://demo.komga.org/api/v1/page-hashes?action=item1,item2&page=0&size=0&sort=item1,item2" ``` ``` -------------------------------- ### GET /api/v2/users/authentication-activity Source: https://raw.githubusercontent.com/gotson/komga/refs/heads/master/komga/docs/openapi.json Required role: **ADMIN** ```markdown ### Parameters - **unpaged** (boolean, query, optional) - **page** (integer, query, optional): Zero-based page index (0..N) - **size** (integer, query, optional): The size of the page to be returned - **sort** (array (string), query, optional): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. ### Responses #### 200 - OK **PageAuthenticationActivityDto** - **content** (array (AuthenticationActivityDto)) Array items: - **apiKeyComment** (string) - **apiKeyId** (string) - **dateTime** (string (date-time)) (required) - **email** (string) - **error** (string) - **ip** (string) - **source** (string) - **success** (boolean) (required) - **userAgent** (string) - **userId** (string) - **empty** (boolean) - **first** (boolean) - **last** (boolean) - **number** (integer (int32)) - **numberOfElements** (integer (int32)) - **pageable** (object) - **offset** (integer (int64)) - **pageNumber** (integer (int32)) - **pageSize** (integer (int32)) - **paged** (boolean) - **sort** (object) - **empty** (boolean) - **sorted** (boolean) - **unsorted** (boolean) - **unpaged** (boolean) - **size** (integer (int32)) - **sort** (object) - **totalElements** (integer (int64)) - **totalPages** (integer (int32)) #### 400 - Bad Request **ValidationErrorResponse** - **violations** (array (Violation)) (required) Array items: - **fieldName** (string) - **message** (string) ### Example Usage ```bash curl -X GET "https://demo.komga.org/api/v2/users/authentication-activity?unpaged=true&page=0&size=20&sort=item1,item2" ``` ``` -------------------------------- ### GET /api/v1/series/new Source: https://raw.githubusercontent.com/gotson/komga/refs/heads/master/komga/docs/openapi.json Return newly added series. ```markdown ### Parameters - **library_id** (array (string), query, optional) - **deleted** (boolean, query, optional) - **oneshot** (boolean, query, optional) - **unpaged** (boolean, query, optional) - **page** (integer, query, optional): Zero-based page index (0..N) - **size** (integer, query, optional): The size of the page to be returned ### Responses #### 200 - OK **PageSeriesDto** - **content** (array (SeriesDto)) Array items: - **booksCount** (integer (int32)) (required) - **booksInProgressCount** (integer (int32)) (required) - **booksMetadata** (object) (required) - **authors** (array (AuthorDto)) (required) Array items: - **name** (string) (required) - **role** (string) (required) - **created** (string (date-time)) (required) - **lastModified** (string (date-time)) (required) - **releaseDate** (string (date)) - **summary** (string) (required) - **summaryNumber** (string) (required) - **tags** (array (string)) (required) - **booksReadCount** (integer (int32)) (required) - **booksUnreadCount** (integer (int32)) (required) - **created** (string (date-time)) (required) - **deleted** (boolean) (required) - **fileLastModified** (string (date-time)) (required) - **id** (string) (required) - **lastModified** (string (date-time)) (required) - **libraryId** (string) (required) - **metadata** (object) (required) - **ageRating** (integer (int32)) - **ageRatingLock** (boolean) (required) - **alternateTitles** (array (AlternateTitleDto)) (required) Array items: - **label** (string) (required) - **title** (string) (required) - **alternateTitlesLock** (boolean) (required) - **created** (string (date-time)) (required) - **genres** (array (string)) (required) - **genresLock** (boolean) (required) - **language** (string) (required) - **languageLock** (boolean) (required) - **lastModified** (string (date-time)) (required) - **links** (array (WebLinkDto)) (required) Array items: - **label** (string) (required) - **url** (string) (required) - **linksLock** (boolean) (required) - **publisher** (string) (required) - **publisherLock** (boolean) (required) - **readingDirection** (string) (required) - **readingDirectionLock** (boolean) (required) - **sharingLabels** (array (string)) (required) - **sharingLabelsLock** (boolean) (required) - **status** (string) (required) - **statusLock** (boolean) (required) - **summary** (string) (required) - **summaryLock** (boolean) (required) - **tags** (array (string)) (required) - **tagsLock** (boolean) (required) - **title** (string) (required) - **titleLock** (boolean) (required) - **titleSort** (string) (required) - **titleSortLock** (boolean) (required) - **totalBookCount** (integer (int32)) - **totalBookCountLock** (boolean) (required) - **name** (string) (required) - **oneshot** (boolean) (required) - **url** (string) (required) - **empty** (boolean) - **first** (boolean) - **last** (boolean) - **number** (integer (int32)) - **numberOfElements** (integer (int32)) - **pageable** (object) - **offset** (integer (int64)) - **pageNumber** (integer (int32)) - **pageSize** (integer (int32)) - **paged** (boolean) - **sort** (object) - **empty** (boolean) - **sorted** (boolean) - **unsorted** (boolean) - **unpaged** (boolean) - **size** (integer (int32)) - **sort** (object) - **totalElements** (integer (int64)) - **totalPages** (integer (int32)) #### 400 - Bad Request **ValidationErrorResponse** - **violations** (array (Violation)) (required) Array items: - **fieldName** (string) - **message** (string) ### Example Usage ```bash curl -X GET "https://demo.komga.org/api/v1/series/new?library_id=item1,item2&deleted=true&oneshot=true&unpaged=true&page=0&size=0" ``` ``` -------------------------------- ### GET /api/v1/page-hashes/{pageHash} Source: https://raw.githubusercontent.com/gotson/komga/refs/heads/master/komga/docs/openapi.json Required role: **ADMIN** ```markdown ### Parameters - **pageHash** (string, path, required) - **page** (integer, query, optional): Zero-based page index (0..N) - **size** (integer, query, optional): The size of the page to be returned - **sort** (array (string), query, optional): Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported. ### Responses #### 200 - OK **PagePageHashMatchDto** - **content** (array (PageHashMatchDto)) Array items: - **bookId** (string) (required) - **fileName** (string) (required) - **fileSize** (integer (int64)) (required) - **mediaType** (string) (required) - **pageNumber** (integer (int32)) (required) - **url** (string) (required) - **empty** (boolean) - **first** (boolean) - **last** (boolean) - **number** (integer (int32)) - **numberOfElements** (integer (int32)) - **pageable** (object) - **offset** (integer (int64)) - **pageNumber** (integer (int32)) - **pageSize** (integer (int32)) - **paged** (boolean) - **sort** (object) - **empty** (boolean) - **sorted** (boolean) - **unsorted** (boolean) - **unpaged** (boolean) - **size** (integer (int32)) - **sort** (object) - **totalElements** (integer (int64)) - **totalPages** (integer (int32)) #### 400 - Bad Request **ValidationErrorResponse** - **violations** (array (Violation)) (required) Array items: - **fieldName** (string) - **message** (string) ### Example Usage ```bash curl -X GET "https://demo.komga.org/api/v1/page-hashes/{pageHash}?page=0&size=0&sort=item1,item2" ``` ``` -------------------------------- ### GET /api/v2/users/{id}/authentication-activity/latest Source: https://raw.githubusercontent.com/gotson/komga/refs/heads/master/komga/docs/openapi.json Required role: **ADMIN** ```markdown ### Parameters - **id** (string, path, required) - **apikey_id** (string, query, optional) ### Responses #### 200 - OK **AuthenticationActivityDto** - **apiKeyComment** (string) - **apiKeyId** (string) - **dateTime** (string (date-time)) (required) - **email** (string) - **error** (string) - **ip** (string) - **source** (string) - **success** (boolean) (required) - **userAgent** (string) - **userId** (string) #### 400 - Bad Request **ValidationErrorResponse** - **violations** (array (Violation)) (required) Array items: - **fieldName** (string) - **message** (string) ### Example Usage ```bash curl -X GET "https://demo.komga.org/api/v2/users/{id}/authentication-activity/latest?apikey_id=string" ``` ``` -------------------------------- ### PUT /api/v1/books/thumbnails Source: https://raw.githubusercontent.com/gotson/komga/refs/heads/master/komga/docs/openapi.json Required role: **ADMIN** ```markdown ### Parameters - **for_bigger_result_only** (boolean, query, optional) ### Responses #### 202 - Accepted Empty response body #### 400 - Bad Request **ValidationErrorResponse** - **violations** (array (Violation)) (required) Array items: - **fieldName** (string) - **message** (string) ### Example Usage ```bash curl -X PUT "https://demo.komga.org/api/v1/books/thumbnails?for_bigger_result_only=true" ``` ``` -------------------------------- ### GET /api/v2/users/me/authentication-activity Source: https://raw.githubusercontent.com/gotson/komga/refs/heads/master/komga/docs/openapi.json API endpoint for GET /api/v2/users/me/authentication-activity ```markdown ### Parameters - **unpaged** (boolean, query, optional) - **page** (integer, query, optional): Zero-based page index (0..N) - **size** (integer, query, optional): The size of the page to be returned - **sort** (array (string), query, optional): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. ### Responses #### 200 - OK **PageAuthenticationActivityDto** - **content** (array (AuthenticationActivityDto)) Array items: - **apiKeyComment** (string) - **apiKeyId** (string) - **dateTime** (string (date-time)) (required) - **email** (string) - **error** (string) - **ip** (string) - **source** (string) - **success** (boolean) (required) - **userAgent** (string) - **userId** (string) - **empty** (boolean) - **first** (boolean) - **last** (boolean) - **number** (integer (int32)) - **numberOfElements** (integer (int32)) - **pageable** (object) - **offset** (integer (int64)) - **pageNumber** (integer (int32)) - **pageSize** (integer (int32)) - **paged** (boolean) - **sort** (object) - **empty** (boolean) - **sorted** (boolean) - **unsorted** (boolean) - **unpaged** (boolean) - **size** (integer (int32)) - **sort** (object) - **totalElements** (integer (int64)) - **totalPages** (integer (int32)) #### 400 - Bad Request **ValidationErrorResponse** - **violations** (array (Violation)) (required) Array items: - **fieldName** (string) - **message** (string) ### Example Usage ```bash curl -X GET "https://demo.komga.org/api/v2/users/me/authentication-activity?unpaged=true&page=0&size=20&sort=item1,item2" ``` ``` -------------------------------- ### GET /api/v2/users/me/api-keys Source: https://raw.githubusercontent.com/gotson/komga/refs/heads/master/komga/docs/openapi.json API endpoint for GET /api/v2/users/me/api-keys ```markdown ### Responses #### 200 - OK - Array of ApiKeyDto #### 400 - Bad Request **ValidationErrorResponse** - **violations** (array (Violation)) (required) Array items: - **fieldName** (string) - **message** (string) ### Example Usage ```bash curl -X GET "https://demo.komga.org/api/v2/users/me/api-keys" ``` ``` -------------------------------- ### POST /api/v1/books/import Source: https://raw.githubusercontent.com/gotson/komga/refs/heads/master/komga/docs/openapi.json Required role: **ADMIN** ```markdown ### Request Body **Content-Type:** application/json - **books** (array (BookImportDto)) (required) Array items: - **destinationName** (string) - **seriesId** (string) (required) - **sourceFile** (string) (required) - **upgradeBookId** (string) - **copyMode** (string (MOVE|COPY|HARDLINK)) (required) ("MOVE"|"COPY"|"HARDLINK") ### Responses #### 202 - Accepted Empty response body #### 400 - Bad Request **ValidationErrorResponse** - **violations** (array (Violation)) (required) Array items: - **fieldName** (string) - **message** (string) ### Example Usage ```bash curl -X POST "https://demo.komga.org/api/v1/books/import" \ -H "Content-Type: application/json" \ -d '{ "books": [ "value" ], "copyMode": "MOVE" }' ``` ``` -------------------------------- ### POST /api/v1/transient-books Source: https://raw.githubusercontent.com/gotson/komga/refs/heads/master/komga/docs/openapi.json Scan provided folder for transient books. Required role: **ADMIN** ```markdown ### Request Body **Content-Type:** application/json - **path** (string) (required) ### Responses #### 200 - OK - Array of TransientBookDto #### 400 - Bad Request **ValidationErrorResponse** - **violations** (array (Violation)) (required) Array items: - **fieldName** (string) - **message** (string) ### Example Usage ```bash curl -X POST "https://demo.komga.org/api/v1/transient-books" \ -H "Content-Type: application/json" \ -d '{ "path": "string" }' ``` ``` -------------------------------- ### GET /api/v2/users/me Source: https://raw.githubusercontent.com/gotson/komga/refs/heads/master/komga/docs/openapi.json API endpoint for GET /api/v2/users/me ```markdown ### Parameters - **remember-me** (boolean, query, optional) ### Responses #### 200 - OK **UserDto** - **ageRestriction** (object) - **age** (integer (int32)) (required) - **restriction** (string (ALLOW_ONLY|EXCLUDE)) (required) ("ALLOW_ONLY"|"EXCLUDE") - **email** (string) (required) - **id** (string) (required) - **labelsAllow** (array (string)) (required) - **labelsExclude** (array (string)) (required) - **roles** (array (string)) (required) - **sharedAllLibraries** (boolean) (required) - **sharedLibrariesIds** (array (string)) (required) #### 400 - Bad Request **ValidationErrorResponse** - **violations** (array (Violation)) (required) Array items: - **fieldName** (string) - **message** (string) ### Example Usage ```bash curl -X GET "https://demo.komga.org/api/v2/users/me?remember-me=true" ``` ``` -------------------------------- ### PATCH /api/v1/client-settings/global Source: https://raw.githubusercontent.com/gotson/komga/refs/heads/master/komga/docs/openapi.json Setting key should be a valid lowercase namespace string like 'application.domain.key' Required role: **ADMIN** ```markdown ### Request Body **Content-Type:** application/json ### Responses #### 204 - No Content Empty response body #### 400 - Bad Request **ValidationErrorResponse** - **violations** (array (Violation)) (required) Array items: - **fieldName** (string) - **message** (string) ### Example Usage ```bash curl -X PATCH "https://demo.komga.org/api/v1/client-settings/global" \ -H "Content-Type: application/json" \ -d '"value"' ``` ``` -------------------------------- ### GET /api/v1/readlists Source: https://raw.githubusercontent.com/gotson/komga/refs/heads/master/komga/docs/openapi.json API endpoint for GET /api/v1/readlists ```markdown ### Parameters - **search** (string, query, optional) - **library_id** (array (string), query, optional) - **unpaged** (boolean, query, optional) - **page** (integer, query, optional): Zero-based page index (0..N) - **size** (integer, query, optional): The size of the page to be returned ### Responses #### 200 - OK **PageReadListDto** - **content** (array (ReadListDto)) Array items: - **bookIds** (array (string)) (required) - **createdDate** (string (date-time)) (required) - **filtered** (boolean) (required) - **id** (string) (required) - **lastModifiedDate** (string (date-time)) (required) - **name** (string) (required) - **ordered** (boolean) (required) - **summary** (string) (required) - **empty** (boolean) - **first** (boolean) - **last** (boolean) - **number** (integer (int32)) - **numberOfElements** (integer (int32)) - **pageable** (object) - **offset** (integer (int64)) - **pageNumber** (integer (int32)) - **pageSize** (integer (int32)) - **paged** (boolean) - **sort** (object) - **empty** (boolean) - **sorted** (boolean) - **unsorted** (boolean) - **unpaged** (boolean) - **size** (integer (int32)) - **sort** (object) - **totalElements** (integer (int64)) - **totalPages** (integer (int32)) #### 400 - Bad Request **ValidationErrorResponse** - **violations** (array (Violation)) (required) Array items: - **fieldName** (string) - **message** (string) ### Example Usage ```bash curl -X GET "https://demo.komga.org/api/v1/readlists?search=string&library_id=item1,item2&unpaged=true&page=0&size=0" ``` ```