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
×

ListComplianceProfiles

GET /v2/compliance/profiles/cluster

ListComplianceProfiles returns profiles matching given request

Description

Parameters

Query Parameters

Name Description Required Default Pattern

clusterId

-

null

query.query

-

null

query.pagination.limit

-

null

query.pagination.offset

-

null

query.pagination.sortOption.field

-

null

query.pagination.sortOption.reversed

-

null

query.pagination.sortOption.aggregateBy.aggrFunc

-

UNSET

query.pagination.sortOption.aggregateBy.distinct

-

null

Return Type

V2ListComplianceProfilesResponse

Content Type

  • application/json

Responses

Table 1. HTTP Response Codes
Code Message Datatype

200

A successful response.

V2ListComplianceProfilesResponse

0

An unexpected error response.

RpcStatus

Samples

Common object reference

ComplianceRuleFix

Field Name Required Nullable Type Description Format

platform

String

disruption

String

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

V2ComplianceProfile

Next Tag: 12
Field Name Required Nullable Type Description Format

id

String

name

String

profileVersion

String

productType

String

description

String

rules

List of V2ComplianceRule

product

String

title

String

values

List of string

standards

List of V2ComplianceBenchmark

V2ComplianceRule

Field Name Required Nullable Type Description Format

name

String

ruleType

String

severity

String

standard

String

control

String

title

String

description

String

rationale

String

fixes

List of ComplianceRuleFix

id

String

ruleId

String

parentRule

String

instructions

String

warning

String

V2ListComplianceProfilesResponse

ListComplianceProfilesResponse provides a list of profiles
Field Name Required Nullable Type Description Format

profiles

List of V2ComplianceProfile

totalCount

Integer

int32