Developer Documentation
Get Policy Compliance Status
Returns the compliance status and details of non compliant configuration
Request
Operation doesn't accept any path, query or header parameters.
URL
https://nsxmanager.your.domain/policy/api/v1/compliance/status
Response
Response
Response BodyResponse Body
200 OK returns
PolicyComplianceStatus
{
"last_updated_time": 0,
"non_compliant_configs": [
{
"affected_resources": [
{
"is_valid": false,
"path": "string",
"target_display_name": "string",
"target_id": "string",
"target_type": "string"
}
],
"description": "string",
"non_compliance_code": 0,
"reported_by": {
"is_valid": false,
"path": "string",
"target_display_name": "string",
"target_id": "string",
"target_type": "string"
}
}
]
}| Property Name | Type | Description |
|---|---|---|
| last_updated_time | integer |
Timestamp of last update |
| non_compliant_configs | array of PolicyNonCompliantConfig |
List of non compliant configuration and impacted services |
Errors
| Code | Returns | Description |
|---|---|---|
| 500 | InternalServerError | The server encountered an unexpected condition which prevented it from fulfilling the request. |
| 503 | ServiceUnavailable | The server is currently unavailable (because it is overloaded or down for maintenance). |
| 400 | BadRequest | The request cannot be fulfilled due to bad syntax. |
| 403 | Forbidden | The server understood the request, but is refusing to fulfill it. |
| 404 | NotFound | The requested resource could not be found but may be available again in the future. |
| 412 | PreconditionFailed | Not available |
