Compliance Audit

Compliance Audit

Compliance audit of resource

Request
URI
POST
https://{api_host}/v1/domains/{id}/compliance-audits
COPY
Path Parameters
string
id
Required

ID of the domain

Request Body
ComplianceAuditSpec of type(s) application/json
Required

Show optional properties

{
    "standardType": "One among: PCI",
    "standardVersion": "string",
    "complianceResourcesConfigurationSpec": [
        {
            "resources": [
                {
                    "resourceType": "One among: SDDC_MANAGER"
                }
            ]
        }
    ]
}
{
    "standardType": "One among: PCI",
    "standardVersion": "string",
    "complianceResourcesConfigurationSpec": [
        {
            "configurationId": "string",
            "resources": [
                {
                    "resourceType": "One among: SDDC_MANAGER",
                    "resourceName": "string"
                }
            ]
        }
    ]
}
string
standardType
Required

Compliance standard type

string
standardVersion
Required

Compliance standard version

array of ComplianceResourcesConfigurationSpec
complianceResourcesConfigurationSpec
Required

Compliance resource and configuration spec

Responses
202

Accepted

Returns ComplianceTask of type(s) application/json 
{
    "id": "string",
    "status": "One among: PENDING, IN_PROGRESS, In Progress, SUCCESSFUL, Successful, FAILED, Failed, CANCELLED, Cancelled, COMPLETED_WITH_WARNING, SKIPPED",
    "complianceAuditId": "string"
}
string
id
Optional

Compliance task id

string
status
Optional

Compliance task status

string
complianceAuditId
Optional

Compliance audit id


400

Bad 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

InternalServerError

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.


On This Page
Compliance Operations
POST
Compliance Audit
GET
Get Compliance Audit
GET
Get Compliance Audit For A Domain
GET
Get Compliance Audit History
GET
Get Compliance Audit History For A Domain
GET
Get Compliance Audit Items
GET
Get Compliance Audit Items For A Domain
GET
Get Compliance Audit Task
GET
Get Compliance Configurations
GET
Get Compliance Standards
PATCH
Retry Compliance Audit Task