docs: clarify HTTPS requirement for custom base URL in README
Build and Analyse / build-and-analyse (push) Successful in 1m21s

The builder example comment is updated to note that HTTP is allowed only for loopback hosts.
This commit is contained in:
thischwa committed 2026-11-07 19:48:05 +01:00
1 parent c02ce68df5
commit 330f665b97
1 file changed
+1 -1
+1 -1
View File
@@ -66,7 +66,7 @@ CfDnsClient cfDnsClient = new CfDnsClientBuilder()
```java
CfDnsClient cfDnsClient = new CfDnsClientBuilder()
.withApiTokenAuth("your-api-token")
.withBaseUrl("https://custom-api.example.com/client/v4") // must use HTTPS
.withBaseUrl("https://custom-api.example.com/client/v4") // HTTPS required; HTTP allowed only for loopback hosts
.withConnectTimeout(Duration.ofSeconds(5)) // default: 10 s
.withResponseTimeout(Duration.ofSeconds(15)) // default: 30 s
.withEmptyResultThrowsException(true) // default: false