Get Compliance Audit For A Domain
Get compliance audit for a domain
Domain ID
Compliance Audit ID
OK
{
"id": "string",
"creationTimestamp": "string",
"completionTimestamp": "string",
"standardType": "One among: PCI",
"standardVersion": "string",
"domainId": "string",
"configurationEvaluationStatus": "One among: ALL_EVALUATED, SOME_EVALUATED, NONE_EVALUATED, UNKNOWN",
"configurationEvaluationStatusDetails": "string",
"compliantStatus": "One among: COMPLIANT, NON_COMPLIANT, PARTIALLY_COMPLIANT, UNKNOWN",
"totalConfigurationsEvaluated": 0,
"numberOfNonCompliantConfigurations": 0,
"numberOfSkippedConfigurations": 0,
"numberOfAuditItems": 0,
"auditItems": [
{
"resourceType": "One among: SDDC_MANAGER",
"resourceVersion": "string",
"resourceName": "string",
"configurationId": "string",
"configurationTitle": "string",
"isConfigurationRecommendedByStandard": false,
"citationReference": "string",
"recommendedValue": "string",
"actualValue": "string",
"complianceStatus": "One among: COMPLIANT, NON_COMPLIANT, PARTIALLY_COMPLIANT, UNKNOWN",
"remediationStep": "string",
"complianceAuditStatus": "One among: SUCCEEDED, FAILED, NOT_SUPPORTED",
"errorMessage": "string"
}
]
}Compliance audit id
The timestamp at which audit was initiated
The timestamp at which audit was completed
Compliance standard type
Compliance standard version
Domain id
Configuration evaluation status
Details about evaluation status
Compliant status of overall task
Total number of configurations evaluated
Number of non compliant configurations
Number of configurations skipped
Number of audit items
Compliance audit items
Unauthorized Request
{
"errorCode": "string",
"errorType": "string",
"arguments": [
"string"
],
"context": {
"context": "string"
},
"notifications": [
{
"severity": "string",
"message": "string",
"remediations": [
{
"message": "string",
"link": "string"
}
],
"impactMessage": "string"
}
],
"message": "string",
"remediationMessage": "string",
"causes": [
{
"type": "string",
"message": "string"
}
],
"nestedErrors": [
{
"errorCode": "string",
"errorType": "string",
"arguments": [
"string"
],
"context": {
"context": "string"
},
"notifications": [
{
"severity": "string",
"message": "string",
"remediations": [
{
"message": "string",
"link": "string"
}
],
"impactMessage": "string"
}
],
"message": "string",
"remediationMessage": "string",
"causes": [
{
"type": "string",
"message": "string"
}
],
"nestedErrors": [
"Error Object"
],
"referenceToken": "string",
"label": "string",
"remediationUrl": "string"
}
],
"referenceToken": "string",
"label": "string",
"remediationUrl": "string"
}The minor error code
The error type
The arguments used to localize the message, Can be used by scripts to automate the error processing.
The error context (e.g. the component where it occurred).
Detailed results of the precheck validation.
The localized error message
The localized remediation error message
The underlying cause exceptions.
The nested errors when the error is a composite one
A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.
The localized label message
The URL string for remediation documentation link
Not Found
"Error Object"The minor error code
The error type
The arguments used to localize the message, Can be used by scripts to automate the error processing.
The error context (e.g. the component where it occurred).
Detailed results of the precheck validation.
The localized error message
The localized remediation error message
The underlying cause exceptions.
A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.
The localized label message
The URL string for remediation documentation link
Internal Server Error
"Error Object"The minor error code
The error type
The arguments used to localize the message, Can be used by scripts to automate the error processing.
The error context (e.g. the component where it occurred).
Detailed results of the precheck validation.
The localized error message
The localized remediation error message
The underlying cause exceptions.
A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.
The localized label message
The URL string for remediation documentation link
curl -H 'Authorization: <value>' https://{api_host}/v1/domains/{id}/compliance-audits/{complianceAuditId}