Get Compliance Audit History For A Domain

Get compliance audit history for a domain

Request

URI

GET

https://{api_host}/v1/domains/{id}/compliance-audits

COPY

Path Parameters

string

Required

Domain ID

Responses

200

Returns PageOfComplianceAudit of type(s) application/json

{
    "elements": [
        {
            "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"
                }
            ]
        }
    ],
    "pageMetadata": {
        "pageNumber": 0,
        "pageSize": 0,
        "totalElements": 0,
        "totalPages": 0
    }
}

array of ComplianceAudit

elements

Optional

The list of elements included in this page

PageMetadata

pageMetadata

Optional

Represents pageable elements pagination metadata

401

Unauthorized Request

Returns Error of type(s) application/json

{
    "errorCode": "string",
    "errorType": "string",
    "arguments": [
        "string"
    ],
    "context": {
        "context": "string"
    },
    "message": "string",
    "remediationMessage": "string",
    "causes": [
        {
            "type": "string",
            "message": "string"
        }
    ],
    "nestedErrors": [
        "Error Object"
    ],
    "referenceToken": "string"
}

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 ErrorCause

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

{
    "errorCode": "string",
    "errorType": "string",
    "arguments": [
        "string"
    ],
    "context": {
        "context": "string"
    },
    "message": "string",
    "remediationMessage": "string",
    "causes": [
        {
            "type": "string",
            "message": "string"
        }
    ],
    "nestedErrors": [
        "Error Object"
    ],
    "referenceToken": "string"
}

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 ErrorCause

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

{
    "errorCode": "string",
    "errorType": "string",
    "arguments": [
        "string"
    ],
    "context": {
        "context": "string"
    },
    "message": "string",
    "remediationMessage": "string",
    "causes": [
        {
            "type": "string",
            "message": "string"
        }
    ],
    "nestedErrors": [
        "Error Object"
    ],
    "referenceToken": "string"
}

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.