Search
K
Konnect Service Catalog

VulnerabilitiesMetricsQuery

object

A query against vulnerability metrics.

* Additional properties are NOT allowed.
metricsarray[string]required

List of aggregated metrics to collect across the requested time span.

Allowed values:vulnerability_count

>= 1 items<= 1 items

dimensionsarray[string]required

The list of dimensions to group by.

Allowed values:timeserviceseveritystatetypesourceenvironmentregion

<= 2 items

Example:service, state

filtersOne Of
arrayrequired

A list of filters to apply to the query.

VulnerabilitiesMetricsFilterByServiceobject

Filters a metrics query by service.

Show Child Parameters
granularitystring

Force time grouping into buckets of the specified duration. Only has an effect if time is in the dimensions list.

The granularity of the result may be coarser than requested.
The exact result granularity will be reported in the response meta.granularity_ms field.

If granularity is not specified and time is in the dimensions list, a default will be chosen based on the time range requested.

Different relative times support different granularities:

  • 1d => daily
  • 7d => daily, weekly
  • 3w => daily, weekly
  • 30d => daily, weekly
  • 3mo => daily, weekly
  • 1y => daily, weekly

For special time ranges:

  • current_week, previous_week => daily
  • current_month, previous_month => daily, weekly

For absolute time ranges, daily will be used.

Allowed values:dailyweekly

time_rangeOne Of
required

The time range to query.

VulnerabilityMetricsRelativeTimeRangeobject

A duration representing a relative-to-now span of time.
The start time is floored to the requested granularity.
The exact start and end timestamps are returned in the result query in the meta.start and meta.end fields.
Example:
7d from now, with 1day granularity initiated at 2024-01-08T17:11:00+05:00 will query for the time range from 2024-01-01T00:00:00+05:00 to 2024-01-08T17:11:00+05:00.

* Additional properties are NOT allowed.
Show Child Parameters
Example

VulnerabilitiesMetricsFilterByService

object

Filters a metrics query by service.

operatorstringrequired

The type of filter to apply.

  • in filters will limit results to only the specified values
  • not_in filters will exclude the specified values

Allowed values:innot_in

valuearray[string](uuid)required
fieldstringrequired

Allowed values:service

Example

VulnerabilitiesMetricsFilterBySeverity

object

Filters a metrics query by severity.

fieldstringrequired

Allowed values:severity

operatorstringrequired

The type of filter to apply.

  • in filters will limit results to only the specified values
  • not_in filters will exclude the specified values

Allowed values:innot_in

valuearray[string]required

Allowed values:lowmediumhighcritical

Example:low

Example

VulnerabilitiesMetricsFilterByState

object

Filters a metrics query by state.

fieldstringrequired

Allowed values:state

operatorstringrequired

The type of filter to apply.

  • in filters will limit results to only the specified values
  • not_in filters will exclude the specified values

Allowed values:innot_in

valuearray[string]required

Allowed values:openfixeddismissed

Example:dismissed

Example

VulnerabilitiesMetricsFilterByType

object

Filters a metrics query by type.

fieldstringrequired

Allowed values:type

operatorstringrequired

The type of filter to apply.

  • in filters will limit results to only the specified values
  • not_in filters will exclude the specified values

Allowed values:innot_in

valuearray[string]requiredread-only

Allowed values:container_imagelibrary

Example:container_image

Example