Get Compliance Configurations

Get Compliance Configurations

Get a list of all compliance configurations

Request
URI
GET
https://{api_host}/v1/compliance-configurations
COPY
Query Parameters
string
standardType
Optional

The standard type

string
standardVersion
Optional

The standard version, use in combination with standardType

string
resourceType
Optional

The resource type One among: SDDC_MANAGER

string
resourceVersion
Optional

The resource version, use in combination with resourceType)


Responses
200

OK

Returns PageOfComplianceConfiguration of type(s) application/json
{
    "elements": [
        {
            "configurationId": "string",
            "configurationTitle": "string",
            "complianceResourceStandardConfigurationDetails": [
                {
                    "resourceType": "One among: SDDC_MANAGER",
                    "resourceVersion": "string",
                    "standardConfigurationDetails": [
                        {
                            "standardType": "One among: PCI",
                            "standardVersion": "string",
                            "isRecommendedByStandard": false,
                            "isAuditAutomated": false,
                            "citationReference": "string",
                            "auditProcedure": "string",
                            "recommendedValue": "string",
                            "remediationProcedure": "string"
                        }
                    ]
                }
            ]
        }
    ],
    "pageMetadata": {
        "pageNumber": 0,
        "pageSize": 0,
        "totalElements": 0,
        "totalPages": 0
    }
}
array of object
elements
Optional

The list of elements included in this page

object
pageMetadata
Optional

Represents pageable elements pagination metadata


400

Bad 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.


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.


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-configurations