OpenShift docs are moving and will soon only be available at docs.redhat.com, the home of all Red Hat product documentation. Explore the new docs experience today.
  1. Documentation
    2. history bug_report picture_as_pdf
×

GetComplianceScanResults

GET /v2/compliance/scan/results

GetComplianceScanResults retrieves the most recent compliance operator scan results for the specified query Optional RawQuery query fields can be combined. Commonly used ones include but are not limited to - scan: id(s) of the compliance scan - cluster: id(s) of the cluster - profile: id(s) of the profile

Description

Parameters

Query Parameters

Name Description Required Default Pattern

query

-

null

pagination.limit

-

null

pagination.offset

-

null

pagination.sortOption.field

-

null

pagination.sortOption.reversed

-

null

pagination.sortOption.aggregateBy.aggrFunc

-

UNSET

pagination.sortOption.aggregateBy.distinct

-

null

Return Type

V2ListComplianceResultsResponse

Content Type

  • application/json

Responses

Table 1. HTTP Response Codes
Code Message Datatype

200

A successful response.

V2ListComplianceResultsResponse

0

An unexpected error response.

RpcStatus

Samples

Common object reference

ProtobufAny

Field Name Required Nullable Type Description Format

@type

String

RpcStatus

Field Name Required Nullable Type Description Format

code

Integer

int32

message

String

details

List of ProtobufAny

V2ComplianceCheckData

Field Name Required Nullable Type Description Format

clusterId

String

scanName

String

result

V2ComplianceCheckResult

V2ComplianceCheckResult

ComplianceCheckResult details of an instance of a compliance check result
Field Name Required Nullable Type Description Format

checkId

String

checkName

String

checkUid

String

description

String

instructions

String

rationale

String

valuesUsed

List of string

warnings

List of string

status

V2ComplianceCheckStatus

UNSET_CHECK_STATUS, PASS, FAIL, ERROR, INFO, MANUAL, NOT_APPLICABLE, INCONSISTENT,

ruleName

String

labels

Map of string

annotations

Map of string

controls

List of V2ComplianceControl

V2ComplianceCheckStatus

Enum Values

UNSET_CHECK_STATUS

PASS

FAIL

ERROR

INFO

MANUAL

NOT_APPLICABLE

INCONSISTENT

V2ComplianceControl

Field Name Required Nullable Type Description Format

standard

String

control

String

V2ListComplianceResultsResponse

ListComplianceResultsResponse provides the complete scan results
Field Name Required Nullable Type Description Format

scanResults

List of V2ComplianceCheckData

totalCount

Integer

int32