Für andere Apps

Ihre anderen Werkzeuge können Routarr fragen.

Ein Skript, n8n, Home Assistant oder ein Dashboard kann fragen, wohin ein Titel käme, seine Kategorie erzwingen, eine Simulation starten und anwenden oder den Zustand lesen, jeweils mit einem Schlüssel, der nur darf, was Sie erlaubt haben.

01
X-Api-Key: rtr_…
Erstellen Sie auf der Seite Apps einen Schlüssel pro Werkzeug. Jeder Schlüssel liest, und ein Geltungsbereich, der etwas ändert, etwa operate (Bedienen) zum Anwenden oder write (Schreiben) zum Festlegen eines Titels, wird nur gewährt, wo er nötig ist: Die Referenz unten nennt den, den jede Operation braucht. Routarr zeigt den Schlüssel nur einmal, und Authorization: Bearer trägt ihn ebenfalls.
02
GET /api/v1/route
Fragen Sie, wohin ein Titel käme. Routarr schlägt ihn im Arr nach, schickt ihn durch Ihre Regeln und verschiebt nichts. Hier behält jq von der Antwort, was ein Skript braucht.
03
GET /api/v1/openapi.json
Jede Operation und der Geltungsbereich, den sie braucht, stehen auf der Seite API-Referenz Ihres Routarr, das den OpenAPI-Vertrag unter diesem Pfad ausliefert, für die Version, die es ausführt.

route.sh

curl -fsS -H "X-Api-Key: $ROUTARR_KEY" \
  "http://localhost:9876/api/v1/route?type=movie&tmdb=149" \
  | jq '.answers[0]
      | {category, folder: .root_folder.path, action, rule}'

answer.json

{
  "category": "anime",
  "folder": "/movies/anime",
  "action": "move",
  "rule": "Japanische Animation"
}

Nichts, was unter /api/v1 dokumentiert ist, wird entfernt, umbenannt oder ändert seinen Typ. Neue Operationen und Felder können mit jeder Version kommen.

Referenz

Was eine App fragen kann.

Die Operationen von Routarr 0.2.0, der Version, die diese Seite nennt, geordnet nach dem, was sie berühren. Öffnen Sie eine, um zu sehen, was sie nimmt und was sie antwortet. Das Wort rechts ist der Geltungsbereich, den ein Schlüssel braucht. Ein Typname führt zu seinem Eintrag unter den zuletzt aufgeführten Typen.

Zustand

Ob Routarr läuft und was Aufmerksamkeit braucht.

GET/api/v1/auth/meWem der Schlüssel gehörtread

Nimmt nichts.

Antwort 200Me

subject: string

GET/api/v1/healthJedes Arr und jede Quelle erreichen und berichtenoperate

Parameter

probe: boolean · in der Abfrage
fresh: boolean · in der Abfrage

Antwort 200HealthResponse

database: string
instances: InstanceHealth[]
metadata: MetadataHealth
stats: AppStats
status: string
version: string
warnings: Warning[]

GET/api/v1/metadata/providersDie Metadatenquellen und was jede beantworten kannread

Nimmt nichts.

Antwort 200ProvidersResponse

order: string[]
providers: ProviderDescription[]

GET/api/v1/metricsPrometheus-Metrikenread

Nimmt nichts.

Antwort 200

GET/api/v1/pingOb Routarr läuftohne Schlüssel

Nimmt nichts.

Antwort 200Pong

status: string

GET/api/v1/statusWas Aufmerksamkeit brauchtread

Nimmt nichts.

Antwort 200StatusResponse

dry_run: boolean
failed_decisions: integer
pending_decisions: integer
running_jobs: integer
version: string
warnings: Warning[]

Bibliothek

Die Titel, die Routarr aus den Arrs gelesen hat, und wohin jeder gehört.

GET/api/v1/mediaDie Bibliothek, Seite für Seiteread

Parameter

instance_id: string · in der Abfrage
media_type: string · in der Abfrage
category: string · in der Abfrage
search: string · in der Abfrage
tmdb_id: integer · in der Abfrage
tvdb_id: integer · in der Abfrage
imdb_id: string · in der Abfrage
unmatched: boolean · in der Abfrage
page: integer · in der Abfrage
per_page: integer · in der Abfrage

Antwort 200Page_MediaListItem

data: MediaListItem[]
pagination: Pagination

GET/api/v1/media/facetsDie Werte der Bibliothek, für jede Bedingungread

Nimmt nichts.

Antwort 200LibraryFacets

certifications: Facet[]
genres: Facet[]
origin_countries: Facet[]
original_languages: Facet[]
root_folders: Facet[]
series_types: Facet[]
statuses: Facet[]
tags: Facet[]
total_media: integer
vocabularies: Vocabularies
without_metadata: integer

GET/api/v1/media/{id}Ein Titelread

Parameter

id: string · im Pfad · erforderlich

Antwort 200MediaDetail

instance_name: string?
media: MediaView
metadata: MediaMetadata?
override: PinnedCategory?

GET/api/v1/media/{id}/explainWohin ein Titel kommt, und warumread

Parameter

