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 using API key. Generate an API key from the Lakera platform. Example: Bearer sk_123…

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

Overall health status

Allowed values:

is_defaultboolean

Whether using the Lakera Guard Default Policy or a custom policy

messagestring or null

Human-readable status message

lintobject

Policy validation results

Bearer authentication using API key. Generate an API key from the Lakera platform. Example: Bearer sk_123…

This endpoint expects an object.

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

Policy health check results

Overall health status

Whether using the Lakera Guard Default Policy or a custom policy

Human-readable status message

Policy validation results

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

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	}

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

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	}