Search
K
Konnect Service Catalog

Query Vulnerabilities Metrics

Post a query to the endpoint to retrieve aggregated vulnerabilities metrics.
Data can be requested to group by any 2 dimensions and can include any number of filter conditions.

post

Body

application/json

VulnerabilitiesMetricsQuery

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

Response

application/json

The result of a vulnerabilities metrics query.
Contains the aggregated data along with metadata about the query.

dataarray[object]requiredread-only

A query result with metrics grouped by the dimensions specified in the query, at a particular time.

Show Child Parameters
metaobjectrequired

Metadata about the query response. This includes:

  • The start and end times of the query
  • The granularity of the result
  • Whether the result was truncated
  • The limit of the result
  • The query_id
Show Child Parameters
post/metrics/vulnerabilities

Body

{ "metrics": [ "vulnerability_count" ], "dimensions": [ "service", "state" ], "filters": [ { "operator": "in", "value": [], "field": "service" } ], "time_range": { "type": "relative", "time_range": {} } }
 
application/json

Catalog Service Custom Fields

Manage custom fields for catalog services.

List Catalog Custom Field Schemas

Returns a paginated collection of catalog custom field schemas.

get

Query Parameters

page[size]integer

The maximum number of items to include per page. The last page of a collection may include fewer items.

Example:10

page[number]integer

Determines which page of the entities to retrieve.

Example:1

filterobject

Filters a collection of custom field schemas.

* Additional properties are NOT allowed.
Show Child Parameters
sortstring

The asc suffix is optional as the default sort order is ascending.
The desc suffix is used to specify a descending order.
Multiple sort attributes may be provided via a comma separated list.
JSONPath notation may be used to specify a sub-attribute (eg: ‘foo.bar desc’).

Example:created_at desc

Response

application/json

A paginated list response for a collection of custom field schemas.

* Additional properties are NOT allowed.
metaobjectrequired

returns the pagination information

Show Child Parameters
dataarray[object]required

Contains information about a custom field schema.

Show Child Parameters
get/catalog-custom-fields/schemas
 
application/json

Catalog Service API Mappings

Service API mappings represent the link between Service and API entities.
Once an API is mapped to a Service, a rich view of the linked APIs will be presented on the APIs tab of the Catalog Service.
Similarily, Services mapped to an API will be listed on the API overview page under Catalog.
An API may be mapped to multiple services, but it cannot be mapped to the same service twice.
If a mapped API is unlinked from a Service, the mapping will be deleted.

List API Mappings for a Service

Returns a paginated collection of API mappings for the given service.

get

Query Parameters

page[size]integer

The maximum number of items to include per page. The last page of a collection may include fewer items.

Example:10

page[number]integer

Determines which page of the entities to retrieve.

Example:1

sortstring

The asc suffix is optional as the default sort order is ascending.
The desc suffix is used to specify a descending order.
Multiple sort attributes may be provided via a comma separated list.
JSONPath notation may be used to specify a sub-attribute (eg: ‘foo.bar desc’).

Example:created_at desc

filterobject

Filters a collection of catalog service API mappings for a given Service. Supported filter attributes are:

  • api_id
  • id
* Additional properties are NOT allowed.
Show Child Parameters

Path Parameters

serviceIdstringrequired

The id of the service.

Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7

Response

application/json

A paginated list response for a collection of catalog service API mappings.

* Additional properties are NOT allowed.
metaobjectrequired

returns the pagination information

Show Child Parameters
dataarray[object]required

Represents an API mapping associated with a service in the catalog.

Show Child Parameters
get/catalog-services/{serviceId}/api-mappings
 
application/json