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
×

ListReportConfigurations

GET /v2/reports/configurations

ListReportConfigurations returns report configurations matching given query

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

V2ListReportConfigurationsResponse

Content Type

  • application/json

Responses

Table 1. HTTP Response Codes
Code Message Datatype

200

A successful response.

V2ListReportConfigurationsResponse

0

An unexpected error response.

RpcStatus

Samples

Common object reference

ProtobufAny

Field Name Required Nullable Type Description Format

@type

String

ReportConfigurationReportType

Enum Values

VULNERABILITY

RpcStatus

Field Name Required Nullable Type Description Format

code

Integer

int32

message

String

details

List of ProtobufAny

V2CollectionReference

Field Name Required Nullable Type Description Format

collectionId

String

collectionName

String

V2EmailNotifierConfiguration

Field Name Required Nullable Type Description Format

notifierId

String

mailingLists

List of string

customSubject

String

customBody

String

V2ListReportConfigurationsResponse

Field Name Required Nullable Type Description Format

reportConfigs

List of V2ReportConfiguration

V2NotifierConfiguration

Field Name Required Nullable Type Description Format

emailConfig

V2EmailNotifierConfiguration

notifierName

String

V2ReportConfiguration

Field Name Required Nullable Type Description Format

id

String

name

String

description

String

type

ReportConfigurationReportType

VULNERABILITY,

vulnReportFilters

V2VulnerabilityReportFilters

schedule

V2ReportSchedule

resourceScope

V2ResourceScope

notifiers

List of V2NotifierConfiguration

V2ReportSchedule

Field Name Required Nullable Type Description Format

intervalType

V2ReportScheduleIntervalType

UNSET, WEEKLY, MONTHLY,

hour

Integer

int32

minute

Integer

int32

daysOfWeek

V2ReportScheduleDaysOfWeek

daysOfMonth

V2ReportScheduleDaysOfMonth

V2ReportScheduleDaysOfMonth

1 for 1st, 2 for 2nd .... 31 for 31st
Field Name Required Nullable Type Description Format

days

List of integer

int32

V2ReportScheduleDaysOfWeek

Sunday = 0, Monday = 1, .... Saturday =  6
Field Name Required Nullable Type Description Format

days

List of integer

int32

V2ReportScheduleIntervalType

Enum Values

UNSET

WEEKLY

MONTHLY

V2ResourceScope

Field Name Required Nullable Type Description Format

collectionScope

V2CollectionReference

V2VulnerabilityReportFilters

Field Name Required Nullable Type Description Format

fixability

VulnerabilityReportFiltersFixability

BOTH, FIXABLE, NOT_FIXABLE,

severities

List of VulnerabilityReportFiltersVulnerabilitySeverity

imageTypes

List of VulnerabilityReportFiltersImageType

allVuln

Boolean

sinceLastSentScheduledReport

Boolean

sinceStartDate

Date

date-time

includeNvdCvss

Boolean

VulnerabilityReportFiltersFixability

Enum Values

BOTH

FIXABLE

NOT_FIXABLE

VulnerabilityReportFiltersImageType

Enum Values

DEPLOYED

WATCHED

VulnerabilityReportFiltersVulnerabilitySeverity

Enum Values

UNKNOWN_VULNERABILITY_SEVERITY

LOW_VULNERABILITY_SEVERITY

MODERATE_VULNERABILITY_SEVERITY

IMPORTANT_VULNERABILITY_SEVERITY

CRITICAL_VULNERABILITY_SEVERITY