Para otras aplicaciones

Sus otras herramientas pueden preguntar a Routarr.

Un script, n8n, Home Assistant o un panel puede preguntar adónde iría un título, forzar su categoría, lanzar una simulación y aplicarla, o leer el estado, cada uno con una clave que solo hace lo que usted permitió.

01
X-Api-Key: rtr_…
Cree una clave en la pantalla Aplicaciones, una por herramienta. Toda clave lee, y un alcance que cambia algo, como operate (operar) para aplicar o write (escribir) para fijar un título, se concede solo donde hace falta: la referencia de abajo nombra el que necesita cada operación. Routarr muestra la clave una sola vez, y Authorization: Bearer también la lleva.
02
GET /api/v1/route
Pregunte adónde iría un título. Routarr lo busca en el Arr, lo pasa por sus reglas y no mueve nada. Aquí jq conserva de la respuesta lo que necesita un script.
03
GET /api/v1/openapi.json
Cada operación y el alcance que necesita figuran en la pantalla Referencia de la API de su Routarr, que sirve el contrato OpenAPI en esta ruta, para la versión que ejecuta.

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": "Animación japonesa"
}

Nada de lo documentado bajo /api/v1 se elimina, se renombra ni cambia de tipo. Nuevas operaciones y campos pueden llegar con cualquier versión.

Referencia

Lo que una aplicación puede pedir.

Las operaciones de Routarr 0.2.0, la versión que nombra esta página, agrupadas por lo que tocan. Abra una para ver lo que recibe y lo que responde. La palabra de la derecha es el alcance que necesita una clave. Un nombre de tipo lleva a su entrada entre los tipos listados al final.

Estado

Si Routarr responde y lo que necesita atención.

GET/api/v1/auth/meA quién pertenece la claveread

No recibe nada.

Respuesta 200Me

subject: string

GET/api/v1/healthContactar con cada Arr y cada fuente, e informaroperate

Parámetros

probe: boolean · en la consulta
fresh: boolean · en la consulta

Respuesta 200HealthResponse

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

GET/api/v1/metadata/providersLas fuentes de metadatos, y lo que cada una puede responderread

No recibe nada.

Respuesta 200ProvidersResponse

order: string[]
providers: ProviderDescription[]

GET/api/v1/metricsMétricas de Prometheusread

No recibe nada.

Respuesta 200

GET/api/v1/pingSi Routarr respondesin clave

No recibe nada.

Respuesta 200Pong

status: string

GET/api/v1/statusLo que necesita atenciónread

No recibe nada.

Respuesta 200StatusResponse

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

Biblioteca

Los títulos que Routarr leyó de los Arrs, y adónde va cada uno.

GET/api/v1/mediaLa biblioteca, página a páginaread

Parámetros

instance_id: string · en la consulta
media_type: string · en la consulta
category: string · en la consulta
search: string · en la consulta
tmdb_id: integer · en la consulta
tvdb_id: integer · en la consulta
imdb_id: string · en la consulta
unmatched: boolean · en la consulta
page: integer · en la consulta
per_page: integer · en la consulta

Respuesta 200Page_MediaListItem

data: MediaListItem[]
pagination: Pagination

GET/api/v1/media/facetsLos valores que contiene la biblioteca, para cada condiciónread

No recibe nada.

Respuesta 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 títuloread

Parámetros

id: string · en la ruta · obligatorio

Respuesta 200MediaDetail

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

GET/api/v1/media/{id}/explainAdónde va un título, y por quéread

Parámetros

id: string · en la ruta · obligatorio

Respuesta 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/routeAdónde iría un título que nombra otro servicioread

Parámetros

type: string · en la consulta · obligatorio
tmdb: integer · en la consulta
tvdb: integer · en la consulta
imdb: string · en la consulta
instance: string · en la consulta
tags: string · en la consulta
series_type: string · en la consulta
monitored: boolean · en la consulta
enrich: boolean · en la consulta

Respuesta 200Placement

answers: PlacementAnswer[]
errors: InstanceFailure[]

Decisiones

Simular las reglas sobre la biblioteca, y aplicar o revertir los movimientos que deciden.

GET/api/v1/decisionsLas decisiones, página a páginaread

Parámetros

