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
×

GetComplianceRule

GET /v2/compliance/rule/summary/{ruleName}

GetComplianceRule returns rule matching given request

Description

Parameters

Path Parameters

Name Description Required Default Pattern

ruleName

X

null

Query Parameters

Name Description Required Default Pattern

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

V2ComplianceRule

Content Type

  • application/json

Responses

Table 1. HTTP Response Codes
Code Message Datatype

200

A successful response.

V2ComplianceRule

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

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