Legacy API Mylar3-compatible command-dispatch API with all 59 commands.
The legacy API maintains backward compatibility with Mylar3. All existing Mylar3 integrations and scripts work with Comicarr by changing only the host URL.
http://localhost:8090/api?cmd=COMMAND&apikey=YOUR_KEY Pass your API key as the apikey query parameter:
curl "http://localhost:8090/api?cmd=getIndex&apikey=YOUR_KEY" # Get all monitored series curl "http://localhost:8090/api?cmd=getIndex&apikey=YOUR_KEY" # Get details for a specific comic curl "http://localhost:8090/api?cmd=getComic&id=12345&apikey=YOUR_KEY" # Search for a new series curl "http://localhost:8090/api?cmd=findComic&name=Batman&apikey=YOUR_KEY" Command Description getIndexList all monitored series getComicGet details for a specific series getUpcomingList upcoming issues getWantedList wanted (missing) issues getHistoryGet download history getLogsRetrieve application logs getAPIGet API information and version clearLogsClear application logs
Command Description findComicSearch ComicVine for a series by name addComicAdd a series to the watchlist delComicRemove a series from the watchlist pauseComicPause monitoring for a series resumeComicResume monitoring for a paused series refreshComicRefresh metadata for a series from ComicVine changeBookTypeChange the book type (comic, TPB, HC, etc.) getComicInfoGet extended series information getIssueInfoGet details for a specific issue getArtGet cover art URLs for a series regenerateCoversRe-download cover images for a series refreshSeriesjsonRefresh the series.json metadata file seriesjsonListingList all series.json entries listAnnualSeriesList annual series linked to a parent series
Command Description addIssueAdd a specific issue to the wanted list recheckFilesRe-scan the filesystem for existing issues queueIssueAdd an issue to the search queue unqueueIssueRemove an issue from the search queue forceSearchForce an immediate search for a series forceProcessForce post-processing of downloaded files changeStatusChange the status of an issue downloadIssueManually trigger download for an issue
Command Description downloadNZBSend an NZB directly to the download client getReadListGet the current reading list
Command Description getStoryArcGet details for a story arc addStoryArcAdd a story arc to tracking
Command Description listProvidersList all configured search providers changeProviderUpdate a provider's configuration addProviderAdd a new search provider delProviderRemove a search provider
Command Description getConfigGet current configuration values setConfigUpdate configuration values
Command Description getImportPendingList files pending import matchImportMatch an imported file to a ComicVine issue ignoreImportIgnore a pending import file refreshImportRe-scan the import directory deleteImportDelete a pending import entry
Command Description findMangaSearch for manga on MangaDex addMangaAdd a manga series to monitoring getMangaInfoGet details for a manga series
Command Description bulkMetatagRun metadata tagging across multiple issues getSeriesImageGet the series cover image URL
Command Description getCalendarGet calendar data for upcoming releases getStartupDiagnosticsGet diagnostic information from last startup
Command Description previewMigrationPreview migration from Mylar3 (validate only) startMigrationExecute the Mylar3 migration getMigrationProgressCheck migration progress and status
Command Description getVersionGet the current Comicarr version checkGithubCheck for available updates on GitHub shutdownShut down the Comicarr process restartRestart the Comicarr process updatePull and apply an update checkGlobalMessagesCheck for global system messages