instance_id: string · en la consulta
media_type: string · en la consulta
status: string · en la consulta
category: string · en la consulta
action: string · en la consulta
simulation_id: string · en la consulta
search: string · en la consulta
include_superseded: boolean · en la consulta
page: integer · en la consulta
per_page: integer · en la consulta

Respuesta 200Page_Decision

data: Decision[]
pagination: Pagination

POST/api/v1/decisions/applyAplicar las decisiones elegidasoperate

Parámetros

Prefer: string? · cabecera

Cuerpo

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

Respuesta 200ApplyReport

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

POST/api/v1/decisions/apply-allAplicar todo lo que propuso una simulaciónoperate

Parámetros

Prefer: string? · cabecera

Cuerpo

confirm: Confirmed
move_files: boolean
simulation_id: string · obligatorio

Respuesta 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/revertDevolver títulos a su sitiooperate

Parámetros

Prefer: string? · cabecera

Cuerpo

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

Respuesta 200ApplyReport

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

POST/api/v1/simulatePasar las reglas por la bibliotecaoperate

Parámetros

Prefer: string? · cabecera

Cuerpo

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

Respuesta 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

Excepciones

Títulos cuya categoría se fuerza a mano, que priman sobre todas las reglas.

GET/api/v1/overridesLas excepcionesread

Parámetros

page: integer · en la consulta
per_page: integer · en la consulta

Respuesta 200Page_OverrideWithMedia

data: OverrideWithMedia[]
pagination: Pagination

POST/api/v1/overridesForzar la categoría de un títulowrite

Cuerpo

media_id: string · obligatorio
reason: string?
target_category: string · obligatorio

Respuesta 201OverrideEntry

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

DELETE/api/v1/overrides/externalQuitar la excepción de un título por el identificador que le da otro serviciowrite

Parámetros

type: string · en la consulta · obligatorio
tmdb: integer · en la consulta
tvdb: integer · en la consulta
imdb: string · en la consulta
instance: string · en la consulta

Respuesta 200Deleted

deleted: boolean

PUT/api/v1/overrides/externalForzar la categoría de un título por el identificador que le da otro serviciowrite

Parámetros

type: string · en la consulta · obligatorio
tmdb: integer · en la consulta
tvdb: integer · en la consulta
imdb: string · en la consulta
instance: string · en la consulta

Cuerpo

reason: string?
target_category: string · obligatorio

Respuesta 200OverrideEntry[]

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

DELETE/api/v1/overrides/{id}Quitar una excepciónwrite

Parámetros

id: string · en la ruta · obligatorio

Respuesta 200Deleted

deleted: boolean

Tareas

Lo que se ejecutó en segundo plano, y cómo terminó.

GET/api/v1/jobsLas tareas, las más recientes primeroread

Parámetros

status: string · en la consulta
kind: string · en la consulta
page: integer · en la consulta
per_page: integer · en la consulta
include: string · en la consulta

Respuesta 200Page_Job

data: Job[]
pagination: Pagination

GET/api/v1/jobs/{id}Una tarearead

Parámetros

id: string · en la ruta · obligatorio

Respuesta 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/logsLo que hizo cada movimiento, página a páginaread

Parámetros

instance_id: string · en la consulta
media_id: string · en la consulta
action: string · en la consulta
success: boolean · en la consulta
search: string · en la consulta
page: integer · en la consulta
per_page: integer · en la consulta

Respuesta 200Page_LogEntry

data: LogEntry[]
pagination: Pagination

GET/api/v1/logs/exportEl mismo registro como archivo CSVread

Parámetros

instance_id: string · en la consulta
media_id: string · en la consulta
action: string · en la consulta
success: boolean · en la consulta
search: string · en la consulta

Respuesta 200

Instancias

Los Arr que Routarr lee, y volver a leerlos.

GET/api/v1/instancesLos Arr que Routarr leeread

No recibe nada.

Respuesta 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/syncVolver a leer cada Arr activadooperate

Parámetros

Prefer: string? · cabecera

Respuesta 200SyncReport[]

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

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

Parámetros

id: string · en la ruta · obligatorio

Respuesta 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}/syncVolver a leer un Arroperate

Parámetros

id: string · en la ruta · obligatorio
Prefer: string? · cabecera

