Check policy configuration health | Lakera API documentation

Check the validity of the policy configuration for a given project. If no project ID is passed then the health of the Lakera Guard Default Policy will be returned.

Authentication

AuthorizationBearer

Bearer authentication of the form `Bearer <token>`, where token is your auth token.

Request

This endpoint expects an object.

project_idstringRequired

The project_id for which the policy health should be checked,.

Response

Policy health check results

statusenum or null

Overall health status

Allowed values:

is_defaultboolean or null

Whether using the Lakera Guard Default Policy or a custom policy

messagestring or null

Human-readable status message

lintobject or null

Policy validation results

1	curl -X POST https://api.lakera.ai/v2/policies/health \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"project_id": "string"
6	}'

1	{
2	"status": "ok",
3	"is_default": true,
4	"message": "string",
5	"lint": {
6	"passed": true,
7	"errors": [
8	{
9	"message": "string",
10	"severity": "error"
11	}
12	]
13	}
14	}