Pour les autres applications

Vos autres outils peuvent interroger Routarr.

Un script, n8n, Home Assistant ou un tableau de bord peut demander où irait un titre, forcer sa catégorie, lancer une simulation et l'appliquer, ou lire l'état, chacun avec une clé qui ne fait que ce que vous avez permis.

01
X-Api-Key: rtr_…
Créez une clé sur l'écran Applications, une par outil. Toute clé lit, et une portée qui change quelque chose, comme operate (piloter) pour appliquer ou write (écrire) pour fixer un titre, ne s'accorde que là où il le faut : la référence plus bas nomme celle que demande chaque opération. Routarr ne montre la clé qu'une fois, et Authorization: Bearer la transporte aussi.
02
GET /api/v1/route
Demandez où irait un titre. Routarr le cherche dans l'Arr, le passe à vos règles et ne déplace rien. Ici, jq garde de la réponse ce dont un script a besoin.
03
GET /api/v1/openapi.json
Chaque opération et la portée qu'elle demande figurent sur l'écran Référence de l'API de votre Routarr, qui sert le contrat OpenAPI à ce chemin, pour la version qu'il exécute.

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": "Anime japonais"
}

Rien de ce qui est documenté sous /api/v1 n'est retiré, renommé ni ne change de type. De nouvelles opérations et de nouveaux champs peuvent arriver avec chaque version.

Référence

Ce qu'une application peut demander.

Les opérations de Routarr 0.2.0, la version que nomme cette page, groupées par ce qu'elles touchent. Ouvrez-en une pour voir ce qu'elle prend et ce qu'elle répond. Le mot à droite est la portée qu'il faut à une clé. Un nom de type mène à son entrée parmi les types listés en dernier.

État

Si Routarr répond, et ce qui demande votre attention.

GET/api/v1/auth/meÀ qui appartient la cléread

Ne prend rien.

Réponse 200Me

subject: string

GET/api/v1/healthJoindre chaque Arr et chaque source, et en rendre compteoperate

Paramètres

probe: boolean · dans la requête
fresh: boolean · dans la requête

Réponse 200HealthResponse

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

GET/api/v1/metadata/providersLes sources de métadonnées, et ce à quoi chacune peut répondreread

Ne prend rien.

Réponse 200ProvidersResponse

order: string[]
providers: ProviderDescription[]

GET/api/v1/metricsMétriques Prometheusread

Ne prend rien.

Réponse 200

GET/api/v1/pingSi Routarr répondsans clé

Ne prend rien.

Réponse 200Pong

status: string

GET/api/v1/statusCe qui demande votre attentionread

Ne prend rien.

Réponse 200StatusResponse

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

Bibliothèque

Les titres que Routarr a lus dans les Arrs, et où va chacun.

GET/api/v1/mediaLa bibliothèque, page par pageread

Paramètres

instance_id: string · dans la requête
media_type: string · dans la requête
category: string · dans la requête
search: string · dans la requête
tmdb_id: integer · dans la requête
tvdb_id: integer · dans la requête
imdb_id: string · dans la requête
unmatched: boolean · dans la requête
page: integer · dans la requête
per_page: integer · dans la requête

Réponse 200Page_MediaListItem

data: MediaListItem[]
pagination: Pagination

GET/api/v1/media/facetsLes valeurs que contient la bibliothèque, pour chaque conditionread

Ne prend rien.

Réponse 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}Un titreread

Paramètres

id: string · dans le chemin · obligatoire

Réponse 200MediaDetail

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

GET/api/v1/media/{id}/explainOù va un titre, et pourquoiread

Paramètres

id: string · dans le chemin · obligatoire

Réponse 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/routeOù irait un titre qu'un autre service nommeread

Paramètres

type: string · dans la requête · obligatoire
tmdb: integer · dans la requête
tvdb: integer · dans la requête
imdb: string · dans la requête
instance: string · dans la requête
tags: string · dans la requête
series_type: string · dans la requête
monitored: boolean · dans la requête
enrich: boolean · dans la requête

Réponse 200Placement

answers: PlacementAnswer[]
errors: InstanceFailure[]

Décisions

Simuler les règles sur la bibliothèque, puis appliquer ou annuler les déplacements qu'elles décident.

GET/api/v1/decisionsLes décisions, page par pageread

Paramètres

instance_id: string · dans la requête
media_type: string · dans la requête
status: string · dans la requête
category: string · dans la requête
action: string · dans la requête
simulation_id: string · dans la requête
search: string · dans la requête
include_superseded: boolean · dans la requête
page: integer · dans la requête
per_page: integer · dans la requête

