Check anonymous liveness at /health.

Check anonymous readiness at /health/ready.

Get the authenticated detailed health report.

Get Cleanuparr version, uptime, resource, and instance status.

Check all configured download-client connections.

Check all configured Sonarr/Radarr/Lidarr-style connections.

List configured health checks.

Run all health checks, or one check by GUID when check_id is supplied.

List scheduled jobs and their current status.

Get one job. Values include QueueCleaner, MalwareBlocker, DownloadCleaner, BlacklistSynchronizer, Seeker, and CustomFormatScoreSyncer.

Run a one-time job now. Seeker cannot be manually triggered.

Start a job with a schedule object containing the JobSchedule DTO.

Replace a job schedule using the JobSchedule DTO.

List events. Dates are ISO-8601 strings; page_size is capped by the API at 500.

Get one event by GUID.

Get events associated with a tracking GUID.

List event type enum values.

List event severity enum values.

Get event timeline buckets for the requested number of hours.

List manual events with pagination and optional filters.

Get one manual event by GUID.

Mark one manual event resolved.

Mark all unresolved manual events resolved.

Get manual-event counts by severity and resolution.

List manual-event severity enum values.

List strike-bearing download items.

List recent strikes; count is capped by the API at 50.

List strike type enum values.

Delete all strikes for a download-item GUID.

Get v2 aggregate statistics. The deprecated v1 stats endpoint is not exposed.

Get v2 metric timeline. Metrics include events, strikesIssued, recovered, removed, and malwareBlocked; buckets include hour, day, week, and month.

Get Seeker search totals and per-instance summary.

List Seeker search events. search_status can contain repeated enum filters.

List current custom-format scores with cutoff and monitored filters.

List recent custom-format score upgrades.

List instances and quality profiles with tracked scores.

Get custom-format score tracking statistics.

Get score history for an item; episode_id is used for Sonarr episode history.

Get general configuration, including dry-run and auth settings.

Replace general config. Fields include dryRun, retry/timeout settings, ignoredDownloads, connectivity, retention, log, and auth objects.

Purge all stored strikes. This is irreversible.

Replace one *arr config, normally containing failedImportMaxStrikes.

Create an *arr instance. DTO fields: enabled, name, url, apiKey, version, externalUrl.

Replace an *arr instance. Use Cleanuparr's secret placeholder for apiKey.

Delete an *arr instance by GUID.

Test an *arr connection. DTO fields: url, apiKey, version, optional instanceId.

List configured download clients.

Create a download client. DTO includes enabled, name, typeName, type, host, username, password, urlBase, externalUrl, and directory source/target.

Replace a download client. Use the secret placeholder for password.

Delete a download client by GUID.

Test a download client. DTO includes typeName, type, host, credentials, urlBase, and optional clientId.

Get queue cleaner configuration.

Replace queue cleaner config. DTO includes enabled, cronExpression, useAdvancedScheduling, failedImport, downloadingMetadataMaxStrikes, processNoContentId, and ignoredDownloads.

List stall or slow queue rules.

Create a stall or slow queue rule. Common DTO fields include name, enabled, maxStrikes, privacyType, completion percentages, and changeCategory.

Replace a stall or slow queue rule. Stall fields include minimumProgress; slow fields include minSpeed, maxTimeHours, and ignoreAboveSize.

Delete a stall or slow queue rule by GUID.

Get download cleaner configuration.

Replace download cleaner config: enabled, cronExpression, useAdvancedScheduling, and ignoredDownloads.

Get dead-torrent settings for a download-client GUID.

Replace dead-torrent settings: enabled, targetCategory, useTag, maxStrikes, categories.

Get unlinked-file settings for a download-client GUID.

Replace unlinked settings: enabled, targetCategory, useTag, ignoredRootDirs, categories.

Get orphaned-file settings for a download-client GUID.

Replace orphaned-file settings: enabled, scanDirectories, orphanedDirectory, excludePatterns, minFileAgeHours, and optional purgeAfterHours.

List seeding rules for a download-client GUID.

Create a seeding rule. DTO includes name, categories, trackerPatterns, tagsAny/tagsAll, priority, privacyType, ratio/time/seeder limits, and deleteSourceFiles.

Replace a seeding rule by GUID. Priority is ignored by the upstream update.

Delete a seeding rule by GUID.

Reorder rules by sending an orderedIds GUID array.

Get malware blocker configuration.

Replace malware blocker config, including per-arr blocklist settings.

Get Seeker configuration.

Replace Seeker config: search toggles, strategy, grace period, and instances.

Get blacklist synchronizer configuration.

Replace blacklist sync config: enabled and optional blacklistPath.

List notification providers. Secret fields may be redacted by Cleanuparr.

Get Apprise CLI availability status.

Create a notification provider.

Types: notifiarr, apprise, ntfy, telegram, discord, pushover, gotify. Common fields are name, isEnabled, and event flags; provider-specific fields follow the API DTO.

Replace a notification provider. Use Cleanuparr placeholders for secrets.

Test a notification provider using its provider-specific DTO.

Delete a notification provider by GUID.