Files
profilarr/docs/api/v1/paths/databases.yaml
2026-04-03 03:40:01 +10:30

31 lines
933 B
YAML

databases:
get:
operationId: listDatabases
summary: List Databases
description: |
Returns all linked database instances with secrets stripped.
**Use cases:**
- Dashboard widgets showing connected databases
- Automation scripts checking database state
- Prerequisite checks (e.g. cutscene onboarding)
**Behavior:**
- Returns an empty array if no databases are linked
- The `personal_access_token` field is never included; `hasPat` indicates
whether one is configured
- The `local_path` field is excluded (internal detail)
tags:
- Databases
responses:
'200':
description: List of linked databases
content:
application/json:
schema:
type: array
items:
$ref: '../schemas/databases.yaml#/DatabaseInstance'
'401':
description: Not authenticated