Get Compliance Audit

Get Compliance Audit

Get compliance audit

Request
URI
GET
https://{api_host}/v1/compliance-audits/{complianceAuditId}
COPY
Path Parameters
string
complianceAuditId
Required

Compliance Audit ID


Responses
200

OK

Returns ComplianceAudit of type(s) application/json
{
    "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"
        }
    ]
}
string
id
Optional

Compliance audit id

string
creationTimestamp
Optional

The timestamp at which audit was initiated

string
completionTimestamp
Optional

The timestamp at which audit was completed

string
standardType
Optional

Compliance standard type

string
standardVersion
Optional

Compliance standard version

string
domainId
Optional

Domain id

string
configurationEvaluationStatus
Optional

Configuration evaluation status

string
configurationEvaluationStatusDetails
Optional

Details about evaluation status

string
compliantStatus
Optional

Compliant status of overall task

integer As int32 As int32
totalConfigurationsEvaluated
Optional

Total number of configurations evaluated

integer As int32 As int32
numberOfNonCompliantConfigurations
Optional

Number of non compliant configurations

integer As int32 As int32
numberOfSkippedConfigurations
Optional

Number of configurations skipped

integer As int32 As int32
numberOfAuditItems
Optional

Number of audit items

array of object
auditItems
Optional

Compliance audit items


401

Unauthorized Request

Returns Error of type(s) application/json
"Error Object"
string
errorCode
Optional

The minor error code

string
errorType
Optional

The error type

array of string
arguments
Optional

The arguments used to localize the message, Can be used by scripts to automate the error processing.

object
context
Optional

The error context (e.g. the component where it occurred).

string
message
Optional

The localized error message

string
remediationMessage
Optional

The localized remediation error message

array of object
causes
Optional

The underlying cause exceptions.

array of Error
nestedErrors
Optional

The nested errors when the error is a composite one

string
referenceToken
Optional

A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.


404

Not Found

Returns Error of type(s) application/json
"Error Object"
string
errorCode
Optional

The minor error code

string
errorType
Optional

The error type

array of string
arguments
Optional

The arguments used to localize the message, Can be used by scripts to automate the error processing.

object
context
Optional

The error context (e.g. the component where it occurred).

string
message
Optional

The localized error message

string
remediationMessage
Optional

The localized remediation error message

array of object
causes
Optional

The underlying cause exceptions.

array of Error
nestedErrors
Optional

The nested errors when the error is a composite one

string
referenceToken
Optional

A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.


500

Internal Server Error

Returns Error of type(s) application/json
"Error Object"
string
errorCode
Optional

The minor error code

string
errorType
Optional

The error type

array of string
arguments
Optional

The arguments used to localize the message, Can be used by scripts to automate the error processing.

object
context
Optional

The error context (e.g. the component where it occurred).

string
message
Optional

The localized error message

string
remediationMessage
Optional

The localized remediation error message

array of object
causes
Optional

The underlying cause exceptions.

array of Error
nestedErrors
Optional

The nested errors when the error is a composite one

string
referenceToken
Optional

A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/v1/compliance-audits/{complianceAuditId}