id: string · im Pfad · erforderlich

Antwort 200Explanation

action: string
confidence: number
instance_enabled: boolean
media: MediaView
metadata: MediaMetadata?
override_category: string?
rule_traces: RuleTrace[]
rules_category: string
target_category: string
target_root_folder: string?
winning_rule: string?

GET/api/v1/routeWohin ein Titel käme, den ein anderer Dienst nenntread

Parameter

type: string · in der Abfrage · erforderlich
tmdb: integer · in der Abfrage
tvdb: integer · in der Abfrage
imdb: string · in der Abfrage
instance: string · in der Abfrage
tags: string · in der Abfrage
series_type: string · in der Abfrage
monitored: boolean · in der Abfrage
enrich: boolean · in der Abfrage

Antwort 200Placement

answers: PlacementAnswer[]
errors: InstanceFailure[]

Entscheidungen

Die Regeln über die Bibliothek simulieren und die Verschiebungen, die sie entscheiden, anwenden oder rückgängig machen.

GET/api/v1/decisionsDie Entscheidungen, Seite für Seiteread

Parameter

instance_id: string · in der Abfrage
media_type: string · in der Abfrage
status: string · in der Abfrage
category: string · in der Abfrage
action: string · in der Abfrage
simulation_id: string · in der Abfrage
search: string · in der Abfrage
include_superseded: boolean · in der Abfrage
page: integer · in der Abfrage
per_page: integer · in der Abfrage

Antwort 200Page_Decision

data: Decision[]
pagination: Pagination

POST/api/v1/decisions/applyAusgewählte Entscheidungen anwendenoperate

Parameter

Prefer: string? · Header

Rumpf

confirm: Confirmed
decision_ids: string[] · erforderlich
move_files: boolean

Antwort 200ApplyReport

applied: integer
errors: ApplyError[]
failed: integer
moving: integer
requested: integer
skipped: integer
stopped: StopReason?
superseded: integer

POST/api/v1/decisions/apply-allAlles anwenden, was eine Simulation vorgeschlagen hatoperate

Parameter

Prefer: string? · Header

Rumpf

confirm: Confirmed
move_files: boolean
simulation_id: string · erforderlich

Antwort 200BatchApplyReport

applied: integer
batches_planned: integer
batches_run: integer
candidates: integer
errors: ApplyError[]
failed: integer
moving: integer
skipped: integer
stopped: StopReason?
stopped_early: boolean
superseded: integer

POST/api/v1/decisions/revertTitel zurückverschiebenoperate

Parameter

Prefer: string? · Header

Rumpf

confirm: Confirmed
decision_ids: string[] · erforderlich
move_files: boolean

Antwort 200ApplyReport

applied: integer
errors: ApplyError[]
failed: integer
moving: integer
requested: integer
skipped: integer
stopped: StopReason?
superseded: integer

POST/api/v1/simulateDie Regeln über die Bibliothek laufen lassenoperate

Parameter

Prefer: string? · Header

Rumpf

instance_ids: string[]?
max_returned: integer?
media_type: string?
persist: boolean
persist_unchanged: boolean

Antwort 200SimulationResult

already_correct: integer
capacity: CapacityForecast[]
decisions: Decision[]
elapsed_ms: integer
excluded_by_rule: integer
moves_required: integer
no_category_match: integer
overrides_applied: integer
returned: integer
simulation_id: string
skipped_unmapped: integer
total_media: integer

Ausnahmen

Titel, deren Kategorie von Hand erzwungen ist und die jede Regel übertreffen.

GET/api/v1/overridesDie Ausnahmenread

Parameter

page: integer · in der Abfrage
per_page: integer · in der Abfrage

Antwort 200Page_OverrideWithMedia

data: OverrideWithMedia[]
pagination: Pagination

POST/api/v1/overridesDie Kategorie eines Titels erzwingenwrite

Rumpf

media_id: string · erforderlich
reason: string?
target_category: string · erforderlich

Antwort 201OverrideEntry

created_at: string
id: string
media_id: string
reason: string?
subject: string?
target_category: string

DELETE/api/v1/overrides/externalDie Ausnahme eines Titels über die Kennung entfernen, die ein anderer Dienst ihm gibtwrite

Parameter

type: string · in der Abfrage · erforderlich
tmdb: integer · in der Abfrage
tvdb: integer · in der Abfrage
imdb: string · in der Abfrage
instance: string · in der Abfrage

Antwort 200Deleted

deleted: boolean

PUT/api/v1/overrides/externalDie Kategorie eines Titels über die Kennung erzwingen, die ein anderer Dienst ihm gibtwrite

Parameter

type: string · in der Abfrage · erforderlich
tmdb: integer · in der Abfrage
tvdb: integer · in der Abfrage
imdb: string · in der Abfrage
instance: string · in der Abfrage

Rumpf

reason: string?
target_category: string · erforderlich

Antwort 200OverrideEntry[]

created_at: string
id: string
media_id: string
reason: string?
subject: string?
target_category: string

DELETE/api/v1/overrides/{id}Eine Ausnahme entfernenwrite

Parameter

id: string · im Pfad · erforderlich

