API

Overview of Comicarr's REST and legacy API surfaces.

Comicarr exposes two API surfaces. Both require API_ENABLED=True and a valid API_KEY configured in Settings > General.

The modern API. JSON request/response bodies, Api-Key header authentication, pagination, and event streaming.

  • Base URL: /rest/
  • Auth: Api-Key header
  • Format: JSON

Command-dispatch API compatible with Mylar3. Useful for existing integrations and tools that already speak the Mylar3 protocol.

  • Base URL: /api?cmd=COMMAND
  • Auth: apikey query parameter
  • Format: JSON

Quick Comparison

FeatureREST APILegacy API
Base URL/rest//api?cmd=
AuthenticationApi-Key headerapikey query param
Paginationlimit/offset paramsNot supported
Event streamingSupportedNot supported
Mylar3 compatibleNoYes

Getting Started

Authentication

API keys, session auth, and rate limiting.

REST API

Modern API with pagination and event streaming.

Legacy API

All 59 commands, Mylar3-compatible.

Post-Migration

Verify migrated data, test connections, and clean up after migration.

Authentication

API key, session, and rate limiting configuration for the Comicarr API.

On this page

Quick ComparisonGetting Started