Respuesta 200SyncReport

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

Reglas

Las reglas por orden de prioridad, las condiciones que pueden usar y las pruebas que fijan lo que deciden.

GET/api/v1/rule-testsLas pruebas de reglasread

Parámetros

page: integer · en la consulta
per_page: integer · en la consulta

Respuesta 200Page_RuleTest

data: RuleTest[]
pagination: Pagination

POST/api/v1/rule-testsFijar como prueba lo que las reglas deciden para un títuloconfigure

Cuerpo

expected_category: string?
media_id: string · obligatorio
name: string · obligatorio

Respuesta 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/runPasar cada prueba por las reglas tal como estánoperate

No recibe nada.

Respuesta 200RuleTestRun

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

DELETE/api/v1/rule-tests/{id}Quitar una prueba de reglasconfigure

Parámetros

id: string · en la ruta · obligatorio

Respuesta 200Deleted

deleted: boolean

GET/api/v1/rulesLas reglas, por orden de prioridadread

No recibe nada.

Respuesta 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/rulesCrear una reglaconfigure

Cuerpo

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

Respuesta 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/conditionsLas condiciones que puede usar una reglaread

No recibe nada.

Respuesta 200ConditionCatalog

conditions: ConditionSpec[]
match_modes: string[]

GET/api/v1/rules/exportLas reglas como paqueteread

No recibe nada.

Respuesta 200RuleBundle

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

GET/api/v1/rules/healthLo que decide cada reglaread

No recibe nada.

Respuesta 200RuleHealthReport

rules: RuleHealth[]
total_media: integer

POST/api/v1/rules/importImportar un paquete de reglasconfigure

Cuerpo

bundle: RuleBundle · obligatorio
create_missing_categories: boolean
replace: boolean

Respuesta 200RuleImportReport

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

POST/api/v1/rules/previewLo que movería un borrador de regla, sin guardar nadaconfigure

Cuerpo

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

Respuesta 200PreviewResponse

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

POST/api/v1/rules/reorderPoner las reglas en un nuevo ordenconfigure

Cuerpo

rule_ids: string[] · obligatorio

Respuesta 200Reordered

reordered: integer

POST/api/v1/rules/validateJuzgar un borrador de regla, sin guardar nadaconfigure

Cuerpo

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

Respuesta 200RuleVerdict

issues: ValidationIssue[]
valid: boolean

DELETE/api/v1/rules/{id}Quitar una reglaconfigure

Parámetros

id: string · en la ruta · obligatorio

Respuesta 200Deleted

deleted: boolean

GET/api/v1/rules/{id}Una reglaread

Parámetros

id: string · en la ruta · obligatorio

Respuesta 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}Reemplazar una reglaconfigure

Parámetros

id: string · en la ruta · obligatorio

Cuerpo

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

Respuesta 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}/duplicateCopiar una regla, desactivadaconfigure

Parámetros

id: string · en la ruta · obligatorio

Respuesta 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

Categorías y carpetas

Las categorías, y las carpetas raíz que llevan a cada una.

POST/api/v1/categoriesCrear una categoríaconfigure

Cuerpo

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

Respuesta 201Category

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

DELETE/api/v1/categories/{id}Quitar una categoríaconfigure

Parámetros

id: string · en la ruta · obligatorio

Respuesta 200Deleted

deleted: boolean

PUT/api/v1/categories/{id}Renombrar una categoríaconfigure

Parámetros

id: string · en la ruta · obligatorio

Cuerpo

name: string · obligatorio

Respuesta 200Category

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

GET/api/v1/root-foldersLas carpetas raíz, y la categoría a la que lleva cada unaread

No recibe nada.

Respuesta 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-foldersDeclarar un destino que el Arr no listaconfigure

Cuerpo

instance_id: string · obligatorio
path: string · obligatorio

Respuesta 201Declared

id: string
path: string
verified: boolean

GET/api/v1/root-folders/conflictsLo que las asignaciones dejan sin decirread

No recibe nada.

Respuesta 200MappingConflict[]

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

DELETE/api/v1/root-folders/{id}Quitar un destino declaradoconfigure

Parámetros

id: string · en la ruta · obligatorio

Respuesta 200Deleted