Antwort 200Deleted

deleted: boolean

Aufgaben

Was im Hintergrund lief und wie es endete.

GET/api/v1/jobsDie Aufgaben, die neuesten zuerstread

Parameter

status: string · in der Abfrage
kind: string · in der Abfrage
page: integer · in der Abfrage
per_page: integer · in der Abfrage
include: string · in der Abfrage

Antwort 200Page_Job

data: Job[]
pagination: Pagination

GET/api/v1/jobs/{id}Eine Aufgaberead

Parameter

id: string · im Pfad · erforderlich

Antwort 200Job

detail: string?
error: string?
error_message: string?
finished_at: string?
id: string
instance_id: string?
kind: string
progress_current: integer
progress_total: integer
result: object
started_at: string
status: string
subject: string?
trigger: string

GET/api/v1/logsWas jede Verschiebung bewirkt hat, Seite für Seiteread

Parameter

instance_id: string · in der Abfrage
media_id: string · in der Abfrage
action: string · in der Abfrage
success: boolean · in der Abfrage
search: string · in der Abfrage
page: integer · in der Abfrage
per_page: integer · in der Abfrage

Antwort 200Page_LogEntry

data: LogEntry[]
pagination: Pagination

GET/api/v1/logs/exportDasselbe Protokoll als CSV-Dateiread

Parameter

instance_id: string · in der Abfrage
media_id: string · in der Abfrage
action: string · in der Abfrage
success: boolean · in der Abfrage
search: string · in der Abfrage

Antwort 200

Instanzen

Die Arrs, die Routarr liest, und sie erneut lesen.

GET/api/v1/instancesDie Arrs, die Routarr liestread

Nimmt nichts.

Antwort 200InstanceResponse[]

api_key_encrypted: boolean
api_key_masked: string
api_key_set: boolean
base_url: string
created_at: string
enabled: boolean
id: string
instance_type: string
last_sync_at: string?
last_sync_attempt_at: string?
last_sync_status: string?
name: string
sync_interval_minutes: integer
updated_at: string
webhook_path: string?
webhook_token: string?
webhook_url: string?

POST/api/v1/instances/syncJedes aktivierte Arr erneut lesenoperate

Parameter

Prefer: string? · Header

Antwort 200SyncReport[]

error: string?
instance_id: string
instance_name: string
media: integer
removed: integer
root_folders: integer

GET/api/v1/instances/{id}Ein Arrread

Parameter

id: string · im Pfad · erforderlich

Antwort 200InstanceResponse

api_key_encrypted: boolean
api_key_masked: string
api_key_set: boolean
base_url: string
created_at: string
enabled: boolean
id: string
instance_type: string
last_sync_at: string?
last_sync_attempt_at: string?
last_sync_status: string?
name: string
sync_interval_minutes: integer
updated_at: string
webhook_path: string?
webhook_token: string?
webhook_url: string?

POST/api/v1/instances/{id}/syncEin Arr erneut lesenoperate

Parameter

id: string · im Pfad · erforderlich
Prefer: string? · Header

Antwort 200SyncReport

error: string?
instance_id: string
instance_name: string
media: integer
removed: integer
root_folders: integer

Regeln

Die Regeln nach Priorität, die Bedingungen, die sie verwenden können, und die Tests, die festhalten, was sie entscheiden.

GET/api/v1/rule-testsDie Regeltestsread

Parameter

page: integer · in der Abfrage
per_page: integer · in der Abfrage

Antwort 200Page_RuleTest

data: RuleTest[]
pagination: Pagination

POST/api/v1/rule-testsAls Test festhalten, was die Regeln für einen Titel entscheidenconfigure

Rumpf

expected_category: string?
media_id: string · erforderlich
name: string · erforderlich

Antwort 201RuleTest

created_at: string
evaluated_at: string
expected_category: string
id: string
media_type: string
name: string
source_media_title: string?

POST/api/v1/rule-tests/runJeden Regeltest gegen die aktuellen Regeln ausführenoperate

Nimmt nichts.

Antwort 200RuleTestRun

failed: integer
passed: integer
results: RuleTestResult[]
total: integer

DELETE/api/v1/rule-tests/{id}Einen Regeltest entfernenconfigure

Parameter

id: string · im Pfad · erforderlich

Antwort 200Deleted

deleted: boolean

GET/api/v1/rulesDie Regeln nach Prioritätread

Nimmt nichts.

Antwort 200Rule[]

conditions: Condition[]
created_at: string
description: string?
enabled: boolean
exclusions: Condition[]
id: string
instance_ids: string[]?
match_mode: MatchMode
media_type: string
name: string
priority: integer
target_category: string
updated_at: string

POST/api/v1/rulesEine Regel anlegenconfigure

Rumpf

conditions: Condition[] · erforderlich
description: string?
enabled: boolean
exclusions: Condition[]
instance_ids: string[]?
match_mode: MatchMode
media_type: string · erforderlich
name: string · erforderlich
priority: integer?
target_category: string · erforderlich

Antwort 201Rule

