docs: document the HTTP API

danroc · Nov 4, 2024 · 5deafe6 · 5deafe6
1 parent 40efe1f
commit 5deafe6
Showing 1 changed file with 24 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -65,6 +65,30 @@ access_control:
       policy: allow
 ```
 
+## API
+
+### `/v1/forward-auth`
+
+Check if a client is authorized to access a domain.
+
+#### Request
+
+- `X-Forwarded-For`: Client's IP address
+- `X-Forwarded-Host`: Requested domain
+
+#### Response
+
+- `204`: Authorized
+- `403`: Forbidden
+
+### `/v1/health`
+
+Check if the service is running.
+
+#### Response
+
+- `204`: The service is running
+
 ## Deployment
 
 ### Traefik