Réponse 200Page_Decision

data: Decision[]
pagination: Pagination

POST/api/v1/decisions/applyAppliquer les décisions choisiesoperate

Paramètres

Prefer: string? · en-tête

Corps

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

Réponse 200ApplyReport

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

POST/api/v1/decisions/apply-allAppliquer tout ce qu'une simulation a proposéoperate

Paramètres

Prefer: string? · en-tête

Corps

confirm: Confirmed
move_files: boolean
simulation_id: string · obligatoire

Réponse 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/revertRemettre des titres en placeoperate

Paramètres

Prefer: string? · en-tête

Corps

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

Réponse 200ApplyReport

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

POST/api/v1/simulatePasser les règles sur la bibliothèqueoperate

Paramètres

Prefer: string? · en-tête

Corps

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

Réponse 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

Exceptions

Les titres dont la catégorie est forcée à la main, qui priment sur toutes les règles.

GET/api/v1/overridesLes exceptionsread

Paramètres

page: integer · dans la requête
per_page: integer · dans la requête

Réponse 200Page_OverrideWithMedia

data: OverrideWithMedia[]
pagination: Pagination

POST/api/v1/overridesForcer la catégorie d'un titrewrite

Corps

media_id: string · obligatoire
reason: string?
target_category: string · obligatoire

Réponse 201OverrideEntry

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

DELETE/api/v1/overrides/externalRetirer l'exception d'un titre par l'identifiant qu'un autre service lui donnewrite

Paramètres

type: string · dans la requête · obligatoire
tmdb: integer · dans la requête
tvdb: integer · dans la requête
imdb: string · dans la requête
instance: string · dans la requête

Réponse 200Deleted

deleted: boolean

PUT/api/v1/overrides/externalForcer la catégorie d'un titre par l'identifiant qu'un autre service lui donnewrite

Paramètres

type: string · dans la requête · obligatoire
tmdb: integer · dans la requête
tvdb: integer · dans la requête
imdb: string · dans la requête
instance: string · dans la requête

Corps

reason: string?
target_category: string · obligatoire

Réponse 200OverrideEntry[]

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

DELETE/api/v1/overrides/{id}Retirer une exceptionwrite

Paramètres

id: string · dans le chemin · obligatoire

Réponse 200Deleted

deleted: boolean

Tâches

Ce qui a tourné en arrière-plan, et comment cela s'est terminé.

GET/api/v1/jobsLes tâches, les plus récentes d'abordread

Paramètres

status: string · dans la requête
kind: string · dans la requête
page: integer · dans la requête
per_page: integer · dans la requête
include: string · dans la requête

Réponse 200Page_Job

data: Job[]
pagination: Pagination

GET/api/v1/jobs/{id}Une tâcheread

Paramètres

id: string · dans le chemin · obligatoire

Réponse 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/logsCe qu'a fait chaque déplacement, page par pageread

Paramètres

instance_id: string · dans la requête
media_id: string · dans la requête
action: string · dans la requête
success: boolean · dans la requête
search: string · dans la requête
page: integer · dans la requête
per_page: integer · dans la requête

Réponse 200Page_LogEntry

data: LogEntry[]
pagination: Pagination

GET/api/v1/logs/exportLe même journal en fichier CSVread

Paramètres

instance_id: string · dans la requête
media_id: string · dans la requête
action: string · dans la requête
success: boolean · dans la requête
search: string · dans la requête

Réponse 200

Instances

Les Arr que Routarr lit, et les relire.

GET/api/v1/instancesLes Arr que Routarr litread

Ne prend rien.

Réponse 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/syncRelire chaque Arr activéoperate

Paramètres

Prefer: string? · en-tête

Réponse 200SyncReport[]

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

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

Paramètres

id: string · dans le chemin · obligatoire

Réponse 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}/syncRelire un Arroperate

Paramètres

id: string · dans le chemin · obligatoire
Prefer: string? · en-tête

Réponse 200SyncReport

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

Règles

Les règles par ordre de priorité, les conditions qu'elles peuvent employer, et les tests qui fixent ce qu'elles décident.

GET/api/v1/rule-testsLes tests de règlesread

Paramètres

page: integer · dans la requête
per_page: integer · dans la requête

Réponse 200Page_RuleTest

data: RuleTest[]
pagination: Pagination