conditions: Condition[]
created_at: string
description: string?
enabled: boolean
exclusions: Condition[]
id: string
instance_ids: string[]?
match_mode: MatchMode
media_type: string
name: string
priority: integer
target_category: string
updated_at: string

GET/api/v1/rules/conditionsDie Bedingungen, die eine Regel verwenden kannread

Nimmt nichts.

Antwort 200ConditionCatalog

conditions: ConditionSpec[]
match_modes: string[]

GET/api/v1/rules/exportDie Regeln als Paketread

Nimmt nichts.

Antwort 200RuleBundle

categories: string[]
exported_at: string?
rules: BundledRule[]
version: integer

GET/api/v1/rules/healthWas jede Regel entscheidetread

Nimmt nichts.

Antwort 200RuleHealthReport

rules: RuleHealth[]
total_media: integer

POST/api/v1/rules/importEin Regelpaket importierenconfigure

Rumpf

bundle: RuleBundle · erforderlich
create_missing_categories: boolean
replace: boolean

Antwort 200RuleImportReport

adjusted: string[]
imported: integer
replaced: boolean
skipped: string[]

POST/api/v1/rules/previewWas ein Regelentwurf verschieben würde, ohne etwas zu speichernconfigure

Rumpf

instance_ids: string[]?
rule: CreateRuleRequest · erforderlich
rule_id: string?
sample_size: integer

Antwort 200PreviewResponse

after: PreviewSummary
before: PreviewSummary
changed: PreviewChange[]
changed_total: integer
issues: ValidationIssue[]

POST/api/v1/rules/reorderDie Regeln neu ordnenconfigure

Rumpf

rule_ids: string[] · erforderlich

Antwort 200Reordered

reordered: integer

POST/api/v1/rules/validateEinen Regelentwurf prüfen, ohne etwas zu speichernconfigure

Rumpf

conditions: Condition[] · erforderlich
description: string?
enabled: boolean
exclusions: Condition[]
instance_ids: string[]?
match_mode: MatchMode
media_type: string · erforderlich
name: string · erforderlich
priority: integer?
target_category: string · erforderlich

Antwort 200RuleVerdict

issues: ValidationIssue[]
valid: boolean

DELETE/api/v1/rules/{id}Eine Regel entfernenconfigure

Parameter

id: string · im Pfad · erforderlich

Antwort 200Deleted

deleted: boolean

GET/api/v1/rules/{id}Eine Regelread

Parameter

id: string · im Pfad · erforderlich

Antwort 200Rule

conditions: Condition[]
created_at: string
description: string?
enabled: boolean
exclusions: Condition[]
id: string
instance_ids: string[]?
match_mode: MatchMode
media_type: string
name: string
priority: integer
target_category: string
updated_at: string

PUT/api/v1/rules/{id}Eine Regel ersetzenconfigure

Parameter

id: string · im Pfad · erforderlich

Rumpf

conditions: Condition[] · erforderlich
description: string?
enabled: boolean
exclusions: Condition[]
instance_ids: string[]?
match_mode: MatchMode
media_type: string · erforderlich
name: string · erforderlich
priority: integer?
target_category: string · erforderlich

Antwort 200Rule

conditions: Condition[]
created_at: string
description: string?
enabled: boolean
exclusions: Condition[]
id: string
instance_ids: string[]?
match_mode: MatchMode
media_type: string
name: string
priority: integer
target_category: string
updated_at: string

POST/api/v1/rules/{id}/duplicateEine Regel kopieren, deaktiviertconfigure

Parameter

id: string · im Pfad · erforderlich

Antwort 201Rule

conditions: Condition[]
created_at: string
description: string?
enabled: boolean
exclusions: Condition[]
id: string
instance_ids: string[]?
match_mode: MatchMode
media_type: string
name: string
priority: integer
target_category: string
updated_at: string

Kategorien und Ordner

Die Kategorien und die Stammordner, die zu jeder führen.

POST/api/v1/categoriesEine Kategorie anlegenconfigure

Rumpf

description: string?
display_order: integer
is_default: boolean
name: string · erforderlich

Antwort 201Category

created_at: string
description: string?
display_order: integer
id: string
is_default: boolean
name: string

DELETE/api/v1/categories/{id}Eine Kategorie entfernenconfigure

Parameter

id: string · im Pfad · erforderlich

Antwort 200Deleted

deleted: boolean

PUT/api/v1/categories/{id}Eine Kategorie umbenennenconfigure

Parameter

id: string · im Pfad · erforderlich

Rumpf

name: string · erforderlich

Antwort 200Category

created_at: string
description: string?
display_order: integer
id: string
is_default: boolean
name: string

GET/api/v1/root-foldersDie Stammordner und die Kategorie, zu der jeder führtread

Nimmt nichts.

Antwort 200RootFolderWithInstance[]

accessible: boolean
arr_id: integer?
category: string?
free_space: integer?
id: string
instance_id: string
last_accessible_at: string?
last_synced_at: string?
origin: string
path: string
instance_name: string
instance_type: string

POST/api/v1/root-foldersEin Ziel angeben, das das Arr nicht auflistetconfigure

Rumpf

instance_id: string · erforderlich
path: string · erforderlich

