feat: health check endpoint with API key auth + plugin ArrClient access#93
Merged
feat: health check endpoint with API key auth + plugin ArrClient access#93
Conversation
…lugins Health check (#20): - GET /api/app/health — returns status, version, uptime, service connectivity - Authenticated via X-Api-Key header or Authorization: Bearer token - Timing-safe key comparison (crypto.timingSafeEqual) - Admin endpoints: GET/POST/DELETE /admin/api-key (get masked, generate, revoke) - GET /admin/settings no longer leaks apiKey field - Full key shown only at generation time with copy warning - Frontend: API key section in General tab with masked display, copy, regenerate, delete - Prisma migration: apiKey field on AppSettings - i18n: EN + FR translations Plugin ArrClient access (#92): - getArrClient(serviceType) added to PluginContext interface and implementation - Plugins can now access any *arr service through the generic ArrClient interface Closes #20, closes #92
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Two features for the 0.4.0 release.
Health check endpoint (#20)
GET /api/app/health— returnsstatus,version,uptime,database, and per-service connectivity (Radarr, Sonarr with versions)X-Api-Keyheader orAuthorization: Bearertokencrypto.timingSafeEqual)GET /admin/api-key— returns masked key only (f3d050b4••••••••c60f885)POST /admin/api-key/generate— generates new key, returns full plaintext (only time it's shown)DELETE /admin/api-key— revokes keyGET /admin/settingsno longer leaksapiKeyfieldapiKeynullable field onAppSettingsPlugin ArrClient access (#92)
getArrClient(serviceType)added toPluginContext(type + implementation)ArrClientinterfaceCloses #20, closes #92
Test plan
curl -H "X-Api-Key: <key>" localhost:3456/api/app/healthreturns service statuscurl localhost:3456/api/app/healthreturns 401curl -H "X-Api-Key: wrong" localhost:3456/api/app/healthreturns 403