diff --git a/README.md b/README.md index 62162be..fc3ab09 100644 --- 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