Antwort 201Declared

id: string
path: string
verified: boolean

GET/api/v1/root-folders/conflictsWas die Zuordnungen offenlassenread

Nimmt nichts.

Antwort 200MappingConflict[]

category: string?
instance_name: string?
kind: string
message: string
severity: string

DELETE/api/v1/root-folders/{id}Ein angegebenes Ziel entfernenconfigure

Parameter

id: string · im Pfad · erforderlich

Antwort 200Deleted

deleted: boolean

PUT/api/v1/root-folders/{id}/categoryEinen Ordner einer Kategorie zuordnen, oder keinerconfigure

Parameter

id: string · im Pfad · erforderlich

Rumpf

category: string? · erforderlich

Antwort 200Mapped

category: string?
updated: boolean

Sicherungen

Die Sicherungen, die Routarr aufbewahrt, und sofort eine anlegen.

GET/api/v1/backupsDie aufbewahrten Sicherungenread

Nimmt nichts.

Antwort 200BackupListResponse

backups: BackupFile[]
retention_count: integer

POST/api/v1/backupsSofort eine Sicherung anlegenoperate

Parameter

Prefer: string? · Header

Antwort 200BackupFile

created_at: string
encrypted: boolean
name: string
size_bytes: integer

Typen

Jede Form, die die Operationen oben nehmen oder antworten. Ein Typname öffnet hier seinen Eintrag.

AlternativeDecision

category: string · erforderlich
confidence: number
excluded_by: string?
reason: string · erforderlich
rule_name: string · erforderlich

ApplyAllRequest

confirm: Confirmed
move_files: boolean
simulation_id: string · erforderlich

ApplyDecisionsRequest

confirm: Confirmed
decision_ids: string[] · erforderlich
move_files: boolean

ApplyError

decision_id: string · erforderlich
media_title: string · erforderlich
message: string · erforderlich

ApplyReport

applied: integer · erforderlich
errors: ApplyError[] · erforderlich
failed: integer · erforderlich
moving: integer · erforderlich
requested: integer · erforderlich
skipped: integer · erforderlich
stopped: StopReason?
superseded: integer · erforderlich

AppStats

applied_decisions: integer · erforderlich
enabled_rules: integer · erforderlich
failed_decisions: integer · erforderlich
pending_decisions: integer · erforderlich
running_jobs: integer · erforderlich
total_instances: integer · erforderlich
total_media: integer · erforderlich
total_movies: integer · erforderlich
total_overrides: integer · erforderlich
total_rules: integer · erforderlich
total_series: integer · erforderlich
unmapped_categories: integer · erforderlich

BackupFile

created_at: string · erforderlich
encrypted: boolean · erforderlich
name: string · erforderlich
size_bytes: integer · erforderlich

BackupListResponse

backups: BackupFile[] · erforderlich
retention_count: integer · erforderlich

BatchApplyReport

applied: integer · erforderlich
batches_planned: integer · erforderlich
batches_run: integer · erforderlich
candidates: integer · erforderlich
errors: ApplyError[] · erforderlich
failed: integer · erforderlich
moving: integer · erforderlich
skipped: integer · erforderlich
stopped: StopReason?
stopped_early: boolean · erforderlich
superseded: integer · erforderlich

BundledRule

conditions: Condition[] · erforderlich
description: string?
enabled: boolean
exclusions: Condition[]
instance_ids: string[]?
match_mode: MatchMode
media_type: string · erforderlich
name: string · erforderlich
priority: integer?
target_category: string · erforderlich
instance_names: string[]?

CapacityForecast

fits: boolean · erforderlich
free_bytes: integer · erforderlich
incoming_bytes: integer · erforderlich
instance_id: string · erforderlich
instance_name: string?
items: integer · erforderlich
path: string · erforderlich
same_filesystem_bytes: integer · erforderlich

Category

created_at: string · erforderlich
description: string?
display_order: integer · erforderlich
id: string · erforderlich
is_default: boolean · erforderlich
name: string · erforderlich

CategoryWithUsage

created_at: string · erforderlich
description: string?
display_order: integer · erforderlich
id: string · erforderlich
is_default: boolean · erforderlich
name: string · erforderlich
root_folder_count: integer · erforderlich
rule_count: integer · erforderlich

Condition

Eine dieser Formen, unterschieden nach type

genre_contains: value string[]
genre_contains_all: value string[]
genre_not_contains: value string[]
keyword_contains: value string[]
keyword_contains_all: value string[]
keyword_not_contains: value string[]
original_language: value string[]
original_language_not: value string[]
origin_country: value string[]
origin_country_all: value string[]
year_range: value object
tag_in: value string[]
tag_in_all: value string[]
series_type_is: value string[]
size_on_disk_over_gb: value integer
season_count_over: value integer
certification_in: value string[]
status_is: value string[]
current_root_folder: value string
current_root_folder_starts_with: value string
has_files: value boolean
title_contains: value string[]
tmdb_id_in: value integer[]
tvdb_id_in: value integer[]
imdb_id_in: value string[]
added_within_days: value integer
monitored: value boolean
has_metadata: value boolean

