Get
/api/v1/abac/pdp/health
Checks the health and availability of the configured Policy Decision Point (PDP) for Attribute-Based Access Control (ABAC).
This endpoint is used by administrators to verify that the external PDP service is operational and properly configured. It includes rate limiting to prevent abuse.
Permission required: abac-management
Changelog
| Version | Change |
|---|---|
| 8.4.0 | Added endpoint to check external PDP health status |
Header parameters
X-Auth-Token
stringRequired
The authToken of the authenticated user.
ExampleRScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f
X-User-Id
stringRequired
The userId of the authenticated user.
ExamplerbAXPnMktTFbNpwtJ
Responses
200
OK - PDP is available and healthy
PDP Healthy
{
"available": true,
"message": "ABAC_PDP_Health_OK",
"success": true
}object
available
boolean
Indicates whether the PDP is available.
Valid values[
true
]
message
string
Health check message.
success
boolean
Indicates if the request was successful.
400
Bad Request - PDP is unavailable or unhealthy
PDP Unavailable
{
"available": false,
"message": "ABAC_PDP_Health_Not_OK",
"success": false
}Connection Error
{
"available": false,
"message": "Failed to connect to external PDP service",
"success": false
}object
available
boolean
Indicates whether the PDP is available.
Valid values[
false
]
message
string
Error message describing why the PDP is unavailable.
success
boolean
Indicates if the request was successful.
401
Unauthorized
Authorization Error
{
"status": "error",
"message": "You must be logged in to do this."
}object
status
string
message
string
403
Forbidden
Permission Error
{
"success": false,
"error": "You do not have permission to manage ABAC"
}object
success
boolean
error
string