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.
Body
application/json
Body
VulnerabilitiesMetricsQuery
A query against vulnerability metrics.
List of aggregated metrics to collect across the requested time span.
Allowed values:vulnerability_count
>= 1 items<= 1 items
The list of dimensions to group by.
Allowed values:timeserviceseveritystatetypesourceenvironmentregion
<= 2 items
Example:["service","state"]
One OfA list of filters to apply to the query.
Filters a metrics query by service.
Show Child Parameters
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
One OfThe time range to query.
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.
Show Child Parameters
Response
application/json
Response
The result of a vulnerabilities metrics query.
Contains the aggregated data along with metadata about the query.
A query result with metrics grouped by the dimensions specified in the query, at a particular time.
Show Child Parameters
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
Authentication
Body
Catalog Service Custom Fields
Manage custom fields for catalog services.
List Catalog Custom Field Schemas
Returns a paginated collection of catalog custom field schemas.
Query Parameters
The maximum number of items to include per page. The last page of a collection may include fewer items.
Example:10
Determines which page of the entities to retrieve.
Example:1
Filters a collection of custom field schemas.
Show Child Parameters
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
Response
A paginated list response for a collection of custom field schemas.
returns the pagination information
Show Child Parameters
Contains information about a custom field schema.
Show Child Parameters
Authentication
Query Parameters
Quotas
Organization quotas and system default quota definitions used for usage limits and governance in the Service Catalog.
List Default Quotas
Returns a paginated collection of system default quota definitions.
Query Parameters
The maximum number of items to include per page. The last page of a collection may include fewer items.
Example:10
Determines which page of the entities to retrieve.
Example:1
Response
application/json
Response
A paginated list response for a collection of default quotas.
returns the pagination information
Show Child Parameters
A system-defined default quota definition.