ConditionCatalog

conditions: ConditionSpec[] · erforderlich
match_modes: string[] · erforderlich

ConditionOutcome

expected: string
key: string · erforderlich
kind: string · erforderlich
matched: boolean · erforderlich
observed: string · erforderlich
params: object · erforderlich
source: string?

ConditionSpec

available: boolean · erforderlich
counterpart: string · erforderlich
label: string · erforderlich
label_key: string · erforderlich
media_types: string[] · erforderlich
metadata_field: string?
needs_metadata: boolean · erforderlich
quantifier: string · erforderlich
suggestions: string · erforderlich
type: string · erforderlich
value_type: string · erforderlich

Confirmed

Eine Liste von string

CreateCategoryRequest

description: string?
display_order: integer
is_default: boolean
name: string · erforderlich

CreateOverrideRequest

media_id: string · erforderlich
reason: string?
target_category: string · erforderlich

CreateRuleRequest

conditions: Condition[] · erforderlich
description: string?
enabled: boolean
exclusions: Condition[]
instance_ids: string[]?
match_mode: MatchMode
media_type: string · erforderlich
name: string · erforderlich
priority: integer?
target_category: string · erforderlich

Decision

action: string · erforderlich
actor: string?
alternatives: AlternativeDecision[] · erforderlich
applied_at: string?
confidence: number
current_root_folder: string?
decided_at: string · erforderlich
error_message: string?
id: string · erforderlich
instance_id: string · erforderlich
instance_name: string?
is_override: boolean · erforderlich
matched_rule_id: string?
matched_rule_name: string?
media_id: string · erforderlich
media_title: string · erforderlich
media_type: string · erforderlich
reason_lines: ReasonLine[] · erforderlich
reasons: string[] · erforderlich
reverted_at: string?
revertible: boolean
simulation_id: string?
status: string · erforderlich
subject: string?
superseded: boolean
target_category: string · erforderlich
target_root_folder: string?

Declared

id: string · erforderlich
path: string · erforderlich
verified: boolean · erforderlich

DeclareRootFolder

instance_id: string · erforderlich
path: string · erforderlich

Deleted

deleted: boolean · erforderlich

Explanation

action: string · erforderlich
confidence: number · erforderlich
instance_enabled: boolean · erforderlich
media: MediaView · erforderlich
metadata: MediaMetadata?
override_category: string?
rule_traces: RuleTrace[] · erforderlich
rules_category: string · erforderlich
target_category: string · erforderlich
target_root_folder: string?
winning_rule: string?

HealthResponse

database: string · erforderlich
instances: InstanceHealth[] · erforderlich
metadata: MetadataHealth · erforderlich
stats: AppStats · erforderlich
status: string · erforderlich
version: string · erforderlich
warnings: Warning[] · erforderlich

ImportRulesRequest

bundle: RuleBundle · erforderlich
create_missing_categories: boolean
replace: boolean

InstanceFailure

error: string · erforderlich
instance_id: string · erforderlich
instance_name: string · erforderlich

InstanceHealth

detail: string?
id: string · erforderlich
instance_type: string · erforderlich
last_sync: string?
last_sync_status: string?
mapped_root_folders: integer · erforderlich
media_count: integer · erforderlich
name: string · erforderlich
status: string · erforderlich
version: string?

InstanceResponse

api_key_encrypted: boolean · erforderlich
api_key_masked: string · erforderlich
api_key_set: boolean · erforderlich
base_url: string · erforderlich
created_at: string · erforderlich
enabled: boolean · erforderlich
id: string · erforderlich
instance_type: string · erforderlich
last_sync_at: string?
last_sync_attempt_at: string?
last_sync_status: string?
name: string · erforderlich
sync_interval_minutes: integer · erforderlich
updated_at: string · erforderlich
webhook_path: string?
webhook_token: string?
webhook_url: string?

Job

detail: string?
error: string?
error_message: string?
finished_at: string?
id: string · erforderlich
instance_id: string?
kind: string · erforderlich
progress_current: integer · erforderlich
progress_total: integer · erforderlich
result: object
started_at: string · erforderlich
status: string · erforderlich
subject: string?
trigger: string · erforderlich

LibraryFacets

certifications: Facet[] · erforderlich
genres: Facet[] · erforderlich
origin_countries: Facet[] · erforderlich
original_languages: Facet[] · erforderlich
root_folders: Facet[] · erforderlich
series_types: Facet[] · erforderlich
statuses: Facet[] · erforderlich
tags: Facet[] · erforderlich
total_media: integer · erforderlich
vocabularies: Vocabularies · erforderlich
without_metadata: integer · erforderlich

LogEntry

action: string · erforderlich
actor: string?
decision_id: string?
details: string?
error_message: string?
executed_at: string · erforderlich
id: string · erforderlich
instance_id: string?
media_id: string?
media_title: string?
subject: string?
success: boolean · erforderlich

Mapped

category: string?
updated: boolean · erforderlich

MappingConflict

category: string?
instance_name: string?
kind: string · erforderlich
message: string · erforderlich
severity: string · erforderlich

MatchMode

Einer dieser Werte