POST/api/v1/rule-testsFixer en test ce que les règles décident pour un titreconfigure

Corps

expected_category: string?
media_id: string · obligatoire
name: string · obligatoire

Réponse 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/runPasser chaque test sur les règles telles qu'elles sontoperate

Ne prend rien.

Réponse 200RuleTestRun

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

DELETE/api/v1/rule-tests/{id}Retirer un test de règlesconfigure

Paramètres

id: string · dans le chemin · obligatoire

Réponse 200Deleted

deleted: boolean

GET/api/v1/rulesLes règles, par ordre de prioritéread

Ne prend rien.

Réponse 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/rulesCréer une règleconfigure

Corps

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

Réponse 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/conditionsLes conditions qu'une règle peut employerread

Ne prend rien.

Réponse 200ConditionCatalog

conditions: ConditionSpec[]
match_modes: string[]

GET/api/v1/rules/exportLes règles en un lotread

Ne prend rien.

Réponse 200RuleBundle

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

GET/api/v1/rules/healthCe que décide chaque règleread

Ne prend rien.

Réponse 200RuleHealthReport

rules: RuleHealth[]
total_media: integer

POST/api/v1/rules/importImporter un lot de règlesconfigure

Corps

bundle: RuleBundle · obligatoire
create_missing_categories: boolean
replace: boolean

Réponse 200RuleImportReport

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

POST/api/v1/rules/previewCe que déplacerait un brouillon de règle, sans rien enregistrerconfigure

Corps

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

Réponse 200PreviewResponse

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

POST/api/v1/rules/reorderRemettre les règles dans un nouvel ordreconfigure

Corps

rule_ids: string[] · obligatoire

Réponse 200Reordered

reordered: integer

POST/api/v1/rules/validateJuger un brouillon de règle, sans rien enregistrerconfigure

Corps

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

Réponse 200RuleVerdict

issues: ValidationIssue[]
valid: boolean

DELETE/api/v1/rules/{id}Retirer une règleconfigure

Paramètres

id: string · dans le chemin · obligatoire

Réponse 200Deleted

deleted: boolean

GET/api/v1/rules/{id}Une règleread

Paramètres

id: string · dans le chemin · obligatoire

Réponse 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}Remplacer une règleconfigure

Paramètres

id: string · dans le chemin · obligatoire

Corps

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

Réponse 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}/duplicateCopier une règle, désactivéeconfigure

Paramètres

id: string · dans le chemin · obligatoire

Réponse 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

Catégories et dossiers

Les catégories, et les dossiers racines qui mènent à chacune.

POST/api/v1/categoriesCréer une catégorieconfigure

Corps

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

Réponse 201Category

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

DELETE/api/v1/categories/{id}Retirer une catégorieconfigure

Paramètres

id: string · dans le chemin · obligatoire

Réponse 200Deleted

deleted: boolean

PUT/api/v1/categories/{id}Renommer une catégorieconfigure

Paramètres

id: string · dans le chemin · obligatoire

Corps

name: string · obligatoire

Réponse 200Category

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

GET/api/v1/root-foldersLes dossiers racines, et la catégorie à laquelle mène chacunread

Ne prend rien.

Réponse 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-foldersDéclarer une destination que l'Arr ne liste pasconfigure

Corps

instance_id: string · obligatoire
path: string · obligatoire

Réponse 201Declared

id: string
path: string
verified: boolean

GET/api/v1/root-folders/conflictsCe que les associations laissent dans le flouread

Ne prend rien.

Réponse 200MappingConflict[]

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

DELETE/api/v1/root-folders/{id}Retirer une destination déclaréeconfigure

Paramètres

id: string · dans le chemin · obligatoire

Réponse 200Deleted

deleted: boolean

PUT/api/v1/root-folders/{id}/categoryMener un dossier à une catégorie, ou à aucuneconfigure

Paramètres

id: string · dans le chemin · obligatoire

Corps

category: string? · obligatoire

Réponse 200Mapped

category: string?
updated: boolean

Sauvegardes

Les sauvegardes que Routarr conserve, et en faire une tout de suite.

GET/api/v1/backupsLes sauvegardes conservéesread

Ne prend rien.

Réponse 200BackupListResponse

backups: BackupFile[]
retention_count: integer

POST/api/v1/backupsFaire une sauvegarde tout de suiteoperate

Paramètres

Prefer: string? · en-tête

Réponse 200BackupFile

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

Types

Chaque forme que prennent ou répondent les opérations ci-dessus. Un nom de type ouvre son entrée ici.

