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
×

GetComplianceProfilesStats

GET /v2/compliance/scan/stats/profiles

GetComplianceProfileScanStats lists current scan stats grouped by profile 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

V2ListComplianceProfileScanStatsResponse

Content Type

  • application/json

Responses

Table 1. HTTP Response Codes
Code Message Datatype

200

A successful response.

V2ListComplianceProfileScanStatsResponse

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

V2ComplianceBenchmark

Field Name Required Nullable Type Description Format

name

String

version

String

description

String

provider

String

shortName

String

V2ComplianceCheckStatus

Enum Values

UNSET_CHECK_STATUS

PASS

FAIL

ERROR

INFO

MANUAL

NOT_APPLICABLE

INCONSISTENT

V2ComplianceCheckStatusCount

Group the number of occurrences by status
Field Name Required Nullable Type Description Format

count

Integer

int32

status

V2ComplianceCheckStatus

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

V2ComplianceProfileScanStats

ComplianceProfileScanStats provides scan stats overview based on profile
Field Name Required Nullable Type Description Format

checkStats

List of V2ComplianceCheckStatusCount

profileName

String

title

String

version

String

benchmarks

List of V2ComplianceBenchmark

V2ListComplianceProfileScanStatsResponse

ListComplianceProfileScanStatsResponse provides stats for the profiles within the scans
Field Name Required Nullable Type Description Format

scanStats

List of V2ComplianceProfileScanStats

totalCount

Integer

int32