all
any

Me

subject: string · erforderlich

Media

added_at: string?
arr_id: integer · erforderlich
certification: string?
current_path: string?
current_root_folder: string?
genres: string?
has_files: boolean · erforderlich
id: string · erforderlich
imdb_id: string?
instance_id: string · erforderlich
last_synced_at: string?
media_type: string · erforderlich
monitored: boolean · erforderlich
original_language: string?
season_count: integer?
series_type: string?
size_on_disk: integer?
sort_title: string?
status: string?
tags: string?
title: string · erforderlich
tmdb_id: integer?
tvdb_id: integer?
year: integer?

MediaDetail

instance_name: string?
media: MediaView · erforderlich
metadata: MediaMetadata?
override: PinnedCategory?

MediaListItem

arr_id: integer · erforderlich
computed_category: string?
current_root_folder: string?
has_files: boolean · erforderlich
has_metadata: boolean · erforderlich
id: string · erforderlich
imdb_id: string?
instance_id: string · erforderlich
instance_name: string · erforderlich
last_synced_at: string?
media_type: string · erforderlich
monitored: boolean · erforderlich
override_category: string?
status: string?
title: string · erforderlich
tmdb_id: integer?
tvdb_id: integer?
year: integer?

MediaMetadata

certification: string?
certification_scale: string?
field_sources: object
genres: string[]
keywords: string[]
origin_countries: string[]
original_language: string?
overview: string?
poster_path: string?
sources: string[]
status: string?

MediaView

added_at: string?
arr_id: integer · erforderlich
certification: string?
current_path: string?
current_root_folder: string?
genres: string?
has_files: boolean · erforderlich
id: string · erforderlich
imdb_id: string?
instance_id: string · erforderlich
last_synced_at: string?
media_type: string · erforderlich
monitored: boolean · erforderlich
original_language: string?
season_count: integer?
series_type: string?
size_on_disk: integer?
sort_title: string?
status: string?
tags: string?
title: string · erforderlich
tmdb_id: integer?
tvdb_id: integer?
year: integer?
genre_list: string[] · erforderlich
tag_list: string[] · erforderlich

MetadataHealth

cached_items: integer · erforderlich
media_missing_metadata: integer · erforderlich
providers: MetadataProviderHealth[] · erforderlich

MetadataProviderHealth

configured: boolean · erforderlich
connected: boolean?
display_name: string · erforderlich
id: string · erforderlich
needs_key: boolean · erforderlich
reason: string?

NewRuleTest

expected_category: string?
media_id: string · erforderlich
name: string · erforderlich

OverrideEntry

created_at: string · erforderlich
id: string · erforderlich
media_id: string · erforderlich
reason: string?
subject: string?
target_category: string · erforderlich

OverrideWithMedia

created_at: string · erforderlich
id: string · erforderlich
media_id: string · erforderlich
reason: string?
subject: string?
target_category: string · erforderlich
instance_name: string · erforderlich
media_title: string · erforderlich
media_type: string · erforderlich

Page_Decision

data: Decision[] · erforderlich
pagination: Pagination · erforderlich

Page_Job

data: Job[] · erforderlich
pagination: Pagination · erforderlich

Page_LogEntry

data: LogEntry[] · erforderlich
pagination: Pagination · erforderlich

Page_MediaListItem

data: MediaListItem[] · erforderlich
pagination: Pagination · erforderlich

Page_OverrideWithMedia

data: OverrideWithMedia[] · erforderlich
pagination: Pagination · erforderlich

Page_RuleTest

data: RuleTest[] · erforderlich
pagination: Pagination · erforderlich

PinnedCategory

reason: string?
target_category: string · erforderlich

PinRequest

reason: string?
target_category: string · erforderlich

Placement

answers: PlacementAnswer[] · erforderlich
errors: InstanceFailure[] · erforderlich

PlacementAnswer

action: string · erforderlich
category: string · erforderlich
confidence: number · erforderlich
current_root_folder: string?
instance_id: string · erforderlich
instance_name: string · erforderlich
is_override: boolean · erforderlich
media_id: string?
root_folder: PlacementFolder?
rule: string?
source: string · erforderlich
title: string · erforderlich
unanswered_fields: string[] · erforderlich
year: integer?

PlacementFolder

origin: string · erforderlich
path: string · erforderlich

Pong

status: string · erforderlich

PreviewChange

confidence: number · erforderlich
current_root_folder: string?
from_category: string · erforderlich
instance_name: string?
media_id: string · erforderlich
media_title: string · erforderlich
media_type: string · erforderlich
reasons: string[] · erforderlich
target_root_folder: string?
to_category: string · erforderlich

PreviewRequest

instance_ids: string[]?
rule: CreateRuleRequest · erforderlich
rule_id: string?
sample_size: integer

PreviewResponse

after: PreviewSummary · erforderlich
before: PreviewSummary · erforderlich
changed: PreviewChange[] · erforderlich
changed_total: integer · erforderlich
issues: ValidationIssue[] · erforderlich

PreviewSummary

