/
KA
kareadita
/
Kavita
Search skmtc…
⌘K
Docs
Sign in
Sign in
APIs
Generators
Stacks
Projects
Docs
History
Schema
Sources
Checked 51m ago · Updated 1d ago
View markdown
kareadita
Kavita
post
Updates a remap rule with issue-level detail (volume/chapter).
a092f0284f3e
latest
OpenAPI 3.0.4
GPL-3.0
raw.githubusercontent.com
2026-08-09
511
372
878.4 KB
Account
28
Activity
1
Admin
1
Annotation
12
Book
4
Cbl
14
post
Enqueues the Reading List to be synced on a background thread. UI will be informed from Kavita.Models.DTOs.SignalR.MessageFactory.ReadingListUpdated event
post
Saves an uploaded CBL file to disk without importing. Returns the saved file info.
post
Downloads a CBL file from a URL and saves it to disk without importing.
post
Downloads selected CBL files from the GitHub repo and saves them to disk without importing.
post
Validates an already-saved CBL file on disk. Called by the import modal after remap rule changes.
post
Finalizes the import of a saved CBL file with user decisions
get
Returns all remap rules accessible to the current user (own rules + global/admin rules).
post
Creates a new remap rule, or updates an existing one if a rule with the same CBL matching key (normalized name + volume + number) already exists for this user. When no explicit VolumeId is provided, attempts to auto-resolve a matching volume on the target series from the CBL volume string.
get
Returns all rules across all users
post
Promotes a remap rule to global scope. Admin-only.
post
Demotes a global remap rule back to user-scoped. Admin-only.
post
Updates a remap rule with issue-level detail (volume/chapter).
delete
Deletes a remap rule. Users can only delete their own rules.
get
Provides the browse CBL Repo interface. Requires Download role.
Chapter
5
Collection
12
ColorScape
3
Device
10
Download
12
Email
1
Filter
12
Font
5
Health
1
Image
15
KavitaPlusAudit
5
Koreader
3
Library
23
License
13
Locale
1
Manage
1
Metadata
14
OAuth
2
Oidc
2
Opds
22
Panels
2
Person
10
Plugin
5
Rating
4
Reader
39
ReadingList
27
ReadingProfile
16
Review
5
Scrobbling
18
Search
4
Series
33
Server
18
Settings
20
Stats
34
Stream
17
Tachiyomi
2
Theme
7
Upload
10
Users
10
Volume
4
WantToRead
4
Cbl
Updates a remap rule with issue-level detail (volume/chapter).
post
/api/Cbl/remap-rules/{id}
Path parameters
id
integer
required
Request body
UpdateRemapRuleDto
required
cblSeriesName
string
nullable
seriesId
integer
nullable
volumeId
integer
nullable
chapterId
integer
nullable
cblVolume
string
nullable
cblNumber
string
nullable
Response
OK
RemapRuleDto
required
id
integer
normalizedCblSeriesName
string
nullable
cblSeriesName
string
nullable
cblVolume
string
nullable
cblNumber
string
nullable
seriesId
integer
volumeId
integer
nullable
volumeNumber
string
nullable
chapterId
integer
nullable
kind
0
|
1
|
2
Members:
0
— Series
1
— Volume
2
— Chapter
chapterRange
string
nullable
chapterTitleName
string
nullable
chapterIsSpecial
boolean
libraryType
0
|
1
|
2
|
3
|
4
|
5
Members:
0
— Manga
1
— Comic (Flexible) (Comic)
2
— Book
3
— Image
4
— Light Novel (LightNovel)
5
— Comic (ComicVine)
seriesNameAtMapping
string
nullable
appUserId
integer
isGlobal
boolean
createdByUserName
string
nullable
createdUtc
string
date-time