[{"label":"Latest (v1.0)","version":"latest"}]
nsx-vmc-policy

Get Policy Compliance Status

Description

Returns the compliance status and details of non compliant configuration

Request

Request

URL

URL


get
https://nsxmanager.your.domain/policy/api/v1/compliance/status
Copy

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK

Returns PolicyComplianceStatus of type(s) application/json
{
	"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"
			}
		}
	]
}
integer as int64
last_updated_time Optional

Timestamp of last update


non_compliant_configs Optional

List of non compliant configuration and impacted services

Errors

Errors

ApiError
400

Bad Request


ApiError
403

Forbidden


ApiError
404

Not Found


ApiError
412

Precondition Failed


ApiError
500

Internal Server Error


ApiError
503

Service Unavailable

Code Samples

Code Samples

cURL Command

curl https://nsxmanager.your.domain/policy/api/v1/compliance/status
Vendor Extensions

Vendor Extensions

This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: get-policy-compliance-status
x-vmw-nsx-module: PolicyCompliance


[{"label":"Latest (v1.0)","version":"latest"}]
nsx-vmc-policy
Feedback

Was this page helpful?