deleted: boolean

PUT/api/v1/root-folders/{id}/categoryLlevar una carpeta a una categoría, o a ningunaconfigure

Parámetros

id: string · en la ruta · obligatorio

Cuerpo

category: string? · obligatorio

Respuesta 200Mapped

category: string?
updated: boolean

Copias de seguridad

Las copias que Routarr conserva, y hacer una ahora mismo.

GET/api/v1/backupsLas copias conservadasread

No recibe nada.

Respuesta 200BackupListResponse

backups: BackupFile[]
retention_count: integer

POST/api/v1/backupsHacer una copia ahora mismooperate

Parámetros

Prefer: string? · cabecera

Respuesta 200BackupFile

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

Tipos

Cada forma que reciben o responden las operaciones de arriba. Un nombre de tipo abre aquí su entrada.

AlternativeDecision

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

ApplyAllRequest

confirm: Confirmed
move_files: boolean
simulation_id: string · obligatorio

ApplyDecisionsRequest

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

ApplyError

decision_id: string · obligatorio
media_title: string · obligatorio
message: string · obligatorio

ApplyReport

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

AppStats

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

BackupFile

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

BackupListResponse

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

BatchApplyReport

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

BundledRule

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

CapacityForecast

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

Category

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

CategoryWithUsage

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

Condition

Una de estas formas, distinguidas por 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[] · obligatorio
match_modes: string[] · obligatorio

ConditionOutcome

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

ConditionSpec

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

Confirmed

Una lista de string

CreateCategoryRequest

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

CreateOverrideRequest

media_id: string · obligatorio
reason: string?
target_category: string · obligatorio

CreateRuleRequest

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

Decision

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

Declared

id: string · obligatorio
path: string · obligatorio
verified: boolean · obligatorio

DeclareRootFolder

instance_id: string · obligatorio
path: string · obligatorio

Deleted

deleted: boolean · obligatorio

Explanation

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

HealthResponse

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

ImportRulesRequest

bundle: RuleBundle · obligatorio
create_missing_categories: boolean
replace: boolean

InstanceFailure

error: string · obligatorio
instance_id: string · obligatorio
instance_name: string · obligatorio

InstanceHealth

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

InstanceResponse

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

Job

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

LibraryFacets

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

LogEntry

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

Mapped

category: string?
updated: boolean · obligatorio

MappingConflict

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

MatchMode

Uno de estos valores

all
any

Me

subject: string · obligatorio

Media

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

MediaDetail

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

MediaListItem

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

MetadataHealth

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

MetadataProviderHealth

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

NewRuleTest

expected_category: string?
media_id: string · obligatorio
name: string · obligatorio

OverrideEntry

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

OverrideWithMedia

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

Page_Decision

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

Page_Job

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

Page_LogEntry

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

Page_MediaListItem

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

Page_OverrideWithMedia

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

Page_RuleTest

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

PinnedCategory

reason: string?
target_category: string · obligatorio

PinRequest

reason: string?
target_category: string · obligatorio

Placement

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

PlacementAnswer

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

PlacementFolder

origin: string · obligatorio
path: string · obligatorio

Pong

status: string · obligatorio

PreviewChange

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

PreviewRequest

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

PreviewResponse

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

PreviewSummary

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

ProviderDescription

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

ProvidersResponse

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

ReasonLine

matched: boolean?
text: string · obligatorio

RenameCategoryRequest

name: string · obligatorio

Reordered

reordered: integer · obligatorio

ReorderRulesRequest

rule_ids: string[] · obligatorio

RevertDecisionsRequest

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

RootFolder

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

RootFolderWithInstance

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

Rule

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

RuleBundle

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

RuleHealth

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

RuleHealthReport

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

RuleImportReport

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

RuleTest

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

RuleTestResult

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

RuleTestRun

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

RuleTrace

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

RuleVerdict

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

SimulationRequest

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

SimulationResult

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

StatusResponse

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

StopReason

Uno de estos valores

dry_run
cancelled
shutdown

SyncReport

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

UpdateRootFolderCategory

category: string? · obligatorio

ValidationIssue

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

Vocabularies

origin_countries: Facet[] · obligatorio
original_languages: Facet[] · obligatorio

Warning

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