docs: document the HTTP API

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