already_correct: integer · erforderlich
excluded_by_rule: integer · erforderlich
moves_required: integer · erforderlich
no_category_match: integer · erforderlich
skipped_unmapped: integer · erforderlich
total_media: integer · erforderlich

ProviderDescription

configured: boolean · erforderlich
display_name: string · erforderlich
fetched: boolean · erforderlich
fields: string[] · erforderlich
id: string · erforderlich
key_env: string?
media_types: string[] · erforderlich
needs_key: boolean · erforderlich
website: string?

ProvidersResponse

order: string[] · erforderlich
providers: ProviderDescription[] · erforderlich

ReasonLine

matched: boolean?
text: string · erforderlich

RenameCategoryRequest

name: string · erforderlich

Reordered

reordered: integer · erforderlich

ReorderRulesRequest

rule_ids: string[] · erforderlich

RevertDecisionsRequest

confirm: Confirmed
decision_ids: string[] · erforderlich
move_files: boolean

RootFolder

accessible: boolean · erforderlich
arr_id: integer?
category: string?
free_space: integer?
id: string · erforderlich
instance_id: string · erforderlich
last_accessible_at: string?
last_synced_at: string?
origin: string · erforderlich
path: string · erforderlich

RootFolderWithInstance

accessible: boolean · erforderlich
arr_id: integer?
category: string?
free_space: integer?
id: string · erforderlich
instance_id: string · erforderlich
last_accessible_at: string?
last_synced_at: string?
origin: string · erforderlich
path: string · erforderlich
instance_name: string · erforderlich
instance_type: string · erforderlich

Rule

conditions: Condition[] · erforderlich
created_at: string · erforderlich
description: string?
enabled: boolean · erforderlich
exclusions: Condition[]
id: string · erforderlich
instance_ids: string[]?
match_mode: MatchMode
media_type: string · erforderlich
name: string · erforderlich
priority: integer · erforderlich
target_category: string · erforderlich
updated_at: string · erforderlich

RuleBundle

categories: string[]
exported_at: string?
rules: BundledRule[] · erforderlich
version: integer · erforderlich

RuleHealth

ambiguous_with: string?
duplicate_of: string?
enabled: boolean · erforderlich
matched_nothing: boolean · erforderlich
priority: integer · erforderlich
rule_id: string · erforderlich
rule_name: string · erforderlich
shadowed: integer · erforderlich
shadowed_by: string?
vetoed: integer · erforderlich
won: integer · erforderlich

RuleHealthReport

rules: RuleHealth[] · erforderlich
total_media: integer · erforderlich

RuleImportReport

adjusted: string[] · erforderlich
imported: integer · erforderlich
replaced: boolean · erforderlich
skipped: string[] · erforderlich

RuleTest

created_at: string · erforderlich
evaluated_at: string · erforderlich
expected_category: string · erforderlich
id: string · erforderlich
media_type: string · erforderlich
name: string · erforderlich
source_media_title: string?

RuleTestResult

actual_category: string?
error: string?
error_key: string?
expected_category: string · erforderlich
id: string · erforderlich
matched_rule: string?
name: string · erforderlich
passed: boolean · erforderlich

RuleTestRun

failed: integer · erforderlich
passed: integer · erforderlich
results: RuleTestResult[] · erforderlich
total: integer · erforderlich

RuleTrace

category: string · erforderlich
conditions: ConditionOutcome[] · erforderlich
excluded_by: string?
matched: boolean · erforderlich
outcome: string · erforderlich
priority: integer · erforderlich
rule_id: string · erforderlich
rule_name: string · erforderlich

RuleVerdict

issues: ValidationIssue[] · erforderlich
valid: boolean · erforderlich

SimulationRequest

instance_ids: string[]?
max_returned: integer?
media_type: string?
persist: boolean
persist_unchanged: boolean

SimulationResult

already_correct: integer · erforderlich
capacity: CapacityForecast[] · erforderlich
decisions: Decision[] · erforderlich
elapsed_ms: integer · erforderlich
excluded_by_rule: integer · erforderlich
moves_required: integer · erforderlich
no_category_match: integer · erforderlich
overrides_applied: integer · erforderlich
returned: integer · erforderlich
simulation_id: string · erforderlich
skipped_unmapped: integer · erforderlich
total_media: integer · erforderlich

StatusResponse

dry_run: boolean · erforderlich
failed_decisions: integer · erforderlich
pending_decisions: integer · erforderlich
running_jobs: integer · erforderlich
version: string · erforderlich
warnings: Warning[] · erforderlich

StopReason

Einer dieser Werte

dry_run
cancelled
shutdown

SyncReport

error: string?
instance_id: string · erforderlich
instance_name: string · erforderlich
media: integer · erforderlich
removed: integer · erforderlich
root_folders: integer · erforderlich

UpdateRootFolderCategory

category: string? · erforderlich

ValidationIssue

field: string · erforderlich
key: string · erforderlich
message: string
params: object · erforderlich
severity: string · erforderlich

Vocabularies

origin_countries: Facet[] · erforderlich
original_languages: Facet[] · erforderlich

Warning

code: string · erforderlich
guide_step: string?
message: string · erforderlich
severity: string · erforderlich