mirror of
https://github.com/Dictionarry-Hub/profilarr.git
synced 2026-06-18 02:08:46 -04:00
29 lines
789 B
YAML
29 lines
789 B
YAML
instances:
|
|
get:
|
|
operationId: listArrInstances
|
|
summary: List Arr Instances
|
|
description: |
|
|
Returns all Arr instances (Radarr/Sonarr) with secrets stripped.
|
|
|
|
**Use cases:**
|
|
- Dashboard widgets showing connected instances
|
|
- Automation scripts checking instance state
|
|
- Prerequisite checks (e.g. onboarding)
|
|
|
|
**Behavior:**
|
|
- Returns an empty array if no instances are connected
|
|
- The `api_key` field is never included
|
|
tags:
|
|
- Arr
|
|
responses:
|
|
'200':
|
|
description: List of Arr instances
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: '../schemas/arr.yaml#/ArrInstance'
|
|
'401':
|
|
description: Not authenticated
|