Files
profilarr/docs/api/v1/paths/arr.yaml

104 lines
2.9 KiB
YAML

library:
get:
operationId: getLibrary
summary: Get Arr instance library
description: |
Fetches the movie or series library from an Arr instance.
Returns a simplified list suitable for selection/matching.
- For Radarr: Returns movies with id, title, year, and tmdbId
- For Sonarr: Returns series with id, title, year, tvdbId, and available seasons
tags:
- Arr
parameters:
- name: instanceId
in: query
required: true
schema:
type: integer
description: Arr instance ID
responses:
'200':
description: Library items
content:
application/json:
schema:
$ref: '../schemas/arr.yaml#/LibraryResponse'
'400':
description: Invalid or missing instanceId
content:
application/json:
schema:
$ref: '../schemas/arr.yaml#/ErrorResponse'
'404':
description: Instance not found
content:
application/json:
schema:
$ref: '../schemas/arr.yaml#/ErrorResponse'
'500':
description: Failed to fetch library
content:
application/json:
schema:
$ref: '../schemas/arr.yaml#/ErrorResponse'
releases:
get:
operationId: getReleases
summary: Search for releases
description: |
Triggers an interactive search on an Arr instance and returns grouped/deduplicated results.
For Radarr: Searches for releases for the specified movie.
For Sonarr: Searches for season pack releases for the specified series and season.
Results are grouped by title, combining information from multiple indexers.
tags:
- Arr
parameters:
- name: instanceId
in: query
required: true
schema:
type: integer
description: Arr instance ID
- name: itemId
in: query
required: true
schema:
type: integer
description: Movie ID (Radarr) or Series ID (Sonarr)
- name: season
in: query
required: false
schema:
type: integer
default: 1
description: Season number for Sonarr searches (defaults to 1)
responses:
'200':
description: Release search results
content:
application/json:
schema:
$ref: '../schemas/arr.yaml#/ReleasesResponse'
'400':
description: Invalid or missing parameters
content:
application/json:
schema:
$ref: '../schemas/arr.yaml#/ErrorResponse'
'404':
description: Instance not found
content:
application/json:
schema:
$ref: '../schemas/arr.yaml#/ErrorResponse'
'500':
description: Failed to fetch releases
content:
application/json:
schema:
$ref: '../schemas/arr.yaml#/ErrorResponse'