> ## Documentation Index
> Fetch the complete documentation index at: https://developer.rocket.chat/llms.txt
> Use this file to discover all available pages before exploring further.
# Get PDP Health Status
>
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.
Permissions required: `abac-management` and `manage-abac-admin-settings`.
### Changelog
| Version | Description |
|---------|--------|
| 8.0.0 | Added |
| 8.5.0 | Added the `manage-abac-admin-settings` granular permission requirement. |
| 8.4.0 | Added endpoint to check external PDP health status |
## OpenAPI
````json GET /api/v1/abac/pdp/health
{
"openapi": "3.0.0",
"info": {
"version": "1.0.0",
"title": "Rooms"
},
"servers": [
{
"url": "https://apiexplorer.support.rocket.chat"
}
],
"tags": [
{
"name": "Channels"
},
{
"name": "Directory"
},
{
"name": "Groups"
},
{
"name": "Rooms"
},
{
"name": "Teams"
},
{
"name": "Room Invites"
},
{
"name": "Subscriptions"
},
{
"name": "ABAC"
}
],
"paths": {
"/api/v1/abac/pdp/health": {
"get": {
"tags": [
"ABAC"
],
"summary": "Get PDP Health Status",
"description": "\n\nChecks the health and availability of the configured Policy Decision Point (PDP)\nfor Attribute-Based Access Control (ABAC).\n\nThis endpoint is used by administrators to verify that the external PDP service\nis operational and properly configured. It includes rate limiting to prevent abuse.\n\nPermissions required: `abac-management` and `manage-abac-admin-settings`.\n\n### Changelog\n| Version | Description |\n|---------|--------|\n| 8.0.0 | Added |\n| 8.5.0 | Added the `manage-abac-admin-settings` granular permission requirement. |\n| 8.4.0 | Added endpoint to check external PDP health status |",
"operationId": "get-abac-pdp-health",
"parameters": [
{
"$ref": "#/components/parameters/Auth-Token"
},
{
"$ref": "#/components/parameters/UserId"
}
],
"responses": {
"200": {
"description": "OK - PDP is available and healthy",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"available": {
"type": "boolean",
"description": "Indicates whether the PDP is available.",
"enum": [
true
]
},
"message": {
"type": "string",
"description": "Health check message."
},
"success": {
"type": "boolean",
"description": "Indicates if the request was successful."
}
}
},
"examples": {
"PDP Healthy": {
"value": {
"available": true,
"message": "ABAC_PDP_Health_OK",
"success": true
}
}
}
}
}
},
"400": {
"description": "Bad Request - PDP is unavailable or unhealthy",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"available": {
"type": "boolean",
"description": "Indicates whether the PDP is available.",
"enum": [
false
]
},
"message": {
"type": "string",
"description": "Error message describing why the PDP is unavailable."
},
"success": {
"type": "boolean",
"description": "Indicates if the request was successful."
}
}
},
"examples": {
"PDP Unavailable": {
"value": {
"available": false,
"message": "ABAC_PDP_Health_Not_OK",
"success": false
}
},
"Connection Error": {
"value": {
"available": false,
"message": "Failed to connect to external PDP service",
"success": false
}
}
}
}
}
},
"401": {
"$ref": "#/components/responses/authorizationError"
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"error": {
"type": "string"
}
}
},
"examples": {
"Permission Error": {
"value": {
"success": false,
"error": "You do not have permission to manage ABAC"
}
}
}
}
}
}
}
}
}
},
"components": {
"parameters": {
"Auth-Token": {
"name": "X-Auth-Token",
"in": "header",
"description": "The `authToken` of the authenticated user.",
"required": true,
"schema": {
"type": "string"
},
"example": "RScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f"
},
"UserId": {
"name": "X-User-Id",
"in": "header",
"description": "The `userId` of the authenticated user.",
"required": true,
"schema": {
"type": "string"
},
"example": "rbAXPnMktTFbNpwtJ"
}
},
"responses": {
"authorizationError": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"status": {
"type": "string"
},
"message": {
"type": "string"
}
}
},
"examples": {
"Authorization Error": {
"value": {
"status": "error",
"message": "You must be logged in to do this."
}
}
}
}
}
}
}
}
}
````
![\"Defense\"](\"https://raw.githubusercontent.com/RocketChat/Rocket.Chat-Open-API/main/images/Defense.svg\")