From 761a247860cf87e0c62fe31fac97784776a0a074 Mon Sep 17 00:00:00 2001 From: Robert Dailey Date: Tue, 18 Apr 2023 22:04:50 -0500 Subject: [PATCH] feat: Send API key via header instead of query param --- CHANGELOG.md | 5 +++++ src/Recyclarr.TrashLib/Http/FlurlLogging.cs | 7 +------ src/Recyclarr.TrashLib/Http/ServiceRequestBuilder.cs | 2 +- 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 7108b4f0..99df8692 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -8,6 +8,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ## [Unreleased] +### Changed + +- API Key is now sent via the `X-Api-Key` header instead of the `apikey` query parameter. This + lessens the need to redact information in the console. + ## [4.4.1] - 2023-04-08 ### Fixed diff --git a/src/Recyclarr.TrashLib/Http/FlurlLogging.cs b/src/Recyclarr.TrashLib/Http/FlurlLogging.cs index 322674f3..72994ddc 100644 --- a/src/Recyclarr.TrashLib/Http/FlurlLogging.cs +++ b/src/Recyclarr.TrashLib/Http/FlurlLogging.cs @@ -55,13 +55,8 @@ public static class FlurlLogging public static Url SanitizeUrl(Url url) { - // Replace hostname and API key for user privacy + // Replace hostname for user privacy url.Host = "REDACTED"; - if (url.QueryParams.Contains("apikey")) - { - url.QueryParams.AddOrReplace("apikey", "REDACTED"); - } - return url; } } diff --git a/src/Recyclarr.TrashLib/Http/ServiceRequestBuilder.cs b/src/Recyclarr.TrashLib/Http/ServiceRequestBuilder.cs index 7d8c2096..561e5adc 100644 --- a/src/Recyclarr.TrashLib/Http/ServiceRequestBuilder.cs +++ b/src/Recyclarr.TrashLib/Http/ServiceRequestBuilder.cs @@ -16,6 +16,6 @@ public class ServiceRequestBuilder : IServiceRequestBuilder { var client = _clientFactory.BuildClient(config.BaseUrl); return client.Request(new[] {"api", "v3"}.Concat(path).ToArray()) - .SetQueryParams(new {apikey = config.ApiKey}); + .WithHeader("X-Api-Key", config.ApiKey); } }