AlternativeDecision

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

ApplyAllRequest

confirm: Confirmed
move_files: boolean
simulation_id: string · obligatoire

ApplyDecisionsRequest

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

ApplyError

decision_id: string · obligatoire
media_title: string · obligatoire
message: string · obligatoire

ApplyReport

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

AppStats

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

BackupFile

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

BackupListResponse

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

BatchApplyReport

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

BundledRule

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

CapacityForecast

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

Category

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

CategoryWithUsage

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

Condition

L'une de ces formes, distinguées par 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[] · obligatoire
match_modes: string[] · obligatoire

ConditionOutcome

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

ConditionSpec

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

Confirmed

Une liste de string

CreateCategoryRequest

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

CreateOverrideRequest

media_id: string · obligatoire
reason: string?
target_category: string · obligatoire

CreateRuleRequest

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

Decision

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

Declared

id: string · obligatoire
path: string · obligatoire
verified: boolean · obligatoire

DeclareRootFolder

instance_id: string · obligatoire
path: string · obligatoire

Deleted

deleted: boolean · obligatoire

Explanation

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

HealthResponse

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

ImportRulesRequest

bundle: RuleBundle · obligatoire
create_missing_categories: boolean
replace: boolean

InstanceFailure

error: string · obligatoire
instance_id: string · obligatoire
instance_name: string · obligatoire

InstanceHealth

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

InstanceResponse

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

Job

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

LibraryFacets

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

LogEntry

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

Mapped

category: string?
updated: boolean · obligatoire

MappingConflict

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

MatchMode

L'une de ces valeurs

all
any

Me

subject: string · obligatoire

Media

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

MediaDetail

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

MediaListItem

arr_id: integer · obligatoire
computed_category: string?
current_root_folder: string?
has_files: boolean · obligatoire
has_metadata: boolean · obligatoire
id: string · obligatoire
imdb_id: string?
instance_id: string · obligatoire
instance_name: string · obligatoire
last_synced_at: string?
media_type: string · obligatoire
monitored: boolean · obligatoire
override_category: string?
status: string?
title: string · obligatoire
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 · obligatoire
certification: string?
current_path: string?
current_root_folder: string?
genres: string?
has_files: boolean · obligatoire
id: string · obligatoire
imdb_id: string?
instance_id: string · obligatoire
last_synced_at: string?
media_type: string · obligatoire
monitored: boolean · obligatoire
original_language: string?
season_count: integer?
series_type: string?
size_on_disk: integer?
sort_title: string?
status: string?
tags: string?
title: string · obligatoire
tmdb_id: integer?
tvdb_id: integer?
year: integer?
genre_list: string[] · obligatoire
tag_list: string[] · obligatoire

MetadataHealth

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

MetadataProviderHealth

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

NewRuleTest

expected_category: string?
media_id: string · obligatoire
name: string · obligatoire

OverrideEntry

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

OverrideWithMedia

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

Page_Decision

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

Page_Job

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

Page_LogEntry

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

Page_MediaListItem

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

Page_OverrideWithMedia

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

Page_RuleTest

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

PinnedCategory

reason: string?
target_category: string · obligatoire

PinRequest

reason: string?
target_category: string · obligatoire

Placement

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

PlacementAnswer

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

PlacementFolder

origin: string · obligatoire
path: string · obligatoire

Pong

status: string · obligatoire

PreviewChange

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

PreviewRequest

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

PreviewResponse

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

PreviewSummary

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

ProviderDescription

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

ProvidersResponse

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

ReasonLine

matched: boolean?
text: string · obligatoire

RenameCategoryRequest

name: string · obligatoire

Reordered

reordered: integer · obligatoire

ReorderRulesRequest

rule_ids: string[] · obligatoire

RevertDecisionsRequest

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

RootFolder

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

RootFolderWithInstance

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

Rule

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

RuleBundle

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

RuleHealth

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

RuleHealthReport

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

RuleImportReport

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

RuleTest

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

RuleTestResult

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

RuleTestRun

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

RuleTrace

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

RuleVerdict

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

SimulationRequest

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

SimulationResult

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

StatusResponse

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

StopReason

L'une de ces valeurs

dry_run
cancelled
shutdown

SyncReport

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

UpdateRootFolderCategory

category: string? · obligatoire

ValidationIssue

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

Vocabularies

origin_countries: Facet[] · obligatoire
original_languages: Facet[] · obligatoire

Warning

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