diff --git a/packages/compliance/src/.openapi-generator/VERSION b/packages/compliance/src/.openapi-generator/VERSION index cd802a1ec..412252180 100644 --- a/packages/compliance/src/.openapi-generator/VERSION +++ b/packages/compliance/src/.openapi-generator/VERSION @@ -1 +1 @@ -6.6.0 \ No newline at end of file +7.0.0 \ No newline at end of file diff --git a/packages/config-manager/src/.openapi-generator/FILES b/packages/config-manager/src/.openapi-generator/FILES index 8981b206c..62da6d411 100644 --- a/packages/config-manager/src/.openapi-generator/FILES +++ b/packages/config-manager/src/.openapi-generator/FILES @@ -4,10 +4,6 @@ CreateProfile/index.ts GetProfile/index.ts api.ts -docs/CreateProfileApi.md -docs/CreateProfileRequest.md -docs/GetProfileApi.md -docs/Profile.md git_push.sh index.ts index.ts diff --git a/packages/config-manager/src/.openapi-generator/VERSION b/packages/config-manager/src/.openapi-generator/VERSION index 2540a3a5b..412252180 100644 --- a/packages/config-manager/src/.openapi-generator/VERSION +++ b/packages/config-manager/src/.openapi-generator/VERSION @@ -1 +1 @@ -7.20.0 +7.0.0 \ No newline at end of file diff --git a/packages/config-manager/src/api.ts b/packages/config-manager/src/api.ts index 9f986865c..14220d9f7 100644 --- a/packages/config-manager/src/api.ts +++ b/packages/config-manager/src/api.ts @@ -10,7 +10,8 @@ import { const endpointList = { createProfile, - getProfile, + getProfile, + }; diff --git a/packages/config-manager/src/docs/CreateProfileApi.md b/packages/config-manager/src/docs/CreateProfileApi.md deleted file mode 100644 index 5eb1755dc..000000000 --- a/packages/config-manager/src/docs/CreateProfileApi.md +++ /dev/null @@ -1,63 +0,0 @@ -# CreateProfileApi - -All URIs are relative to *https://raw.githubusercontent.com/api/config-manager/v2* - -|Method | HTTP request | Description| -|------------- | ------------- | -------------| -|[**createProfile**](#createprofile) | **POST** /profiles | Create a new profile| - -# **createProfile** -> Profile createProfile(createProfileRequest) - -Create and optionally activate a new profile. - -### Example - -```typescript -import { - CreateProfileApi, - Configuration, - CreateProfileRequest -} from './api'; - -const configuration = new Configuration(); -const apiInstance = new CreateProfileApi(configuration); - -let createProfileRequest: CreateProfileRequest; // - -const { status, data } = await apiInstance.createProfile( - createProfileRequest -); -``` - -### Parameters - -|Name | Type | Description | Notes| -|------------- | ------------- | ------------- | -------------| -| **createProfileRequest** | **CreateProfileRequest**| | | - - -### Return type - -**Profile** - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json, text/plain - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -|**201** | Created | - | -|**304** | Not Modified | - | -|**400** | Bad Request | - | -|**500** | Internal Server Error | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/packages/config-manager/src/docs/CreateProfileRequest.md b/packages/config-manager/src/docs/CreateProfileRequest.md deleted file mode 100644 index c8b31cc1b..000000000 --- a/packages/config-manager/src/docs/CreateProfileRequest.md +++ /dev/null @@ -1,26 +0,0 @@ -# CreateProfileRequest - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**active** | **boolean** | Remote host configuration enabled state | [default to undefined] -**compliance** | **boolean** | Remote configuration status for running Compliance data collection | [default to undefined] -**insights** | **boolean** | Remote configuration status for running Insights data collection | [default to undefined] -**remediations** | **boolean** | Remote configuration status for running Remediation playbooks | [default to undefined] - -## Example - -```typescript -import { CreateProfileRequest } from './api'; - -const instance: CreateProfileRequest = { - active, - compliance, - insights, - remediations, -}; -``` - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/packages/config-manager/src/docs/GetProfileApi.md b/packages/config-manager/src/docs/GetProfileApi.md deleted file mode 100644 index f59e86cf1..000000000 --- a/packages/config-manager/src/docs/GetProfileApi.md +++ /dev/null @@ -1,62 +0,0 @@ -# GetProfileApi - -All URIs are relative to *https://raw.githubusercontent.com/api/config-manager/v2* - -|Method | HTTP request | Description| -|------------- | ------------- | -------------| -|[**getProfile**](#getprofile) | **GET** /profiles/{id} | Get a specific profile| - -# **getProfile** -> Profile getProfile() - -Retrieve a specific profile identified by the \'id\' path parameter for the identified account. If the special value \"current\" is used for the \'id\' path parameter, the most recent profile is retrieved instead. - -### Example - -```typescript -import { - GetProfileApi, - Configuration -} from './api'; - -const configuration = new Configuration(); -const apiInstance = new GetProfileApi(configuration); - -let id: string; // (default to undefined) - -const { status, data } = await apiInstance.getProfile( - id -); -``` - -### Parameters - -|Name | Type | Description | Notes| -|------------- | ------------- | ------------- | -------------| -| **id** | [**string**] | | defaults to undefined| - - -### Return type - -**Profile** - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, text/plain - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -|**200** | OK | - | -|**400** | Bad Request | - | -|**404** | Not Found | - | -|**500** | Internal Server Error | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/packages/config-manager/src/docs/Profile.md b/packages/config-manager/src/docs/Profile.md deleted file mode 100644 index ec1c9b86c..000000000 --- a/packages/config-manager/src/docs/Profile.md +++ /dev/null @@ -1,34 +0,0 @@ -# Profile - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**id** | **string** | Profile unique identity value | [optional] [default to undefined] -**account_id** | **string** | Red Hat account number | [optional] [default to undefined] -**org_id** | **string** | Red Hat organization identity value | [optional] [default to undefined] -**created_at** | **string** | Time of profile creation | [optional] [default to undefined] -**active** | **boolean** | Remote host configuration enabled state | [optional] [default to undefined] -**compliance** | **boolean** | Remote configuration status for running Compliance data collection | [optional] [default to undefined] -**insights** | **boolean** | Remote configuration status for running Insights data collection | [optional] [default to undefined] -**remediations** | **boolean** | Remote configuration status for running Remediation playbooks | [optional] [default to undefined] - -## Example - -```typescript -import { Profile } from './api'; - -const instance: Profile = { - id, - account_id, - org_id, - created_at, - active, - compliance, - insights, - remediations, -}; -``` - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/packages/host-inventory/src/.openapi-generator/FILES b/packages/host-inventory/src/.openapi-generator/FILES index ed9dd6643..24cdc35c7 100644 --- a/packages/host-inventory/src/.openapi-generator/FILES +++ b/packages/host-inventory/src/.openapi-generator/FILES @@ -36,6 +36,12 @@ ApiSystemProfileGetSapSids/index.ts ApiSystemProfileGetSapSystem/index.ts ApiSystemProfileValidateSchema/index.ts ApiTagGetTags/index.ts +ApiViewsCloneView/index.ts +ApiViewsCreateView/index.ts +ApiViewsDeleteView/index.ts +ApiViewsGetViewById/index.ts +ApiViewsGetViewsList/index.ts +ApiViewsUpdateView/index.ts api.ts git_push.sh index.ts diff --git a/packages/host-inventory/src/ApiGroupGetGroupList/index.ts b/packages/host-inventory/src/ApiGroupGetGroupList/index.ts index 9c5831cfa..d6d6a92b3 100644 --- a/packages/host-inventory/src/ApiGroupGetGroupList/index.ts +++ b/packages/host-inventory/src/ApiGroupGetGroupList/index.ts @@ -37,7 +37,7 @@ export type ApiGroupGetGroupListParams = { */ orderBy?: ApiGroupGetGroupListOrderByEnum, /** - * Direction of the ordering (case-insensitive); defaults to ASC for name, and to DESC for host_count + * Direction of the ordering (case-insensitive); defaults to ASC for name, and to DESC for host_count and updated * @type { string } * @memberof ApiGroupGetGroupListApi */ diff --git a/packages/host-inventory/src/ApiGroupGetGroupsById/index.ts b/packages/host-inventory/src/ApiGroupGetGroupsById/index.ts index 0af91ff56..e454b8e1b 100644 --- a/packages/host-inventory/src/ApiGroupGetGroupsById/index.ts +++ b/packages/host-inventory/src/ApiGroupGetGroupsById/index.ts @@ -37,7 +37,7 @@ export type ApiGroupGetGroupsByIdParams = { */ orderBy?: ApiGroupGetGroupsByIdOrderByEnum, /** - * Direction of the ordering (case-insensitive); defaults to ASC for name, and to DESC for host_count + * Direction of the ordering (case-insensitive); defaults to ASC for name, and to DESC for host_count and updated * @type { string } * @memberof ApiGroupGetGroupsByIdApi */ diff --git a/packages/host-inventory/src/ApiViewsCloneView/index.ts b/packages/host-inventory/src/ApiViewsCloneView/index.ts new file mode 100644 index 000000000..efedff661 --- /dev/null +++ b/packages/host-inventory/src/ApiViewsCloneView/index.ts @@ -0,0 +1,72 @@ +// @ts-ignore +import type { AxiosPromise, AxiosInstance, AxiosRequestConfig, Method } from 'axios'; +// @ts-ignore +import { COLLECTION_FORMATS, RequiredError, AuthTypeEnum, DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '@redhat-cloud-services/javascript-clients-shared/dist/common'; +import type { RequestArgs } from '@redhat-cloud-services/javascript-clients-shared/dist/common'; +// @ts-ignore +import { BaseAPI } from '@redhat-cloud-services/javascript-clients-shared/dist/base'; +import { Configuration } from '@redhat-cloud-services/javascript-clients-shared/dist/configuration'; + +// @ts-ignore +import type { ViewOut } from '../types'; + + +export type ApiViewsCloneViewParams = { + /** + * View ID. + * @type { string } + * @memberof ApiViewsCloneViewApi + */ + viewId: string, + options?: AxiosRequestConfig +} + +export type ApiViewsCloneViewReturnType = ViewOut; + +const isApiViewsCloneViewObjectParams = (params: [ApiViewsCloneViewParams] | unknown[]): params is [ApiViewsCloneViewParams] => { + const l = params.length === 1 + if(l && typeof params[0] === 'object' && !Array.isArray(params[0])) { + return true && Object.prototype.hasOwnProperty.call(params[0], 'viewId') + } + return false +} +/** +* Creates a copy of any visible view (including system views) as a new private view owned by the requesting user. The cloned view name is prefixed with \"Copy of \".

Required permissions: inventory:views:write

NOTE: This endpoint is not yet implemented and will return HTTP 501. +* @summary Clone an inventory view +* @param {ApiViewsCloneViewParams} config with all available params. +* @param {*} [options] Override http request option. +* @throws {RequiredError} +*/ +export const apiViewsCloneViewParamCreator = async (sendRequest: BaseAPI["sendRequest"], ...config: ([ApiViewsCloneViewParams] | [string, AxiosRequestConfig])) => { + const params = isApiViewsCloneViewObjectParams(config) ? config[0] : ['viewId', 'options'].reduce((acc, curr, index) => ({ ...acc, [curr]: config[index] }), {}) as ApiViewsCloneViewParams; + const { viewId, options = {} } = params; + const localVarPath = `/beta/views/{view_id}/clone` + .replace(`{${"view_id"}}`, encodeURIComponent(String(viewId))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + const localVarRequestOptions = { method: 'POST' as Method, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + localVarRequestOptions.headers = {...localVarHeaderParameter, ...options.headers}; + + const args = { + urlObj: localVarUrlObj, + options: localVarRequestOptions, + auth:[ + { + // authentication ApiKeyAuth required + // in header with key required + authType: AuthTypeEnum.InHeader, + authKey: "x-rh-identity" + } + ] + }; + + return sendRequest(Promise.resolve(args)); +} + +export default apiViewsCloneViewParamCreator; diff --git a/packages/host-inventory/src/ApiViewsCreateView/index.ts b/packages/host-inventory/src/ApiViewsCreateView/index.ts new file mode 100644 index 000000000..86abc5fb0 --- /dev/null +++ b/packages/host-inventory/src/ApiViewsCreateView/index.ts @@ -0,0 +1,74 @@ +// @ts-ignore +import type { AxiosPromise, AxiosInstance, AxiosRequestConfig, Method } from 'axios'; +// @ts-ignore +import { COLLECTION_FORMATS, RequiredError, AuthTypeEnum, DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '@redhat-cloud-services/javascript-clients-shared/dist/common'; +import type { RequestArgs } from '@redhat-cloud-services/javascript-clients-shared/dist/common'; +// @ts-ignore +import { BaseAPI } from '@redhat-cloud-services/javascript-clients-shared/dist/base'; +import { Configuration } from '@redhat-cloud-services/javascript-clients-shared/dist/configuration'; + +// @ts-ignore +import type { ViewIn, ViewOut } from '../types'; + + +export type ApiViewsCreateViewParams = { + /** + * Data required to create a new inventory view. + * @type { ViewIn } + * @memberof ApiViewsCreateViewApi + */ + viewIn: ViewIn, + options?: AxiosRequestConfig +} + +export type ApiViewsCreateViewReturnType = ViewOut; + +const isApiViewsCreateViewObjectParams = (params: [ApiViewsCreateViewParams] | unknown[]): params is [ApiViewsCreateViewParams] => { + const l = params.length === 1 + if(l && typeof params[0] === 'object' && !Array.isArray(params[0])) { + return true && Object.prototype.hasOwnProperty.call(params[0], 'viewIn') + } + return false +} +/** +* Creates a new inventory view with the provided name and configuration. The view is owned by the requesting user.

Required permissions: inventory:views:write

NOTE: This endpoint is not yet implemented and will return HTTP 501. +* @summary Create a new inventory view +* @param {ApiViewsCreateViewParams} config with all available params. +* @param {*} [options] Override http request option. +* @throws {RequiredError} +*/ +export const apiViewsCreateViewParamCreator = async (sendRequest: BaseAPI["sendRequest"], ...config: ([ApiViewsCreateViewParams] | [ViewIn, AxiosRequestConfig])) => { + const params = isApiViewsCreateViewObjectParams(config) ? config[0] : ['viewIn', 'options'].reduce((acc, curr, index) => ({ ...acc, [curr]: config[index] }), {}) as ApiViewsCreateViewParams; + const { viewIn, options = {} } = params; + const localVarPath = `/beta/views`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + const localVarRequestOptions = { method: 'POST' as Method, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + localVarRequestOptions.headers = {...localVarHeaderParameter, ...options.headers}; + + const args = { + urlObj: localVarUrlObj, + options: localVarRequestOptions, + serializeData: viewIn, + auth:[ + { + // authentication ApiKeyAuth required + // in header with key required + authType: AuthTypeEnum.InHeader, + authKey: "x-rh-identity" + } + ] + }; + + return sendRequest(Promise.resolve(args)); +} + +export default apiViewsCreateViewParamCreator; diff --git a/packages/host-inventory/src/ApiViewsDeleteView/index.ts b/packages/host-inventory/src/ApiViewsDeleteView/index.ts new file mode 100644 index 000000000..19bb4ef2c --- /dev/null +++ b/packages/host-inventory/src/ApiViewsDeleteView/index.ts @@ -0,0 +1,72 @@ +// @ts-ignore +import type { AxiosPromise, AxiosInstance, AxiosRequestConfig, Method } from 'axios'; +// @ts-ignore +import { COLLECTION_FORMATS, RequiredError, AuthTypeEnum, DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '@redhat-cloud-services/javascript-clients-shared/dist/common'; +import type { RequestArgs } from '@redhat-cloud-services/javascript-clients-shared/dist/common'; +// @ts-ignore +import { BaseAPI } from '@redhat-cloud-services/javascript-clients-shared/dist/base'; +import { Configuration } from '@redhat-cloud-services/javascript-clients-shared/dist/configuration'; + +// @ts-ignore +import type { } from '../types'; + + +export type ApiViewsDeleteViewParams = { + /** + * View ID. + * @type { string } + * @memberof ApiViewsDeleteViewApi + */ + viewId: string, + options?: AxiosRequestConfig +} + +export type ApiViewsDeleteViewReturnType = void; + +const isApiViewsDeleteViewObjectParams = (params: [ApiViewsDeleteViewParams] | unknown[]): params is [ApiViewsDeleteViewParams] => { + const l = params.length === 1 + if(l && typeof params[0] === 'object' && !Array.isArray(params[0])) { + return true && Object.prototype.hasOwnProperty.call(params[0], 'viewId') + } + return false +} +/** +* Deletes an existing inventory view. Only the view creator can delete a view. System views cannot be deleted.

Required permissions: inventory:views:write

NOTE: This endpoint is not yet implemented and will return HTTP 501. +* @summary Delete an inventory view +* @param {ApiViewsDeleteViewParams} config with all available params. +* @param {*} [options] Override http request option. +* @throws {RequiredError} +*/ +export const apiViewsDeleteViewParamCreator = async (sendRequest: BaseAPI["sendRequest"], ...config: ([ApiViewsDeleteViewParams] | [string, AxiosRequestConfig])) => { + const params = isApiViewsDeleteViewObjectParams(config) ? config[0] : ['viewId', 'options'].reduce((acc, curr, index) => ({ ...acc, [curr]: config[index] }), {}) as ApiViewsDeleteViewParams; + const { viewId, options = {} } = params; + const localVarPath = `/beta/views/{view_id}` + .replace(`{${"view_id"}}`, encodeURIComponent(String(viewId))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + const localVarRequestOptions = { method: 'DELETE' as Method, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + localVarRequestOptions.headers = {...localVarHeaderParameter, ...options.headers}; + + const args = { + urlObj: localVarUrlObj, + options: localVarRequestOptions, + auth:[ + { + // authentication ApiKeyAuth required + // in header with key required + authType: AuthTypeEnum.InHeader, + authKey: "x-rh-identity" + } + ] + }; + + return sendRequest(Promise.resolve(args)); +} + +export default apiViewsDeleteViewParamCreator; diff --git a/packages/host-inventory/src/ApiViewsGetViewById/index.ts b/packages/host-inventory/src/ApiViewsGetViewById/index.ts new file mode 100644 index 000000000..ceee6ffae --- /dev/null +++ b/packages/host-inventory/src/ApiViewsGetViewById/index.ts @@ -0,0 +1,72 @@ +// @ts-ignore +import type { AxiosPromise, AxiosInstance, AxiosRequestConfig, Method } from 'axios'; +// @ts-ignore +import { COLLECTION_FORMATS, RequiredError, AuthTypeEnum, DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '@redhat-cloud-services/javascript-clients-shared/dist/common'; +import type { RequestArgs } from '@redhat-cloud-services/javascript-clients-shared/dist/common'; +// @ts-ignore +import { BaseAPI } from '@redhat-cloud-services/javascript-clients-shared/dist/base'; +import { Configuration } from '@redhat-cloud-services/javascript-clients-shared/dist/configuration'; + +// @ts-ignore +import type { ViewOut } from '../types'; + + +export type ApiViewsGetViewByIdParams = { + /** + * View ID. + * @type { string } + * @memberof ApiViewsGetViewByIdApi + */ + viewId: string, + options?: AxiosRequestConfig +} + +export type ApiViewsGetViewByIdReturnType = ViewOut; + +const isApiViewsGetViewByIdObjectParams = (params: [ApiViewsGetViewByIdParams] | unknown[]): params is [ApiViewsGetViewByIdParams] => { + const l = params.length === 1 + if(l && typeof params[0] === 'object' && !Array.isArray(params[0])) { + return true && Object.prototype.hasOwnProperty.call(params[0], 'viewId') + } + return false +} +/** +* Returns the full details and configuration for a single inventory view. The view must be visible to the requesting user.

Required permissions: inventory:views:read

NOTE: This endpoint is not yet implemented and will return HTTP 501. +* @summary Get a single inventory view +* @param {ApiViewsGetViewByIdParams} config with all available params. +* @param {*} [options] Override http request option. +* @throws {RequiredError} +*/ +export const apiViewsGetViewByIdParamCreator = async (sendRequest: BaseAPI["sendRequest"], ...config: ([ApiViewsGetViewByIdParams] | [string, AxiosRequestConfig])) => { + const params = isApiViewsGetViewByIdObjectParams(config) ? config[0] : ['viewId', 'options'].reduce((acc, curr, index) => ({ ...acc, [curr]: config[index] }), {}) as ApiViewsGetViewByIdParams; + const { viewId, options = {} } = params; + const localVarPath = `/beta/views/{view_id}` + .replace(`{${"view_id"}}`, encodeURIComponent(String(viewId))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + const localVarRequestOptions = { method: 'GET' as Method, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + localVarRequestOptions.headers = {...localVarHeaderParameter, ...options.headers}; + + const args = { + urlObj: localVarUrlObj, + options: localVarRequestOptions, + auth:[ + { + // authentication ApiKeyAuth required + // in header with key required + authType: AuthTypeEnum.InHeader, + authKey: "x-rh-identity" + } + ] + }; + + return sendRequest(Promise.resolve(args)); +} + +export default apiViewsGetViewByIdParamCreator; diff --git a/packages/host-inventory/src/ApiViewsGetViewsList/index.ts b/packages/host-inventory/src/ApiViewsGetViewsList/index.ts new file mode 100644 index 000000000..0aae02a91 --- /dev/null +++ b/packages/host-inventory/src/ApiViewsGetViewsList/index.ts @@ -0,0 +1,85 @@ +// @ts-ignore +import type { AxiosPromise, AxiosInstance, AxiosRequestConfig, Method } from 'axios'; +// @ts-ignore +import { COLLECTION_FORMATS, RequiredError, AuthTypeEnum, DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '@redhat-cloud-services/javascript-clients-shared/dist/common'; +import type { RequestArgs } from '@redhat-cloud-services/javascript-clients-shared/dist/common'; +// @ts-ignore +import { BaseAPI } from '@redhat-cloud-services/javascript-clients-shared/dist/base'; +import { Configuration } from '@redhat-cloud-services/javascript-clients-shared/dist/configuration'; + +// @ts-ignore +import type { ViewsListOut } from '../types'; + + +export type ApiViewsGetViewsListParams = { + /** + * A number of items to return per page. + * @type { number } + * @memberof ApiViewsGetViewsListApi + */ + perPage?: number, + /** + * A page number of the items to return. + * @type { number } + * @memberof ApiViewsGetViewsListApi + */ + page?: number, + options?: AxiosRequestConfig +} + +export type ApiViewsGetViewsListReturnType = ViewsListOut; + +const isApiViewsGetViewsListObjectParams = (params: [ApiViewsGetViewsListParams] | unknown[]): params is [ApiViewsGetViewsListParams] => { + const l = params.length === 1 + if(l && typeof params[0] === 'object' && !Array.isArray(params[0])) { + return true + } + return false +} +/** +* Read the list of all inventory views visible to the requesting user. This includes system views, org-wide views, and private views owned by the requester.

Required permissions: inventory:views:read

NOTE: This endpoint is not yet implemented and will return HTTP 501. +* @summary Read the list of inventory views +* @param {ApiViewsGetViewsListParams} config with all available params. +* @param {*} [options] Override http request option. +* @throws {RequiredError} +*/ +export const apiViewsGetViewsListParamCreator = async (sendRequest: BaseAPI["sendRequest"], ...config: ([ApiViewsGetViewsListParams] | [number, number, AxiosRequestConfig])) => { + const params = isApiViewsGetViewsListObjectParams(config) ? config[0] : ['perPage', 'page', 'options'].reduce((acc, curr, index) => ({ ...acc, [curr]: config[index] }), {}) as ApiViewsGetViewsListParams; + const { perPage, page, options = {} } = params; + const localVarPath = `/beta/views`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + const localVarRequestOptions = { method: 'GET' as Method, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + if (perPage !== undefined) { + localVarQueryParameter['per_page'] = perPage; + } + + if (page !== undefined) { + localVarQueryParameter['page'] = page; + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + localVarRequestOptions.headers = {...localVarHeaderParameter, ...options.headers}; + + const args = { + urlObj: localVarUrlObj, + options: localVarRequestOptions, + auth:[ + { + // authentication ApiKeyAuth required + // in header with key required + authType: AuthTypeEnum.InHeader, + authKey: "x-rh-identity" + } + ] + }; + + return sendRequest(Promise.resolve(args)); +} + +export default apiViewsGetViewsListParamCreator; diff --git a/packages/host-inventory/src/ApiViewsUpdateView/index.ts b/packages/host-inventory/src/ApiViewsUpdateView/index.ts new file mode 100644 index 000000000..6dba1fa32 --- /dev/null +++ b/packages/host-inventory/src/ApiViewsUpdateView/index.ts @@ -0,0 +1,81 @@ +// @ts-ignore +import type { AxiosPromise, AxiosInstance, AxiosRequestConfig, Method } from 'axios'; +// @ts-ignore +import { COLLECTION_FORMATS, RequiredError, AuthTypeEnum, DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '@redhat-cloud-services/javascript-clients-shared/dist/common'; +import type { RequestArgs } from '@redhat-cloud-services/javascript-clients-shared/dist/common'; +// @ts-ignore +import { BaseAPI } from '@redhat-cloud-services/javascript-clients-shared/dist/base'; +import { Configuration } from '@redhat-cloud-services/javascript-clients-shared/dist/configuration'; + +// @ts-ignore +import type { ViewOut, ViewPatch } from '../types'; + + +export type ApiViewsUpdateViewParams = { + /** + * View ID. + * @type { string } + * @memberof ApiViewsUpdateViewApi + */ + viewId: string, + /** + * Data with which to update the inventory view. + * @type { ViewPatch } + * @memberof ApiViewsUpdateViewApi + */ + viewPatch: ViewPatch, + options?: AxiosRequestConfig +} + +export type ApiViewsUpdateViewReturnType = ViewOut; + +const isApiViewsUpdateViewObjectParams = (params: [ApiViewsUpdateViewParams] | unknown[]): params is [ApiViewsUpdateViewParams] => { + const l = params.length === 1 + if(l && typeof params[0] === 'object' && !Array.isArray(params[0])) { + return true && Object.prototype.hasOwnProperty.call(params[0], 'viewId') && Object.prototype.hasOwnProperty.call(params[0], 'viewPatch') + } + return false +} +/** +* Updates an existing inventory view\'s name, description, configuration, or sharing settings. Only the view creator can update a view. System views cannot be updated.

Required permissions: inventory:views:write

NOTE: This endpoint is not yet implemented and will return HTTP 501. +* @summary Update an inventory view +* @param {ApiViewsUpdateViewParams} config with all available params. +* @param {*} [options] Override http request option. +* @throws {RequiredError} +*/ +export const apiViewsUpdateViewParamCreator = async (sendRequest: BaseAPI["sendRequest"], ...config: ([ApiViewsUpdateViewParams] | [string, ViewPatch, AxiosRequestConfig])) => { + const params = isApiViewsUpdateViewObjectParams(config) ? config[0] : ['viewId', 'viewPatch', 'options'].reduce((acc, curr, index) => ({ ...acc, [curr]: config[index] }), {}) as ApiViewsUpdateViewParams; + const { viewId, viewPatch, options = {} } = params; + const localVarPath = `/beta/views/{view_id}` + .replace(`{${"view_id"}}`, encodeURIComponent(String(viewId))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + const localVarRequestOptions = { method: 'PUT' as Method, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + localVarRequestOptions.headers = {...localVarHeaderParameter, ...options.headers}; + + const args = { + urlObj: localVarUrlObj, + options: localVarRequestOptions, + serializeData: viewPatch, + auth:[ + { + // authentication ApiKeyAuth required + // in header with key required + authType: AuthTypeEnum.InHeader, + authKey: "x-rh-identity" + } + ] + }; + + return sendRequest(Promise.resolve(args)); +} + +export default apiViewsUpdateViewParamCreator; diff --git a/packages/host-inventory/src/api.ts b/packages/host-inventory/src/api.ts index 992601a5f..ac654b47c 100644 --- a/packages/host-inventory/src/api.ts +++ b/packages/host-inventory/src/api.ts @@ -38,6 +38,12 @@ import { apiSystemProfileGetSapSystem, apiSystemProfileValidateSchema, apiTagGetTags, + apiViewsCloneView, + apiViewsCreateView, + apiViewsDeleteView, + apiViewsGetViewById, + apiViewsGetViewsList, + apiViewsUpdateView, } from './index'; @@ -77,6 +83,12 @@ const endpointList = { apiSystemProfileGetSapSystem, apiSystemProfileValidateSchema, apiTagGetTags, + apiViewsCloneView, + apiViewsCreateView, + apiViewsDeleteView, + apiViewsGetViewById, + apiViewsGetViewsList, + apiViewsUpdateView, }; diff --git a/packages/host-inventory/src/index.ts b/packages/host-inventory/src/index.ts index 3f5cd4cd7..f277d6f2d 100644 --- a/packages/host-inventory/src/index.ts +++ b/packages/host-inventory/src/index.ts @@ -68,5 +68,17 @@ export { default as apiSystemProfileValidateSchema, type ApiSystemProfileValidat export { default as apiTagGetTags, type ApiTagGetTagsReturnType } from './ApiTagGetTags' +export { default as apiViewsCloneView, type ApiViewsCloneViewReturnType } from './ApiViewsCloneView' + +export { default as apiViewsCreateView, type ApiViewsCreateViewReturnType } from './ApiViewsCreateView' + +export { default as apiViewsDeleteView, type ApiViewsDeleteViewReturnType } from './ApiViewsDeleteView' + +export { default as apiViewsGetViewById, type ApiViewsGetViewByIdReturnType } from './ApiViewsGetViewById' + +export { default as apiViewsGetViewsList, type ApiViewsGetViewsListReturnType } from './ApiViewsGetViewsList' + +export { default as apiViewsUpdateView, type ApiViewsUpdateViewReturnType } from './ApiViewsUpdateView' + export * from './types' diff --git a/packages/host-inventory/src/types/index.ts b/packages/host-inventory/src/types/index.ts index 6d7512158..2eda6620f 100644 --- a/packages/host-inventory/src/types/index.ts +++ b/packages/host-inventory/src/types/index.ts @@ -2269,6 +2269,12 @@ export type SystemProfileDnfModuleStatusEnum = typeof SystemProfileDnfModuleStat * @interface SystemProfileImageBuilder */ export interface SystemProfileImageBuilder { + /** + * The blueprint used to build the image deployed on this host + * @type {string} + * @memberof SystemProfileImageBuilder + */ + 'blueprint_id'?: string; /** * The compliance policy that was used and applied during the image build * @type {string} @@ -3080,6 +3086,249 @@ export interface TagsOut { */ 'results'?: { [key: string]: Array; }; } +/** + * Configuration for a single column in a view. + * @export + * @interface ViewColumnConfig + */ +export interface ViewColumnConfig { + /** + * The column key identifier, e.g. \"insights_id\", \"compliance.last_scan\", \"advisor.recommendations\". + * @type {string} + * @memberof ViewColumnConfig + */ + 'key': string; + /** + * Whether the column is visible in the view. + * @type {boolean} + * @memberof ViewColumnConfig + */ + 'visible'?: boolean; +} +/** + * The full visual configuration for an inventory view, including column layout, sort order, and active filters. + * @export + * @interface ViewConfiguration + */ +export interface ViewConfiguration { + /** + * Ordered list of column configurations. + * @type {Array} + * @memberof ViewConfiguration + */ + 'columns': Array; + /** + * + * @type {ViewSortConfig} + * @memberof ViewConfiguration + */ + 'sort'?: ViewSortConfig; + /** + * Active filter criteria. Keys are filter names, values are arrays of selected filter values. + * @type {{ [key: string]: Array; }} + * @memberof ViewConfiguration + */ + 'filters'?: { [key: string]: Array; }; +} +/** + * Data required to create a new inventory view. + * @export + * @interface ViewIn + */ +export interface ViewIn { + /** + * The display name for the view. + * @type {string} + * @memberof ViewIn + */ + 'name': string; + /** + * An optional description of the view. + * @type {string} + * @memberof ViewIn + */ + 'description'?: string | null; + /** + * + * @type {ViewConfiguration} + * @memberof ViewIn + */ + 'configuration': ViewConfiguration; + /** + * If true, the view is visible to all users in the organization. If false, only the creator can see it. + * @type {boolean} + * @memberof ViewIn + */ + 'org_wide'?: boolean; +} +/** + * Full representation of an inventory view returned by the API. + * @export + * @interface ViewOut + */ +export interface ViewOut { + /** + * The unique identifier of the view. + * @type {string} + * @memberof ViewOut + */ + 'id': string; + /** + * The organization ID that owns the view. null for system views. + * @type {string} + * @memberof ViewOut + */ + 'org_id'?: string | null; + /** + * The display name for the view. + * @type {string} + * @memberof ViewOut + */ + 'name': string; + /** + * An optional description of the view. + * @type {string} + * @memberof ViewOut + */ + 'description'?: string | null; + /** + * + * @type {ViewConfiguration} + * @memberof ViewOut + */ + 'configuration': ViewConfiguration; + /** + * Whether the view is visible to the entire organization. + * @type {boolean} + * @memberof ViewOut + */ + 'org_wide': boolean; + /** + * True if this is a read-only system view (Red Hat preset). System views cannot be updated or deleted, but can be cloned. + * @type {boolean} + * @memberof ViewOut + */ + 'is_system_view': boolean; + /** + * True if the requesting user is the creator of this view. Only the owner can update or delete a view. + * @type {boolean} + * @memberof ViewOut + */ + 'is_owner': boolean; + /** + * The username of the view creator. + * @type {string} + * @memberof ViewOut + */ + 'created_by'?: string | null; + /** + * Timestamp when the view was created. + * @type {string} + * @memberof ViewOut + */ + 'created_at': string; + /** + * Timestamp when the view was last updated. + * @type {string} + * @memberof ViewOut + */ + 'updated_at': string; +} +/** + * Data for updating an existing inventory view. All fields are optional. + * @export + * @interface ViewPatch + */ +export interface ViewPatch { + /** + * The display name for the view. + * @type {string} + * @memberof ViewPatch + */ + 'name'?: string; + /** + * An optional description of the view. + * @type {string} + * @memberof ViewPatch + */ + 'description'?: string | null; + /** + * + * @type {ViewConfiguration} + * @memberof ViewPatch + */ + 'configuration'?: ViewConfiguration; + /** + * If true, the view is visible to all users in the organization. If false, only the creator can see it. + * @type {boolean} + * @memberof ViewPatch + */ + 'org_wide'?: boolean; +} +/** + * Sort configuration for a view. + * @export + * @interface ViewSortConfig + */ +export interface ViewSortConfig { + /** + * The column key to sort by. + * @type {string} + * @memberof ViewSortConfig + */ + 'key': string; + /** + * The sort direction. + * @type {string} + * @memberof ViewSortConfig + */ + 'direction'?: ViewSortConfigDirectionEnum; +} + +export const ViewSortConfigDirectionEnum = { + Asc: 'asc', + Desc: 'desc' +} as const; + +export type ViewSortConfigDirectionEnum = typeof ViewSortConfigDirectionEnum[keyof typeof ViewSortConfigDirectionEnum]; + +/** + * A paginated list of inventory views. + * @export + * @interface ViewsListOut + */ +export interface ViewsListOut { + /** + * The number of items on the current page + * @type {number} + * @memberof ViewsListOut + */ + 'count': number; + /** + * The page number + * @type {number} + * @memberof ViewsListOut + */ + 'page': number; + /** + * The number of items to return per page + * @type {number} + * @memberof ViewsListOut + */ + 'per_page': number; + /** + * Total number of items + * @type {number} + * @memberof ViewsListOut + */ + 'total': number; + /** + * List of inventory views. + * @type {Array} + * @memberof ViewsListOut + */ + 'results': Array; +} /** * * @export diff --git a/packages/insights/src/RuleSystemsDetailList/index.ts b/packages/insights/src/RuleSystemsDetailList/index.ts index 99673966d..aa3bb6173 100644 --- a/packages/insights/src/RuleSystemsDetailList/index.ts +++ b/packages/insights/src/RuleSystemsDetailList/index.ts @@ -68,10 +68,10 @@ export type RuleSystemsDetailListParams = { offset?: number, /** * Display only systems with these versions of RHEL - * @type { Array } + * @type { Array } * @memberof RuleSystemsDetailListApi */ - rhelVersion?: Array, + rhelVersion?: Array, /** * Order by this field * @type { RuleSystemsDetailListSortEnum } @@ -92,58 +92,6 @@ export type RuleSystemsDetailListParams = { tags?: Array, options?: AxiosRequestConfig } -/** - * @export - * @enum {string} - */ -export const RuleSystemsDetailListRhelVersionEnum = { - _100: '10.0', - _101: '10.1', - _102: '10.2', - _60: '6.0', - _61: '6.1', - _610: '6.10', - _62: '6.2', - _63: '6.3', - _64: '6.4', - _65: '6.5', - _66: '6.6', - _67: '6.7', - _68: '6.8', - _69: '6.9', - _70: '7.0', - _71: '7.1', - _710: '7.10', - _72: '7.2', - _73: '7.3', - _74: '7.4', - _75: '7.5', - _76: '7.6', - _77: '7.7', - _78: '7.8', - _79: '7.9', - _80: '8.0', - _81: '8.1', - _810: '8.10', - _82: '8.2', - _83: '8.3', - _84: '8.4', - _85: '8.5', - _86: '8.6', - _87: '8.7', - _88: '8.8', - _89: '8.9', - _90: '9.0', - _91: '9.1', - _92: '9.2', - _93: '9.3', - _94: '9.4', - _95: '9.5', - _96: '9.6', - _97: '9.7', - _98: '9.8' -} as const; -export type RuleSystemsDetailListRhelVersionEnum = typeof RuleSystemsDetailListRhelVersionEnum[keyof typeof RuleSystemsDetailListRhelVersionEnum]; /** * @export * @enum {string} @@ -198,7 +146,7 @@ const isRuleSystemsDetailListObjectParams = (params: [RuleSystemsDetailListParam * @param {*} [options] Override http request option. * @throws {RequiredError} */ -export const ruleSystemsDetailListParamCreator = async (sendRequest: BaseAPI["sendRequest"], ...config: ([RuleSystemsDetailListParams] | [string, boolean, boolean, Array, boolean, Array, number, string, number, Array, RuleSystemsDetailListSortEnum, RuleSystemsDetailListSystemTypeEnum, Array, AxiosRequestConfig])) => { +export const ruleSystemsDetailListParamCreator = async (sendRequest: BaseAPI["sendRequest"], ...config: ([RuleSystemsDetailListParams] | [string, boolean, boolean, Array, boolean, Array, number, string, number, Array, RuleSystemsDetailListSortEnum, RuleSystemsDetailListSystemTypeEnum, Array, AxiosRequestConfig])) => { const params = isRuleSystemsDetailListObjectParams(config) ? config[0] : ['ruleId', 'filterSystemProfileAnsible', 'filterSystemProfileMssql', 'filterSystemProfileSapSidsContains', 'filterSystemProfileSapSystem', 'groups', 'limit', 'name', 'offset', 'rhelVersion', 'sort', 'systemType', 'tags', 'options'].reduce((acc, curr, index) => ({ ...acc, [curr]: config[index] }), {}) as RuleSystemsDetailListParams; const { ruleId, filterSystemProfileAnsible, filterSystemProfileMssql, filterSystemProfileSapSidsContains, filterSystemProfileSapSystem, groups, limit, name, offset, rhelVersion, sort, systemType, tags, options = {} } = params; const localVarPath = `/api/insights/v1/rule/{rule_id}/systems_detail/` diff --git a/packages/insights/src/RuleSystemsRetrieve/index.ts b/packages/insights/src/RuleSystemsRetrieve/index.ts index a4108379f..d39cffdcf 100644 --- a/packages/insights/src/RuleSystemsRetrieve/index.ts +++ b/packages/insights/src/RuleSystemsRetrieve/index.ts @@ -62,10 +62,10 @@ export type RuleSystemsRetrieveParams = { name?: string, /** * Display only systems with these versions of RHEL - * @type { Array } + * @type { Array } * @memberof RuleSystemsRetrieveApi */ - rhelVersion?: Array, + rhelVersion?: Array, /** * Order by this field * @type { Array } @@ -101,58 +101,6 @@ export const RuleSystemsRetrieveFormatEnum = { Json: 'json' } as const; export type RuleSystemsRetrieveFormatEnum = typeof RuleSystemsRetrieveFormatEnum[keyof typeof RuleSystemsRetrieveFormatEnum]; -/** - * @export - * @enum {string} - */ -export const RuleSystemsRetrieveRhelVersionEnum = { - _100: '10.0', - _101: '10.1', - _102: '10.2', - _60: '6.0', - _61: '6.1', - _610: '6.10', - _62: '6.2', - _63: '6.3', - _64: '6.4', - _65: '6.5', - _66: '6.6', - _67: '6.7', - _68: '6.8', - _69: '6.9', - _70: '7.0', - _71: '7.1', - _710: '7.10', - _72: '7.2', - _73: '7.3', - _74: '7.4', - _75: '7.5', - _76: '7.6', - _77: '7.7', - _78: '7.8', - _79: '7.9', - _80: '8.0', - _81: '8.1', - _810: '8.10', - _82: '8.2', - _83: '8.3', - _84: '8.4', - _85: '8.5', - _86: '8.6', - _87: '8.7', - _88: '8.8', - _89: '8.9', - _90: '9.0', - _91: '9.1', - _92: '9.2', - _93: '9.3', - _94: '9.4', - _95: '9.5', - _96: '9.6', - _97: '9.7', - _98: '9.8' -} as const; -export type RuleSystemsRetrieveRhelVersionEnum = typeof RuleSystemsRetrieveRhelVersionEnum[keyof typeof RuleSystemsRetrieveRhelVersionEnum]; /** * @export * @enum {string} @@ -206,7 +154,7 @@ const isRuleSystemsRetrieveObjectParams = (params: [RuleSystemsRetrieveParams] | * @param {*} [options] Override http request option. * @throws {RequiredError} */ -export const ruleSystemsRetrieveParamCreator = async (sendRequest: BaseAPI["sendRequest"], ...config: ([RuleSystemsRetrieveParams] | [string, boolean, boolean, Array, boolean, RuleSystemsRetrieveFormatEnum, Array, string, Array, Array, RuleSystemsRetrieveSystemTypeEnum, Array, Array, AxiosRequestConfig])) => { +export const ruleSystemsRetrieveParamCreator = async (sendRequest: BaseAPI["sendRequest"], ...config: ([RuleSystemsRetrieveParams] | [string, boolean, boolean, Array, boolean, RuleSystemsRetrieveFormatEnum, Array, string, Array, Array, RuleSystemsRetrieveSystemTypeEnum, Array, Array, AxiosRequestConfig])) => { const params = isRuleSystemsRetrieveObjectParams(config) ? config[0] : ['ruleId', 'filterSystemProfileAnsible', 'filterSystemProfileMssql', 'filterSystemProfileSapSidsContains', 'filterSystemProfileSapSystem', 'format', 'groups', 'name', 'rhelVersion', 'sort', 'systemType', 'tags', 'updateMethod', 'options'].reduce((acc, curr, index) => ({ ...acc, [curr]: config[index] }), {}) as RuleSystemsRetrieveParams; const { ruleId, filterSystemProfileAnsible, filterSystemProfileMssql, filterSystemProfileSapSidsContains, filterSystemProfileSapSystem, format, groups, name, rhelVersion, sort, systemType, tags, updateMethod, options = {} } = params; const localVarPath = `/api/insights/v1/rule/{rule_id}/systems/` diff --git a/packages/insights/src/SystemList/index.ts b/packages/insights/src/SystemList/index.ts index aa97e815e..ea48f1f03 100644 --- a/packages/insights/src/SystemList/index.ts +++ b/packages/insights/src/SystemList/index.ts @@ -86,10 +86,10 @@ export type SystemListParams = { pathway?: string, /** * Display only systems with these versions of RHEL - * @type { Array } + * @type { Array } * @memberof SystemListApi */ - rhelVersion?: Array, + rhelVersion?: Array, /** * Order by this field * @type { SystemListSortEnum } @@ -130,58 +130,6 @@ export const SystemListHitsEnum = { Yes: 'yes' } as const; export type SystemListHitsEnum = typeof SystemListHitsEnum[keyof typeof SystemListHitsEnum]; -/** - * @export - * @enum {string} - */ -export const SystemListRhelVersionEnum = { - _100: '10.0', - _101: '10.1', - _102: '10.2', - _60: '6.0', - _61: '6.1', - _610: '6.10', - _62: '6.2', - _63: '6.3', - _64: '6.4', - _65: '6.5', - _66: '6.6', - _67: '6.7', - _68: '6.8', - _69: '6.9', - _70: '7.0', - _71: '7.1', - _710: '7.10', - _72: '7.2', - _73: '7.3', - _74: '7.4', - _75: '7.5', - _76: '7.6', - _77: '7.7', - _78: '7.8', - _79: '7.9', - _80: '8.0', - _81: '8.1', - _810: '8.10', - _82: '8.2', - _83: '8.3', - _84: '8.4', - _85: '8.5', - _86: '8.6', - _87: '8.7', - _88: '8.8', - _89: '8.9', - _90: '9.0', - _91: '9.1', - _92: '9.2', - _93: '9.3', - _94: '9.4', - _95: '9.5', - _96: '9.6', - _97: '9.7', - _98: '9.8' -} as const; -export type SystemListRhelVersionEnum = typeof SystemListRhelVersionEnum[keyof typeof SystemListRhelVersionEnum]; /** * @export * @enum {string} @@ -243,7 +191,7 @@ const isSystemListObjectParams = (params: [SystemListParams] | unknown[]): param * @param {*} [options] Override http request option. * @throws {RequiredError} */ -export const systemListParamCreator = async (sendRequest: BaseAPI["sendRequest"], ...config: ([SystemListParams] | [string, boolean, boolean, Array, boolean, Array, boolean, Array, boolean, number, number, string, Array, SystemListSortEnum, SystemListSystemTypeEnum, Array, Array, AxiosRequestConfig])) => { +export const systemListParamCreator = async (sendRequest: BaseAPI["sendRequest"], ...config: ([SystemListParams] | [string, boolean, boolean, Array, boolean, Array, boolean, Array, boolean, number, number, string, Array, SystemListSortEnum, SystemListSystemTypeEnum, Array, Array, AxiosRequestConfig])) => { const params = isSystemListObjectParams(config) ? config[0] : ['displayName', 'filterSystemProfileAnsible', 'filterSystemProfileMssql', 'filterSystemProfileSapSidsContains', 'filterSystemProfileSapSystem', 'groups', 'hasDisabledRecommendation', 'hits', 'incident', 'limit', 'offset', 'pathway', 'rhelVersion', 'sort', 'systemType', 'tags', 'updateMethod', 'options'].reduce((acc, curr, index) => ({ ...acc, [curr]: config[index] }), {}) as SystemListParams; const { displayName, filterSystemProfileAnsible, filterSystemProfileMssql, filterSystemProfileSapSidsContains, filterSystemProfileSapSystem, groups, hasDisabledRecommendation, hits, incident, limit, offset, pathway, rhelVersion, sort, systemType, tags, updateMethod, options = {} } = params; const localVarPath = `/api/insights/v1/system/`; diff --git a/packages/notifications/src/DrawerResourceV1GetDrawerEntries/index.ts b/packages/notifications/src/DrawerResourceV1GetDrawerEntries/index.ts index fe28067fd..3a88d8c3d 100644 --- a/packages/notifications/src/DrawerResourceV1GetDrawerEntries/index.ts +++ b/packages/notifications/src/DrawerResourceV1GetDrawerEntries/index.ts @@ -91,7 +91,7 @@ const isDrawerResourceV1GetDrawerEntriesObjectParams = (params: [DrawerResourceV return false } /** -* Allowed `sort_by` fields are `bundleIds`, `applicationIds`, `eventTypeIds`, `startTime`, `endTime` and `read`. The ordering can be optionally specified by appending `:asc` or `:desc` to the field, e.g. `bundle:desc`. Defaults to `desc` for the `created` field and to `asc` for all other fields. +* Retrieve paginated drawer notifications with optional filtering and sorting. Available filters: `bundleIds`, `appIds`, `eventTypeIds`, `startDate`, `endDate`, `readStatus`. Allowed `sort_by` fields: `bundle`, `application`, `event`, `created`. Sorting can be specified by appending `:asc` or `:desc` to the field, e.g. `bundle:desc`. Defaults to `created:desc`. * @summary Retrieve drawer notifications entries. * @param {DrawerResourceV1GetDrawerEntriesParams} config with all available params. * @param {*} [options] Override http request option. diff --git a/packages/notifications/src/types/index.ts b/packages/notifications/src/types/index.ts index f7ed713ec..8d5c9519a 100644 --- a/packages/notifications/src/types/index.ts +++ b/packages/notifications/src/types/index.ts @@ -625,6 +625,12 @@ export interface EventType { * @memberof EventType */ 'restrict_to_recipients_integrations'?: any; + /** + * + * @type {any} + * @memberof EventType + */ + 'included_in_drawer'?: any; /** * * @type {any} diff --git a/packages/notifications/src/v2/types/index.ts b/packages/notifications/src/v2/types/index.ts index 586b969a2..8ea1b9bb4 100644 --- a/packages/notifications/src/v2/types/index.ts +++ b/packages/notifications/src/v2/types/index.ts @@ -356,6 +356,12 @@ export interface EventType { * @memberof EventType */ 'restrict_to_recipients_integrations'?: any; + /** + * + * @type {any} + * @memberof EventType + */ + 'included_in_drawer'?: any; /** * * @type {any} diff --git a/packages/patch/src/ExportAdvisories/index.ts b/packages/patch/src/ExportAdvisories/index.ts index 2720d6ec2..6da6b647c 100644 --- a/packages/patch/src/ExportAdvisories/index.ts +++ b/packages/patch/src/ExportAdvisories/index.ts @@ -56,6 +56,12 @@ export type ExportAdvisoriesParams = { filterSeverity?: number, /** * Filter + * @type { ExportAdvisoriesFilterSeverityNameEnum } + * @memberof ExportAdvisoriesApi + */ + filterSeverityName?: ExportAdvisoriesFilterSeverityNameEnum, + /** + * Filter * @type { number } * @memberof ExportAdvisoriesApi */ @@ -75,6 +81,17 @@ export const ExportAdvisoriesFilterAdvisoryTypeNameEnum = { Security: 'security' } as const; export type ExportAdvisoriesFilterAdvisoryTypeNameEnum = typeof ExportAdvisoriesFilterAdvisoryTypeNameEnum[keyof typeof ExportAdvisoriesFilterAdvisoryTypeNameEnum]; +/** + * @export + * @enum {string} + */ +export const ExportAdvisoriesFilterSeverityNameEnum = { + Low: 'Low', + Medium: 'Medium', + High: 'High', + Critical: 'Critical' +} as const; +export type ExportAdvisoriesFilterSeverityNameEnum = typeof ExportAdvisoriesFilterSeverityNameEnum[keyof typeof ExportAdvisoriesFilterSeverityNameEnum]; export type ExportAdvisoriesReturnType = Array; @@ -92,9 +109,9 @@ const isExportAdvisoriesObjectParams = (params: [ExportAdvisoriesParams] | unkno * @param {*} [options] Override http request option. * @throws {RequiredError} */ -export const exportAdvisoriesParamCreator = async (sendRequest: BaseAPI["sendRequest"], ...config: ([ExportAdvisoriesParams] | [string, string, string, string, string, ExportAdvisoriesFilterAdvisoryTypeNameEnum, number, number, AxiosRequestConfig])) => { - const params = isExportAdvisoriesObjectParams(config) ? config[0] : ['search', 'filterId', 'filterDescription', 'filterPublicDate', 'filterSynopsis', 'filterAdvisoryTypeName', 'filterSeverity', 'filterApplicableSystems', 'options'].reduce((acc, curr, index) => ({ ...acc, [curr]: config[index] }), {}) as ExportAdvisoriesParams; - const { search, filterId, filterDescription, filterPublicDate, filterSynopsis, filterAdvisoryTypeName, filterSeverity, filterApplicableSystems, options = {} } = params; +export const exportAdvisoriesParamCreator = async (sendRequest: BaseAPI["sendRequest"], ...config: ([ExportAdvisoriesParams] | [string, string, string, string, string, ExportAdvisoriesFilterAdvisoryTypeNameEnum, number, ExportAdvisoriesFilterSeverityNameEnum, number, AxiosRequestConfig])) => { + const params = isExportAdvisoriesObjectParams(config) ? config[0] : ['search', 'filterId', 'filterDescription', 'filterPublicDate', 'filterSynopsis', 'filterAdvisoryTypeName', 'filterSeverity', 'filterSeverityName', 'filterApplicableSystems', 'options'].reduce((acc, curr, index) => ({ ...acc, [curr]: config[index] }), {}) as ExportAdvisoriesParams; + const { search, filterId, filterDescription, filterPublicDate, filterSynopsis, filterAdvisoryTypeName, filterSeverity, filterSeverityName, filterApplicableSystems, options = {} } = params; const localVarPath = `/export/advisories`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); @@ -130,6 +147,10 @@ export const exportAdvisoriesParamCreator = async (sendRequest: BaseAPI["sendReq localVarQueryParameter['filter[severity]'] = filterSeverity; } + if (filterSeverityName !== undefined) { + localVarQueryParameter['filter[severity_name]'] = filterSeverityName; + } + if (filterApplicableSystems !== undefined) { localVarQueryParameter['filter[applicable_systems]'] = filterApplicableSystems; } diff --git a/packages/patch/src/ExportSystemAdvisories/index.ts b/packages/patch/src/ExportSystemAdvisories/index.ts index c51222779..03dc32317 100644 --- a/packages/patch/src/ExportSystemAdvisories/index.ts +++ b/packages/patch/src/ExportSystemAdvisories/index.ts @@ -60,6 +60,12 @@ export type ExportSystemAdvisoriesParams = { * @memberof ExportSystemAdvisoriesApi */ filterSeverity?: number, + /** + * Filter + * @type { ExportSystemAdvisoriesFilterSeverityNameEnum } + * @memberof ExportSystemAdvisoriesApi + */ + filterSeverityName?: ExportSystemAdvisoriesFilterSeverityNameEnum, options?: AxiosRequestConfig } /** @@ -75,6 +81,17 @@ export const ExportSystemAdvisoriesFilterAdvisoryTypeNameEnum = { Security: 'security' } as const; export type ExportSystemAdvisoriesFilterAdvisoryTypeNameEnum = typeof ExportSystemAdvisoriesFilterAdvisoryTypeNameEnum[keyof typeof ExportSystemAdvisoriesFilterAdvisoryTypeNameEnum]; +/** + * @export + * @enum {string} + */ +export const ExportSystemAdvisoriesFilterSeverityNameEnum = { + Low: 'Low', + Medium: 'Medium', + High: 'High', + Critical: 'Critical' +} as const; +export type ExportSystemAdvisoriesFilterSeverityNameEnum = typeof ExportSystemAdvisoriesFilterSeverityNameEnum[keyof typeof ExportSystemAdvisoriesFilterSeverityNameEnum]; export type ExportSystemAdvisoriesReturnType = Array; @@ -92,9 +109,9 @@ const isExportSystemAdvisoriesObjectParams = (params: [ExportSystemAdvisoriesPar * @param {*} [options] Override http request option. * @throws {RequiredError} */ -export const exportSystemAdvisoriesParamCreator = async (sendRequest: BaseAPI["sendRequest"], ...config: ([ExportSystemAdvisoriesParams] | [string, string, string, string, string, string, ExportSystemAdvisoriesFilterAdvisoryTypeNameEnum, number, AxiosRequestConfig])) => { - const params = isExportSystemAdvisoriesObjectParams(config) ? config[0] : ['inventoryId', 'search', 'filterId', 'filterDescription', 'filterPublicDate', 'filterSynopsis', 'filterAdvisoryTypeName', 'filterSeverity', 'options'].reduce((acc, curr, index) => ({ ...acc, [curr]: config[index] }), {}) as ExportSystemAdvisoriesParams; - const { inventoryId, search, filterId, filterDescription, filterPublicDate, filterSynopsis, filterAdvisoryTypeName, filterSeverity, options = {} } = params; +export const exportSystemAdvisoriesParamCreator = async (sendRequest: BaseAPI["sendRequest"], ...config: ([ExportSystemAdvisoriesParams] | [string, string, string, string, string, string, ExportSystemAdvisoriesFilterAdvisoryTypeNameEnum, number, ExportSystemAdvisoriesFilterSeverityNameEnum, AxiosRequestConfig])) => { + const params = isExportSystemAdvisoriesObjectParams(config) ? config[0] : ['inventoryId', 'search', 'filterId', 'filterDescription', 'filterPublicDate', 'filterSynopsis', 'filterAdvisoryTypeName', 'filterSeverity', 'filterSeverityName', 'options'].reduce((acc, curr, index) => ({ ...acc, [curr]: config[index] }), {}) as ExportSystemAdvisoriesParams; + const { inventoryId, search, filterId, filterDescription, filterPublicDate, filterSynopsis, filterAdvisoryTypeName, filterSeverity, filterSeverityName, options = {} } = params; const localVarPath = `/export/systems/{inventory_id}/advisories` .replace(`{${"inventory_id"}}`, encodeURIComponent(String(inventoryId))); // use dummy base URL string because the URL constructor only accepts absolute URLs. @@ -131,6 +148,10 @@ export const exportSystemAdvisoriesParamCreator = async (sendRequest: BaseAPI["s localVarQueryParameter['filter[severity]'] = filterSeverity; } + if (filterSeverityName !== undefined) { + localVarQueryParameter['filter[severity_name]'] = filterSeverityName; + } + setSearchParams(localVarUrlObj, localVarQueryParameter); diff --git a/packages/patch/src/ListAdvisories/index.ts b/packages/patch/src/ListAdvisories/index.ts index bb73b11d9..7ed2eeb9b 100644 --- a/packages/patch/src/ListAdvisories/index.ts +++ b/packages/patch/src/ListAdvisories/index.ts @@ -74,6 +74,12 @@ export type ListAdvisoriesParams = { filterSeverity?: number, /** * Filter + * @type { ListAdvisoriesFilterSeverityNameEnum } + * @memberof ListAdvisoriesApi + */ + filterSeverityName?: ListAdvisoriesFilterSeverityNameEnum, + /** + * Filter * @type { number } * @memberof ListAdvisoriesApi */ @@ -161,6 +167,17 @@ export const ListAdvisoriesFilterAdvisoryTypeNameEnum = { Security: 'security' } as const; export type ListAdvisoriesFilterAdvisoryTypeNameEnum = typeof ListAdvisoriesFilterAdvisoryTypeNameEnum[keyof typeof ListAdvisoriesFilterAdvisoryTypeNameEnum]; +/** + * @export + * @enum {string} + */ +export const ListAdvisoriesFilterSeverityNameEnum = { + Low: 'Low', + Medium: 'Medium', + High: 'High', + Critical: 'Critical' +} as const; +export type ListAdvisoriesFilterSeverityNameEnum = typeof ListAdvisoriesFilterSeverityNameEnum[keyof typeof ListAdvisoriesFilterSeverityNameEnum]; export type ListAdvisoriesReturnType = ControllersAdvisoriesResponse; @@ -178,9 +195,9 @@ const isListAdvisoriesObjectParams = (params: [ListAdvisoriesParams] | unknown[] * @param {*} [options] Override http request option. * @throws {RequiredError} */ -export const listAdvisoriesParamCreator = async (sendRequest: BaseAPI["sendRequest"], ...config: ([ListAdvisoriesParams] | [number, number, ListAdvisoriesSortEnum, string, string, string, string, string, ListAdvisoriesFilterAdvisoryTypeNameEnum, number, number, number, Array, Array, boolean, Array, string, string, string, string, AxiosRequestConfig])) => { - const params = isListAdvisoriesObjectParams(config) ? config[0] : ['limit', 'offset', 'sort', 'search', 'filterId', 'filterDescription', 'filterPublicDate', 'filterSynopsis', 'filterAdvisoryTypeName', 'filterSeverity', 'filterInstallableSystems', 'filterApplicableSystems', 'tags', 'filterGroupName', 'filterSystemProfileSapSystem', 'filterSystemProfileSapSids', 'filterSystemProfileAnsible', 'filterSystemProfileAnsibleControllerVersion', 'filterSystemProfileMssql', 'filterSystemProfileMssqlVersion', 'options'].reduce((acc, curr, index) => ({ ...acc, [curr]: config[index] }), {}) as ListAdvisoriesParams; - const { limit, offset, sort, search, filterId, filterDescription, filterPublicDate, filterSynopsis, filterAdvisoryTypeName, filterSeverity, filterInstallableSystems, filterApplicableSystems, tags, filterGroupName, filterSystemProfileSapSystem, filterSystemProfileSapSids, filterSystemProfileAnsible, filterSystemProfileAnsibleControllerVersion, filterSystemProfileMssql, filterSystemProfileMssqlVersion, options = {} } = params; +export const listAdvisoriesParamCreator = async (sendRequest: BaseAPI["sendRequest"], ...config: ([ListAdvisoriesParams] | [number, number, ListAdvisoriesSortEnum, string, string, string, string, string, ListAdvisoriesFilterAdvisoryTypeNameEnum, number, ListAdvisoriesFilterSeverityNameEnum, number, number, Array, Array, boolean, Array, string, string, string, string, AxiosRequestConfig])) => { + const params = isListAdvisoriesObjectParams(config) ? config[0] : ['limit', 'offset', 'sort', 'search', 'filterId', 'filterDescription', 'filterPublicDate', 'filterSynopsis', 'filterAdvisoryTypeName', 'filterSeverity', 'filterSeverityName', 'filterInstallableSystems', 'filterApplicableSystems', 'tags', 'filterGroupName', 'filterSystemProfileSapSystem', 'filterSystemProfileSapSids', 'filterSystemProfileAnsible', 'filterSystemProfileAnsibleControllerVersion', 'filterSystemProfileMssql', 'filterSystemProfileMssqlVersion', 'options'].reduce((acc, curr, index) => ({ ...acc, [curr]: config[index] }), {}) as ListAdvisoriesParams; + const { limit, offset, sort, search, filterId, filterDescription, filterPublicDate, filterSynopsis, filterAdvisoryTypeName, filterSeverity, filterSeverityName, filterInstallableSystems, filterApplicableSystems, tags, filterGroupName, filterSystemProfileSapSystem, filterSystemProfileSapSids, filterSystemProfileAnsible, filterSystemProfileAnsibleControllerVersion, filterSystemProfileMssql, filterSystemProfileMssqlVersion, options = {} } = params; const localVarPath = `/advisories`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); @@ -228,6 +245,10 @@ export const listAdvisoriesParamCreator = async (sendRequest: BaseAPI["sendReque localVarQueryParameter['filter[severity]'] = filterSeverity; } + if (filterSeverityName !== undefined) { + localVarQueryParameter['filter[severity_name]'] = filterSeverityName; + } + if (filterInstallableSystems !== undefined) { localVarQueryParameter['filter[installable_systems]'] = filterInstallableSystems; } diff --git a/packages/patch/src/ListAdvisorySystemsIds/index.ts b/packages/patch/src/ListAdvisorySystemsIds/index.ts index 8abf7e6dc..586c6aa22 100644 --- a/packages/patch/src/ListAdvisorySystemsIds/index.ts +++ b/packages/patch/src/ListAdvisorySystemsIds/index.ts @@ -53,12 +53,6 @@ export type ListAdvisorySystemsIdsParams = { * @type { string } * @memberof ListAdvisorySystemsIdsApi */ - filterInsightsId?: string, - /** - * Filter - * @type { string } - * @memberof ListAdvisorySystemsIdsApi - */ filterDisplayName?: string, /** * Filter @@ -247,9 +241,9 @@ const isListAdvisorySystemsIdsObjectParams = (params: [ListAdvisorySystemsIdsPar * @param {*} [options] Override http request option. * @throws {RequiredError} */ -export const listAdvisorySystemsIdsParamCreator = async (sendRequest: BaseAPI["sendRequest"], ...config: ([ListAdvisorySystemsIdsParams] | [string, number, number, ListAdvisorySystemsIdsSortEnum, string, string, string, string, string, string, number, number, number, number, boolean, boolean, string, string, string, string, string, string, string, string, boolean, Array, Array, boolean, Array, string, string, string, string, AxiosRequestConfig])) => { - const params = isListAdvisorySystemsIdsObjectParams(config) ? config[0] : ['advisoryId', 'limit', 'offset', 'sort', 'search', 'filterId', 'filterInsightsId', 'filterDisplayName', 'filterLastEvaluation', 'filterLastUpload', 'filterRhsaCount', 'filterRhbaCount', 'filterRheaCount', 'filterOtherCount', 'filterSatelliteManaged', 'filterStale', 'filterStaleTimestamp', 'filterStaleWarningTimestamp', 'filterCulledTimestamp', 'filterCreated', 'filterOsname', 'filterOsminor', 'filterOsmajor', 'filterOs', 'filterBuiltPkgcache', 'tags', 'filterGroupName', 'filterSystemProfileSapSystem', 'filterSystemProfileSapSids', 'filterSystemProfileAnsible', 'filterSystemProfileAnsibleControllerVersion', 'filterSystemProfileMssql', 'filterSystemProfileMssqlVersion', 'options'].reduce((acc, curr, index) => ({ ...acc, [curr]: config[index] }), {}) as ListAdvisorySystemsIdsParams; - const { advisoryId, limit, offset, sort, search, filterId, filterInsightsId, filterDisplayName, filterLastEvaluation, filterLastUpload, filterRhsaCount, filterRhbaCount, filterRheaCount, filterOtherCount, filterSatelliteManaged, filterStale, filterStaleTimestamp, filterStaleWarningTimestamp, filterCulledTimestamp, filterCreated, filterOsname, filterOsminor, filterOsmajor, filterOs, filterBuiltPkgcache, tags, filterGroupName, filterSystemProfileSapSystem, filterSystemProfileSapSids, filterSystemProfileAnsible, filterSystemProfileAnsibleControllerVersion, filterSystemProfileMssql, filterSystemProfileMssqlVersion, options = {} } = params; +export const listAdvisorySystemsIdsParamCreator = async (sendRequest: BaseAPI["sendRequest"], ...config: ([ListAdvisorySystemsIdsParams] | [string, number, number, ListAdvisorySystemsIdsSortEnum, string, string, string, string, string, number, number, number, number, boolean, boolean, string, string, string, string, string, string, string, string, boolean, Array, Array, boolean, Array, string, string, string, string, AxiosRequestConfig])) => { + const params = isListAdvisorySystemsIdsObjectParams(config) ? config[0] : ['advisoryId', 'limit', 'offset', 'sort', 'search', 'filterId', 'filterDisplayName', 'filterLastEvaluation', 'filterLastUpload', 'filterRhsaCount', 'filterRhbaCount', 'filterRheaCount', 'filterOtherCount', 'filterSatelliteManaged', 'filterStale', 'filterStaleTimestamp', 'filterStaleWarningTimestamp', 'filterCulledTimestamp', 'filterCreated', 'filterOsname', 'filterOsminor', 'filterOsmajor', 'filterOs', 'filterBuiltPkgcache', 'tags', 'filterGroupName', 'filterSystemProfileSapSystem', 'filterSystemProfileSapSids', 'filterSystemProfileAnsible', 'filterSystemProfileAnsibleControllerVersion', 'filterSystemProfileMssql', 'filterSystemProfileMssqlVersion', 'options'].reduce((acc, curr, index) => ({ ...acc, [curr]: config[index] }), {}) as ListAdvisorySystemsIdsParams; + const { advisoryId, limit, offset, sort, search, filterId, filterDisplayName, filterLastEvaluation, filterLastUpload, filterRhsaCount, filterRhbaCount, filterRheaCount, filterOtherCount, filterSatelliteManaged, filterStale, filterStaleTimestamp, filterStaleWarningTimestamp, filterCulledTimestamp, filterCreated, filterOsname, filterOsminor, filterOsmajor, filterOs, filterBuiltPkgcache, tags, filterGroupName, filterSystemProfileSapSystem, filterSystemProfileSapSids, filterSystemProfileAnsible, filterSystemProfileAnsibleControllerVersion, filterSystemProfileMssql, filterSystemProfileMssqlVersion, options = {} } = params; const localVarPath = `/ids/advisories/{advisory_id}/systems` .replace(`{${"advisory_id"}}`, encodeURIComponent(String(advisoryId))); // use dummy base URL string because the URL constructor only accepts absolute URLs. @@ -278,10 +272,6 @@ export const listAdvisorySystemsIdsParamCreator = async (sendRequest: BaseAPI["s localVarQueryParameter['filter[id]'] = filterId; } - if (filterInsightsId !== undefined) { - localVarQueryParameter['filter[insights_id]'] = filterInsightsId; - } - if (filterDisplayName !== undefined) { localVarQueryParameter['filter[display_name]'] = filterDisplayName; } diff --git a/packages/patch/src/ListSystemAdvisories/index.ts b/packages/patch/src/ListSystemAdvisories/index.ts index b426e9117..f26df0ce4 100644 --- a/packages/patch/src/ListSystemAdvisories/index.ts +++ b/packages/patch/src/ListSystemAdvisories/index.ts @@ -78,6 +78,12 @@ export type ListSystemAdvisoriesParams = { * @memberof ListSystemAdvisoriesApi */ filterSeverity?: number, + /** + * Filter + * @type { ListSystemAdvisoriesFilterSeverityNameEnum } + * @memberof ListSystemAdvisoriesApi + */ + filterSeverityName?: ListSystemAdvisoriesFilterSeverityNameEnum, options?: AxiosRequestConfig } /** @@ -105,6 +111,17 @@ export const ListSystemAdvisoriesFilterAdvisoryTypeNameEnum = { Security: 'security' } as const; export type ListSystemAdvisoriesFilterAdvisoryTypeNameEnum = typeof ListSystemAdvisoriesFilterAdvisoryTypeNameEnum[keyof typeof ListSystemAdvisoriesFilterAdvisoryTypeNameEnum]; +/** + * @export + * @enum {string} + */ +export const ListSystemAdvisoriesFilterSeverityNameEnum = { + Low: 'Low', + Medium: 'Medium', + High: 'High', + Critical: 'Critical' +} as const; +export type ListSystemAdvisoriesFilterSeverityNameEnum = typeof ListSystemAdvisoriesFilterSeverityNameEnum[keyof typeof ListSystemAdvisoriesFilterSeverityNameEnum]; export type ListSystemAdvisoriesReturnType = ControllersSystemAdvisoriesResponse; @@ -122,9 +139,9 @@ const isListSystemAdvisoriesObjectParams = (params: [ListSystemAdvisoriesParams] * @param {*} [options] Override http request option. * @throws {RequiredError} */ -export const listSystemAdvisoriesParamCreator = async (sendRequest: BaseAPI["sendRequest"], ...config: ([ListSystemAdvisoriesParams] | [string, number, number, ListSystemAdvisoriesSortEnum, string, string, string, string, string, ListSystemAdvisoriesFilterAdvisoryTypeNameEnum, number, AxiosRequestConfig])) => { - const params = isListSystemAdvisoriesObjectParams(config) ? config[0] : ['inventoryId', 'limit', 'offset', 'sort', 'search', 'filterId', 'filterDescription', 'filterPublicDate', 'filterSynopsis', 'filterAdvisoryTypeName', 'filterSeverity', 'options'].reduce((acc, curr, index) => ({ ...acc, [curr]: config[index] }), {}) as ListSystemAdvisoriesParams; - const { inventoryId, limit, offset, sort, search, filterId, filterDescription, filterPublicDate, filterSynopsis, filterAdvisoryTypeName, filterSeverity, options = {} } = params; +export const listSystemAdvisoriesParamCreator = async (sendRequest: BaseAPI["sendRequest"], ...config: ([ListSystemAdvisoriesParams] | [string, number, number, ListSystemAdvisoriesSortEnum, string, string, string, string, string, ListSystemAdvisoriesFilterAdvisoryTypeNameEnum, number, ListSystemAdvisoriesFilterSeverityNameEnum, AxiosRequestConfig])) => { + const params = isListSystemAdvisoriesObjectParams(config) ? config[0] : ['inventoryId', 'limit', 'offset', 'sort', 'search', 'filterId', 'filterDescription', 'filterPublicDate', 'filterSynopsis', 'filterAdvisoryTypeName', 'filterSeverity', 'filterSeverityName', 'options'].reduce((acc, curr, index) => ({ ...acc, [curr]: config[index] }), {}) as ListSystemAdvisoriesParams; + const { inventoryId, limit, offset, sort, search, filterId, filterDescription, filterPublicDate, filterSynopsis, filterAdvisoryTypeName, filterSeverity, filterSeverityName, options = {} } = params; const localVarPath = `/systems/{inventory_id}/advisories` .replace(`{${"inventory_id"}}`, encodeURIComponent(String(inventoryId))); // use dummy base URL string because the URL constructor only accepts absolute URLs. @@ -173,6 +190,10 @@ export const listSystemAdvisoriesParamCreator = async (sendRequest: BaseAPI["sen localVarQueryParameter['filter[severity]'] = filterSeverity; } + if (filterSeverityName !== undefined) { + localVarQueryParameter['filter[severity_name]'] = filterSeverityName; + } + setSearchParams(localVarUrlObj, localVarQueryParameter); diff --git a/packages/patch/src/types/index.ts b/packages/patch/src/types/index.ts index 733b359a1..861597a5e 100644 --- a/packages/patch/src/types/index.ts +++ b/packages/patch/src/types/index.ts @@ -64,6 +64,12 @@ export interface ControllersAdvisoriesDBLookup { * @memberof ControllersAdvisoriesDBLookup */ 'severity'?: number; + /** + * + * @type {string} + * @memberof ControllersAdvisoriesDBLookup + */ + 'severity_name'?: string; /** * * @type {string} @@ -193,6 +199,12 @@ export interface ControllersAdvisoryDetailAttributes { * @memberof ControllersAdvisoryDetailAttributes */ 'severity'?: number; + /** + * + * @type {string} + * @memberof ControllersAdvisoryDetailAttributes + */ + 'severity_name'?: string; /** * * @type {string} @@ -335,6 +347,12 @@ export interface ControllersAdvisoryItemAttributes { * @memberof ControllersAdvisoryItemAttributes */ 'severity'?: number; + /** + * + * @type {string} + * @memberof ControllersAdvisoryItemAttributes + */ + 'severity_name'?: string; /** * * @type {string} @@ -1198,6 +1216,12 @@ export interface ControllersSystemAdvisoriesDBLookup { * @memberof ControllersSystemAdvisoriesDBLookup */ 'severity'?: number; + /** + * + * @type {string} + * @memberof ControllersSystemAdvisoriesDBLookup + */ + 'severity_name'?: string; /** * * @type {string} @@ -1309,6 +1333,12 @@ export interface ControllersSystemAdvisoryItemAttributes { * @memberof ControllersSystemAdvisoryItemAttributes */ 'severity'?: number; + /** + * + * @type {string} + * @memberof ControllersSystemAdvisoryItemAttributes + */ + 'severity_name'?: string; /** * * @type {string} @@ -1891,12 +1921,6 @@ export interface ControllersSystemItemAttributesExtended { * @memberof ControllersSystemItemAttributesExtended */ 'groups'?: Array; - /** - * - * @type {string} - * @memberof ControllersSystemItemAttributesExtended - */ - 'insights_id'?: string; /** * * @type {number} diff --git a/packages/quickstarts/src/QuickstartsGet/index.ts b/packages/quickstarts/src/QuickstartsGet/index.ts index 8e0d4d3b9..fd85beeb6 100644 --- a/packages/quickstarts/src/QuickstartsGet/index.ts +++ b/packages/quickstarts/src/QuickstartsGet/index.ts @@ -67,6 +67,12 @@ export type QuickstartsGetParams = { */ displayName?: string, /** + * Enable fuzzy search using Levenshtein distance for typo tolerance (searches spec.displayName) + * @type { boolean } + * @memberof QuickstartsGetApi + */ + fuzzy?: boolean, + /** * Pagination limit * @type { number } * @memberof QuickstartsGetApi @@ -97,9 +103,9 @@ const isQuickstartsGetObjectParams = (params: [QuickstartsGetParams] | unknown[] * @param {*} [options] Override http request option. * @throws {RequiredError} */ -export const quickstartsGetParamCreator = async (sendRequest: BaseAPI["sendRequest"], ...config: ([QuickstartsGetParams] | [Array, Array, Array, Array, Array, Array, Array, string, string, number, number, AxiosRequestConfig])) => { - const params = isQuickstartsGetObjectParams(config) ? config[0] : ['productFamilies', 'content', 'useCase', 'bundle', 'application', 'kind', 'topic', 'name', 'displayName', 'limit', 'offset', 'options'].reduce((acc, curr, index) => ({ ...acc, [curr]: config[index] }), {}) as QuickstartsGetParams; - const { productFamilies, content, useCase, bundle, application, kind, topic, name, displayName, limit, offset, options = {} } = params; +export const quickstartsGetParamCreator = async (sendRequest: BaseAPI["sendRequest"], ...config: ([QuickstartsGetParams] | [Array, Array, Array, Array, Array, Array, Array, string, string, boolean, number, number, AxiosRequestConfig])) => { + const params = isQuickstartsGetObjectParams(config) ? config[0] : ['productFamilies', 'content', 'useCase', 'bundle', 'application', 'kind', 'topic', 'name', 'displayName', 'fuzzy', 'limit', 'offset', 'options'].reduce((acc, curr, index) => ({ ...acc, [curr]: config[index] }), {}) as QuickstartsGetParams; + const { productFamilies, content, useCase, bundle, application, kind, topic, name, displayName, fuzzy, limit, offset, options = {} } = params; const localVarPath = `/quickstarts`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); @@ -143,6 +149,10 @@ export const quickstartsGetParamCreator = async (sendRequest: BaseAPI["sendReque localVarQueryParameter['display-name'] = displayName; } + if (fuzzy !== undefined) { + localVarQueryParameter['fuzzy'] = fuzzy; + } + if (limit !== undefined) { localVarQueryParameter['limit'] = limit; } diff --git a/packages/rbac/src/v2/RoleBindingsListBySubject/index.ts b/packages/rbac/src/v2/RoleBindingsListBySubject/index.ts index 510387b9d..caae244c8 100644 --- a/packages/rbac/src/v2/RoleBindingsListBySubject/index.ts +++ b/packages/rbac/src/v2/RoleBindingsListBySubject/index.ts @@ -13,29 +13,35 @@ import type { ExcludeSources, ProblemsProblem403, ResourceType, RoleBindingsBind export type RoleBindingsListBySubjectParams = { /** - * Filter by resource ID. For workspace: UUID. For tenant: tenant resource ID (format: {domain}/{org_id}). + * + * @type { number } + * @memberof RoleBindingsListBySubjectApi + */ + limit?: number, + /** + * Cursor for cursor-based pagination. * @type { string } * @memberof RoleBindingsListBySubjectApi */ - resourceId: string, + cursor?: string, /** - * Filter by resource type - * @type { ResourceType } + * Filter by resource ID. For workspace: UUID. For tenant: tenant resource ID (format: {domain}/{org_id}). Required unless resource.tenant.org_id is provided. + * @type { string } * @memberof RoleBindingsListBySubjectApi */ - resourceType: ResourceType, + resourceId?: string, /** - * - * @type { number } + * Filter by resource type. Required unless resource.tenant.org_id is provided. + * @type { ResourceType } * @memberof RoleBindingsListBySubjectApi */ - limit?: number, + resourceType?: ResourceType, /** - * Cursor for cursor-based pagination. + * Org ID of the tenant resource to filter by. Cannot be combined with resource_id. When provided, resource_type is implicitly \'tenant\'. * @type { string } * @memberof RoleBindingsListBySubjectApi */ - cursor?: string, + resourceTenantOrgId?: string, /** * Filter by binding subject kind: group or user (principal UUID). There is no granted_subject.* on this endpoint. * @type { RoleBindingsBindingSubjectType } @@ -74,7 +80,7 @@ export type RoleBindingsListBySubjectReturnType = RoleBindingsListBySubject200Re const isRoleBindingsListBySubjectObjectParams = (params: [RoleBindingsListBySubjectParams] | unknown[]): params is [RoleBindingsListBySubjectParams] => { const l = params.length === 1 if(l && typeof params[0] === 'object' && !Array.isArray(params[0])) { - return true && Object.prototype.hasOwnProperty.call(params[0], 'resourceId') && Object.prototype.hasOwnProperty.call(params[0], 'resourceType') + return true } return false } @@ -85,9 +91,9 @@ const isRoleBindingsListBySubjectObjectParams = (params: [RoleBindingsListBySubj * @param {*} [options] Override http request option. * @throws {RequiredError} */ -export const roleBindingsListBySubjectParamCreator = async (sendRequest: BaseAPI["sendRequest"], ...config: ([RoleBindingsListBySubjectParams] | [string, ResourceType, number, string, RoleBindingsBindingSubjectType, string, ExcludeSources, string, string, AxiosRequestConfig])) => { - const params = isRoleBindingsListBySubjectObjectParams(config) ? config[0] : ['resourceId', 'resourceType', 'limit', 'cursor', 'subjectType', 'subjectId', 'excludeSources', 'fields', 'orderBy', 'options'].reduce((acc, curr, index) => ({ ...acc, [curr]: config[index] }), {}) as RoleBindingsListBySubjectParams; - const { resourceId, resourceType, limit, cursor, subjectType, subjectId, excludeSources, fields, orderBy, options = {} } = params; +export const roleBindingsListBySubjectParamCreator = async (sendRequest: BaseAPI["sendRequest"], ...config: ([RoleBindingsListBySubjectParams] | [number, string, string, ResourceType, string, RoleBindingsBindingSubjectType, string, ExcludeSources, string, string, AxiosRequestConfig])) => { + const params = isRoleBindingsListBySubjectObjectParams(config) ? config[0] : ['limit', 'cursor', 'resourceId', 'resourceType', 'resourceTenantOrgId', 'subjectType', 'subjectId', 'excludeSources', 'fields', 'orderBy', 'options'].reduce((acc, curr, index) => ({ ...acc, [curr]: config[index] }), {}) as RoleBindingsListBySubjectParams; + const { limit, cursor, resourceId, resourceType, resourceTenantOrgId, subjectType, subjectId, excludeSources, fields, orderBy, options = {} } = params; const localVarPath = `/role-bindings/by-subject/`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); @@ -111,6 +117,10 @@ export const roleBindingsListBySubjectParamCreator = async (sendRequest: BaseAPI localVarQueryParameter['resource_type'] = resourceType; } + if (resourceTenantOrgId !== undefined) { + localVarQueryParameter['resource.tenant.org_id'] = resourceTenantOrgId; + } + if (subjectType !== undefined) { localVarQueryParameter['subject_type'] = subjectType; } diff --git a/packages/rbac/src/v2/RoleBindingsUpdate/index.ts b/packages/rbac/src/v2/RoleBindingsUpdate/index.ts index 8a38dc783..9d7d4c520 100644 --- a/packages/rbac/src/v2/RoleBindingsUpdate/index.ts +++ b/packages/rbac/src/v2/RoleBindingsUpdate/index.ts @@ -12,18 +12,6 @@ import type { ProblemsProblem400, ProblemsProblem403, ProblemsProblem404, Resour export type RoleBindingsUpdateParams = { - /** - * Identify the resource ID for the set of role bindings to replace. For workspace: UUID. For tenant: tenant resource ID (format: {domain}/{org_id}). - * @type { string } - * @memberof RoleBindingsUpdateApi - */ - resourceId: string, - /** - * Identify the resource type for the set of role bindings to replace - * @type { ResourceType } - * @memberof RoleBindingsUpdateApi - */ - resourceType: ResourceType, /** * Identify the subject ID for the set of role bindings to replace * @type { string } @@ -43,6 +31,24 @@ export type RoleBindingsUpdateParams = { */ roleBindingsUpdateRoleBindingsRequest: RoleBindingsUpdateRoleBindingsRequest, /** + * Identify the resource ID for the set of role bindings to replace. For workspace: UUID. For tenant: tenant resource ID (format: {domain}/{org_id}). Required unless resource.tenant.org_id is provided. + * @type { string } + * @memberof RoleBindingsUpdateApi + */ + resourceId?: string, + /** + * Identify the resource type for the set of role bindings to replace. Required unless resource.tenant.org_id is provided. + * @type { ResourceType } + * @memberof RoleBindingsUpdateApi + */ + resourceType?: ResourceType, + /** + * Org ID of the tenant resource. Cannot be combined with resource_id. When provided, resource_type is implicitly \'tenant\'. + * @type { string } + * @memberof RoleBindingsUpdateApi + */ + resourceTenantOrgId?: string, + /** * * @type { string } * @memberof RoleBindingsUpdateApi @@ -56,7 +62,7 @@ export type RoleBindingsUpdateReturnType = RoleBindingsRoleBindingBySubject; const isRoleBindingsUpdateObjectParams = (params: [RoleBindingsUpdateParams] | unknown[]): params is [RoleBindingsUpdateParams] => { const l = params.length === 1 if(l && typeof params[0] === 'object' && !Array.isArray(params[0])) { - return true && Object.prototype.hasOwnProperty.call(params[0], 'resourceId') && Object.prototype.hasOwnProperty.call(params[0], 'resourceType') && Object.prototype.hasOwnProperty.call(params[0], 'subjectId') && Object.prototype.hasOwnProperty.call(params[0], 'subjectType') && Object.prototype.hasOwnProperty.call(params[0], 'roleBindingsUpdateRoleBindingsRequest') + return true && Object.prototype.hasOwnProperty.call(params[0], 'subjectId') && Object.prototype.hasOwnProperty.call(params[0], 'subjectType') && Object.prototype.hasOwnProperty.call(params[0], 'roleBindingsUpdateRoleBindingsRequest') } return false } @@ -67,9 +73,9 @@ const isRoleBindingsUpdateObjectParams = (params: [RoleBindingsUpdateParams] | u * @param {*} [options] Override http request option. * @throws {RequiredError} */ -export const roleBindingsUpdateParamCreator = async (sendRequest: BaseAPI["sendRequest"], ...config: ([RoleBindingsUpdateParams] | [string, ResourceType, string, RoleBindingsBindingSubjectType, RoleBindingsUpdateRoleBindingsRequest, string, AxiosRequestConfig])) => { - const params = isRoleBindingsUpdateObjectParams(config) ? config[0] : ['resourceId', 'resourceType', 'subjectId', 'subjectType', 'roleBindingsUpdateRoleBindingsRequest', 'fields', 'options'].reduce((acc, curr, index) => ({ ...acc, [curr]: config[index] }), {}) as RoleBindingsUpdateParams; - const { resourceId, resourceType, subjectId, subjectType, roleBindingsUpdateRoleBindingsRequest, fields, options = {} } = params; +export const roleBindingsUpdateParamCreator = async (sendRequest: BaseAPI["sendRequest"], ...config: ([RoleBindingsUpdateParams] | [string, RoleBindingsBindingSubjectType, RoleBindingsUpdateRoleBindingsRequest, string, ResourceType, string, string, AxiosRequestConfig])) => { + const params = isRoleBindingsUpdateObjectParams(config) ? config[0] : ['subjectId', 'subjectType', 'roleBindingsUpdateRoleBindingsRequest', 'resourceId', 'resourceType', 'resourceTenantOrgId', 'fields', 'options'].reduce((acc, curr, index) => ({ ...acc, [curr]: config[index] }), {}) as RoleBindingsUpdateParams; + const { subjectId, subjectType, roleBindingsUpdateRoleBindingsRequest, resourceId, resourceType, resourceTenantOrgId, fields, options = {} } = params; const localVarPath = `/role-bindings/by-subject/`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); @@ -85,6 +91,10 @@ export const roleBindingsUpdateParamCreator = async (sendRequest: BaseAPI["sendR localVarQueryParameter['resource_type'] = resourceType; } + if (resourceTenantOrgId !== undefined) { + localVarQueryParameter['resource.tenant.org_id'] = resourceTenantOrgId; + } + if (subjectId !== undefined) { localVarQueryParameter['subject_id'] = subjectId; } diff --git a/packages/rbac/src/v2/WorkspacesList/index.ts b/packages/rbac/src/v2/WorkspacesList/index.ts index 1f76e06a1..d8ff1c8bf 100644 --- a/packages/rbac/src/v2/WorkspacesList/index.ts +++ b/packages/rbac/src/v2/WorkspacesList/index.ts @@ -8,7 +8,7 @@ import { BaseAPI } from '@redhat-cloud-services/javascript-clients-shared/dist/b import { Configuration } from '@redhat-cloud-services/javascript-clients-shared/dist/configuration'; // @ts-ignore -import type { ProblemsProblem403, RoleBindingsList401Response, RoleBindingsList500Response, WorkspacesWorkspaceListResponse, WorkspacesWorkspaceTypesQueryParam } from '../types'; +import type { ProblemsProblem403, RoleBindingsList401Response, RoleBindingsList500Response, WorkspacesWorkspaceListResponse } from '../types'; export type WorkspacesListParams = { @@ -25,11 +25,11 @@ export type WorkspacesListParams = { */ offset?: number, /** - * Defaults to all when param is not supplied. - * @type { WorkspacesWorkspaceTypesQueryParam } + * Filter by workspace type. Supports comma-separated values (e.g. type=standard,ungrouped-hosts). Defaults to all when not supplied. Case-insensitive. + * @type { string } * @memberof WorkspacesListApi */ - type?: WorkspacesWorkspaceTypesQueryParam, + type?: string, /** * Case sensitive exact match of workspace by name. * @type { string } @@ -73,7 +73,7 @@ const isWorkspacesListObjectParams = (params: [WorkspacesListParams] | unknown[] * @param {*} [options] Override http request option. * @throws {RequiredError} */ -export const workspacesListParamCreator = async (sendRequest: BaseAPI["sendRequest"], ...config: ([WorkspacesListParams] | [number, number, WorkspacesWorkspaceTypesQueryParam, string, string, Array, string, AxiosRequestConfig])) => { +export const workspacesListParamCreator = async (sendRequest: BaseAPI["sendRequest"], ...config: ([WorkspacesListParams] | [number, number, string, string, string, Array, string, AxiosRequestConfig])) => { const params = isWorkspacesListObjectParams(config) ? config[0] : ['limit', 'offset', 'type', 'name', 'parentId', 'ids', 'orderBy', 'options'].reduce((acc, curr, index) => ({ ...acc, [curr]: config[index] }), {}) as WorkspacesListParams; const { limit, offset, type, name, parentId, ids, orderBy, options = {} } = params; const localVarPath = `/workspaces/`; diff --git a/packages/remediations/src/types/index.ts b/packages/remediations/src/types/index.ts index 7adef0a73..3ae278a7d 100644 --- a/packages/remediations/src/types/index.ts +++ b/packages/remediations/src/types/index.ts @@ -1401,6 +1401,12 @@ export interface RemediationListItem { * @memberof RemediationListItem */ 'archived': boolean; + /** + * Timestamp of the most recent playbook run for the remediation or null if never executed + * @type {string} + * @memberof RemediationListItem + */ + 'last_run_at'?: string | null; /** * * @type {Array} diff --git a/packages/vulnerabilities/api.ts b/packages/vulnerabilities/api.ts index 1c6530874..ec72b5d62 100644 --- a/packages/vulnerabilities/api.ts +++ b/packages/vulnerabilities/api.ts @@ -3,7 +3,7 @@ * Vulnerability Engine Manager * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * - * The version of the OpenAPI document: 2.70.8 + * The version of the OpenAPI document: 2.74.1 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -33,1041 +33,2170 @@ export interface AffectedSystemsIdsOut { data: string | Array; /** * - * @type {Links} + * @type {InlineResponse2003Links} * @memberof AffectedSystemsIdsOut */ - links: Links; + links: InlineResponse2003Links; /** * - * @type {MetaAffectedSystems} + * @type {object} * @memberof AffectedSystemsIdsOut */ - meta: MetaAffectedSystems; + meta: object; +} +/** + * + * @export + * @interface AffectedSystemsOut + */ +export interface AffectedSystemsOut { + /** + * + * @type {string | Array} + * @memberof AffectedSystemsOut + */ + data: string | Array; + /** + * + * @type {InlineResponse2003Links} + * @memberof AffectedSystemsOut + */ + links: InlineResponse2003Links; + /** + * + * @type {object} + * @memberof AffectedSystemsOut + */ + meta: object; +} +/** + * + * @export + * @interface AnnouncementOut + */ +export interface AnnouncementOut { + /** + * Announcement message. + * @type {string} + * @memberof AnnouncementOut + */ + message: string; + /** + * Datetime string. + * @type {string} + * @memberof AnnouncementOut + */ + last_updated: string; +} +/** + * + * @export + * @interface BulkChangeOut + */ +export interface BulkChangeOut { + /** + * List of updated objects/updated object IDs. + * @type {Array} + * @memberof BulkChangeOut + */ + updated: Array; + /** + * + * @type {InlineResponse2002Meta} + * @memberof BulkChangeOut + */ + meta?: InlineResponse2002Meta; +} +/** + * + * @export + * @interface BusinessRiskListOut + */ +export interface BusinessRiskListOut { + /** + * List of available business risk/business_risk_id pairs. + * @type {Array} + * @memberof BusinessRiskListOut + */ + data: Array; + /** + * + * @type {InlineResponse2001Meta} + * @memberof BusinessRiskListOut + */ + meta: InlineResponse2001Meta; +} +/** + * + * @export + * @interface CveDetailOut + */ +export interface CveDetailOut { + /** + * + * @type {InlineResponse2002Data} + * @memberof CveDetailOut + */ + data?: InlineResponse2002Data; + /** + * + * @type {InlineResponse2002Meta} + * @memberof CveDetailOut + */ + meta?: InlineResponse2002Meta; +} +/** + * @type CveOrList + * @export + */ +export type CveOrList = Array | string; + +/** + * + * @export + * @interface CveRiskIn + */ +export interface CveRiskIn { + /** + * + * @type {string | Array} + * @memberof CveRiskIn + */ + cve: string | Array; + /** + * Business risk ID to be set, obtained by GET method. + * @type {number} + * @memberof CveRiskIn + */ + business_risk_id?: number; + /** + * Complementary text to the business risk. + * @type {string} + * @memberof CveRiskIn + */ + business_risk_text?: string | null; +} +/** + * + * @export + * @interface CveStatusIn + */ +export interface CveStatusIn { + /** + * + * @type {string | Array} + * @memberof CveStatusIn + */ + cve: string | Array; + /** + * Status ID to be set, obtained by GET method. + * @type {number} + * @memberof CveStatusIn + */ + status_id?: number; + /** + * Complementary text to the status. + * @type {string} + * @memberof CveStatusIn + */ + status_text?: string | null; +} +/** + * + * @export + * @interface CvesWithoutErrataIn + */ +export interface CvesWithoutErrataIn { + /** + * Enable or disable CVEs without Errata feature. + * @type {boolean} + * @memberof CvesWithoutErrataIn + */ + enable: boolean; +} +/** + * + * @export + * @interface CvesWithoutErrataOut + */ +export interface CvesWithoutErrataOut { + /** + * + * @type {InlineResponse20022CvesWithoutErrata} + * @memberof CvesWithoutErrataOut + */ + cves_without_errata: InlineResponse20022CvesWithoutErrata; +} +/** + * + * @export + * @interface CvesWithoutErrataPatchOut + */ +export interface CvesWithoutErrataPatchOut { + /** + * + * @type {InlineResponse20023Updated} + * @memberof CvesWithoutErrataPatchOut + */ + updated: InlineResponse20023Updated; + /** + * + * @type {InlineResponse2002Meta} + * @memberof CvesWithoutErrataPatchOut + */ + meta: InlineResponse2002Meta; +} +/** + * + * @export + * @interface DashbarOut + */ +export interface DashbarOut { + /** + * + * @type {number} + * @memberof DashbarOut + */ + exploitable_cves?: number; + /** + * + * @type {number} + * @memberof DashbarOut + */ + cves_with_rule?: number; + /** + * + * @type {number} + * @memberof DashbarOut + */ + critical_cves?: number; + /** + * + * @type {number} + * @memberof DashbarOut + */ + important_cves?: number; +} +/** + * + * @export + * @interface Dashboard + */ +export interface Dashboard { + /** + * Number of unique CVEs discovered on the managed systems. + * @type {number} + * @memberof Dashboard + */ + cves_total: number; + /** + * + * @type {InlineResponse2006CvesBySeverity} + * @memberof Dashboard + */ + cves_by_severity: InlineResponse2006CvesBySeverity; + /** + * + * @type {InlineResponse2006RecentCves} + * @memberof Dashboard + */ + recent_cves: InlineResponse2006RecentCves; + /** + * List of recently (14 days) released security rules. + * @type {Array} + * @memberof Dashboard + */ + recent_rules: Array; + /** + * Total number of CVEs with associated security rules affecting given account. + * @type {number} + * @memberof Dashboard + */ + rules_cves_total: number; + /** + * Total systems registered to Vulnerability service (with applied filtering). + * @type {number} + * @memberof Dashboard + */ + system_count: number; + /** + * unique number of CVEs having known exploit affecting at least one system + * @type {number} + * @memberof Dashboard + */ + exploited_cves_count: number; +} +/** + * + * @export + * @interface Errors + */ +export interface Errors { + /** + * + * @type {Array} + * @memberof Errors + */ + errors: Array; +} +/** + * + * @export + * @interface ExecutiveReport + */ +export interface ExecutiveReport { + /** + * + * @type {InlineResponse2008SystemCountPerType} + * @memberof ExecutiveReport + */ + system_count_per_type?: InlineResponse2008SystemCountPerType; + /** + * Total number of systems managed by vulnerability application. + * @type {number} + * @memberof ExecutiveReport + */ + system_count: number; + /** + * Number of unique CVEs discovered on the managed systems. + * @type {number} + * @memberof ExecutiveReport + */ + cves_total: number; + /** + * + * @type {InlineResponse2008CvesBySeverity} + * @memberof ExecutiveReport + */ + cves_by_severity: InlineResponse2008CvesBySeverity; + /** + * + * @type {InlineResponse2006RecentCves} + * @memberof ExecutiveReport + */ + recent_cves: InlineResponse2006RecentCves; + /** + * + * @type {InlineResponse2008RulesBySeverity} + * @memberof ExecutiveReport + */ + rules_by_severity: InlineResponse2008RulesBySeverity; + /** + * Number of unique CVEs discovered on the managed systems. + * @type {number} + * @memberof ExecutiveReport + */ + rules_total: number; + /** + * + * @type {Array} + * @memberof ExecutiveReport + */ + top_cves?: Array; + /** + * + * @type {Array} + * @memberof ExecutiveReport + */ + top_rules?: Array; + /** + * + * @type {InlineResponse2002Meta} + * @memberof ExecutiveReport + */ + meta?: InlineResponse2002Meta; +} +/** + * + * @export + * @interface InlineObject + */ +export interface InlineObject { + /** + * + * @type {string | Array} + * @memberof InlineObject + */ + cve: string | Array; + /** + * Business risk ID to be set, obtained by GET method. + * @type {number} + * @memberof InlineObject + */ + business_risk_id?: number; + /** + * Complementary text to the business risk. + * @type {string} + * @memberof InlineObject + */ + business_risk_text?: string | null; +} +/** + * + * @export + * @interface InlineObject1 + */ +export interface InlineObject1 { + /** + * + * @type {string | Array} + * @memberof InlineObject1 + */ + cve: string | Array; + /** + * Status ID to be set, obtained by GET method. + * @type {number} + * @memberof InlineObject1 + */ + status_id?: number; + /** + * Complementary text to the status. + * @type {string} + * @memberof InlineObject1 + */ + status_text?: string | null; +} +/** + * + * @export + * @interface InlineObject2 + */ +export interface InlineObject2 { + /** + * + * @type {string | Array} + * @memberof InlineObject2 + */ + inventory_id?: string | Array; + /** + * + * @type {string | Array} + * @memberof InlineObject2 + */ + cve: string | Array; + /** + * Status ID to be set, obtained by GET method. If not specified, global CVE status is set. + * @type {number} + * @memberof InlineObject2 + */ + status_id?: number; + /** + * Complementary text to the status. + * @type {string} + * @memberof InlineObject2 + */ + status_text?: string | null; +} +/** + * + * @export + * @interface InlineObject3 + */ +export interface InlineObject3 { + /** + * + * @type {string | Array} + * @memberof InlineObject3 + */ + inventory_id: string | Array; + /** + * Opt out setting to be set. + * @type {boolean} + * @memberof InlineObject3 + */ + opt_out: boolean; +} +/** + * + * @export + * @interface InlineObject4 + */ +export interface InlineObject4 { + /** + * Array of CVEs to provide info about + * @type {Array} + * @memberof InlineObject4 + */ + cve_list: Array; +} +/** + * + * @export + * @interface InlineObject5 + */ +export interface InlineObject5 { + /** + * Enable or disable CVEs without Errata feature. + * @type {boolean} + * @memberof InlineObject5 + */ + enable: boolean; +} +/** + * + * @export + * @interface InlineResponse200 + */ +export interface InlineResponse200 { + /** + * Version of application. + * @type {string} + * @memberof InlineResponse200 + */ + application_version: string; + /** + * Version of database schema. + * @type {string | number} + * @memberof InlineResponse200 + */ + database_version: string | number; +} +/** + * + * @export + * @interface InlineResponse2001 + */ +export interface InlineResponse2001 { + /** + * List of available business risk/business_risk_id pairs. + * @type {Array} + * @memberof InlineResponse2001 + */ + data: Array; + /** + * + * @type {InlineResponse2001Meta} + * @memberof InlineResponse2001 + */ + meta: InlineResponse2001Meta; +} +/** + * + * @export + * @interface InlineResponse20010 + */ +export interface InlineResponse20010 { + /** + * List of available status/status_id pairs. + * @type {Array} + * @memberof InlineResponse20010 + */ + data: Array; + /** + * + * @type {InlineResponse20010Meta} + * @memberof InlineResponse20010 + */ + meta: InlineResponse20010Meta; +} +/** + * + * @export + * @interface InlineResponse20010Data + */ +export interface InlineResponse20010Data { + /** + * Internal status_id. + * @type {number} + * @memberof InlineResponse20010Data + */ + id: number; + /** + * Represenation of internal status_id. + * @type {string} + * @memberof InlineResponse20010Data + */ + name: string; +} +/** + * + * @export + * @interface InlineResponse20010Meta + */ +export interface InlineResponse20010Meta { + /** + * Total number of available status/status_id pairs. + * @type {number} + * @memberof InlineResponse20010Meta + */ + total_items: number; +} +/** + * + * @export + * @interface InlineResponse20011 + */ +export interface InlineResponse20011 { + /** + * List of updated objects/updated object IDs. + * @type {Array} + * @memberof InlineResponse20011 + */ + updated: Array; + /** + * + * @type {InlineResponse2002Meta} + * @memberof InlineResponse20011 + */ + meta?: InlineResponse2002Meta; +} +/** + * + * @export + * @interface InlineResponse20011Updated + */ +export interface InlineResponse20011Updated { + /** + * + * @type {string} + * @memberof InlineResponse20011Updated + */ + inventory_id: string; + /** + * + * @type {string} + * @memberof InlineResponse20011Updated + */ + cve: string; +} +/** + * + * @export + * @interface InlineResponse20012 + */ +export interface InlineResponse20012 { + /** + * + * @type {string | Array} + * @memberof InlineResponse20012 + */ + data: string | Array; + /** + * + * @type {InlineResponse2003Links} + * @memberof InlineResponse20012 + */ + links: InlineResponse2003Links; + /** + * + * @type {object} + * @memberof InlineResponse20012 + */ + meta: object; +} +/** + * + * @export + * @interface InlineResponse20013 + */ +export interface InlineResponse20013 { + /** + * + * @type {string | Array} + * @memberof InlineResponse20013 + */ + data: string | Array; + /** + * + * @type {InlineResponse2003Links} + * @memberof InlineResponse20013 + */ + links: InlineResponse2003Links; + /** + * + * @type {object} + * @memberof InlineResponse20013 + */ + meta: object; +} +/** + * + * @export + * @interface InlineResponse20014 + */ +export interface InlineResponse20014 { + /** + * + * @type {InlineResponse20014Data} + * @memberof InlineResponse20014 + */ + data: InlineResponse20014Data; + /** + * + * @type {InlineResponse2002Meta} + * @memberof InlineResponse20014 + */ + meta: InlineResponse2002Meta; +} +/** + * + * @export + * @interface InlineResponse20014Data + */ +export interface InlineResponse20014Data { + /** + * Date of last evaluation. + * @type {string} + * @memberof InlineResponse20014Data + */ + last_evaluation: string | null; + /** + * Date of last security rules evaluation. + * @type {string} + * @memberof InlineResponse20014Data + */ + rules_evaluation: string | null; + /** + * System opt out status. + * @type {boolean} + * @memberof InlineResponse20014Data + */ + opt_out: boolean; + /** + * Date of the latest upload of archive. + * @type {string} + * @memberof InlineResponse20014Data + */ + last_upload: string | null; + /** + * System stale status. + * @type {boolean} + * @memberof InlineResponse20014Data + */ + stale?: boolean; + /** + * Date of the lastest upload of archive taken from Inventory syndicated data. + * @type {string} + * @memberof InlineResponse20014Data + */ + updated?: string | null; + /** + * Operating system. + * @type {string} + * @memberof InlineResponse20014Data + */ + os: string; + /** + * System is locked to following RHSM version. + * @type {string} + * @memberof InlineResponse20014Data + */ + rhsm_lock: string | null; + /** + * + * @type {Array} + * @memberof InlineResponse20014Data + */ + tags: Array; + /** + * Type of the host + * @type {string} + * @memberof InlineResponse20014Data + */ + host_type: InlineResponse20014DataHostTypeEnum; +} + +/** + * @export + * @enum {string} + */ +export enum InlineResponse20014DataHostTypeEnum { + Rpmdnf = 'rpmdnf', + Image = 'image' +} + +/** + * + * @export + * @interface InlineResponse20014DataTags + */ +export interface InlineResponse20014DataTags { + /** + * Namespace of single tag. + * @type {string} + * @memberof InlineResponse20014DataTags + */ + namespace: string | null; + /** + * Key of the single tag. + * @type {string} + * @memberof InlineResponse20014DataTags + */ + key: string; + /** + * Value of the single tag. + * @type {string} + * @memberof InlineResponse20014DataTags + */ + value: string | null; +} +/** + * + * @export + * @interface InlineResponse20015 + */ +export interface InlineResponse20015 { + /** + * + * @type {string | Array} + * @memberof InlineResponse20015 + */ + data: string | Array; + /** + * + * @type {InlineResponse2003Links} + * @memberof InlineResponse20015 + */ + links: InlineResponse2003Links; + /** + * + * @type {object} + * @memberof InlineResponse20015 + */ + meta: object; +} +/** + * + * @export + * @interface InlineResponse20016 + */ +export interface InlineResponse20016 { + /** + * + * @type {string | Array} + * @memberof InlineResponse20016 + */ + data: string | Array; + /** + * + * @type {InlineResponse2003Links} + * @memberof InlineResponse20016 + */ + links: InlineResponse2003Links; + /** + * + * @type {object} + * @memberof InlineResponse20016 + */ + meta: object; +} +/** + * + * @export + * @interface InlineResponse20017 + */ +export interface InlineResponse20017 { + /** + * + * @type {string | Array} + * @memberof InlineResponse20017 + */ + data: string | Array; + /** + * + * @type {InlineResponse2003Links} + * @memberof InlineResponse20017 + */ + links: InlineResponse2003Links; + /** + * + * @type {object} + * @memberof InlineResponse20017 + */ + meta: object; +} +/** + * + * @export + * @interface InlineResponse20018 + */ +export interface InlineResponse20018 { + /** + * + * @type {Array} + * @memberof InlineResponse20018 + */ + data: Array; + /** + * + * @type {InlineResponse2003Links} + * @memberof InlineResponse20018 + */ + links: InlineResponse2003Links; + /** + * + * @type {object} + * @memberof InlineResponse20018 + */ + meta: object; +} +/** + * + * @export + * @interface InlineResponse20018Attributes + */ +export interface InlineResponse20018Attributes { + /** + * String representation of cvss3 or cvvs2 (if v3 is not present) score of the CVE. + * @type {string} + * @memberof InlineResponse20018Attributes + */ + cvss_score: string | null; + /** + * Red Hat security impact of the CVE. + * @type {string} + * @memberof InlineResponse20018Attributes + */ + impact: string; + /** + * Synopsis of the CVE. + * @type {string} + * @memberof InlineResponse20018Attributes + */ + synopsis: string; +} +/** + * + * @export + * @interface InlineResponse20018Data + */ +export interface InlineResponse20018Data { + /** + * CVE id. + * @type {string} + * @memberof InlineResponse20018Data + */ + id: string; + /** + * Type of the record. + * @type {string} + * @memberof InlineResponse20018Data + */ + type: string; + /** + * + * @type {InlineResponse20018Attributes} + * @memberof InlineResponse20018Data + */ + attributes: InlineResponse20018Attributes; } /** * * @export - * @interface AffectedSystemsOut + * @interface InlineResponse20019 */ -export interface AffectedSystemsOut { +export interface InlineResponse20019 { /** * * @type {string | Array} - * @memberof AffectedSystemsOut + * @memberof InlineResponse20019 */ data: string | Array; /** * - * @type {Links} - * @memberof AffectedSystemsOut + * @type {InlineResponse2003Links} + * @memberof InlineResponse20019 */ - links: Links; + links: InlineResponse2003Links; /** * - * @type {MetaAffectedSystems} - * @memberof AffectedSystemsOut + * @type {object} + * @memberof InlineResponse20019 */ - meta: MetaAffectedSystems; + meta: object; } /** * * @export - * @interface AnnouncementOut + * @interface InlineResponse2001Data */ -export interface AnnouncementOut { +export interface InlineResponse2001Data { + /** + * Internal business_risk_id. + * @type {number} + * @memberof InlineResponse2001Data + */ + id: number; + /** + * Represenation of internal business_risk_id. + * @type {string} + * @memberof InlineResponse2001Data + */ + name: string; +} +/** + * + * @export + * @interface InlineResponse2001Meta + */ +export interface InlineResponse2001Meta { + /** + * Total number of available business risk/business_risk_id pairs. + * @type {number} + * @memberof InlineResponse2001Meta + */ + total_items: number; +} +/** + * + * @export + * @interface InlineResponse2002 + */ +export interface InlineResponse2002 { + /** + * + * @type {InlineResponse2002Data} + * @memberof InlineResponse2002 + */ + data?: InlineResponse2002Data; + /** + * + * @type {InlineResponse2002Meta} + * @memberof InlineResponse2002 + */ + meta?: InlineResponse2002Meta; +} +/** + * + * @export + * @interface InlineResponse20020 + */ +export interface InlineResponse20020 { /** * Announcement message. * @type {string} - * @memberof AnnouncementOut + * @memberof InlineResponse20020 */ message: string; /** * Datetime string. * @type {string} - * @memberof AnnouncementOut + * @memberof InlineResponse20020 */ last_updated: string; } /** * * @export - * @interface BulkChangeOut + * @interface InlineResponse20021 */ -export interface BulkChangeOut { +export interface InlineResponse20021 { /** - * List of updated objects/updated object IDs. - * @type {Array} - * @memberof BulkChangeOut + * + * @type {number} + * @memberof InlineResponse20021 */ - updated: Array; + exploitable_cves?: number; /** * - * @type {MetaPermissions} - * @memberof BulkChangeOut + * @type {number} + * @memberof InlineResponse20021 + */ + cves_with_rule?: number; + /** + * + * @type {number} + * @memberof InlineResponse20021 + */ + critical_cves?: number; + /** + * + * @type {number} + * @memberof InlineResponse20021 */ - meta?: MetaPermissions; + important_cves?: number; } /** * * @export - * @interface BusinessRiskListOut + * @interface InlineResponse20022 */ -export interface BusinessRiskListOut { - /** - * List of available business risk/business_risk_id pairs. - * @type {Array} - * @memberof BusinessRiskListOut - */ - data: Array; +export interface InlineResponse20022 { /** * - * @type {BusinessRiskListOutMeta} - * @memberof BusinessRiskListOut + * @type {InlineResponse20022CvesWithoutErrata} + * @memberof InlineResponse20022 */ - meta: BusinessRiskListOutMeta; + cves_without_errata: InlineResponse20022CvesWithoutErrata; } /** * * @export - * @interface BusinessRiskListOutData + * @interface InlineResponse20022CvesWithoutErrata */ -export interface BusinessRiskListOutData { - /** - * Internal business_risk_id. - * @type {number} - * @memberof BusinessRiskListOutData - */ - id: number; +export interface InlineResponse20022CvesWithoutErrata { /** - * Represenation of internal business_risk_id. - * @type {string} - * @memberof BusinessRiskListOutData + * + * @type {boolean} + * @memberof InlineResponse20022CvesWithoutErrata */ - name: string; + enabled?: boolean; } /** * * @export - * @interface BusinessRiskListOutMeta + * @interface InlineResponse20023 */ -export interface BusinessRiskListOutMeta { +export interface InlineResponse20023 { /** - * Total number of available business risk/business_risk_id pairs. - * @type {number} - * @memberof BusinessRiskListOutMeta + * + * @type {InlineResponse20023Updated} + * @memberof InlineResponse20023 */ - total_items: number; + updated: InlineResponse20023Updated; + /** + * + * @type {InlineResponse2002Meta} + * @memberof InlineResponse20023 + */ + meta: InlineResponse2002Meta; } /** * * @export - * @interface CveDetailOut + * @interface InlineResponse20023Updated */ -export interface CveDetailOut { +export interface InlineResponse20023Updated { /** * - * @type {CveDetailOutData} - * @memberof CveDetailOut + * @type {string} + * @memberof InlineResponse20023Updated */ - data?: CveDetailOutData; + org_id?: string; /** * - * @type {MetaPermissions} - * @memberof CveDetailOut + * @type {InlineResponse20022CvesWithoutErrata} + * @memberof InlineResponse20023Updated + */ + cves_without_errata?: InlineResponse20022CvesWithoutErrata; +} +/** + * + * @export + * @interface InlineResponse20024 + */ +export interface InlineResponse20024 { + /** + * Number of deleted notifications for CVEs + * @type {number} + * @memberof InlineResponse20024 */ - meta?: MetaPermissions; + deleted: number; } /** * * @export - * @interface CveDetailOutData + * @interface InlineResponse2002Data */ -export interface CveDetailOutData { +export interface InlineResponse2002Data { /** * CVE id. * @type {string} - * @memberof CveDetailOutData + * @memberof InlineResponse2002Data */ id: string; /** * Type of the record. * @type {string} - * @memberof CveDetailOutData + * @memberof InlineResponse2002Data */ type: string; /** * - * @type {CveDetailOutDataAttributes} - * @memberof CveDetailOutData + * @type {InlineResponse2002DataAttributes} + * @memberof InlineResponse2002Data */ - attributes: CveDetailOutDataAttributes; + attributes: InlineResponse2002DataAttributes; } /** * * @export - * @interface CveDetailOutDataAttributes + * @interface InlineResponse2002DataAttributes */ -export interface CveDetailOutDataAttributes { +export interface InlineResponse2002DataAttributes { /** * Business risk of the vulnerability. * @type {string} - * @memberof CveDetailOutDataAttributes + * @memberof InlineResponse2002DataAttributes */ business_risk: string; /** * Internal ID of the vulnerability business risk. * @type {number} - * @memberof CveDetailOutDataAttributes + * @memberof InlineResponse2002DataAttributes */ business_risk_id: number; /** * Complementary text to the business risk. * @type {string} - * @memberof CveDetailOutDataAttributes + * @memberof InlineResponse2002DataAttributes */ business_risk_text: string | null; /** * \"Celebrity\" name of the CVE. * @type {string} - * @memberof CveDetailOutDataAttributes + * @memberof InlineResponse2002DataAttributes */ celebrity_name: string | null; /** * cvss2 metrics of the CVE. * @type {string} - * @memberof CveDetailOutDataAttributes + * @memberof InlineResponse2002DataAttributes */ cvss2_metrics: string | null; /** * String representation of cvss2 score of the CVE. * @type {string} - * @memberof CveDetailOutDataAttributes + * @memberof InlineResponse2002DataAttributes */ cvss2_score: string | null; /** * cvss3 metrics of the CVE. * @type {string} - * @memberof CveDetailOutDataAttributes + * @memberof InlineResponse2002DataAttributes */ cvss3_metrics: string | null; /** * String representation of cvss3 score of the CVE. * @type {string} - * @memberof CveDetailOutDataAttributes + * @memberof InlineResponse2002DataAttributes */ cvss3_score: string | null; /** * Description of the CVE. * @type {string} - * @memberof CveDetailOutDataAttributes + * @memberof InlineResponse2002DataAttributes */ description: string; /** * String representation of ISO-8601 formatted date of last modification of the CVE. * @type {string} - * @memberof CveDetailOutDataAttributes + * @memberof InlineResponse2002DataAttributes */ modified_date: string | null; /** * Red Hat security impact of the CVE. * @type {string} - * @memberof CveDetailOutDataAttributes + * @memberof InlineResponse2002DataAttributes */ impact: string; /** * String representation of ISO-8601 formatted date of first public disclosure of the CVE. * @type {string} - * @memberof CveDetailOutDataAttributes + * @memberof InlineResponse2002DataAttributes */ public_date: string | null; /** * Additional resource about the CVE, provided by Red Hat. * @type {string} - * @memberof CveDetailOutDataAttributes + * @memberof InlineResponse2002DataAttributes */ redhat_url: string | null; /** * - * @type {Array} - * @memberof CveDetailOutDataAttributes + * @type {Array} + * @memberof InlineResponse2002DataAttributes */ - rules: Array; + rules: Array; /** * Additional resources about the CVE. * @type {string} - * @memberof CveDetailOutDataAttributes + * @memberof InlineResponse2002DataAttributes */ secondary_url: string | null; /** * Status of the vulnerability. * @type {string} - * @memberof CveDetailOutDataAttributes + * @memberof InlineResponse2002DataAttributes */ status: string; /** * Internal ID of the vulnerability status. * @type {number} - * @memberof CveDetailOutDataAttributes + * @memberof InlineResponse2002DataAttributes */ status_id: number; /** * Complementary text to the status. * @type {string} - * @memberof CveDetailOutDataAttributes + * @memberof InlineResponse2002DataAttributes */ status_text: string | null; /** * Synopsis of the CVE. * @type {string} - * @memberof CveDetailOutDataAttributes + * @memberof InlineResponse2002DataAttributes */ synopsis: string; /** * Counts of systems with given status type. * @type {object} - * @memberof CveDetailOutDataAttributes + * @memberof InlineResponse2002DataAttributes */ systems_status_detail: object; /** * How many systems-CVE pairs have different status than CVE-level. * @type {number} - * @memberof CveDetailOutDataAttributes + * @memberof InlineResponse2002DataAttributes */ systems_status_divergent: number; /** * List of advisory names or detailed advisory information * @type {Array} - * @memberof CveDetailOutDataAttributes + * @memberof InlineResponse2002DataAttributes */ advisories_list: Array | null; /** * Shows whether a CVE has known exploits or not * @type {boolean} - * @memberof CveDetailOutDataAttributes + * @memberof InlineResponse2002DataAttributes */ known_exploit: boolean; /** * Number of systems that are affected by given CVE but are not vulnerable. * @type {number} - * @memberof CveDetailOutDataAttributes + * @memberof InlineResponse2002DataAttributes */ affected_but_not_vulnerable: number | null; /** * Number of systems that are overall affected by given CVE * @type {number} - * @memberof CveDetailOutDataAttributes + * @memberof InlineResponse2002DataAttributes */ affected_systems?: number | null; } -/** - * @type CveOrList - * @export - */ -export type CveOrList = Array | string; - /** * * @export - * @interface CveRiskIn + * @interface InlineResponse2002DataAttributesRules */ -export interface CveRiskIn { +export interface InlineResponse2002DataAttributesRules { /** - * - * @type {CveOrList} - * @memberof CveRiskIn + * ID(s) of associated security rule(s). + * @type {string} + * @memberof InlineResponse2002DataAttributesRules */ - cve: CveOrList; + rule_id: string; /** - * Business risk ID to be set, obtained by GET method. - * @type {number} - * @memberof CveRiskIn + * Description of the rule. + * @type {string} + * @memberof InlineResponse2002DataAttributesRules */ - business_risk_id?: number; + description: string | null; /** - * Complementary text to the business risk. + * Summary of the rule. * @type {string} - * @memberof CveRiskIn + * @memberof InlineResponse2002DataAttributesRules */ - business_risk_text?: string | null; -} -/** - * - * @export - * @interface CveStatusIn - */ -export interface CveStatusIn { + summary: string | null; /** - * - * @type {CveOrList} - * @memberof CveStatusIn + * Indicator whter reboot is required to mitigate vulnerability. + * @type {boolean} + * @memberof InlineResponse2002DataAttributesRules */ - cve: CveOrList; + reboot_required: boolean | null; /** - * Status ID to be set, obtained by GET method. + * Number of available Ansible playbooks for remediation/mitigation. * @type {number} - * @memberof CveStatusIn + * @memberof InlineResponse2002DataAttributesRules */ - status_id?: number; + playbook_count: number | null; /** - * Complementary text to the status. + * Indicates how likely remediation can change environment on the remediatied system. + * @type {number} + * @memberof InlineResponse2002DataAttributesRules + */ + change_risk: number | null; + /** + * ID of associated Red Hat knowledgebase article. + * @type {number} + * @memberof InlineResponse2002DataAttributesRules + */ + kbase_node_id: number | null; + /** + * List of CVEs associated with the rule. + * @type {Array} + * @memberof InlineResponse2002DataAttributesRules + */ + associated_cves: Array; + /** + * Shows rules impact number from 1 to 4 + * @type {number} + * @memberof InlineResponse2002DataAttributesRules + */ + rule_impact: number | null; + /** + * Number of systems affected by the rule. + * @type {number} + * @memberof InlineResponse2002DataAttributesRules + */ + systems_affected?: number; + /** + * Date when the rule was published. * @type {string} - * @memberof CveStatusIn + * @memberof InlineResponse2002DataAttributesRules */ - status_text?: string | null; + publish_date: string | null; } /** * * @export - * @interface CvesWithoutErrataIn + * @interface InlineResponse2002Meta */ -export interface CvesWithoutErrataIn { +export interface InlineResponse2002Meta { /** - * Enable or disable CVEs without Errata feature. - * @type {boolean} - * @memberof CvesWithoutErrataIn + * Fetched permissions from RBAC for given user + * @type {Array} + * @memberof InlineResponse2002Meta */ - enable: boolean; + permissions: Array; } /** * * @export - * @interface CvesWithoutErrataOut + * @interface InlineResponse2003 */ -export interface CvesWithoutErrataOut { +export interface InlineResponse2003 { /** * - * @type {CvesWithoutErrataOutUpdated} - * @memberof CvesWithoutErrataOut + * @type {string | Array} + * @memberof InlineResponse2003 */ - updated: CvesWithoutErrataOutUpdated; + data: string | Array; /** * - * @type {MetaPermissions} - * @memberof CvesWithoutErrataOut + * @type {InlineResponse2003Links} + * @memberof InlineResponse2003 + */ + links: InlineResponse2003Links; + /** + * + * @type {object} + * @memberof InlineResponse2003 */ - meta: MetaPermissions; + meta: object; } /** * * @export - * @interface CvesWithoutErrataOutUpdated + * @interface InlineResponse2003Links */ -export interface CvesWithoutErrataOutUpdated { +export interface InlineResponse2003Links { /** - * + * Link to first page. * @type {string} - * @memberof CvesWithoutErrataOutUpdated + * @memberof InlineResponse2003Links */ - org_id?: string; + first: string; /** - * - * @type {CvesWithoutErrataOutUpdatedCvesWithoutErrata} - * @memberof CvesWithoutErrataOutUpdated + * Link to last page. + * @type {string} + * @memberof InlineResponse2003Links */ - cves_without_errata?: CvesWithoutErrataOutUpdatedCvesWithoutErrata; -} -/** - * - * @export - * @interface CvesWithoutErrataOutUpdatedCvesWithoutErrata - */ -export interface CvesWithoutErrataOutUpdatedCvesWithoutErrata { + last: string; /** - * - * @type {boolean} - * @memberof CvesWithoutErrataOutUpdatedCvesWithoutErrata + * Link to next page. + * @type {string} + * @memberof InlineResponse2003Links */ - enabled?: boolean; + next: string | null; + /** + * Link to next page. + * @type {string} + * @memberof InlineResponse2003Links + */ + previous: string | null; } /** * * @export - * @interface DashbarOut + * @interface InlineResponse2004 */ -export interface DashbarOut { +export interface InlineResponse2004 { /** * - * @type {number} - * @memberof DashbarOut + * @type {string | Array} + * @memberof InlineResponse2004 */ - exploitable_cves?: number; + data: string | Array; /** * - * @type {number} - * @memberof DashbarOut + * @type {InlineResponse2003Links} + * @memberof InlineResponse2004 */ - cves_with_rule?: number; + links: InlineResponse2003Links; /** * - * @type {number} - * @memberof DashbarOut + * @type {object} + * @memberof InlineResponse2004 */ - critical_cves?: number; + meta: object; +} +/** + * + * @export + * @interface InlineResponse2005 + */ +export interface InlineResponse2005 { + /** + * List of updated objects/updated object IDs. + * @type {Array} + * @memberof InlineResponse2005 + */ + updated: Array; /** * - * @type {number} - * @memberof DashbarOut + * @type {InlineResponse2002Meta} + * @memberof InlineResponse2005 */ - important_cves?: number; + meta?: InlineResponse2002Meta; } /** * * @export - * @interface Dashboard + * @interface InlineResponse2006 */ -export interface Dashboard { +export interface InlineResponse2006 { /** * Number of unique CVEs discovered on the managed systems. * @type {number} - * @memberof Dashboard + * @memberof InlineResponse2006 */ cves_total: number; /** * - * @type {DashboardCvesBySeverity} - * @memberof Dashboard + * @type {InlineResponse2006CvesBySeverity} + * @memberof InlineResponse2006 */ - cves_by_severity: DashboardCvesBySeverity; + cves_by_severity: InlineResponse2006CvesBySeverity; /** * - * @type {ExecutiveReportRecentCves} - * @memberof Dashboard + * @type {InlineResponse2006RecentCves} + * @memberof InlineResponse2006 */ - recent_cves: ExecutiveReportRecentCves; + recent_cves: InlineResponse2006RecentCves; /** * List of recently (14 days) released security rules. - * @type {Array} - * @memberof Dashboard + * @type {Array} + * @memberof InlineResponse2006 */ - recent_rules: Array; + recent_rules: Array; /** * Total number of CVEs with associated security rules affecting given account. * @type {number} - * @memberof Dashboard + * @memberof InlineResponse2006 */ rules_cves_total: number; /** * Total systems registered to Vulnerability service (with applied filtering). * @type {number} - * @memberof Dashboard + * @memberof InlineResponse2006 */ system_count: number; /** * unique number of CVEs having known exploit affecting at least one system * @type {number} - * @memberof Dashboard + * @memberof InlineResponse2006 */ exploited_cves_count: number; } /** * Number of CVEs discovered on the managed systems, divided into buckets based on their CVSSv3 score (CVSSv2 is used when CVSSv3 is not available). * @export - * @interface DashboardCvesBySeverity + * @interface InlineResponse2006CvesBySeverity */ -export interface DashboardCvesBySeverity { +export interface InlineResponse2006CvesBySeverity { /** * - * @type {DashboardCvesBySeverity0to39} - * @memberof DashboardCvesBySeverity + * @type {InlineResponse2006CvesBySeverity0to39} + * @memberof InlineResponse2006CvesBySeverity */ - _0to3_9: DashboardCvesBySeverity0to39; + _0to3_9: InlineResponse2006CvesBySeverity0to39; /** * - * @type {DashboardCvesBySeverity4to79} - * @memberof DashboardCvesBySeverity + * @type {InlineResponse2006CvesBySeverity4to79} + * @memberof InlineResponse2006CvesBySeverity */ - _4to7_9: DashboardCvesBySeverity4to79; + _4to7_9: InlineResponse2006CvesBySeverity4to79; /** * - * @type {DashboardCvesBySeverity8to10} - * @memberof DashboardCvesBySeverity + * @type {InlineResponse2006CvesBySeverity8to10} + * @memberof InlineResponse2006CvesBySeverity */ - _8to10: DashboardCvesBySeverity8to10; + _8to10: InlineResponse2006CvesBySeverity8to10; } /** * * @export - * @interface DashboardCvesBySeverity0to39 + * @interface InlineResponse2006CvesBySeverity0to39 */ -export interface DashboardCvesBySeverity0to39 { +export interface InlineResponse2006CvesBySeverity0to39 { /** * Number of CVEs with CVSS score lower than 4. * @type {number} - * @memberof DashboardCvesBySeverity0to39 + * @memberof InlineResponse2006CvesBySeverity0to39 */ count: number; /** * Percentage of CVEs with CVSS score lower than 4. * @type {number} - * @memberof DashboardCvesBySeverity0to39 + * @memberof InlineResponse2006CvesBySeverity0to39 */ percentage: number; /** * Number of CVEs in given bracket with a known exploit. * @type {number} - * @memberof DashboardCvesBySeverity0to39 + * @memberof InlineResponse2006CvesBySeverity0to39 */ known_exploits?: number; } /** * * @export - * @interface DashboardCvesBySeverity4to79 + * @interface InlineResponse2006CvesBySeverity4to79 */ -export interface DashboardCvesBySeverity4to79 { +export interface InlineResponse2006CvesBySeverity4to79 { /** * Number of CVEs with CVSS score higher or equal to 4 and lower then 8. * @type {number} - * @memberof DashboardCvesBySeverity4to79 + * @memberof InlineResponse2006CvesBySeverity4to79 */ count: number; /** * Percentage of CVEs with CVSS score higher or equal to 4 and lower then 8. * @type {number} - * @memberof DashboardCvesBySeverity4to79 + * @memberof InlineResponse2006CvesBySeverity4to79 */ percentage: number; /** * Number of CVEs in given bracket with a known exploit. * @type {number} - * @memberof DashboardCvesBySeverity4to79 + * @memberof InlineResponse2006CvesBySeverity4to79 */ known_exploits?: number; } /** * * @export - * @interface DashboardCvesBySeverity8to10 + * @interface InlineResponse2006CvesBySeverity8to10 */ -export interface DashboardCvesBySeverity8to10 { +export interface InlineResponse2006CvesBySeverity8to10 { /** * Number of CVEs with CVSS score higher or equal to 8. * @type {number} - * @memberof DashboardCvesBySeverity8to10 + * @memberof InlineResponse2006CvesBySeverity8to10 */ count: number; /** * Percentage of CVEs with CVSS score higher or equal to 8. * @type {number} - * @memberof DashboardCvesBySeverity8to10 + * @memberof InlineResponse2006CvesBySeverity8to10 */ percentage: number; /** * Number of CVEs in given bracket with a known exploit. * @type {number} - * @memberof DashboardCvesBySeverity8to10 + * @memberof InlineResponse2006CvesBySeverity8to10 */ known_exploits?: number; } +/** + * Number of recently published CVEs identified on managed systems + * @export + * @interface InlineResponse2006RecentCves + */ +export interface InlineResponse2006RecentCves { + /** + * Number of CVEs identified on managed systems published in last 7 days. + * @type {number} + * @memberof InlineResponse2006RecentCves + */ + last7days: number; + /** + * Number of CVEs identified on managed systems published in last 30 days. + * @type {number} + * @memberof InlineResponse2006RecentCves + */ + last30days: number; + /** + * Number of CVEs identified on managed systems published in last 90 days. + * @type {number} + * @memberof InlineResponse2006RecentCves + */ + last90days: number; +} /** * Security rule. * @export - * @interface DashboardRecentRules + * @interface InlineResponse2006RecentRules */ -export interface DashboardRecentRules { +export interface InlineResponse2006RecentRules { /** * List of CVEs associated with the security rule. * @type {Array} - * @memberof DashboardRecentRules + * @memberof InlineResponse2006RecentRules */ associated_cves?: Array; /** * Description of the issue related with the security rule. * @type {string} - * @memberof DashboardRecentRules + * @memberof InlineResponse2006RecentRules */ description?: string; /** * ID of the security rule. * @type {string} - * @memberof DashboardRecentRules + * @memberof InlineResponse2006RecentRules */ id?: string; /** * Name of the security rule. * @type {string} - * @memberof DashboardRecentRules + * @memberof InlineResponse2006RecentRules */ name?: string; /** * Node id of access.redhat.com/node/_* article. * @type {number} - * @memberof DashboardRecentRules + * @memberof InlineResponse2006RecentRules */ node_id?: number | null; /** * String representation of ISO-8601 formatted date of release of the security rule. * @type {string} - * @memberof DashboardRecentRules + * @memberof InlineResponse2006RecentRules */ public_date?: string | null; /** * Number representation of the security rule severity. * @type {number} - * @memberof DashboardRecentRules + * @memberof InlineResponse2006RecentRules */ severity?: number; /** * Number of systems triggering the security rule. * @type {number} - * @memberof DashboardRecentRules + * @memberof InlineResponse2006RecentRules */ systems_affected?: number; } /** * * @export - * @interface Errors + * @interface InlineResponse2007 */ -export interface Errors { +export interface InlineResponse2007 { /** * - * @type {Array} - * @memberof Errors + * @type {Array} + * @memberof InlineResponse2007 */ - errors: Array; + data?: Array; } /** * * @export - * @interface ErrorsErrors + * @interface InlineResponse2007Data */ -export interface ErrorsErrors { +export interface InlineResponse2007Data { /** - * - * @type {string | object} - * @memberof ErrorsErrors + * Playbook template description. + * @type {string} + * @memberof InlineResponse2007Data */ - detail: string | object; + description: string; /** - * String representation of HTTP status code. + * Actual playbook template. * @type {string} - * @memberof ErrorsErrors + * @memberof InlineResponse2007Data */ - status: string; + play: string; + /** + * Revision of the playbook template. + * @type {string} + * @memberof InlineResponse2007Data + */ + version: string; + /** + * Indicator whter reboot is required to mitigate vulnerability. + * @type {boolean} + * @memberof InlineResponse2007Data + */ + reboot_required?: boolean | null; + /** + * Type of the resolution provided by playbook. + * @type {string} + * @memberof InlineResponse2007Data + */ + resolution_type: string; } /** * * @export - * @interface ExecutiveReport + * @interface InlineResponse2008 */ -export interface ExecutiveReport { +export interface InlineResponse2008 { /** * - * @type {MetaVulnerabilitiesOutAllOfSystemCountPerType} - * @memberof ExecutiveReport + * @type {InlineResponse2008SystemCountPerType} + * @memberof InlineResponse2008 */ - system_count_per_type?: MetaVulnerabilitiesOutAllOfSystemCountPerType; + system_count_per_type?: InlineResponse2008SystemCountPerType; /** * Total number of systems managed by vulnerability application. * @type {number} - * @memberof ExecutiveReport + * @memberof InlineResponse2008 */ system_count: number; /** * Number of unique CVEs discovered on the managed systems. * @type {number} - * @memberof ExecutiveReport + * @memberof InlineResponse2008 */ cves_total: number; /** * - * @type {ExecutiveReportCvesBySeverity} - * @memberof ExecutiveReport + * @type {InlineResponse2008CvesBySeverity} + * @memberof InlineResponse2008 */ - cves_by_severity: ExecutiveReportCvesBySeverity; + cves_by_severity: InlineResponse2008CvesBySeverity; /** * - * @type {ExecutiveReportRecentCves} - * @memberof ExecutiveReport + * @type {InlineResponse2006RecentCves} + * @memberof InlineResponse2008 */ - recent_cves: ExecutiveReportRecentCves; + recent_cves: InlineResponse2006RecentCves; /** * - * @type {ExecutiveReportRulesBySeverity} - * @memberof ExecutiveReport + * @type {InlineResponse2008RulesBySeverity} + * @memberof InlineResponse2008 */ - rules_by_severity: ExecutiveReportRulesBySeverity; + rules_by_severity: InlineResponse2008RulesBySeverity; /** * Number of unique CVEs discovered on the managed systems. * @type {number} - * @memberof ExecutiveReport + * @memberof InlineResponse2008 */ rules_total: number; /** * - * @type {Array} - * @memberof ExecutiveReport + * @type {Array} + * @memberof InlineResponse2008 */ - top_cves?: Array; + top_cves?: Array; /** * - * @type {Array} - * @memberof ExecutiveReport + * @type {Array} + * @memberof InlineResponse2008 */ - top_rules?: Array; + top_rules?: Array; /** * - * @type {MetaPermissions} - * @memberof ExecutiveReport + * @type {InlineResponse2002Meta} + * @memberof InlineResponse2008 */ - meta?: MetaPermissions; + meta?: InlineResponse2002Meta; } /** * Number of CVEs discovered on the managed systems, divided into buckets based on their CVSSv3 score (CVSSv2 is used when CVSSv3 is not available). * @export - * @interface ExecutiveReportCvesBySeverity + * @interface InlineResponse2008CvesBySeverity */ -export interface ExecutiveReportCvesBySeverity { +export interface InlineResponse2008CvesBySeverity { /** * - * @type {ExecutiveReportCvesBySeverity0to39} - * @memberof ExecutiveReportCvesBySeverity + * @type {InlineResponse2008CvesBySeverity0to39} + * @memberof InlineResponse2008CvesBySeverity */ - _0to3_9: ExecutiveReportCvesBySeverity0to39; + _0to3_9: InlineResponse2008CvesBySeverity0to39; /** * - * @type {ExecutiveReportCvesBySeverity4to79} - * @memberof ExecutiveReportCvesBySeverity + * @type {InlineResponse2008CvesBySeverity4to79} + * @memberof InlineResponse2008CvesBySeverity */ - _4to7_9: ExecutiveReportCvesBySeverity4to79; + _4to7_9: InlineResponse2008CvesBySeverity4to79; /** * - * @type {ExecutiveReportCvesBySeverity8to10} - * @memberof ExecutiveReportCvesBySeverity + * @type {InlineResponse2008CvesBySeverity8to10} + * @memberof InlineResponse2008CvesBySeverity */ - _8to10: ExecutiveReportCvesBySeverity8to10; + _8to10: InlineResponse2008CvesBySeverity8to10; } /** * * @export - * @interface ExecutiveReportCvesBySeverity0to39 + * @interface InlineResponse2008CvesBySeverity0to39 */ -export interface ExecutiveReportCvesBySeverity0to39 { +export interface InlineResponse2008CvesBySeverity0to39 { /** * Number of CVEs with CVSS score lower than 4. * @type {number} - * @memberof ExecutiveReportCvesBySeverity0to39 + * @memberof InlineResponse2008CvesBySeverity0to39 */ count: number; /** * Percentage of CVEs with CVSS score lower than 4. * @type {number} - * @memberof ExecutiveReportCvesBySeverity0to39 + * @memberof InlineResponse2008CvesBySeverity0to39 */ percentage: number; } /** * * @export - * @interface ExecutiveReportCvesBySeverity4to79 + * @interface InlineResponse2008CvesBySeverity4to79 */ -export interface ExecutiveReportCvesBySeverity4to79 { +export interface InlineResponse2008CvesBySeverity4to79 { /** * Number of CVEs with CVSS score higher or equal to 4 and lower then 8. * @type {number} - * @memberof ExecutiveReportCvesBySeverity4to79 + * @memberof InlineResponse2008CvesBySeverity4to79 */ count: number; /** * Percentage of CVEs with CVSS score higher or equal to 4 and lower then 8. * @type {number} - * @memberof ExecutiveReportCvesBySeverity4to79 + * @memberof InlineResponse2008CvesBySeverity4to79 */ percentage: number; } /** * * @export - * @interface ExecutiveReportCvesBySeverity8to10 + * @interface InlineResponse2008CvesBySeverity8to10 */ -export interface ExecutiveReportCvesBySeverity8to10 { +export interface InlineResponse2008CvesBySeverity8to10 { /** * Number of CVEs with CVSS score higher or equal to 8. * @type {number} - * @memberof ExecutiveReportCvesBySeverity8to10 + * @memberof InlineResponse2008CvesBySeverity8to10 */ count: number; /** * Percentage of CVEs with CVSS score higher or equal to 8. * @type {number} - * @memberof ExecutiveReportCvesBySeverity8to10 + * @memberof InlineResponse2008CvesBySeverity8to10 */ percentage: number; } -/** - * Number of recently published CVEs identified on managed systems - * @export - * @interface ExecutiveReportRecentCves - */ -export interface ExecutiveReportRecentCves { - /** - * Number of CVEs identified on managed systems published in last 7 days. - * @type {number} - * @memberof ExecutiveReportRecentCves - */ - last7days: number; - /** - * Number of CVEs identified on managed systems published in last 30 days. - * @type {number} - * @memberof ExecutiveReportRecentCves - */ - last30days: number; - /** - * Number of CVEs identified on managed systems published in last 90 days. - * @type {number} - * @memberof ExecutiveReportRecentCves - */ - last90days: number; -} /** * Information about how much systems are affected by a security rule, broken down by rule severity. * @export - * @interface ExecutiveReportRulesBySeverity + * @interface InlineResponse2008RulesBySeverity */ -export interface ExecutiveReportRulesBySeverity { +export interface InlineResponse2008RulesBySeverity { /** * - * @type {ExecutiveReportRulesBySeverity1} - * @memberof ExecutiveReportRulesBySeverity + * @type {InlineResponse2008RulesBySeverity1} + * @memberof InlineResponse2008RulesBySeverity */ - _1: ExecutiveReportRulesBySeverity1; + _1: InlineResponse2008RulesBySeverity1; /** * - * @type {ExecutiveReportRulesBySeverity1} - * @memberof ExecutiveReportRulesBySeverity + * @type {InlineResponse2008RulesBySeverity1} + * @memberof InlineResponse2008RulesBySeverity */ - _2: ExecutiveReportRulesBySeverity1; + _2: InlineResponse2008RulesBySeverity1; /** * - * @type {ExecutiveReportRulesBySeverity1} - * @memberof ExecutiveReportRulesBySeverity + * @type {InlineResponse2008RulesBySeverity1} + * @memberof InlineResponse2008RulesBySeverity */ - _3: ExecutiveReportRulesBySeverity1; + _3: InlineResponse2008RulesBySeverity1; /** * - * @type {ExecutiveReportRulesBySeverity1} - * @memberof ExecutiveReportRulesBySeverity + * @type {InlineResponse2008RulesBySeverity1} + * @memberof InlineResponse2008RulesBySeverity */ - _4: ExecutiveReportRulesBySeverity1; + _4: InlineResponse2008RulesBySeverity1; } /** * * @export - * @interface ExecutiveReportRulesBySeverity1 + * @interface InlineResponse2008RulesBySeverity1 */ -export interface ExecutiveReportRulesBySeverity1 { +export interface InlineResponse2008RulesBySeverity1 { /** * How many unique rules with at least system affected are present. * @type {number} - * @memberof ExecutiveReportRulesBySeverity1 + * @memberof InlineResponse2008RulesBySeverity1 */ rule_count: number; /** * How many unique systems are affected by at least one rules with given severity * @type {number} - * @memberof ExecutiveReportRulesBySeverity1 + * @memberof InlineResponse2008RulesBySeverity1 */ systems_affected: number; } +/** + * Number of systems managed by vulnerability application, grouped by host type. + * @export + * @interface InlineResponse2008SystemCountPerType + */ +export interface InlineResponse2008SystemCountPerType { + /** + * Number of conventional systems. + * @type {number} + * @memberof InlineResponse2008SystemCountPerType + */ + rpmdnf?: number; + /** + * Number of image-mode systems. + * @type {number} + * @memberof InlineResponse2008SystemCountPerType + */ + image?: number | null; + /** + * Number of image-mode systems. (Deprecated) + * @type {number} + * @memberof InlineResponse2008SystemCountPerType + */ + edge?: number | null; +} /** * * @export - * @interface ExecutiveReportTopCves + * @interface InlineResponse2008TopCves */ -export interface ExecutiveReportTopCves { +export interface InlineResponse2008TopCves { /** * CVE synopsis * @type {string} - * @memberof ExecutiveReportTopCves + * @memberof InlineResponse2008TopCves */ synopsis: string; /** * String representation of cvss2 score of the CVE. * @type {string} - * @memberof ExecutiveReportTopCves + * @memberof InlineResponse2008TopCves */ cvss2_score: string | null; /** * String representation of cvss3 score of the CVE. * @type {string} - * @memberof ExecutiveReportTopCves + * @memberof InlineResponse2008TopCves */ cvss3_score: string | null; /** * Description of the CVE. * @type {string} - * @memberof ExecutiveReportTopCves + * @memberof InlineResponse2008TopCves */ description: string; /** * Indicator of security rule presence * @type {boolean} - * @memberof ExecutiveReportTopCves + * @memberof InlineResponse2008TopCves */ security_rule?: boolean; /** * Indicator of security rule presence * @type {boolean} - * @memberof ExecutiveReportTopCves + * @memberof InlineResponse2008TopCves */ rule_presence?: boolean; /** * Systems affected by the CVE. * @type {number} - * @memberof ExecutiveReportTopCves + * @memberof InlineResponse2008TopCves */ systems_affected: number; /** * Shows whether a CVE has known exploits or not * @type {boolean} - * @memberof ExecutiveReportTopCves + * @memberof InlineResponse2008TopCves */ known_exploit: boolean; } /** * * @export - * @interface ExecutiveReportTopRules + * @interface InlineResponse2008TopRules */ -export interface ExecutiveReportTopRules { +export interface InlineResponse2008TopRules { /** * All CVEs associated with the rule * @type {Array} - * @memberof ExecutiveReportTopRules + * @memberof InlineResponse2008TopRules */ associated_cves: Array; /** * Brief description of the issue. * @type {string} - * @memberof ExecutiveReportTopRules + * @memberof InlineResponse2008TopRules */ description: string; /** * ID of associated security rule. * @type {string} - * @memberof ExecutiveReportTopRules + * @memberof InlineResponse2008TopRules */ rule_id: string; /** * Name of the security rule. * @type {string} - * @memberof ExecutiveReportTopRules + * @memberof InlineResponse2008TopRules */ name: string; /** * Severity of the security rule. * @type {number} - * @memberof ExecutiveReportTopRules + * @memberof InlineResponse2008TopRules */ severity: number; /** * Number of systems affected by the rule. * @type {number} - * @memberof ExecutiveReportTopRules + * @memberof InlineResponse2008TopRules */ systems_affected: number; } +/** + * + * @export + * @interface InlineResponse2009 + */ +export interface InlineResponse2009 { + /** + * + * @type {string | Array} + * @memberof InlineResponse2009 + */ + data: string | Array; +} +/** + * + * @export + * @interface InlineResponse404 + */ +export interface InlineResponse404 { + /** + * + * @type {Array} + * @memberof InlineResponse404 + */ + errors: Array; +} +/** + * + * @export + * @interface InlineResponse404Errors + */ +export interface InlineResponse404Errors { + /** + * + * @type {string | object} + * @memberof InlineResponse404Errors + */ + detail: string | object; + /** + * String representation of HTTP status code. + * @type {string} + * @memberof InlineResponse404Errors + */ + status: string; +} /** * * @export @@ -1656,7 +2785,7 @@ export interface MetaCvesAllOf { * @export * @interface MetaCvesSystems */ -export interface MetaCvesSystems { +export interface MetaCvesSystems extends MetaCvesSystemsAllOf { /** * Full text filter * @type {string} @@ -1789,12 +2918,6 @@ export interface MetaCvesSystems { * @memberof MetaCvesSystems */ cves_without_errata: boolean | null; - /** - * If given system was opted out. - * @type {boolean} - * @memberof MetaCvesSystems - */ - opt_out: boolean; } /** * @@ -2030,10 +3153,10 @@ export interface MetaVulnerabilitiesOut { impact: string | null; /** * - * @type {MetaVulnerabilitiesOutAllOfSystemCountPerType} + * @type {InlineResponse2008SystemCountPerType} * @memberof MetaVulnerabilitiesOut */ - system_count_per_type?: MetaVulnerabilitiesOutAllOfSystemCountPerType; + system_count_per_type?: InlineResponse2008SystemCountPerType; /** * Total number of systems managed by vulnerability application. * @type {number} @@ -2078,115 +3201,151 @@ export interface MetaVulnerabilitiesOut { */ export interface MetaVulnerabilitiesOutAllOf { /** - * Description of CVE showing preferences + * Full text filter + * @type {string} + * @memberof MetaVulnerabilitiesOutAllOf + */ + filter: string | null; + /** + * Maximum number of paginated results. + * @type {number} + * @memberof MetaVulnerabilitiesOutAllOf + */ + limit: number; + /** + * First record of paginated response. + * @type {number} + * @memberof MetaVulnerabilitiesOutAllOf + */ + offset: number; + /** + * Page number of paginated response. + * @type {number} + * @memberof MetaVulnerabilitiesOutAllOf + */ + page: number; + /** + * Number of records per page of paginated response. + * @type {number} + * @memberof MetaVulnerabilitiesOutAllOf + */ + page_size: number; + /** + * Total number of pages of paginated response. + * @type {number} + * @memberof MetaVulnerabilitiesOutAllOf + */ + pages: number; + /** + * Sorting filter. + * @type {string} + * @memberof MetaVulnerabilitiesOutAllOf + */ + sort: string | null; + /** + * Total number of records. + * @type {number} + * @memberof MetaVulnerabilitiesOutAllOf + */ + total_items: number; + /** + * Format of the output data, either JSON (default) or CSV. * @type {string} * @memberof MetaVulnerabilitiesOutAllOf */ + data_format: string; +} +/** + * + * @export + * @interface MetaVulnerabilitiesOutAllOf1 + */ +export interface MetaVulnerabilitiesOutAllOf1 { + /** + * Description of CVE showing preferences + * @type {string} + * @memberof MetaVulnerabilitiesOutAllOf1 + */ affecting: string | null; /** * Filter based on business risk IDs. * @type {string} - * @memberof MetaVulnerabilitiesOutAllOf + * @memberof MetaVulnerabilitiesOutAllOf1 */ business_risk_id: string | null; /** * Filter based on cvss score, starting from the value. Use -1 to include also CVEs with N/A cvss score. * @type {number} - * @memberof MetaVulnerabilitiesOutAllOf + * @memberof MetaVulnerabilitiesOutAllOf1 */ cvss_from: number | null; /** * Filter based on cvss score, up to the value. * @type {number} - * @memberof MetaVulnerabilitiesOutAllOf + * @memberof MetaVulnerabilitiesOutAllOf1 */ cvss_to: number | null; /** * Filter CVEs based on their published date, starting from the date. * @type {string} - * @memberof MetaVulnerabilitiesOutAllOf + * @memberof MetaVulnerabilitiesOutAllOf1 */ public_from: string | null; /** * Filter CVEs based on their published date, up to the date. * @type {string} - * @memberof MetaVulnerabilitiesOutAllOf + * @memberof MetaVulnerabilitiesOutAllOf1 */ public_to: string | null; /** * Filter based on impact IDs. * @type {string} - * @memberof MetaVulnerabilitiesOutAllOf + * @memberof MetaVulnerabilitiesOutAllOf1 */ impact: string | null; /** * - * @type {MetaVulnerabilitiesOutAllOfSystemCountPerType} - * @memberof MetaVulnerabilitiesOutAllOf + * @type {InlineResponse2008SystemCountPerType} + * @memberof MetaVulnerabilitiesOutAllOf1 */ - system_count_per_type?: MetaVulnerabilitiesOutAllOfSystemCountPerType; + system_count_per_type?: InlineResponse2008SystemCountPerType; /** * Total number of systems managed by vulnerability application. * @type {number} - * @memberof MetaVulnerabilitiesOutAllOf + * @memberof MetaVulnerabilitiesOutAllOf1 */ system_count?: number; /** * Filter base on system RHEL version. * @type {string} - * @memberof MetaVulnerabilitiesOutAllOf + * @memberof MetaVulnerabilitiesOutAllOf1 */ rhel_version: string | null; /** * Filter based on presence of security rule * @type {string} - * @memberof MetaVulnerabilitiesOutAllOf + * @memberof MetaVulnerabilitiesOutAllOf1 */ rule_presence: string | null; /** * CVEs without Errata feature flag * @type {boolean} - * @memberof MetaVulnerabilitiesOutAllOf + * @memberof MetaVulnerabilitiesOutAllOf1 */ cves_without_errata: boolean | null; /** * Shows whether a CVE has available advisory or not * @type {string} - * @memberof MetaVulnerabilitiesOutAllOf + * @memberof MetaVulnerabilitiesOutAllOf1 */ advisory_available: string | null; /** * Flag if cached data was used to produce the response. * @type {boolean} - * @memberof MetaVulnerabilitiesOutAllOf + * @memberof MetaVulnerabilitiesOutAllOf1 */ cache_used: boolean; } -/** - * Number of systems managed by vulnerability application, grouped by host type. - * @export - * @interface MetaVulnerabilitiesOutAllOfSystemCountPerType - */ -export interface MetaVulnerabilitiesOutAllOfSystemCountPerType { - /** - * Number of conventional systems. - * @type {number} - * @memberof MetaVulnerabilitiesOutAllOfSystemCountPerType - */ - rpmdnf?: number; - /** - * Number of image-mode systems. - * @type {number} - * @memberof MetaVulnerabilitiesOutAllOfSystemCountPerType - */ - image?: number | null; - /** - * Number of image-mode systems. (Deprecated) - * @type {number} - * @memberof MetaVulnerabilitiesOutAllOfSystemCountPerType - */ - edge?: number | null; -} /** * * @export @@ -2221,66 +3380,29 @@ export interface OSExposureReport { export interface OptOutIn { /** * - * @type {InventoryIdOrList} + * @type {string | Array} * @memberof OptOutIn */ - inventory_id: InventoryIdOrList; + inventory_id: string | Array; /** * Opt out setting to be set. * @type {boolean} * @memberof OptOutIn */ - opt_out: boolean; -} -/** - * - * @export - * @interface PlaybookTemplate - */ -export interface PlaybookTemplate { - /** - * - * @type {Array} - * @memberof PlaybookTemplate - */ - data?: Array; + opt_out: boolean; } /** * * @export - * @interface PlaybookTemplateData + * @interface PlaybookTemplate */ -export interface PlaybookTemplateData { - /** - * Playbook template description. - * @type {string} - * @memberof PlaybookTemplateData - */ - description: string; - /** - * Actual playbook template. - * @type {string} - * @memberof PlaybookTemplateData - */ - play: string; - /** - * Revision of the playbook template. - * @type {string} - * @memberof PlaybookTemplateData - */ - version: string; - /** - * Indicator whter reboot is required to mitigate vulnerability. - * @type {boolean} - * @memberof PlaybookTemplateData - */ - reboot_required?: boolean | null; +export interface PlaybookTemplate { /** - * Type of the resolution provided by playbook. - * @type {string} - * @memberof PlaybookTemplateData + * + * @type {Array} + * @memberof PlaybookTemplate */ - resolution_type: string; + data?: Array; } /** * @@ -2290,16 +3412,16 @@ export interface PlaybookTemplateData { export interface StatusIn { /** * - * @type {InventoryIdOrList} + * @type {string | Array} * @memberof StatusIn */ - inventory_id?: InventoryIdOrList; + inventory_id?: string | Array; /** * - * @type {CveOrList} + * @type {string | Array} * @memberof StatusIn */ - cve: CveOrList; + cve: string | Array; /** * Status ID to be set, obtained by GET method. If not specified, global CVE status is set. * @type {number} @@ -2321,48 +3443,16 @@ export interface StatusIn { export interface StatusListOut { /** * List of available status/status_id pairs. - * @type {Array} + * @type {Array} * @memberof StatusListOut */ - data: Array; + data: Array; /** * - * @type {StatusListOutMeta} + * @type {InlineResponse20010Meta} * @memberof StatusListOut */ - meta: StatusListOutMeta; -} -/** - * - * @export - * @interface StatusListOutData - */ -export interface StatusListOutData { - /** - * Internal status_id. - * @type {number} - * @memberof StatusListOutData - */ - id: number; - /** - * Represenation of internal status_id. - * @type {string} - * @memberof StatusListOutData - */ - name: string; -} -/** - * - * @export - * @interface StatusListOutMeta - */ -export interface StatusListOutMeta { - /** - * Total number of available status/status_id pairs. - * @type {number} - * @memberof StatusListOutMeta - */ - total_items: number; + meta: InlineResponse20010Meta; } /** * @@ -2372,35 +3462,16 @@ export interface StatusListOutMeta { export interface StatusOut { /** * List of updated objects/updated object IDs. - * @type {Array} + * @type {Array} * @memberof StatusOut */ - updated: Array; + updated: Array; /** * - * @type {MetaPermissions} + * @type {InlineResponse2002Meta} * @memberof StatusOut */ - meta?: MetaPermissions; -} -/** - * - * @export - * @interface StatusOutUpdated - */ -export interface StatusOutUpdated { - /** - * - * @type {string} - * @memberof StatusOutUpdated - */ - inventory_id: string; - /** - * - * @type {string} - * @memberof StatusOutUpdated - */ - cve: string; + meta?: InlineResponse2002Meta; } /** * @@ -2416,16 +3487,16 @@ export interface SystemCvesIdsOut { data: string | Array; /** * - * @type {Links} + * @type {InlineResponse2003Links} * @memberof SystemCvesIdsOut */ - links: Links; + links: InlineResponse2003Links; /** * - * @type {MetaCves} + * @type {object} * @memberof SystemCvesIdsOut */ - meta: MetaCves; + meta: object; } /** * @@ -2441,16 +3512,16 @@ export interface SystemCvesOut { data: string | Array; /** * - * @type {Links} + * @type {InlineResponse2003Links} * @memberof SystemCvesOut */ - links: Links; + links: InlineResponse2003Links; /** * - * @type {MetaCves} + * @type {object} * @memberof SystemCvesOut */ - meta: MetaCves; + meta: object; } /** * @@ -2460,118 +3531,16 @@ export interface SystemCvesOut { export interface SystemDetailsOut { /** * - * @type {SystemDetailsOutData} + * @type {InlineResponse20014Data} * @memberof SystemDetailsOut */ - data: SystemDetailsOutData; + data: InlineResponse20014Data; /** * - * @type {MetaPermissions} + * @type {InlineResponse2002Meta} * @memberof SystemDetailsOut */ - meta: MetaPermissions; -} -/** - * - * @export - * @interface SystemDetailsOutData - */ -export interface SystemDetailsOutData { - /** - * Date of last evaluation. - * @type {string} - * @memberof SystemDetailsOutData - */ - last_evaluation: string | null; - /** - * Date of last security rules evaluation. - * @type {string} - * @memberof SystemDetailsOutData - */ - rules_evaluation: string | null; - /** - * System opt out status. - * @type {boolean} - * @memberof SystemDetailsOutData - */ - opt_out: boolean; - /** - * Date of the latest upload of archive. - * @type {string} - * @memberof SystemDetailsOutData - */ - last_upload: string | null; - /** - * System stale status. - * @type {boolean} - * @memberof SystemDetailsOutData - */ - stale?: boolean; - /** - * Date of the lastest upload of archive taken from Inventory syndicated data. - * @type {string} - * @memberof SystemDetailsOutData - */ - updated?: string | null; - /** - * Operating system. - * @type {string} - * @memberof SystemDetailsOutData - */ - os: string; - /** - * System is locked to following RHSM version. - * @type {string} - * @memberof SystemDetailsOutData - */ - rhsm_lock: string | null; - /** - * - * @type {Array} - * @memberof SystemDetailsOutData - */ - tags: Array; - /** - * Type of the host - * @type {string} - * @memberof SystemDetailsOutData - */ - host_type: SystemDetailsOutDataHostTypeEnum; -} - -/** - * @export - * @enum {string} - */ -export enum SystemDetailsOutDataHostTypeEnum { - Rpmdnf = 'rpmdnf', - Image = 'image' -} - -/** - * - * @export - * @interface SystemDetailsOutDataTags - */ -export interface SystemDetailsOutDataTags { - /** - * Namespace of single tag. - * @type {string} - * @memberof SystemDetailsOutDataTags - */ - namespace: string | null; - /** - * Key of the single tag. - * @type {string} - * @memberof SystemDetailsOutDataTags - */ - key: string; - /** - * Value of the single tag. - * @type {string} - * @memberof SystemDetailsOutDataTags - */ - value: string | null; + meta: InlineResponse2002Meta; } /** * @@ -2587,16 +3556,16 @@ export interface SystemIdsOut { data: string | Array; /** * - * @type {Links} + * @type {InlineResponse2003Links} * @memberof SystemIdsOut */ - links: Links; + links: InlineResponse2003Links; /** * - * @type {MetaSystems} + * @type {object} * @memberof SystemIdsOut */ - meta: MetaSystems; + meta: object; } /** * @@ -2612,16 +3581,16 @@ export interface SystemListOut { data: string | Array; /** * - * @type {Links} + * @type {InlineResponse2003Links} * @memberof SystemListOut */ - links: Links; + links: InlineResponse2003Links; /** * - * @type {MetaSystems} + * @type {object} * @memberof SystemListOut */ - meta: MetaSystems; + meta: object; } /** * @@ -2656,16 +3625,16 @@ export interface VulnerabilitiesIdsOut { data: string | Array; /** * - * @type {Links} + * @type {InlineResponse2003Links} * @memberof VulnerabilitiesIdsOut */ - links: Links; + links: InlineResponse2003Links; /** * - * @type {MetaVulnerabilitiesOut} + * @type {object} * @memberof VulnerabilitiesIdsOut */ - meta: MetaVulnerabilitiesOut; + meta: object; } /** * @@ -2681,16 +3650,16 @@ export interface VulnerabilitiesOut { data: string | Array; /** * - * @type {Links} + * @type {InlineResponse2003Links} * @memberof VulnerabilitiesOut */ - links: Links; + links: InlineResponse2003Links; /** * - * @type {MetaVulnerabilitiesOut} + * @type {object} * @memberof VulnerabilitiesOut */ - meta: MetaVulnerabilitiesOut; + meta: object; } /** * @@ -2713,72 +3682,22 @@ export interface VulnerabilitiesPostIn { export interface VulnerabilitiesPostOut { /** * - * @type {Array} + * @type {Array} * @memberof VulnerabilitiesPostOut */ - data: Array; + data: Array; /** * - * @type {Links} + * @type {InlineResponse2003Links} * @memberof VulnerabilitiesPostOut */ - links: Links; + links: InlineResponse2003Links; /** * - * @type {Meta & MetaPermissions} + * @type {object} * @memberof VulnerabilitiesPostOut */ - meta: Meta & MetaPermissions; -} -/** - * - * @export - * @interface VulnerabilitiesPostOutAttributes - */ -export interface VulnerabilitiesPostOutAttributes { - /** - * String representation of cvss3 or cvvs2 (if v3 is not present) score of the CVE. - * @type {string} - * @memberof VulnerabilitiesPostOutAttributes - */ - cvss_score: string | null; - /** - * Red Hat security impact of the CVE. - * @type {string} - * @memberof VulnerabilitiesPostOutAttributes - */ - impact: string; - /** - * Synopsis of the CVE. - * @type {string} - * @memberof VulnerabilitiesPostOutAttributes - */ - synopsis: string; -} -/** - * - * @export - * @interface VulnerabilitiesPostOutData - */ -export interface VulnerabilitiesPostOutData { - /** - * CVE id. - * @type {string} - * @memberof VulnerabilitiesPostOutData - */ - id: string; - /** - * Type of the record. - * @type {string} - * @memberof VulnerabilitiesPostOutData - */ - type: string; - /** - * - * @type {VulnerabilitiesPostOutAttributes} - * @memberof VulnerabilitiesPostOutData - */ - attributes: VulnerabilitiesPostOutAttributes; + meta: object; } /** @@ -4066,7 +4985,7 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati /** * This is an overview of vulnerabilities for specific CVEs provided in the body. Use this endpoint to get a CVSS score, and learn the severity for a list of CVEs provided in the request. * @summary Send a vulnerabilities overview - * @param {VulnerabilitiesPostIn} vulnerabilitiesPostIn List of CVEs to provide info about. + * @param {InlineObject4} inlineObject4 * @param {string} [filter] Full text filter for CVE and it\'s description text. * @param {number} [limit] Maximum number of records per page. Limit/Offset pagination wins over page/page_size pagination. * @param {number} [offset] Offset of first record of paginated response. Limit/Offset pagination wins over page/page_size pagination. @@ -4076,10 +4995,10 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getCveList_1: async (vulnerabilitiesPostIn: VulnerabilitiesPostIn, filter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sort?: string, options: any = {}): Promise => { - // verify required parameter 'vulnerabilitiesPostIn' is not null or undefined - if (vulnerabilitiesPostIn === null || vulnerabilitiesPostIn === undefined) { - throw new RequiredError('vulnerabilitiesPostIn','Required parameter vulnerabilitiesPostIn was null or undefined when calling getCveList_1.'); + getCveList_1: async (inlineObject4: InlineObject4, filter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sort?: string, options: any = {}): Promise => { + // verify required parameter 'inlineObject4' is not null or undefined + if (inlineObject4 === null || inlineObject4 === undefined) { + throw new RequiredError('inlineObject4','Required parameter inlineObject4 was null or undefined when calling getCveList_1.'); } const localVarPath = `/vulnerabilities/cves`; const localVarUrlObj = globalImportUrl.parse(localVarPath, true); @@ -4138,8 +5057,52 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati delete localVarUrlObj.search; let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - const needsSerialization = (typeof vulnerabilitiesPostIn !== "string") || localVarRequestOptions.headers['Content-Type'] === 'application/json'; - localVarRequestOptions.data = needsSerialization ? JSON.stringify(vulnerabilitiesPostIn !== undefined ? vulnerabilitiesPostIn : {}) : (vulnerabilitiesPostIn || ""); + const needsSerialization = (typeof inlineObject4 !== "string") || localVarRequestOptions.headers['Content-Type'] === 'application/json'; + localVarRequestOptions.data = needsSerialization ? JSON.stringify(inlineObject4 !== undefined ? inlineObject4 : {}) : (inlineObject4 || ""); + + return { + url: globalImportUrl.format(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Use this endpoint to get an enablement status of reporting CVEs that do not have advisories (errata) for your customer account. If the feature is disabled, CVEs without advisories will be hidden in outputs of all endpoints. + * @summary Get a feature flag status for CVEs without errata + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getCvesWithoutErrata: async (options: any = {}): Promise => { + const localVarPath = `/feature/cves_without_errata`; + const localVarUrlObj = globalImportUrl.parse(localVarPath, true); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication ApiKeyAuth required + if (configuration && configuration.apiKey) { + const localVarApiKeyValue = typeof configuration.apiKey === 'function' + ? await configuration.apiKey("x-rh-identity") + : await configuration.apiKey; + localVarHeaderParameter["x-rh-identity"] = localVarApiKeyValue; + } + + // authentication BasicAuth required + // http basic authentication required + if (configuration && (configuration.username || configuration.password)) { + localVarRequestOptions["auth"] = { username: configuration.username, password: configuration.password }; + } + + + + localVarUrlObj.query = {...localVarUrlObj.query, ...localVarQueryParameter, ...options.query}; + // fix override query string Detail: https://stackoverflow.com/a/7517673/1077943 + delete localVarUrlObj.search; + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; return { url: globalImportUrl.format(localVarUrlObj), @@ -4842,14 +5805,14 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati /** * This sets a business risk for a specific CVE. Set a value of low, medium, high or critical for a given CVE. These values are obtained by the business risk path *GET/business_risk*. To set a business risk, you must call the GET/business_risk endpoint first, followed by the *PATCH/cves/business_risk* path. * @summary Set business risk for a CVE - * @param {CveRiskIn} cveRiskIn Values to be set. At least one of the \"business_risk_id\" or \"business_risk_text\" parameters is required. + * @param {InlineObject} inlineObject * @param {*} [options] Override http request option. * @throws {RequiredError} */ - setCveBusinessRisk: async (cveRiskIn: CveRiskIn, options: any = {}): Promise => { - // verify required parameter 'cveRiskIn' is not null or undefined - if (cveRiskIn === null || cveRiskIn === undefined) { - throw new RequiredError('cveRiskIn','Required parameter cveRiskIn was null or undefined when calling setCveBusinessRisk.'); + setCveBusinessRisk: async (inlineObject: InlineObject, options: any = {}): Promise => { + // verify required parameter 'inlineObject' is not null or undefined + if (inlineObject === null || inlineObject === undefined) { + throw new RequiredError('inlineObject','Required parameter inlineObject was null or undefined when calling setCveBusinessRisk.'); } const localVarPath = `/cves/business_risk`; const localVarUrlObj = globalImportUrl.parse(localVarPath, true); @@ -4884,8 +5847,8 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati delete localVarUrlObj.search; let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - const needsSerialization = (typeof cveRiskIn !== "string") || localVarRequestOptions.headers['Content-Type'] === 'application/json'; - localVarRequestOptions.data = needsSerialization ? JSON.stringify(cveRiskIn !== undefined ? cveRiskIn : {}) : (cveRiskIn || ""); + const needsSerialization = (typeof inlineObject !== "string") || localVarRequestOptions.headers['Content-Type'] === 'application/json'; + localVarRequestOptions.data = needsSerialization ? JSON.stringify(inlineObject !== undefined ? inlineObject : {}) : (inlineObject || ""); return { url: globalImportUrl.format(localVarUrlObj), @@ -4895,14 +5858,14 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati /** * This sets the status for a specific CVE. Set a status value for a given CVE (e.g. in-review, on-hold, scheduled for a patch, or resolved). These values are obtained by sending a *GET/status* request. To set a status, you must call the *GET/business_risk* first, followed by the *PATCH/cves/status* path. * @summary Set status for a CVE - * @param {CveStatusIn} cveStatusIn Values to be set. At least one of the \"status_id\" or \"status_text\" parameters is required. + * @param {InlineObject1} inlineObject1 * @param {*} [options] Override http request option. * @throws {RequiredError} */ - setCveStatus: async (cveStatusIn: CveStatusIn, options: any = {}): Promise => { - // verify required parameter 'cveStatusIn' is not null or undefined - if (cveStatusIn === null || cveStatusIn === undefined) { - throw new RequiredError('cveStatusIn','Required parameter cveStatusIn was null or undefined when calling setCveStatus.'); + setCveStatus: async (inlineObject1: InlineObject1, options: any = {}): Promise => { + // verify required parameter 'inlineObject1' is not null or undefined + if (inlineObject1 === null || inlineObject1 === undefined) { + throw new RequiredError('inlineObject1','Required parameter inlineObject1 was null or undefined when calling setCveStatus.'); } const localVarPath = `/cves/status`; const localVarUrlObj = globalImportUrl.parse(localVarPath, true); @@ -4937,8 +5900,8 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati delete localVarUrlObj.search; let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - const needsSerialization = (typeof cveStatusIn !== "string") || localVarRequestOptions.headers['Content-Type'] === 'application/json'; - localVarRequestOptions.data = needsSerialization ? JSON.stringify(cveStatusIn !== undefined ? cveStatusIn : {}) : (cveStatusIn || ""); + const needsSerialization = (typeof inlineObject1 !== "string") || localVarRequestOptions.headers['Content-Type'] === 'application/json'; + localVarRequestOptions.data = needsSerialization ? JSON.stringify(inlineObject1 !== undefined ? inlineObject1 : {}) : (inlineObject1 || ""); return { url: globalImportUrl.format(localVarUrlObj), @@ -4948,14 +5911,14 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati /** * Use this endpoint to enable/disable reporting CVEs that do not have advisories (errata) for your customer account. If the feature is disabled, CVEs without advisories will be hidden in outputs of all endpoints. * @summary Set a feature flag for CVEs without errata - * @param {CvesWithoutErrataIn} cvesWithoutErrataIn Values to be set. + * @param {InlineObject5} inlineObject5 * @param {*} [options] Override http request option. * @throws {RequiredError} */ - setCvesWithoutErrata: async (cvesWithoutErrataIn: CvesWithoutErrataIn, options: any = {}): Promise => { - // verify required parameter 'cvesWithoutErrataIn' is not null or undefined - if (cvesWithoutErrataIn === null || cvesWithoutErrataIn === undefined) { - throw new RequiredError('cvesWithoutErrataIn','Required parameter cvesWithoutErrataIn was null or undefined when calling setCvesWithoutErrata.'); + setCvesWithoutErrata: async (inlineObject5: InlineObject5, options: any = {}): Promise => { + // verify required parameter 'inlineObject5' is not null or undefined + if (inlineObject5 === null || inlineObject5 === undefined) { + throw new RequiredError('inlineObject5','Required parameter inlineObject5 was null or undefined when calling setCvesWithoutErrata.'); } const localVarPath = `/feature/cves_without_errata`; const localVarUrlObj = globalImportUrl.parse(localVarPath, true); @@ -4990,8 +5953,8 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati delete localVarUrlObj.search; let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - const needsSerialization = (typeof cvesWithoutErrataIn !== "string") || localVarRequestOptions.headers['Content-Type'] === 'application/json'; - localVarRequestOptions.data = needsSerialization ? JSON.stringify(cvesWithoutErrataIn !== undefined ? cvesWithoutErrataIn : {}) : (cvesWithoutErrataIn || ""); + const needsSerialization = (typeof inlineObject5 !== "string") || localVarRequestOptions.headers['Content-Type'] === 'application/json'; + localVarRequestOptions.data = needsSerialization ? JSON.stringify(inlineObject5 !== undefined ? inlineObject5 : {}) : (inlineObject5 || ""); return { url: globalImportUrl.format(localVarUrlObj), @@ -5001,14 +5964,14 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati /** * This endpoint sets status for given systems and CVEs. Use this endpoint when you need to set a status value for system-CVE pairs. * @summary Set status for system vulnerabilities - * @param {StatusIn} statusIn Values to be set. + * @param {InlineObject2} inlineObject2 * @param {*} [options] Override http request option. * @throws {RequiredError} */ - setStatus: async (statusIn: StatusIn, options: any = {}): Promise => { - // verify required parameter 'statusIn' is not null or undefined - if (statusIn === null || statusIn === undefined) { - throw new RequiredError('statusIn','Required parameter statusIn was null or undefined when calling setStatus.'); + setStatus: async (inlineObject2: InlineObject2, options: any = {}): Promise => { + // verify required parameter 'inlineObject2' is not null or undefined + if (inlineObject2 === null || inlineObject2 === undefined) { + throw new RequiredError('inlineObject2','Required parameter inlineObject2 was null or undefined when calling setStatus.'); } const localVarPath = `/status`; const localVarUrlObj = globalImportUrl.parse(localVarPath, true); @@ -5043,8 +6006,8 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati delete localVarUrlObj.search; let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - const needsSerialization = (typeof statusIn !== "string") || localVarRequestOptions.headers['Content-Type'] === 'application/json'; - localVarRequestOptions.data = needsSerialization ? JSON.stringify(statusIn !== undefined ? statusIn : {}) : (statusIn || ""); + const needsSerialization = (typeof inlineObject2 !== "string") || localVarRequestOptions.headers['Content-Type'] === 'application/json'; + localVarRequestOptions.data = needsSerialization ? JSON.stringify(inlineObject2 !== undefined ? inlineObject2 : {}) : (inlineObject2 || ""); return { url: globalImportUrl.format(localVarUrlObj), @@ -5054,14 +6017,14 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati /** * Opt a specific system in or out of vulnerability analysis. Use this when you want to use other Insights services but do not want to see specific systems in vulnerability reports. This allows you to hide select systems. * @summary Opt a system in or out of the vulnerability service - * @param {OptOutIn} optOutIn Values to be set. + * @param {InlineObject3} inlineObject3 * @param {*} [options] Override http request option. * @throws {RequiredError} */ - setSystemsOptOut: async (optOutIn: OptOutIn, options: any = {}): Promise => { - // verify required parameter 'optOutIn' is not null or undefined - if (optOutIn === null || optOutIn === undefined) { - throw new RequiredError('optOutIn','Required parameter optOutIn was null or undefined when calling setSystemsOptOut.'); + setSystemsOptOut: async (inlineObject3: InlineObject3, options: any = {}): Promise => { + // verify required parameter 'inlineObject3' is not null or undefined + if (inlineObject3 === null || inlineObject3 === undefined) { + throw new RequiredError('inlineObject3','Required parameter inlineObject3 was null or undefined when calling setSystemsOptOut.'); } const localVarPath = `/systems/opt_out`; const localVarUrlObj = globalImportUrl.parse(localVarPath, true); @@ -5096,8 +6059,8 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati delete localVarUrlObj.search; let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - const needsSerialization = (typeof optOutIn !== "string") || localVarRequestOptions.headers['Content-Type'] === 'application/json'; - localVarRequestOptions.data = needsSerialization ? JSON.stringify(optOutIn !== undefined ? optOutIn : {}) : (optOutIn || ""); + const needsSerialization = (typeof inlineObject3 !== "string") || localVarRequestOptions.headers['Content-Type'] === 'application/json'; + localVarRequestOptions.data = needsSerialization ? JSON.stringify(inlineObject3 !== undefined ? inlineObject3 : {}) : (inlineObject3 || ""); return { url: globalImportUrl.format(localVarUrlObj), @@ -5119,7 +6082,7 @@ export const DefaultApiFp = function(configuration?: Configuration) { * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async deleteNotifications(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + async deleteNotifications(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await DefaultApiAxiosParamCreator(configuration).deleteNotifications(options); return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { const axiosRequestArgs = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url}; @@ -5161,7 +6124,7 @@ export const DefaultApiFp = function(configuration?: Configuration) { * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async getAffectedSystemsByCve(cveId: string, filter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sort?: string, statusId?: string, dataFormat?: string, uuid?: string, ruleKey?: Array, rulePresence?: Array, rule?: Array, tags?: Array, sapSids?: Array, sapSystem?: boolean, showAdvisories?: boolean, advisory?: string, rhelVersion?: string, firstReportedFrom?: string, firstReportedTo?: string, advisoryAvailable?: Array, remediation?: string, report?: boolean, ansible?: boolean, mssql?: boolean, groupNames?: Array, groupIds?: Array, hostType?: Array<'rpmdnf' | 'image' | 'edge'>, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + async getAffectedSystemsByCve(cveId: string, filter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sort?: string, statusId?: string, dataFormat?: string, uuid?: string, ruleKey?: Array, rulePresence?: Array, rule?: Array, tags?: Array, sapSids?: Array, sapSystem?: boolean, showAdvisories?: boolean, advisory?: string, rhelVersion?: string, firstReportedFrom?: string, firstReportedTo?: string, advisoryAvailable?: Array, remediation?: string, report?: boolean, ansible?: boolean, mssql?: boolean, groupNames?: Array, groupIds?: Array, hostType?: Array<'rpmdnf' | 'image' | 'edge'>, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await DefaultApiAxiosParamCreator(configuration).getAffectedSystemsByCve(cveId, filter, limit, offset, page, pageSize, sort, statusId, dataFormat, uuid, ruleKey, rulePresence, rule, tags, sapSids, sapSystem, showAdvisories, advisory, rhelVersion, firstReportedFrom, firstReportedTo, advisoryAvailable, remediation, report, ansible, mssql, groupNames, groupIds, hostType, options); return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { const axiosRequestArgs = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url}; @@ -5202,7 +6165,7 @@ export const DefaultApiFp = function(configuration?: Configuration) { * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async getAffectedSystemsIdsByCve(cveId: string, filter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sort?: string, statusId?: string, dataFormat?: string, uuid?: string, ruleKey?: Array, rulePresence?: Array, rule?: Array, tags?: Array, sapSids?: Array, sapSystem?: boolean, showAdvisories?: boolean, advisory?: string, rhelVersion?: string, firstReportedFrom?: string, firstReportedTo?: string, advisoryAvailable?: Array, remediation?: string, ansible?: boolean, mssql?: boolean, groupNames?: Array, groupIds?: Array, hostType?: Array<'rpmdnf' | 'image' | 'edge'>, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + async getAffectedSystemsIdsByCve(cveId: string, filter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sort?: string, statusId?: string, dataFormat?: string, uuid?: string, ruleKey?: Array, rulePresence?: Array, rule?: Array, tags?: Array, sapSids?: Array, sapSystem?: boolean, showAdvisories?: boolean, advisory?: string, rhelVersion?: string, firstReportedFrom?: string, firstReportedTo?: string, advisoryAvailable?: Array, remediation?: string, ansible?: boolean, mssql?: boolean, groupNames?: Array, groupIds?: Array, hostType?: Array<'rpmdnf' | 'image' | 'edge'>, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await DefaultApiAxiosParamCreator(configuration).getAffectedSystemsIdsByCve(cveId, filter, limit, offset, page, pageSize, sort, statusId, dataFormat, uuid, ruleKey, rulePresence, rule, tags, sapSids, sapSystem, showAdvisories, advisory, rhelVersion, firstReportedFrom, firstReportedTo, advisoryAvailable, remediation, ansible, mssql, groupNames, groupIds, hostType, options); return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { const axiosRequestArgs = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url}; @@ -5215,7 +6178,7 @@ export const DefaultApiFp = function(configuration?: Configuration) { * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async getAnnouncement(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + async getAnnouncement(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await DefaultApiAxiosParamCreator(configuration).getAnnouncement(options); return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { const axiosRequestArgs = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url}; @@ -5241,7 +6204,7 @@ export const DefaultApiFp = function(configuration?: Configuration) { * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async getBusinessRiskList(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + async getBusinessRiskList(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await DefaultApiAxiosParamCreator(configuration).getBusinessRiskList(options); return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { const axiosRequestArgs = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url}; @@ -5256,7 +6219,7 @@ export const DefaultApiFp = function(configuration?: Configuration) { * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async getCveDetails(cveId: string, advisoryAvailable?: Array, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + async getCveDetails(cveId: string, advisoryAvailable?: Array, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await DefaultApiAxiosParamCreator(configuration).getCveDetails(cveId, advisoryAvailable, options); return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { const axiosRequestArgs = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url}; @@ -5294,7 +6257,7 @@ export const DefaultApiFp = function(configuration?: Configuration) { * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async getCveIdsBySystem(inventoryId: string, filter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sort?: string, cvssFrom?: number, cvssTo?: number, publicFrom?: string, publicTo?: string, impact?: string, statusId?: string, dataFormat?: string, businessRiskId?: string, rulePresence?: Array, showAdvisories?: boolean, advisory?: string, ruleKey?: Array, knownExploit?: Array, firstReportedFrom?: string, firstReportedTo?: string, advisoryAvailable?: Array, remediation?: string, tags?: Array, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + async getCveIdsBySystem(inventoryId: string, filter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sort?: string, cvssFrom?: number, cvssTo?: number, publicFrom?: string, publicTo?: string, impact?: string, statusId?: string, dataFormat?: string, businessRiskId?: string, rulePresence?: Array, showAdvisories?: boolean, advisory?: string, ruleKey?: Array, knownExploit?: Array, firstReportedFrom?: string, firstReportedTo?: string, advisoryAvailable?: Array, remediation?: string, tags?: Array, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await DefaultApiAxiosParamCreator(configuration).getCveIdsBySystem(inventoryId, filter, limit, offset, page, pageSize, sort, cvssFrom, cvssTo, publicFrom, publicTo, impact, statusId, dataFormat, businessRiskId, rulePresence, showAdvisories, advisory, ruleKey, knownExploit, firstReportedFrom, firstReportedTo, advisoryAvailable, remediation, tags, options); return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { const axiosRequestArgs = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url}; @@ -5331,7 +6294,7 @@ export const DefaultApiFp = function(configuration?: Configuration) { * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async getCveIdsList(filter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sort?: string, cvssFrom?: number, cvssTo?: number, publicFrom?: string, publicTo?: string, impact?: string, dataFormat?: string, businessRiskId?: string, statusId?: string, rulePresence?: Array, tags?: Array, sapSids?: Array, sapSystem?: boolean, knownExploit?: Array, affecting?: Array, rhelVersion?: string, ansible?: boolean, mssql?: boolean, advisoryAvailable?: Array, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + async getCveIdsList(filter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sort?: string, cvssFrom?: number, cvssTo?: number, publicFrom?: string, publicTo?: string, impact?: string, dataFormat?: string, businessRiskId?: string, statusId?: string, rulePresence?: Array, tags?: Array, sapSids?: Array, sapSystem?: boolean, knownExploit?: Array, affecting?: Array, rhelVersion?: string, ansible?: boolean, mssql?: boolean, advisoryAvailable?: Array, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await DefaultApiAxiosParamCreator(configuration).getCveIdsList(filter, limit, offset, page, pageSize, sort, cvssFrom, cvssTo, publicFrom, publicTo, impact, dataFormat, businessRiskId, statusId, rulePresence, tags, sapSids, sapSystem, knownExploit, affecting, rhelVersion, ansible, mssql, advisoryAvailable, options); return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { const axiosRequestArgs = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url}; @@ -5373,7 +6336,7 @@ export const DefaultApiFp = function(configuration?: Configuration) { * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async getCveList(filter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sort?: string, cvssFrom?: number, cvssTo?: number, publicFrom?: string, publicTo?: string, impact?: string, dataFormat?: string, businessRiskId?: string, statusId?: string, rulePresence?: Array, tags?: Array, sapSids?: Array, sapSystem?: boolean, knownExploit?: Array, affecting?: Array, rhelVersion?: string, report?: boolean, advancedReport?: boolean, ansible?: boolean, mssql?: boolean, advisoryAvailable?: Array, groupNames?: Array, groupIds?: Array, affectingHostType?: Array<'rpmdnf' | 'image' | 'edge' | 'none'>, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + async getCveList(filter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sort?: string, cvssFrom?: number, cvssTo?: number, publicFrom?: string, publicTo?: string, impact?: string, dataFormat?: string, businessRiskId?: string, statusId?: string, rulePresence?: Array, tags?: Array, sapSids?: Array, sapSystem?: boolean, knownExploit?: Array, affecting?: Array, rhelVersion?: string, report?: boolean, advancedReport?: boolean, ansible?: boolean, mssql?: boolean, advisoryAvailable?: Array, groupNames?: Array, groupIds?: Array, affectingHostType?: Array<'rpmdnf' | 'image' | 'edge' | 'none'>, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await DefaultApiAxiosParamCreator(configuration).getCveList(filter, limit, offset, page, pageSize, sort, cvssFrom, cvssTo, publicFrom, publicTo, impact, dataFormat, businessRiskId, statusId, rulePresence, tags, sapSids, sapSystem, knownExploit, affecting, rhelVersion, report, advancedReport, ansible, mssql, advisoryAvailable, groupNames, groupIds, affectingHostType, options); return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { const axiosRequestArgs = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url}; @@ -5412,7 +6375,7 @@ export const DefaultApiFp = function(configuration?: Configuration) { * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async getCveListBySystem(inventoryId: string, filter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sort?: string, cvssFrom?: number, cvssTo?: number, publicFrom?: string, publicTo?: string, impact?: string, statusId?: string, dataFormat?: string, businessRiskId?: string, rulePresence?: Array, showAdvisories?: boolean, advisory?: string, ruleKey?: Array, knownExploit?: Array, firstReportedFrom?: string, firstReportedTo?: string, advisoryAvailable?: Array, remediation?: string, report?: boolean, tags?: Array, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + async getCveListBySystem(inventoryId: string, filter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sort?: string, cvssFrom?: number, cvssTo?: number, publicFrom?: string, publicTo?: string, impact?: string, statusId?: string, dataFormat?: string, businessRiskId?: string, rulePresence?: Array, showAdvisories?: boolean, advisory?: string, ruleKey?: Array, knownExploit?: Array, firstReportedFrom?: string, firstReportedTo?: string, advisoryAvailable?: Array, remediation?: string, report?: boolean, tags?: Array, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await DefaultApiAxiosParamCreator(configuration).getCveListBySystem(inventoryId, filter, limit, offset, page, pageSize, sort, cvssFrom, cvssTo, publicFrom, publicTo, impact, statusId, dataFormat, businessRiskId, rulePresence, showAdvisories, advisory, ruleKey, knownExploit, firstReportedFrom, firstReportedTo, advisoryAvailable, remediation, report, tags, options); return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { const axiosRequestArgs = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url}; @@ -5422,7 +6385,7 @@ export const DefaultApiFp = function(configuration?: Configuration) { /** * This is an overview of vulnerabilities for specific CVEs provided in the body. Use this endpoint to get a CVSS score, and learn the severity for a list of CVEs provided in the request. * @summary Send a vulnerabilities overview - * @param {VulnerabilitiesPostIn} vulnerabilitiesPostIn List of CVEs to provide info about. + * @param {InlineObject4} inlineObject4 * @param {string} [filter] Full text filter for CVE and it\'s description text. * @param {number} [limit] Maximum number of records per page. Limit/Offset pagination wins over page/page_size pagination. * @param {number} [offset] Offset of first record of paginated response. Limit/Offset pagination wins over page/page_size pagination. @@ -5432,8 +6395,21 @@ export const DefaultApiFp = function(configuration?: Configuration) { * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async getCveList_1(vulnerabilitiesPostIn: VulnerabilitiesPostIn, filter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sort?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await DefaultApiAxiosParamCreator(configuration).getCveList_1(vulnerabilitiesPostIn, filter, limit, offset, page, pageSize, sort, options); + async getCveList_1(inlineObject4: InlineObject4, filter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sort?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await DefaultApiAxiosParamCreator(configuration).getCveList_1(inlineObject4, filter, limit, offset, page, pageSize, sort, options); + return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { + const axiosRequestArgs = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url}; + return axios.request(axiosRequestArgs); + }; + }, + /** + * Use this endpoint to get an enablement status of reporting CVEs that do not have advisories (errata) for your customer account. If the feature is disabled, CVEs without advisories will be hidden in outputs of all endpoints. + * @summary Get a feature flag status for CVEs without errata + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async getCvesWithoutErrata(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await DefaultApiAxiosParamCreator(configuration).getCvesWithoutErrata(options); return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { const axiosRequestArgs = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url}; return axios.request(axiosRequestArgs); @@ -5450,7 +6426,7 @@ export const DefaultApiFp = function(configuration?: Configuration) { * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async getDashbar(tags?: Array, sapSids?: Array, sapSystem?: boolean, ansible?: boolean, mssql?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + async getDashbar(tags?: Array, sapSids?: Array, sapSystem?: boolean, ansible?: boolean, mssql?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await DefaultApiAxiosParamCreator(configuration).getDashbar(tags, sapSids, sapSystem, ansible, mssql, options); return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { const axiosRequestArgs = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url}; @@ -5468,7 +6444,7 @@ export const DefaultApiFp = function(configuration?: Configuration) { * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async getDashboard(tags?: Array, sapSids?: Array, sapSystem?: boolean, ansible?: boolean, mssql?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + async getDashboard(tags?: Array, sapSids?: Array, sapSystem?: boolean, ansible?: boolean, mssql?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await DefaultApiAxiosParamCreator(configuration).getDashboard(tags, sapSids, sapSystem, ansible, mssql, options); return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { const axiosRequestArgs = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url}; @@ -5481,7 +6457,7 @@ export const DefaultApiFp = function(configuration?: Configuration) { * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async getExecutiveReport(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + async getExecutiveReport(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await DefaultApiAxiosParamCreator(configuration).getExecutiveReport(options); return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { const axiosRequestArgs = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url}; @@ -5495,7 +6471,7 @@ export const DefaultApiFp = function(configuration?: Configuration) { * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async getOSExposure(dataFormat?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + async getOSExposure(dataFormat?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await DefaultApiAxiosParamCreator(configuration).getOSExposure(dataFormat, options); return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { const axiosRequestArgs = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url}; @@ -5509,7 +6485,7 @@ export const DefaultApiFp = function(configuration?: Configuration) { * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async getPlaybookTemplate(ruleId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + async getPlaybookTemplate(ruleId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await DefaultApiAxiosParamCreator(configuration).getPlaybookTemplate(ruleId, options); return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { const axiosRequestArgs = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url}; @@ -5522,7 +6498,7 @@ export const DefaultApiFp = function(configuration?: Configuration) { * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async getStatusList(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + async getStatusList(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await DefaultApiAxiosParamCreator(configuration).getStatusList(options); return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { const axiosRequestArgs = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url}; @@ -5537,7 +6513,7 @@ export const DefaultApiFp = function(configuration?: Configuration) { * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async getSystemDetails(inventoryId: string, tags?: Array, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + async getSystemDetails(inventoryId: string, tags?: Array, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await DefaultApiAxiosParamCreator(configuration).getSystemDetails(inventoryId, tags, options); return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { const axiosRequestArgs = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url}; @@ -5569,7 +6545,7 @@ export const DefaultApiFp = function(configuration?: Configuration) { * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async getSystemsIds(filter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sort?: string, dataFormat?: string, stale?: boolean, uuid?: string, tags?: Array, sapSids?: Array, sapSystem?: boolean, excluded?: Array, rhelVersion?: string, ansible?: boolean, mssql?: boolean, groupNames?: Array, groupIds?: Array, hostType?: Array<'rpmdnf' | 'image' | 'edge'>, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + async getSystemsIds(filter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sort?: string, dataFormat?: string, stale?: boolean, uuid?: string, tags?: Array, sapSids?: Array, sapSystem?: boolean, excluded?: Array, rhelVersion?: string, ansible?: boolean, mssql?: boolean, groupNames?: Array, groupIds?: Array, hostType?: Array<'rpmdnf' | 'image' | 'edge'>, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await DefaultApiAxiosParamCreator(configuration).getSystemsIds(filter, limit, offset, page, pageSize, sort, dataFormat, stale, uuid, tags, sapSids, sapSystem, excluded, rhelVersion, ansible, mssql, groupNames, groupIds, hostType, options); return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { const axiosRequestArgs = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url}; @@ -5602,7 +6578,7 @@ export const DefaultApiFp = function(configuration?: Configuration) { * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async getSystemsList(filter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sort?: string, dataFormat?: string, stale?: boolean, uuid?: string, tags?: Array, sapSids?: Array, sapSystem?: boolean, excluded?: Array, rhelVersion?: string, report?: boolean, ansible?: boolean, mssql?: boolean, groupNames?: Array, groupIds?: Array, hostType?: Array<'rpmdnf' | 'image' | 'edge'>, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + async getSystemsList(filter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sort?: string, dataFormat?: string, stale?: boolean, uuid?: string, tags?: Array, sapSids?: Array, sapSystem?: boolean, excluded?: Array, rhelVersion?: string, report?: boolean, ansible?: boolean, mssql?: boolean, groupNames?: Array, groupIds?: Array, hostType?: Array<'rpmdnf' | 'image' | 'edge'>, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await DefaultApiAxiosParamCreator(configuration).getSystemsList(filter, limit, offset, page, pageSize, sort, dataFormat, stale, uuid, tags, sapSids, sapSystem, excluded, rhelVersion, report, ansible, mssql, groupNames, groupIds, hostType, options); return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { const axiosRequestArgs = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url}; @@ -5615,7 +6591,7 @@ export const DefaultApiFp = function(configuration?: Configuration) { * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async getVersion(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + async getVersion(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await DefaultApiAxiosParamCreator(configuration).getVersion(options); return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { const axiosRequestArgs = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url}; @@ -5625,12 +6601,12 @@ export const DefaultApiFp = function(configuration?: Configuration) { /** * This sets a business risk for a specific CVE. Set a value of low, medium, high or critical for a given CVE. These values are obtained by the business risk path *GET/business_risk*. To set a business risk, you must call the GET/business_risk endpoint first, followed by the *PATCH/cves/business_risk* path. * @summary Set business risk for a CVE - * @param {CveRiskIn} cveRiskIn Values to be set. At least one of the \"business_risk_id\" or \"business_risk_text\" parameters is required. + * @param {InlineObject} inlineObject * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async setCveBusinessRisk(cveRiskIn: CveRiskIn, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await DefaultApiAxiosParamCreator(configuration).setCveBusinessRisk(cveRiskIn, options); + async setCveBusinessRisk(inlineObject: InlineObject, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await DefaultApiAxiosParamCreator(configuration).setCveBusinessRisk(inlineObject, options); return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { const axiosRequestArgs = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url}; return axios.request(axiosRequestArgs); @@ -5639,12 +6615,12 @@ export const DefaultApiFp = function(configuration?: Configuration) { /** * This sets the status for a specific CVE. Set a status value for a given CVE (e.g. in-review, on-hold, scheduled for a patch, or resolved). These values are obtained by sending a *GET/status* request. To set a status, you must call the *GET/business_risk* first, followed by the *PATCH/cves/status* path. * @summary Set status for a CVE - * @param {CveStatusIn} cveStatusIn Values to be set. At least one of the \"status_id\" or \"status_text\" parameters is required. + * @param {InlineObject1} inlineObject1 * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async setCveStatus(cveStatusIn: CveStatusIn, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await DefaultApiAxiosParamCreator(configuration).setCveStatus(cveStatusIn, options); + async setCveStatus(inlineObject1: InlineObject1, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await DefaultApiAxiosParamCreator(configuration).setCveStatus(inlineObject1, options); return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { const axiosRequestArgs = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url}; return axios.request(axiosRequestArgs); @@ -5653,12 +6629,12 @@ export const DefaultApiFp = function(configuration?: Configuration) { /** * Use this endpoint to enable/disable reporting CVEs that do not have advisories (errata) for your customer account. If the feature is disabled, CVEs without advisories will be hidden in outputs of all endpoints. * @summary Set a feature flag for CVEs without errata - * @param {CvesWithoutErrataIn} cvesWithoutErrataIn Values to be set. + * @param {InlineObject5} inlineObject5 * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async setCvesWithoutErrata(cvesWithoutErrataIn: CvesWithoutErrataIn, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await DefaultApiAxiosParamCreator(configuration).setCvesWithoutErrata(cvesWithoutErrataIn, options); + async setCvesWithoutErrata(inlineObject5: InlineObject5, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await DefaultApiAxiosParamCreator(configuration).setCvesWithoutErrata(inlineObject5, options); return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { const axiosRequestArgs = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url}; return axios.request(axiosRequestArgs); @@ -5667,12 +6643,12 @@ export const DefaultApiFp = function(configuration?: Configuration) { /** * This endpoint sets status for given systems and CVEs. Use this endpoint when you need to set a status value for system-CVE pairs. * @summary Set status for system vulnerabilities - * @param {StatusIn} statusIn Values to be set. + * @param {InlineObject2} inlineObject2 * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async setStatus(statusIn: StatusIn, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await DefaultApiAxiosParamCreator(configuration).setStatus(statusIn, options); + async setStatus(inlineObject2: InlineObject2, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await DefaultApiAxiosParamCreator(configuration).setStatus(inlineObject2, options); return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { const axiosRequestArgs = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url}; return axios.request(axiosRequestArgs); @@ -5681,12 +6657,12 @@ export const DefaultApiFp = function(configuration?: Configuration) { /** * Opt a specific system in or out of vulnerability analysis. Use this when you want to use other Insights services but do not want to see specific systems in vulnerability reports. This allows you to hide select systems. * @summary Opt a system in or out of the vulnerability service - * @param {OptOutIn} optOutIn Values to be set. + * @param {InlineObject3} inlineObject3 * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async setSystemsOptOut(optOutIn: OptOutIn, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await DefaultApiAxiosParamCreator(configuration).setSystemsOptOut(optOutIn, options); + async setSystemsOptOut(inlineObject3: InlineObject3, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await DefaultApiAxiosParamCreator(configuration).setSystemsOptOut(inlineObject3, options); return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { const axiosRequestArgs = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url}; return axios.request(axiosRequestArgs); @@ -5707,7 +6683,7 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa * @param {*} [options] Override http request option. * @throws {RequiredError} */ - deleteNotifications(options?: any): AxiosPromise { + deleteNotifications(options?: any): AxiosPromise { return DefaultApiFp(configuration).deleteNotifications(options).then((request) => request(axios, basePath)); }, /** @@ -5745,7 +6721,7 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getAffectedSystemsByCve(cveId: string, filter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sort?: string, statusId?: string, dataFormat?: string, uuid?: string, ruleKey?: Array, rulePresence?: Array, rule?: Array, tags?: Array, sapSids?: Array, sapSystem?: boolean, showAdvisories?: boolean, advisory?: string, rhelVersion?: string, firstReportedFrom?: string, firstReportedTo?: string, advisoryAvailable?: Array, remediation?: string, report?: boolean, ansible?: boolean, mssql?: boolean, groupNames?: Array, groupIds?: Array, hostType?: Array<'rpmdnf' | 'image' | 'edge'>, options?: any): AxiosPromise { + getAffectedSystemsByCve(cveId: string, filter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sort?: string, statusId?: string, dataFormat?: string, uuid?: string, ruleKey?: Array, rulePresence?: Array, rule?: Array, tags?: Array, sapSids?: Array, sapSystem?: boolean, showAdvisories?: boolean, advisory?: string, rhelVersion?: string, firstReportedFrom?: string, firstReportedTo?: string, advisoryAvailable?: Array, remediation?: string, report?: boolean, ansible?: boolean, mssql?: boolean, groupNames?: Array, groupIds?: Array, hostType?: Array<'rpmdnf' | 'image' | 'edge'>, options?: any): AxiosPromise { return DefaultApiFp(configuration).getAffectedSystemsByCve(cveId, filter, limit, offset, page, pageSize, sort, statusId, dataFormat, uuid, ruleKey, rulePresence, rule, tags, sapSids, sapSystem, showAdvisories, advisory, rhelVersion, firstReportedFrom, firstReportedTo, advisoryAvailable, remediation, report, ansible, mssql, groupNames, groupIds, hostType, options).then((request) => request(axios, basePath)); }, /** @@ -5782,7 +6758,7 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getAffectedSystemsIdsByCve(cveId: string, filter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sort?: string, statusId?: string, dataFormat?: string, uuid?: string, ruleKey?: Array, rulePresence?: Array, rule?: Array, tags?: Array, sapSids?: Array, sapSystem?: boolean, showAdvisories?: boolean, advisory?: string, rhelVersion?: string, firstReportedFrom?: string, firstReportedTo?: string, advisoryAvailable?: Array, remediation?: string, ansible?: boolean, mssql?: boolean, groupNames?: Array, groupIds?: Array, hostType?: Array<'rpmdnf' | 'image' | 'edge'>, options?: any): AxiosPromise { + getAffectedSystemsIdsByCve(cveId: string, filter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sort?: string, statusId?: string, dataFormat?: string, uuid?: string, ruleKey?: Array, rulePresence?: Array, rule?: Array, tags?: Array, sapSids?: Array, sapSystem?: boolean, showAdvisories?: boolean, advisory?: string, rhelVersion?: string, firstReportedFrom?: string, firstReportedTo?: string, advisoryAvailable?: Array, remediation?: string, ansible?: boolean, mssql?: boolean, groupNames?: Array, groupIds?: Array, hostType?: Array<'rpmdnf' | 'image' | 'edge'>, options?: any): AxiosPromise { return DefaultApiFp(configuration).getAffectedSystemsIdsByCve(cveId, filter, limit, offset, page, pageSize, sort, statusId, dataFormat, uuid, ruleKey, rulePresence, rule, tags, sapSids, sapSystem, showAdvisories, advisory, rhelVersion, firstReportedFrom, firstReportedTo, advisoryAvailable, remediation, ansible, mssql, groupNames, groupIds, hostType, options).then((request) => request(axios, basePath)); }, /** @@ -5791,7 +6767,7 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getAnnouncement(options?: any): AxiosPromise { + getAnnouncement(options?: any): AxiosPromise { return DefaultApiFp(configuration).getAnnouncement(options).then((request) => request(axios, basePath)); }, /** @@ -5809,7 +6785,7 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getBusinessRiskList(options?: any): AxiosPromise { + getBusinessRiskList(options?: any): AxiosPromise { return DefaultApiFp(configuration).getBusinessRiskList(options).then((request) => request(axios, basePath)); }, /** @@ -5820,7 +6796,7 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getCveDetails(cveId: string, advisoryAvailable?: Array, options?: any): AxiosPromise { + getCveDetails(cveId: string, advisoryAvailable?: Array, options?: any): AxiosPromise { return DefaultApiFp(configuration).getCveDetails(cveId, advisoryAvailable, options).then((request) => request(axios, basePath)); }, /** @@ -5854,7 +6830,7 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getCveIdsBySystem(inventoryId: string, filter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sort?: string, cvssFrom?: number, cvssTo?: number, publicFrom?: string, publicTo?: string, impact?: string, statusId?: string, dataFormat?: string, businessRiskId?: string, rulePresence?: Array, showAdvisories?: boolean, advisory?: string, ruleKey?: Array, knownExploit?: Array, firstReportedFrom?: string, firstReportedTo?: string, advisoryAvailable?: Array, remediation?: string, tags?: Array, options?: any): AxiosPromise { + getCveIdsBySystem(inventoryId: string, filter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sort?: string, cvssFrom?: number, cvssTo?: number, publicFrom?: string, publicTo?: string, impact?: string, statusId?: string, dataFormat?: string, businessRiskId?: string, rulePresence?: Array, showAdvisories?: boolean, advisory?: string, ruleKey?: Array, knownExploit?: Array, firstReportedFrom?: string, firstReportedTo?: string, advisoryAvailable?: Array, remediation?: string, tags?: Array, options?: any): AxiosPromise { return DefaultApiFp(configuration).getCveIdsBySystem(inventoryId, filter, limit, offset, page, pageSize, sort, cvssFrom, cvssTo, publicFrom, publicTo, impact, statusId, dataFormat, businessRiskId, rulePresence, showAdvisories, advisory, ruleKey, knownExploit, firstReportedFrom, firstReportedTo, advisoryAvailable, remediation, tags, options).then((request) => request(axios, basePath)); }, /** @@ -5887,7 +6863,7 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getCveIdsList(filter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sort?: string, cvssFrom?: number, cvssTo?: number, publicFrom?: string, publicTo?: string, impact?: string, dataFormat?: string, businessRiskId?: string, statusId?: string, rulePresence?: Array, tags?: Array, sapSids?: Array, sapSystem?: boolean, knownExploit?: Array, affecting?: Array, rhelVersion?: string, ansible?: boolean, mssql?: boolean, advisoryAvailable?: Array, options?: any): AxiosPromise { + getCveIdsList(filter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sort?: string, cvssFrom?: number, cvssTo?: number, publicFrom?: string, publicTo?: string, impact?: string, dataFormat?: string, businessRiskId?: string, statusId?: string, rulePresence?: Array, tags?: Array, sapSids?: Array, sapSystem?: boolean, knownExploit?: Array, affecting?: Array, rhelVersion?: string, ansible?: boolean, mssql?: boolean, advisoryAvailable?: Array, options?: any): AxiosPromise { return DefaultApiFp(configuration).getCveIdsList(filter, limit, offset, page, pageSize, sort, cvssFrom, cvssTo, publicFrom, publicTo, impact, dataFormat, businessRiskId, statusId, rulePresence, tags, sapSids, sapSystem, knownExploit, affecting, rhelVersion, ansible, mssql, advisoryAvailable, options).then((request) => request(axios, basePath)); }, /** @@ -5925,7 +6901,7 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getCveList(filter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sort?: string, cvssFrom?: number, cvssTo?: number, publicFrom?: string, publicTo?: string, impact?: string, dataFormat?: string, businessRiskId?: string, statusId?: string, rulePresence?: Array, tags?: Array, sapSids?: Array, sapSystem?: boolean, knownExploit?: Array, affecting?: Array, rhelVersion?: string, report?: boolean, advancedReport?: boolean, ansible?: boolean, mssql?: boolean, advisoryAvailable?: Array, groupNames?: Array, groupIds?: Array, affectingHostType?: Array<'rpmdnf' | 'image' | 'edge' | 'none'>, options?: any): AxiosPromise { + getCveList(filter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sort?: string, cvssFrom?: number, cvssTo?: number, publicFrom?: string, publicTo?: string, impact?: string, dataFormat?: string, businessRiskId?: string, statusId?: string, rulePresence?: Array, tags?: Array, sapSids?: Array, sapSystem?: boolean, knownExploit?: Array, affecting?: Array, rhelVersion?: string, report?: boolean, advancedReport?: boolean, ansible?: boolean, mssql?: boolean, advisoryAvailable?: Array, groupNames?: Array, groupIds?: Array, affectingHostType?: Array<'rpmdnf' | 'image' | 'edge' | 'none'>, options?: any): AxiosPromise { return DefaultApiFp(configuration).getCveList(filter, limit, offset, page, pageSize, sort, cvssFrom, cvssTo, publicFrom, publicTo, impact, dataFormat, businessRiskId, statusId, rulePresence, tags, sapSids, sapSystem, knownExploit, affecting, rhelVersion, report, advancedReport, ansible, mssql, advisoryAvailable, groupNames, groupIds, affectingHostType, options).then((request) => request(axios, basePath)); }, /** @@ -5960,13 +6936,13 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getCveListBySystem(inventoryId: string, filter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sort?: string, cvssFrom?: number, cvssTo?: number, publicFrom?: string, publicTo?: string, impact?: string, statusId?: string, dataFormat?: string, businessRiskId?: string, rulePresence?: Array, showAdvisories?: boolean, advisory?: string, ruleKey?: Array, knownExploit?: Array, firstReportedFrom?: string, firstReportedTo?: string, advisoryAvailable?: Array, remediation?: string, report?: boolean, tags?: Array, options?: any): AxiosPromise { + getCveListBySystem(inventoryId: string, filter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sort?: string, cvssFrom?: number, cvssTo?: number, publicFrom?: string, publicTo?: string, impact?: string, statusId?: string, dataFormat?: string, businessRiskId?: string, rulePresence?: Array, showAdvisories?: boolean, advisory?: string, ruleKey?: Array, knownExploit?: Array, firstReportedFrom?: string, firstReportedTo?: string, advisoryAvailable?: Array, remediation?: string, report?: boolean, tags?: Array, options?: any): AxiosPromise { return DefaultApiFp(configuration).getCveListBySystem(inventoryId, filter, limit, offset, page, pageSize, sort, cvssFrom, cvssTo, publicFrom, publicTo, impact, statusId, dataFormat, businessRiskId, rulePresence, showAdvisories, advisory, ruleKey, knownExploit, firstReportedFrom, firstReportedTo, advisoryAvailable, remediation, report, tags, options).then((request) => request(axios, basePath)); }, /** * This is an overview of vulnerabilities for specific CVEs provided in the body. Use this endpoint to get a CVSS score, and learn the severity for a list of CVEs provided in the request. * @summary Send a vulnerabilities overview - * @param {VulnerabilitiesPostIn} vulnerabilitiesPostIn List of CVEs to provide info about. + * @param {InlineObject4} inlineObject4 * @param {string} [filter] Full text filter for CVE and it\'s description text. * @param {number} [limit] Maximum number of records per page. Limit/Offset pagination wins over page/page_size pagination. * @param {number} [offset] Offset of first record of paginated response. Limit/Offset pagination wins over page/page_size pagination. @@ -5976,8 +6952,17 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getCveList_1(vulnerabilitiesPostIn: VulnerabilitiesPostIn, filter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sort?: string, options?: any): AxiosPromise { - return DefaultApiFp(configuration).getCveList_1(vulnerabilitiesPostIn, filter, limit, offset, page, pageSize, sort, options).then((request) => request(axios, basePath)); + getCveList_1(inlineObject4: InlineObject4, filter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sort?: string, options?: any): AxiosPromise { + return DefaultApiFp(configuration).getCveList_1(inlineObject4, filter, limit, offset, page, pageSize, sort, options).then((request) => request(axios, basePath)); + }, + /** + * Use this endpoint to get an enablement status of reporting CVEs that do not have advisories (errata) for your customer account. If the feature is disabled, CVEs without advisories will be hidden in outputs of all endpoints. + * @summary Get a feature flag status for CVEs without errata + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getCvesWithoutErrata(options?: any): AxiosPromise { + return DefaultApiFp(configuration).getCvesWithoutErrata(options).then((request) => request(axios, basePath)); }, /** * These are aggregations summarizing your account such as number of unique CVEs, list of security rules, CVEs by severity and more. Use this endpoint to obtain a snapshot of all the CVES and details about their prevalence, severity and other details. @@ -5990,7 +6975,7 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getDashbar(tags?: Array, sapSids?: Array, sapSystem?: boolean, ansible?: boolean, mssql?: boolean, options?: any): AxiosPromise { + getDashbar(tags?: Array, sapSids?: Array, sapSystem?: boolean, ansible?: boolean, mssql?: boolean, options?: any): AxiosPromise { return DefaultApiFp(configuration).getDashbar(tags, sapSids, sapSystem, ansible, mssql, options).then((request) => request(axios, basePath)); }, /** @@ -6004,7 +6989,7 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getDashboard(tags?: Array, sapSids?: Array, sapSystem?: boolean, ansible?: boolean, mssql?: boolean, options?: any): AxiosPromise { + getDashboard(tags?: Array, sapSids?: Array, sapSystem?: boolean, ansible?: boolean, mssql?: boolean, options?: any): AxiosPromise { return DefaultApiFp(configuration).getDashboard(tags, sapSids, sapSystem, ansible, mssql, options).then((request) => request(axios, basePath)); }, /** @@ -6013,7 +6998,7 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getExecutiveReport(options?: any): AxiosPromise { + getExecutiveReport(options?: any): AxiosPromise { return DefaultApiFp(configuration).getExecutiveReport(options).then((request) => request(axios, basePath)); }, /** @@ -6023,7 +7008,7 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getOSExposure(dataFormat?: string, options?: any): AxiosPromise { + getOSExposure(dataFormat?: string, options?: any): AxiosPromise { return DefaultApiFp(configuration).getOSExposure(dataFormat, options).then((request) => request(axios, basePath)); }, /** @@ -6033,7 +7018,7 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getPlaybookTemplate(ruleId: string, options?: any): AxiosPromise { + getPlaybookTemplate(ruleId: string, options?: any): AxiosPromise { return DefaultApiFp(configuration).getPlaybookTemplate(ruleId, options).then((request) => request(axios, basePath)); }, /** @@ -6042,7 +7027,7 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getStatusList(options?: any): AxiosPromise { + getStatusList(options?: any): AxiosPromise { return DefaultApiFp(configuration).getStatusList(options).then((request) => request(axios, basePath)); }, /** @@ -6053,7 +7038,7 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getSystemDetails(inventoryId: string, tags?: Array, options?: any): AxiosPromise { + getSystemDetails(inventoryId: string, tags?: Array, options?: any): AxiosPromise { return DefaultApiFp(configuration).getSystemDetails(inventoryId, tags, options).then((request) => request(axios, basePath)); }, /** @@ -6081,7 +7066,7 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getSystemsIds(filter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sort?: string, dataFormat?: string, stale?: boolean, uuid?: string, tags?: Array, sapSids?: Array, sapSystem?: boolean, excluded?: Array, rhelVersion?: string, ansible?: boolean, mssql?: boolean, groupNames?: Array, groupIds?: Array, hostType?: Array<'rpmdnf' | 'image' | 'edge'>, options?: any): AxiosPromise { + getSystemsIds(filter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sort?: string, dataFormat?: string, stale?: boolean, uuid?: string, tags?: Array, sapSids?: Array, sapSystem?: boolean, excluded?: Array, rhelVersion?: string, ansible?: boolean, mssql?: boolean, groupNames?: Array, groupIds?: Array, hostType?: Array<'rpmdnf' | 'image' | 'edge'>, options?: any): AxiosPromise { return DefaultApiFp(configuration).getSystemsIds(filter, limit, offset, page, pageSize, sort, dataFormat, stale, uuid, tags, sapSids, sapSystem, excluded, rhelVersion, ansible, mssql, groupNames, groupIds, hostType, options).then((request) => request(axios, basePath)); }, /** @@ -6110,7 +7095,7 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getSystemsList(filter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sort?: string, dataFormat?: string, stale?: boolean, uuid?: string, tags?: Array, sapSids?: Array, sapSystem?: boolean, excluded?: Array, rhelVersion?: string, report?: boolean, ansible?: boolean, mssql?: boolean, groupNames?: Array, groupIds?: Array, hostType?: Array<'rpmdnf' | 'image' | 'edge'>, options?: any): AxiosPromise { + getSystemsList(filter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sort?: string, dataFormat?: string, stale?: boolean, uuid?: string, tags?: Array, sapSids?: Array, sapSystem?: boolean, excluded?: Array, rhelVersion?: string, report?: boolean, ansible?: boolean, mssql?: boolean, groupNames?: Array, groupIds?: Array, hostType?: Array<'rpmdnf' | 'image' | 'edge'>, options?: any): AxiosPromise { return DefaultApiFp(configuration).getSystemsList(filter, limit, offset, page, pageSize, sort, dataFormat, stale, uuid, tags, sapSids, sapSystem, excluded, rhelVersion, report, ansible, mssql, groupNames, groupIds, hostType, options).then((request) => request(axios, basePath)); }, /** @@ -6119,58 +7104,58 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getVersion(options?: any): AxiosPromise { + getVersion(options?: any): AxiosPromise { return DefaultApiFp(configuration).getVersion(options).then((request) => request(axios, basePath)); }, /** * This sets a business risk for a specific CVE. Set a value of low, medium, high or critical for a given CVE. These values are obtained by the business risk path *GET/business_risk*. To set a business risk, you must call the GET/business_risk endpoint first, followed by the *PATCH/cves/business_risk* path. * @summary Set business risk for a CVE - * @param {CveRiskIn} cveRiskIn Values to be set. At least one of the \"business_risk_id\" or \"business_risk_text\" parameters is required. + * @param {InlineObject} inlineObject * @param {*} [options] Override http request option. * @throws {RequiredError} */ - setCveBusinessRisk(cveRiskIn: CveRiskIn, options?: any): AxiosPromise { - return DefaultApiFp(configuration).setCveBusinessRisk(cveRiskIn, options).then((request) => request(axios, basePath)); + setCveBusinessRisk(inlineObject: InlineObject, options?: any): AxiosPromise { + return DefaultApiFp(configuration).setCveBusinessRisk(inlineObject, options).then((request) => request(axios, basePath)); }, /** * This sets the status for a specific CVE. Set a status value for a given CVE (e.g. in-review, on-hold, scheduled for a patch, or resolved). These values are obtained by sending a *GET/status* request. To set a status, you must call the *GET/business_risk* first, followed by the *PATCH/cves/status* path. * @summary Set status for a CVE - * @param {CveStatusIn} cveStatusIn Values to be set. At least one of the \"status_id\" or \"status_text\" parameters is required. + * @param {InlineObject1} inlineObject1 * @param {*} [options] Override http request option. * @throws {RequiredError} */ - setCveStatus(cveStatusIn: CveStatusIn, options?: any): AxiosPromise { - return DefaultApiFp(configuration).setCveStatus(cveStatusIn, options).then((request) => request(axios, basePath)); + setCveStatus(inlineObject1: InlineObject1, options?: any): AxiosPromise { + return DefaultApiFp(configuration).setCveStatus(inlineObject1, options).then((request) => request(axios, basePath)); }, /** * Use this endpoint to enable/disable reporting CVEs that do not have advisories (errata) for your customer account. If the feature is disabled, CVEs without advisories will be hidden in outputs of all endpoints. * @summary Set a feature flag for CVEs without errata - * @param {CvesWithoutErrataIn} cvesWithoutErrataIn Values to be set. + * @param {InlineObject5} inlineObject5 * @param {*} [options] Override http request option. * @throws {RequiredError} */ - setCvesWithoutErrata(cvesWithoutErrataIn: CvesWithoutErrataIn, options?: any): AxiosPromise { - return DefaultApiFp(configuration).setCvesWithoutErrata(cvesWithoutErrataIn, options).then((request) => request(axios, basePath)); + setCvesWithoutErrata(inlineObject5: InlineObject5, options?: any): AxiosPromise { + return DefaultApiFp(configuration).setCvesWithoutErrata(inlineObject5, options).then((request) => request(axios, basePath)); }, /** * This endpoint sets status for given systems and CVEs. Use this endpoint when you need to set a status value for system-CVE pairs. * @summary Set status for system vulnerabilities - * @param {StatusIn} statusIn Values to be set. + * @param {InlineObject2} inlineObject2 * @param {*} [options] Override http request option. * @throws {RequiredError} */ - setStatus(statusIn: StatusIn, options?: any): AxiosPromise { - return DefaultApiFp(configuration).setStatus(statusIn, options).then((request) => request(axios, basePath)); + setStatus(inlineObject2: InlineObject2, options?: any): AxiosPromise { + return DefaultApiFp(configuration).setStatus(inlineObject2, options).then((request) => request(axios, basePath)); }, /** * Opt a specific system in or out of vulnerability analysis. Use this when you want to use other Insights services but do not want to see specific systems in vulnerability reports. This allows you to hide select systems. * @summary Opt a system in or out of the vulnerability service - * @param {OptOutIn} optOutIn Values to be set. + * @param {InlineObject3} inlineObject3 * @param {*} [options] Override http request option. * @throws {RequiredError} */ - setSystemsOptOut(optOutIn: OptOutIn, options?: any): AxiosPromise { - return DefaultApiFp(configuration).setSystemsOptOut(optOutIn, options).then((request) => request(axios, basePath)); + setSystemsOptOut(inlineObject3: InlineObject3, options?: any): AxiosPromise { + return DefaultApiFp(configuration).setSystemsOptOut(inlineObject3, options).then((request) => request(axios, basePath)); }, }; }; @@ -6469,7 +7454,7 @@ export class DefaultApi extends BaseAPI { /** * This is an overview of vulnerabilities for specific CVEs provided in the body. Use this endpoint to get a CVSS score, and learn the severity for a list of CVEs provided in the request. * @summary Send a vulnerabilities overview - * @param {VulnerabilitiesPostIn} vulnerabilitiesPostIn List of CVEs to provide info about. + * @param {InlineObject4} inlineObject4 * @param {string} [filter] Full text filter for CVE and it\'s description text. * @param {number} [limit] Maximum number of records per page. Limit/Offset pagination wins over page/page_size pagination. * @param {number} [offset] Offset of first record of paginated response. Limit/Offset pagination wins over page/page_size pagination. @@ -6480,8 +7465,19 @@ export class DefaultApi extends BaseAPI { * @throws {RequiredError} * @memberof DefaultApi */ - public getCveList_1(vulnerabilitiesPostIn: VulnerabilitiesPostIn, filter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sort?: string, options?: any) { - return DefaultApiFp(this.configuration).getCveList_1(vulnerabilitiesPostIn, filter, limit, offset, page, pageSize, sort, options).then((request) => request(this.axios, this.basePath)); + public getCveList_1(inlineObject4: InlineObject4, filter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sort?: string, options?: any) { + return DefaultApiFp(this.configuration).getCveList_1(inlineObject4, filter, limit, offset, page, pageSize, sort, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Use this endpoint to get an enablement status of reporting CVEs that do not have advisories (errata) for your customer account. If the feature is disabled, CVEs without advisories will be hidden in outputs of all endpoints. + * @summary Get a feature flag status for CVEs without errata + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof DefaultApi + */ + public getCvesWithoutErrata(options?: any) { + return DefaultApiFp(this.configuration).getCvesWithoutErrata(options).then((request) => request(this.axios, this.basePath)); } /** @@ -6650,61 +7646,61 @@ export class DefaultApi extends BaseAPI { /** * This sets a business risk for a specific CVE. Set a value of low, medium, high or critical for a given CVE. These values are obtained by the business risk path *GET/business_risk*. To set a business risk, you must call the GET/business_risk endpoint first, followed by the *PATCH/cves/business_risk* path. * @summary Set business risk for a CVE - * @param {CveRiskIn} cveRiskIn Values to be set. At least one of the \"business_risk_id\" or \"business_risk_text\" parameters is required. + * @param {InlineObject} inlineObject * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ - public setCveBusinessRisk(cveRiskIn: CveRiskIn, options?: any) { - return DefaultApiFp(this.configuration).setCveBusinessRisk(cveRiskIn, options).then((request) => request(this.axios, this.basePath)); + public setCveBusinessRisk(inlineObject: InlineObject, options?: any) { + return DefaultApiFp(this.configuration).setCveBusinessRisk(inlineObject, options).then((request) => request(this.axios, this.basePath)); } /** * This sets the status for a specific CVE. Set a status value for a given CVE (e.g. in-review, on-hold, scheduled for a patch, or resolved). These values are obtained by sending a *GET/status* request. To set a status, you must call the *GET/business_risk* first, followed by the *PATCH/cves/status* path. * @summary Set status for a CVE - * @param {CveStatusIn} cveStatusIn Values to be set. At least one of the \"status_id\" or \"status_text\" parameters is required. + * @param {InlineObject1} inlineObject1 * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ - public setCveStatus(cveStatusIn: CveStatusIn, options?: any) { - return DefaultApiFp(this.configuration).setCveStatus(cveStatusIn, options).then((request) => request(this.axios, this.basePath)); + public setCveStatus(inlineObject1: InlineObject1, options?: any) { + return DefaultApiFp(this.configuration).setCveStatus(inlineObject1, options).then((request) => request(this.axios, this.basePath)); } /** * Use this endpoint to enable/disable reporting CVEs that do not have advisories (errata) for your customer account. If the feature is disabled, CVEs without advisories will be hidden in outputs of all endpoints. * @summary Set a feature flag for CVEs without errata - * @param {CvesWithoutErrataIn} cvesWithoutErrataIn Values to be set. + * @param {InlineObject5} inlineObject5 * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ - public setCvesWithoutErrata(cvesWithoutErrataIn: CvesWithoutErrataIn, options?: any) { - return DefaultApiFp(this.configuration).setCvesWithoutErrata(cvesWithoutErrataIn, options).then((request) => request(this.axios, this.basePath)); + public setCvesWithoutErrata(inlineObject5: InlineObject5, options?: any) { + return DefaultApiFp(this.configuration).setCvesWithoutErrata(inlineObject5, options).then((request) => request(this.axios, this.basePath)); } /** * This endpoint sets status for given systems and CVEs. Use this endpoint when you need to set a status value for system-CVE pairs. * @summary Set status for system vulnerabilities - * @param {StatusIn} statusIn Values to be set. + * @param {InlineObject2} inlineObject2 * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ - public setStatus(statusIn: StatusIn, options?: any) { - return DefaultApiFp(this.configuration).setStatus(statusIn, options).then((request) => request(this.axios, this.basePath)); + public setStatus(inlineObject2: InlineObject2, options?: any) { + return DefaultApiFp(this.configuration).setStatus(inlineObject2, options).then((request) => request(this.axios, this.basePath)); } /** * Opt a specific system in or out of vulnerability analysis. Use this when you want to use other Insights services but do not want to see specific systems in vulnerability reports. This allows you to hide select systems. * @summary Opt a system in or out of the vulnerability service - * @param {OptOutIn} optOutIn Values to be set. + * @param {InlineObject3} inlineObject3 * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ - public setSystemsOptOut(optOutIn: OptOutIn, options?: any) { - return DefaultApiFp(this.configuration).setSystemsOptOut(optOutIn, options).then((request) => request(this.axios, this.basePath)); + public setSystemsOptOut(inlineObject3: InlineObject3, options?: any) { + return DefaultApiFp(this.configuration).setSystemsOptOut(inlineObject3, options).then((request) => request(this.axios, this.basePath)); } } diff --git a/packages/vulnerabilities/apiSpec.json b/packages/vulnerabilities/apiSpec.json index de205dac8..0bb604071 100644 --- a/packages/vulnerabilities/apiSpec.json +++ b/packages/vulnerabilities/apiSpec.json @@ -1 +1 @@ -{"openapi":"3.0.0","info":{"title":"Vulnerability Engine Manager","version":"2.70.8"},"paths":{"/apistatus":{"get":{"summary":"Determine the health of the application","description":"Checks database availability and API response threshold time.","operationId":"getApiStatus","x-methodName":"getApiStatus","responses":{"200":{"description":"API is healthy"},"503":{"description":"Database is unavaiable"}}}},"/version":{"get":{"summary":"Get application version","description":"This endpoint will provide you with the application version. Use this endpoint to track application changes.\n","operationId":"getVersion","x-methodName":"getVersion","responses":{"200":{"description":"Application version.","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/VersionOut"}}}}}}},"/business_risk":{"get":{"summary":"Access business risk values","description":"This endpoint helps you determine the numeric business risk for a given CVE. A business risk is a label you can set for a given CVE. Choose one of five business risk options ranging from 0-4, where 0 is not defined and 4 indicates a critical risk. You must call this endpoint to choose a numerical value before calling the *PATCH/cves/business_risk* endpoint.\n","operationId":"getBusinessRiskList","x-methodName":"getBusinessRiskList","security":[{"ApiKeyAuth":[]},{"BasicAuth":[]}],"responses":{"200":{"description":"List of business risk/business_risk_id pairs.","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/BusinessRiskListOut"}}}}}}},"/cves/{cve_id}":{"get":{"summary":"Get CVE details","description":"This endpoint returns the CVE identification number, description, scores and other metadata. The metadata includes the description, CVSS 2/3 Score, CVSS 2/3 attack vector, severity, public date, modified date, business risk, status, a URL to Red Hat web pages, a list of advisories remediating the CVE, and information regarding known exploits for the CVE.\n","operationId":"getCveDetails","x-methodName":"getCveDetails","security":[{"ApiKeyAuth":[]},{"BasicAuth":[]}],"responses":{"200":{"description":"CVE details","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/CveDetailOut"}}}},"404":{"description":"Given CVE does not exist.","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/Errors"}}}}},"parameters":[{"$ref":"#/components/parameters/cve_id"},{"$ref":"#/components/parameters/advisory_available"}]}},"/cves/{cve_id}/affected_systems":{"get":{"summary":"Determine affected systems for a given CVE","description":"This is a report of affected systems for a given CVE. Use this request to obtain server identification numbers of all affected servers along with last check-in, system name and more.\n","operationId":"getAffectedSystemsByCve","x-methodName":"getAffectedSystemsByCve","security":[{"ApiKeyAuth":[]},{"BasicAuth":[]}],"responses":{"200":{"description":"Report of affected systems for a given CVE.","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/AffectedSystemsOut"}}}},"404":{"description":"Given CVE does not exist.","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/Errors"}}}}},"parameters":[{"$ref":"#/components/parameters/filter"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/offset"},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page_size"},{"$ref":"#/components/parameters/sort"},{"$ref":"#/components/parameters/cve_id"},{"$ref":"#/components/parameters/status_id"},{"$ref":"#/components/parameters/data_format"},{"$ref":"#/components/parameters/uuid"},{"$ref":"#/components/parameters/rule_key_deprecated"},{"$ref":"#/components/parameters/rule_presence_deprecated"},{"$ref":"#/components/parameters/rule"},{"$ref":"#/components/parameters/tags"},{"$ref":"#/components/parameters/sap_sids"},{"$ref":"#/components/parameters/sap_system"},{"$ref":"#/components/parameters/show_advisories"},{"$ref":"#/components/parameters/advisory"},{"$ref":"#/components/parameters/rhel_version"},{"$ref":"#/components/parameters/first_reported_from"},{"$ref":"#/components/parameters/first_reported_to"},{"$ref":"#/components/parameters/advisory_available"},{"$ref":"#/components/parameters/remediation"},{"$ref":"#/components/parameters/report"},{"$ref":"#/components/parameters/ansible"},{"$ref":"#/components/parameters/mssql"},{"$ref":"#/components/parameters/group_names"},{"$ref":"#/components/parameters/group_ids"},{"$ref":"#/components/parameters/host_type"}]}},"/cves/{cve_id}/affected_systems/ids":{"get":{"summary":"Get identification numbers of affected systems for a given CVE","description":"This is a report of identification numbers of affected systems for a given CVE. Use this request to obtain server identification numbers of all affected systems.\n","operationId":"getAffectedSystemsIdsByCve","x-methodName":"getAffectedSystemsIdsByCve","security":[{"ApiKeyAuth":[]},{"BasicAuth":[]}],"responses":{"200":{"description":"Report of IDs of affected systems for a given CVE.","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/AffectedSystemsIdsOut"}}}},"404":{"description":"Given CVE does not exist.","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/Errors"}}}}},"parameters":[{"$ref":"#/components/parameters/filter"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/offset"},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page_size"},{"$ref":"#/components/parameters/sort"},{"$ref":"#/components/parameters/cve_id"},{"$ref":"#/components/parameters/status_id"},{"$ref":"#/components/parameters/data_format"},{"$ref":"#/components/parameters/uuid"},{"$ref":"#/components/parameters/rule_key_deprecated"},{"$ref":"#/components/parameters/rule_presence_deprecated"},{"$ref":"#/components/parameters/rule"},{"$ref":"#/components/parameters/tags"},{"$ref":"#/components/parameters/sap_sids"},{"$ref":"#/components/parameters/sap_system"},{"$ref":"#/components/parameters/show_advisories"},{"$ref":"#/components/parameters/advisory"},{"$ref":"#/components/parameters/rhel_version"},{"$ref":"#/components/parameters/first_reported_from"},{"$ref":"#/components/parameters/first_reported_to"},{"$ref":"#/components/parameters/advisory_available"},{"$ref":"#/components/parameters/remediation"},{"$ref":"#/components/parameters/ansible"},{"$ref":"#/components/parameters/mssql"},{"$ref":"#/components/parameters/group_names"},{"$ref":"#/components/parameters/group_ids"},{"$ref":"#/components/parameters/host_type"}]}},"/cves/business_risk":{"patch":{"summary":"Set business risk for a CVE","description":"This sets a business risk for a specific CVE. Set a value of low, medium, high or critical for a given CVE. These values are obtained by the business risk path *GET/business_risk*. To set a business risk, you must call the GET/business_risk endpoint first, followed by the *PATCH/cves/business_risk* path.\n","operationId":"setCveBusinessRisk","x-methodName":"setCveBusinessRisk","security":[{"ApiKeyAuth":[]},{"BasicAuth":[]}],"requestBody":{"description":"Values to be set. At least one of the \"business_risk_id\" or \"business_risk_text\" parameters is required.","required":true,"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/CveRiskIn","x-body-name":"data"}}}},"responses":{"200":{"description":"Business risk successfully updated.","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/BulkChangeOut"}}}},"404":{"description":"Given CVE does not exist.","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/Errors"}}}},"503":{"description":"Service is running in read-only mode.","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/Errors"}}}}}}},"/cves/status":{"patch":{"summary":"Set status for a CVE","description":"This sets the status for a specific CVE. Set a status value for a given CVE (e.g. in-review, on-hold, scheduled for a patch, or resolved). These values are obtained by sending a *GET/status* request. To set a status, you must call the *GET/business_risk* first, followed by the *PATCH/cves/status* path.\n","operationId":"setCveStatus","x-methodName":"setCveStatus","security":[{"ApiKeyAuth":[]},{"BasicAuth":[]}],"requestBody":{"description":"Values to be set. At least one of the \"status_id\" or \"status_text\" parameters is required.","required":true,"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/CveStatusIn","x-body-name":"data"}}}},"responses":{"200":{"description":"Status successfully updated.","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/BulkChangeOut"}}}},"404":{"description":"Given CVE does not exist.","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/Errors"}}}},"503":{"description":"Service is running in read-only mode.","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/Errors"}}}}}}},"/dashboard":{"get":{"summary":"Get a macro level overview of aggregated vulnerabilities","description":"These are aggregations summarizing your account such as number of unique CVEs, list of security rules, CVEs by severity, and more. Use this endpoint to obtain a snapshot of all the CVES and details about their prevalence and severity.\n","operationId":"getDashboard","x-methodName":"getDashboard","security":[{"ApiKeyAuth":[]},{"BasicAuth":[]}],"responses":{"200":{"description":"Dashboard.","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/Dashboard"}}}}},"parameters":[{"$ref":"#/components/parameters/tags"},{"$ref":"#/components/parameters/sap_sids"},{"$ref":"#/components/parameters/sap_system"},{"$ref":"#/components/parameters/ansible"},{"$ref":"#/components/parameters/mssql"}]}},"/playbooks/templates/{rule_id}":{"get":{"summary":"Get an Ansible Playbook template for CVEs with security rules","description":"This returns an Ansible playbook template for a given rule identification number. Use this endpoint to return an Ansible playbook template for a given rule error key. The template is used to remediate issues on your system.\n","operationId":"getPlaybookTemplate","x-methodName":"getPlaybookTemplate","security":[{"ApiKeyAuth":[]},{"BasicAuth":[]}],"responses":{"200":{"description":"Playbook template response","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/PlaybookTemplate"}}}},"404":{"description":"Given rule id does not exist.","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/Errors"}}}}},"parameters":[{"in":"path","name":"rule_id","description":"Insights security rule ID.","required":true,"schema":{"type":"string"},"example":"CVE_2017_8779_rpc|CVE_2017_8779_WARN"}]}},"/report/executive":{"get":{"summary":"Generate an executive report","description":"This returns an overview of vulnerabilities affecting a given account. Use this request when you need to download a high-level, executive report summarizing the security exposure of your infrastructure. These reports are designed for an executive audience and include data such as the number of RHEL systems analyzed, the number of security rules in your infrastructure, percentage of CVEs with a certain severity and more.\n","operationId":"getExecutiveReport","x-methodName":"getExecutiveReport","security":[{"ApiKeyAuth":[]},{"BasicAuth":[]}],"responses":{"200":{"description":"Executive report.","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ExecutiveReport"}}}}}}},"/report/os":{"get":{"summary":"Generate CVE exposure report by RHEL version","description":"List RHEL versions and number of CVEs exposing each of these versions. Each RHEL version represents system with base and core group packages installed.\n","operationId":"getOSExposure","x-methodName":"getOSExposure","security":[{"ApiKeyAuth":[]},{"BasicAuth":[]}],"responses":{"200":{"description":"RHEL version CVE exposure list","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/OSExposureReport"}}}}},"parameters":[{"$ref":"#/components/parameters/data_format"}]}},"/status":{"get":{"summary":"Access available status values","description":"This endpoint returns a list of possible values for setting status for a CVE or system-CVE pair. Call this api when you want to know which values are available for setting a status. A list of numbers will be returned. You must call this endpoint before calling the *PATCH/cves/status* endpoint.\n","operationId":"getStatusList","x-methodName":"getStatusList","security":[{"ApiKeyAuth":[]},{"BasicAuth":[]}],"responses":{"200":{"description":"List of status/status_id pairs.","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/StatusListOut"}}}}}},"patch":{"summary":"Set status for system vulnerabilities","description":"This endpoint sets status for given systems and CVEs. Use this endpoint when you need to set a status value for system-CVE pairs.\n","operationId":"setStatus","x-methodName":"setStatus","security":[{"ApiKeyAuth":[]},{"BasicAuth":[]}],"requestBody":{"description":"Values to be set.","required":true,"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/StatusIn","x-body-name":"data"}}}},"responses":{"200":{"description":"Status successfully updated.","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/StatusOut"}}}},"404":{"description":"Given host/CVE does not exist.","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/Errors"}}}},"503":{"description":"Service is running in read-only mode.","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/Errors"}}}}}}},"/systems":{"get":{"summary":"List systems","description":"List systems that are accessible when you are logged into your account. Use this endpoint to view basic system attributes such as display name and system type.\n","operationId":"getSystemsList","x-methodName":"getSystemsList","security":[{"ApiKeyAuth":[]},{"BasicAuth":[]}],"responses":{"200":{"description":"System list","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/SystemListOut"}}}}},"parameters":[{"$ref":"#/components/parameters/filter"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/offset"},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page_size"},{"$ref":"#/components/parameters/sort"},{"$ref":"#/components/parameters/data_format"},{"$ref":"#/components/parameters/stale"},{"$ref":"#/components/parameters/uuid"},{"$ref":"#/components/parameters/tags"},{"$ref":"#/components/parameters/sap_sids"},{"$ref":"#/components/parameters/sap_system"},{"$ref":"#/components/parameters/excluded"},{"$ref":"#/components/parameters/rhel_version"},{"$ref":"#/components/parameters/report"},{"$ref":"#/components/parameters/ansible"},{"$ref":"#/components/parameters/mssql"},{"$ref":"#/components/parameters/group_names"},{"$ref":"#/components/parameters/group_ids"},{"$ref":"#/components/parameters/host_type"}]}},"/systems/ids":{"get":{"summary":"List systems identification numbers along with opt out state","description":"This lists systems including those that have opted out of the current query. Use this when you do not want to see a registered system or systems in your reports.\n","operationId":"getSystemsIds","x-methodName":"getSystemsIds","security":[{"ApiKeyAuth":[]},{"BasicAuth":[]}],"responses":{"200":{"description":"System list","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/SystemIdsOut"}}}}},"parameters":[{"$ref":"#/components/parameters/filter"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/offset"},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page_size"},{"$ref":"#/components/parameters/sort"},{"$ref":"#/components/parameters/data_format"},{"$ref":"#/components/parameters/stale"},{"$ref":"#/components/parameters/uuid"},{"$ref":"#/components/parameters/tags"},{"$ref":"#/components/parameters/sap_sids"},{"$ref":"#/components/parameters/sap_system"},{"$ref":"#/components/parameters/excluded"},{"$ref":"#/components/parameters/rhel_version"},{"$ref":"#/components/parameters/ansible"},{"$ref":"#/components/parameters/mssql"},{"$ref":"#/components/parameters/group_names"},{"$ref":"#/components/parameters/group_ids"},{"$ref":"#/components/parameters/host_type"}]}},"/systems/{inventory_id}":{"get":{"summary":"Get system details","description":"This allows you to get information about systems related to an inventory identification number. This includes details such as operating system, inventory tags, last update, opt-out status, and more.\n","operationId":"getSystemDetails","x-methodName":"getSystemDetails","security":[{"ApiKeyAuth":[]},{"BasicAuth":[]}],"responses":{"200":{"description":"System details","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/SystemDetailsOut"}}}},"404":{"description":"System has not been found in the database.","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/Errors"}}}}},"parameters":[{"$ref":"#/components/parameters/inventory_id"},{"$ref":"#/components/parameters/tags"}]}},"/systems/{inventory_id}/cves":{"get":{"summary":"Get a CVE report for a system","description":"This endpoint displays detailed information about all CVEs for which a system is exposed. Use this endpoint to discover which CVEs are affecting a given system. CVE metadata is included.\n","operationId":"getCveListBySystem","x-methodName":"getCveListBySystem","security":[{"ApiKeyAuth":[]},{"BasicAuth":[]}],"responses":{"200":{"description":"CVE report.","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/SystemCvesOut"}}}},"404":{"description":"System has not been found in the database.","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/Errors"}}}}},"parameters":[{"$ref":"#/components/parameters/inventory_id"},{"$ref":"#/components/parameters/cve_filter"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/offset"},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page_size"},{"$ref":"#/components/parameters/cve_sort"},{"$ref":"#/components/parameters/cvss_from"},{"$ref":"#/components/parameters/cvss_to"},{"$ref":"#/components/parameters/public_from"},{"$ref":"#/components/parameters/public_to"},{"$ref":"#/components/parameters/impact"},{"$ref":"#/components/parameters/status_id"},{"$ref":"#/components/parameters/data_format"},{"$ref":"#/components/parameters/business_risk_id"},{"$ref":"#/components/parameters/rule_presence"},{"$ref":"#/components/parameters/show_advisories"},{"$ref":"#/components/parameters/advisory"},{"$ref":"#/components/parameters/rule_key"},{"$ref":"#/components/parameters/known_exploit"},{"$ref":"#/components/parameters/first_reported_from"},{"$ref":"#/components/parameters/first_reported_to"},{"$ref":"#/components/parameters/advisory_available"},{"$ref":"#/components/parameters/remediation"},{"$ref":"#/components/parameters/report"},{"$ref":"#/components/parameters/tags"}]}},"/systems/{inventory_id}/cves/ids":{"get":{"summary":"Get a CVE identification number report for a system","description":"This endpoint displays identification numbers of all CVEs for which a system is exposed. Use this endpoint to learn which CVEs are affecting a given system.\n","operationId":"getCveIdsBySystem","x-methodName":"getCveIdsBySystem","security":[{"ApiKeyAuth":[]},{"BasicAuth":[]}],"responses":{"200":{"description":"CVE Ids report.","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/SystemCvesIdsOut"}}}},"404":{"description":"System has not been found in the database.","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/Errors"}}}}},"parameters":[{"$ref":"#/components/parameters/inventory_id"},{"$ref":"#/components/parameters/cve_filter"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/offset"},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page_size"},{"$ref":"#/components/parameters/cve_sort"},{"$ref":"#/components/parameters/cvss_from"},{"$ref":"#/components/parameters/cvss_to"},{"$ref":"#/components/parameters/public_from"},{"$ref":"#/components/parameters/public_to"},{"$ref":"#/components/parameters/impact"},{"$ref":"#/components/parameters/status_id"},{"$ref":"#/components/parameters/data_format"},{"$ref":"#/components/parameters/business_risk_id"},{"$ref":"#/components/parameters/rule_presence"},{"$ref":"#/components/parameters/show_advisories"},{"$ref":"#/components/parameters/advisory"},{"$ref":"#/components/parameters/rule_key"},{"$ref":"#/components/parameters/known_exploit"},{"$ref":"#/components/parameters/first_reported_from"},{"$ref":"#/components/parameters/first_reported_to"},{"$ref":"#/components/parameters/advisory_available"},{"$ref":"#/components/parameters/remediation"},{"$ref":"#/components/parameters/tags"}]}},"/systems/opt_out":{"patch":{"summary":"Opt a system in or out of the vulnerability service","description":"Opt a specific system in or out of vulnerability analysis. Use this when you want to use other Insights services but do not want to see specific systems in vulnerability reports. This allows you to hide select systems.\n","operationId":"setSystemsOptOut","x-methodName":"setSystemsOptOut","security":[{"ApiKeyAuth":[]},{"BasicAuth":[]}],"requestBody":{"description":"Values to be set.","required":true,"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/OptOutIn","x-body-name":"data"}}}},"responses":{"200":{"description":"System(s) setting has been updated.","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/BulkChangeOut"}}}},"503":{"description":"Service is running in read-only mode.","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/Errors"}}}}}}},"/vulnerabilities/cves":{"get":{"summary":"Get a vulnerabilities overview","description":"This provides an overview of vulnerabilities across your entire system inventory. Use this endpoint to get an overview of which CVEs are affecting your account, including some CVE metadata, how many systems are affected by each CVE, and more.\n","operationId":"getCveList","x-methodName":"getCveList","security":[{"ApiKeyAuth":[]},{"BasicAuth":[]}],"responses":{"200":{"description":"Vulnerabilities overview.","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/VulnerabilitiesOut"}}}}},"parameters":[{"$ref":"#/components/parameters/cve_filter"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/offset"},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page_size"},{"$ref":"#/components/parameters/cve_sort"},{"$ref":"#/components/parameters/cvss_from"},{"$ref":"#/components/parameters/cvss_to"},{"$ref":"#/components/parameters/public_from"},{"$ref":"#/components/parameters/public_to"},{"$ref":"#/components/parameters/impact"},{"$ref":"#/components/parameters/data_format"},{"$ref":"#/components/parameters/business_risk_id"},{"$ref":"#/components/parameters/status_id"},{"$ref":"#/components/parameters/rule_presence"},{"$ref":"#/components/parameters/tags"},{"$ref":"#/components/parameters/sap_sids"},{"$ref":"#/components/parameters/sap_system"},{"$ref":"#/components/parameters/known_exploit"},{"$ref":"#/components/parameters/affecting"},{"$ref":"#/components/parameters/rhel_version"},{"$ref":"#/components/parameters/report"},{"$ref":"#/components/parameters/advanced_report"},{"$ref":"#/components/parameters/ansible"},{"$ref":"#/components/parameters/mssql"},{"$ref":"#/components/parameters/advisory_available"},{"$ref":"#/components/parameters/group_names"},{"$ref":"#/components/parameters/group_ids"},{"$ref":"#/components/parameters/affecting_host_type"}]},"post":{"summary":"Send a vulnerabilities overview","description":"This is an overview of vulnerabilities for specific CVEs provided in the body. Use this endpoint to get a CVSS score, and learn the severity for a list of CVEs provided in the request.\n","operationId":"getCveList","x-methodName":"getCveList","security":[{"ApiKeyAuth":[]},{"BasicAuth":[]}],"requestBody":{"description":"List of CVEs to provide info about.","required":true,"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/VulnerabilitiesPostIn","x-body-name":"data"}}}},"responses":{"200":{"description":"Vulnerabilities overview.","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/VulnerabilitiesPostOut"}}}}},"parameters":[{"$ref":"#/components/parameters/cve_filter"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/offset"},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page_size"},{"$ref":"#/components/parameters/sort"}]}},"/vulnerabilities/cves/ids":{"get":{"summary":"Get an overview of Vulnerabilities' identification numbers","description":"This is an overview of vulnerabilities identification numbers across your entire system inventory. Use this endpoint to get an overview of which CVEs are affecting your account.\n","operationId":"getCveIdsList","x-methodName":"getCveIdsList","security":[{"ApiKeyAuth":[]},{"BasicAuth":[]}],"responses":{"200":{"description":"Vulnerabilities IDs overview.","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/VulnerabilitiesIdsOut"}}}}},"parameters":[{"$ref":"#/components/parameters/cve_filter"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/offset"},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page_size"},{"$ref":"#/components/parameters/cve_sort"},{"$ref":"#/components/parameters/cvss_from"},{"$ref":"#/components/parameters/cvss_to"},{"$ref":"#/components/parameters/public_from"},{"$ref":"#/components/parameters/public_to"},{"$ref":"#/components/parameters/impact"},{"$ref":"#/components/parameters/data_format"},{"$ref":"#/components/parameters/business_risk_id"},{"$ref":"#/components/parameters/status_id"},{"$ref":"#/components/parameters/rule_presence"},{"$ref":"#/components/parameters/tags"},{"$ref":"#/components/parameters/sap_sids"},{"$ref":"#/components/parameters/sap_system"},{"$ref":"#/components/parameters/known_exploit"},{"$ref":"#/components/parameters/affecting"},{"$ref":"#/components/parameters/rhel_version"},{"$ref":"#/components/parameters/ansible"},{"$ref":"#/components/parameters/mssql"},{"$ref":"#/components/parameters/advisory_available"}]}},"/announcement":{"get":{"summary":"Announce important updates","description":"This endpoint provides vulnerability service announcements. Remain informed about important alerts for the vulnerability service. Announcements are issued by Insights Product Managers and other subject matter experts.\n","operationId":"getAnnouncement","x-methodName":"getAnnouncement","responses":{"200":{"description":"Announcement.","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/AnnouncementOut"}}}}}}},"/dashbar":{"get":{"summary":"Get aggregations for the dashbar","description":"These are aggregations summarizing your account such as number of unique CVEs, list of security rules, CVEs by severity and more. Use this endpoint to obtain a snapshot of all the CVES and details about their prevalence, severity and other details.\n","operationId":"getDashbar","x-methodName":"getDashbar","security":[{"ApiKeyAuth":[]},{"BasicAuth":[]}],"responses":{"200":{"description":"Dashbar aggregations.","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/DashbarOut"}}}}},"parameters":[{"$ref":"#/components/parameters/tags"},{"$ref":"#/components/parameters/sap_sids"},{"$ref":"#/components/parameters/sap_system"},{"$ref":"#/components/parameters/ansible"},{"$ref":"#/components/parameters/mssql"}]}},"/feature/cves_without_errata":{"patch":{"summary":"Set a feature flag for CVEs without errata","description":"Use this endpoint to enable/disable reporting CVEs that do not have advisories (errata) for your customer account. If the feature is disabled, CVEs without advisories will be hidden in outputs of all endpoints.\n","operationId":"setCvesWithoutErrata","x-methodName":"setCvesWithoutErrata","security":[{"ApiKeyAuth":[]},{"BasicAuth":[]}],"requestBody":{"description":"Values to be set.","required":true,"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/CvesWithoutErrataIn","x-body-name":"data"}}}},"responses":{"200":{"description":"CVEs without Errata feature successfully updated.","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/CvesWithoutErrataOut"}}}}}}},"/notifications":{"delete":{"summary":"Delete already sent notifications for CVEs","description":"Use this endpoint for restarting your already obtained notifications for CVEs.\n","operationId":"deleteNotifications","x-methodName":"deleteNotifications","security":[{"ApiKeyAuth":[]},{"BasicAuth":[]}],"responses":{"200":{"description":"Sent notifications deleted.","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/NotificationsOut"}}}},"403":{"description":"Non-existing account."}}}}},"components":{"parameters":{"filter":{"in":"query","name":"filter","description":"Full text filter for the display name of system.","schema":{"type":"string"},"example":"INV-ID-1234"},"cve_filter":{"in":"query","name":"filter","description":"Full text filter for CVE and it's description text.","schema":{"type":"string"},"example":"CVE-2017"},"limit":{"in":"query","name":"limit","description":"Maximum number of records per page. Limit/Offset pagination wins over page/page_size pagination.","schema":{"type":"integer","maximum":9007199254740991,"minimum":1},"example":25},"offset":{"in":"query","name":"offset","description":"Offset of first record of paginated response. Limit/Offset pagination wins over page/page_size pagination.","schema":{"type":"integer","maximum":9007199254740991,"minimum":0},"example":1},"page":{"in":"query","name":"page","description":"Page number of paginated response. Limit/Offset pagination wins over page/page_size pagination.","schema":{"type":"integer","maximum":9007199254740991,"minimum":1},"example":1},"page_size":{"in":"query","name":"page_size","description":"Page size of paginated response. Limit/Offset pagination wins over page/page_size pagination.","schema":{"type":"integer","maximum":9007199254740991,"minimum":1},"example":25},"sort":{"in":"query","name":"sort","description":"Sorting used for response.","schema":{"type":"string"},"example":"-inventory_id"},"cve_sort":{"in":"query","name":"sort","description":"Sorting used for response.","schema":{"type":"string"},"example":"-synopsis"},"inventory_id":{"in":"path","name":"inventory_id","description":"Inventory ID.","required":true,"schema":{"type":"string","format":"uuid"},"example":"INV-ID-0000-1234"},"cve_id":{"in":"path","name":"cve_id","description":"CVE id.","required":true,"schema":{"type":"string"},"example":"CVE-2016-0800"},"public_from":{"in":"query","name":"public_from","description":"Filter CVEs based on their published date, starting from the date.","schema":{"type":"string"},"example":"2017-09-18T00:00:00+00:00"},"public_to":{"in":"query","name":"public_to","description":"Filter CVEs based on their published date, up to the date.","schema":{"type":"string"},"example":"2017-09-18T00:00:00+00:00"},"cvss_from":{"in":"query","name":"cvss_from","description":"Filter based on cvss score, starting from the value. Use -1 to include also CVEs with N/A cvss score.","schema":{"type":"number"},"example":4.6},"cvss_to":{"in":"query","name":"cvss_to","description":"Filter based on cvss score, up to the value.","schema":{"type":"number"},"example":7.2},"impact":{"in":"query","name":"impact","description":"Filter based on impact IDs.","schema":{"type":"string"},"example":"5,7"},"status_id":{"in":"query","name":"status_id","description":"Filer based on CVE status ID.","schema":{"type":"string","example":"1,4"}},"business_risk_id":{"in":"query","name":"business_risk_id","description":"Filter based on business risk IDs.","schema":{"type":"string","example":"1,3"}},"data_format":{"in":"query","name":"data_format","description":"Format of the output data, either JSON (default) or CSV.","schema":{"type":"string","example":"json"}},"account_id":{"in":"path","name":"account_id","description":"Account ID of user.","required":true,"schema":{"type":"string"},"example":"123456"},"stale":{"in":"query","name":"stale","description":"If set to true, shows stale systems. If not set defaults to false.","schema":{"type":"boolean"}},"rule_presence":{"in":"query","name":"rule_presence","description":"Comma seprated string with bools. If true shows only CVEs with security rule associated, if false shows CVEs without rules. true, false shows all.","schema":{"type":"array","items":{"type":"boolean"},"maxItems":2},"example":"true,false"},"rule_presence_deprecated":{"in":"query","name":"rule_presence","description":"Comma seprated string with bools. If true shows only CVEs with security rule associated, if false shows CVEs without rules. true, false shows all.","schema":{"type":"array","items":{"type":"boolean"},"maxItems":2},"deprecated":true,"example":"true,false"},"rule_key":{"in":"query","name":"rule_key","description":"Filters security rules by its error key.","schema":{"type":"array","items":{"type":"string"}},"example":"CVE_2018_3639_cpu_kernel|CVE_2018_3639_CPU_BAD_MICROCODE_2,CVE_2018_12207_cpu_kernel|CVE_2018_12207_CPU_KERNEL_FOR_SURE"},"rule_key_deprecated":{"in":"query","name":"rule_key","description":"Filters security rules by its error key.","schema":{"type":"array","items":{"type":"string"}},"deprecated":true,"example":"CVE_2018_3639_cpu_kernel|CVE_2018_3639_CPU_BAD_MICROCODE_2,CVE_2018_12207_cpu_kernel|CVE_2018_12207_CPU_KERNEL_FOR_SURE"},"rule":{"in":"query","name":"rule","description":"Filters CVEs or systems by security rule, has two functionalities. If value is false, shows results without security rules, every other value is taken as rule error key.","schema":{"type":"array","items":{"type":"string","minLength":1}},"example":"CVE_2018_3639_cpu_kernel|CVE_2018_3639_CPU_BAD_MICROCODE_2,CVE_2018_12207_cpu_kernel|CVE_2018_12207_CPU_KERNEL_FOR_SURE"},"uuid":{"in":"query","name":"uuid","description":"Filter based on UUID of inventory.","schema":{"type":"string"},"example":"2ee58c62-809f-11ea-bc55-0242ac130003"},"tags":{"in":"query","name":"tags","description":"Filter based on hosts tags. Tags needs to be in query format, that means /= or / if value is null. Characters '/', '=' in tag values needs to be escaped by url encoding.","schema":{"type":"array","items":{"type":"string","pattern":"^([^=/]+\\/){1}([^=/])+(=[^=/]+)?$"}},"example":"vulnerability/usage=server"},"sap_system":{"in":"query","name":"sap_system","description":"Boolean value which shows systems managed by SAP.","schema":{"type":"boolean"},"example":false},"known_exploit":{"in":"query","name":"known_exploit","description":"String of booleans (array of booleans), where true shows CVEs with known exploits, false shows CVEs without known exploits.","schema":{"type":"array","items":{"type":"boolean"},"maxItems":2},"example":"true,false"},"sap_sids":{"in":"query","name":"sap_sids","description":"List of SAP IDs to filter with","schema":{"type":"array","items":{"type":"string"}},"example":"ABC,CDE"},"show_advisories":{"in":"query","name":"show_advisories","description":"If true shows advisories list","schema":{"type":"boolean"},"example":false},"advisory":{"in":"query","name":"advisory","description":"Filter by advisory name, works only with show_advisories=true","schema":{"type":"string"},"example":"RHSA-2019:1481"},"affecting":{"in":"query","name":"affecting","description":"Comma seprated string with bools (array of bools). True value controls displaying CVEs with at least one system affected. False value toggles CVEs with no systems affected. Defaults to showing only CVEs with at least one system affected.","schema":{"type":"array","items":{"type":"boolean"},"maxItems":2},"example":"true,false"},"affecting_host_type":{"in":"query","name":"affecting_host_type","description":"Controls, whenever CVE has 1 or more affecting systems. Value \"image\" returns CVEs with one or more vulnerable image-mode systems, value \"rpmdnf\" returns CVEs with one or more vulnerable conventional systems. Value \"none\" returns CVEs not affecting systems of any kind.","schema":{"type":"array","items":{"type":"string","enum":["rpmdnf","image","edge","none"]},"maxItems":3},"example":"image,none"},"excluded":{"in":"query","name":"excluded","description":"Comma seprated string with bools (array of bools). True boolean value displays systems which are excluded. False value displays systems excluded from vulnerability analysis. Defaults to showing only those systems which are not excluded.","schema":{"type":"array","items":{"type":"boolean"},"maxItems":2},"example":"true,false"},"rhel_version":{"in":"query","name":"rhel_version","description":"Filters results by RHEL OS version. Automatically flters out systems which are not RHEL or have uknown OS.","required":false,"schema":{"type":"string","description":"List of RHEL versions. E.g. 7,8.1 will filter out everything which is not RHEL 7.x or RHEL 8.1"}},"first_reported_from":{"in":"query","name":"first_reported_from","description":"Filter for CVEs/Systems where the vulnerability appeared after given date.","required":false,"schema":{"type":"string","description":"Datetime string"},"example":"2017-09-18T00:00:00+00:00"},"first_reported_to":{"in":"query","name":"first_reported_to","description":"Filter for CVEs/Systems where the vulnerability appeared before given date.","required":false,"schema":{"type":"string","description":"Datetime string"},"example":"2017-09-18T00:00:00+00:00"},"advisory_available":{"in":"query","name":"advisory_available","description":"String of booleans (array of booleans), where true shows CVE-system pairs with available advisory, false shows CVE-system pairs without available advisory.","schema":{"type":"array","items":{"type":"boolean"},"maxItems":2},"example":"true,false"},"remediation":{"in":"query","name":"remediation","description":"Filer based on available remediation type id.","schema":{"type":"string","example":1}},"report":{"in":"query","name":"report","description":"Needs to be used when endpoint data is used for report generation, checks RBAC permission for report and export feature.","required":false,"schema":{"type":"boolean"},"example":false},"advanced_report":{"in":"query","name":"advanced_report","description":"Needs to be used when endpoint data is used for Report by CVEs feature, checks RBAC permission for advanced report.","schema":{"type":"boolean"},"example":false},"ansible":{"in":"query","name":"ansible","description":"Boolean value which shows systems managed by Ansible Automation Platform.","schema":{"type":"boolean"},"example":false},"mssql":{"in":"query","name":"mssql","description":"Boolean value which shows systems managed by MSSQL.","schema":{"type":"boolean"},"example":false},"group_names":{"in":"query","name":"group_names","description":"Names of the inventory groups.","schema":{"type":"array","items":{"type":"string"}},"example":"Production,Stage"},"group_ids":{"in":"query","name":"group_ids","description":"IDs of the inventory groups.","schema":{"type":"array","items":{"type":"string"}},"example":"00000000-1111-0000-0000-000000000000,00000000-2222-0000-0000-000000000000"},"host_type":{"in":"query","name":"host_type","description":"For filtering out the systems based on their type. Value \"rpmdnf\" for RPMDNF systems, \"image\" for image-mode systems.","schema":{"type":"array","items":{"type":"string","enum":["rpmdnf","image","edge"]},"maxItems":2}}},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic","description":"Username and password login.","x-basicInfoFunc":"manager.base.basic_auth"},"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-rh-identity","description":"Identity header provided by 3scale (for non-prod testing only).","x-apikeyInfoFunc":"manager.base.auth"}},"schemas":{"Errors":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"oneOf":[{"type":"string","description":"Error detail.","example":"Record not found."},{"type":"object","description":"Returned with RBAC (user permissions) related issue","properties":{"msg":{"type":"string","description":"Error detail related to RBAC problem"},"permissions":{"type":"array","items":{"type":"string"},"description":"Array with RBAC permissions of user"}}}]},"status":{"type":"string","description":"String representation of HTTP status code.","example":404}},"required":["detail","status"]},"minItems":1}},"required":["errors"]},"Links":{"type":"object","properties":{"first":{"type":"string","description":"Link to first page.","example":"/api?offset=0&limit=1"},"last":{"type":"string","description":"Link to last page.","example":"/api?offset=7&limit=1"},"next":{"type":"string","description":"Link to next page.","example":"/api?offset=5&limit=1","nullable":true},"previous":{"type":"string","description":"Link to next page.","example":"/api?offset=3&limit=1","nullable":true}},"required":["first","last","next","previous"]},"Meta":{"type":"object","properties":{"filter":{"type":"string","description":"Full text filter","example":"CVE-2016-0800","nullable":true},"limit":{"type":"integer","description":"Maximum number of paginated results.","example":25},"offset":{"type":"integer","description":"First record of paginated response.","example":0},"page":{"type":"integer","description":"Page number of paginated response.","example":1},"page_size":{"type":"integer","description":"Number of records per page of paginated response.","example":25},"pages":{"type":"integer","description":"Total number of pages of paginated response.","example":1},"sort":{"type":"string","description":"Sorting filter.","example":"-inventory_id","nullable":true},"total_items":{"type":"integer","description":"Total number of records.","example":37},"data_format":{"type":"string","description":"Format of the output data, either JSON (default) or CSV.","example":"JSON"}},"required":["filter","limit","offset","page","page_size","pages","sort","total_items","data_format"]},"MetaPermissions":{"type":"object","properties":{"permissions":{"type":"array","description":"Fetched permissions from RBAC for given user","nullable":false,"items":{"type":"string","example":"vulnerability:vulnerability_results:read"}}},"required":["permissions"]},"MetaVulnerabilitiesOut":{"allOf":[{"$ref":"#/components/schemas/Meta"},{"$ref":"#/components/schemas/MetaPermissions"},{"type":"object","properties":{"affecting":{"type":"string","description":"Description of CVE showing preferences","example":"True,False","nullable":true},"business_risk_id":{"type":"string","description":"Filter based on business risk IDs.","example":"1,3","nullable":true},"cvss_from":{"type":"number","description":"Filter based on cvss score, starting from the value. Use -1 to include also CVEs with N/A cvss score.","example":4.6,"nullable":true},"cvss_to":{"type":"number","description":"Filter based on cvss score, up to the value.","example":7.2,"nullable":true},"public_from":{"type":"string","description":"Filter CVEs based on their published date, starting from the date.","example":"2017-09-18T00:00:00+00:00","nullable":true},"public_to":{"type":"string","description":"Filter CVEs based on their published date, up to the date.","example":"2017-09-18T00:00:00+00:00","nullable":true},"impact":{"type":"string","description":"Filter based on impact IDs.","example":"5,7","nullable":true},"system_count_per_type":{"type":"object","description":"Number of systems managed by vulnerability application, grouped by host type.","properties":{"rpmdnf":{"type":"number","description":"Number of conventional systems.","example":26},"image":{"type":"number","description":"Number of image-mode systems.","example":3,"nullable":true},"edge":{"type":"number","description":"Number of image-mode systems. (Deprecated)","example":3,"nullable":true}}},"system_count":{"type":"integer","description":"Total number of systems managed by vulnerability application.","example":25641},"rhel_version":{"type":"string","description":"Filter base on system RHEL version.","example":"8.2","nullable":true},"rule_presence":{"type":"string","description":"Filter based on presence of security rule","example":"true,false","nullable":true},"cves_without_errata":{"type":"boolean","description":"CVEs without Errata feature flag","nullable":true},"advisory_available":{"type":"string","description":"Shows whether a CVE has available advisory or not","example":"true,false","nullable":true},"cache_used":{"type":"boolean","description":"Flag if cached data was used to produce the response.","example":false}},"required":["affecting","business_risk_id","cvss_from","cvss_to","public_from","public_to","impact","rhel_version","rule_presence","cves_without_errata","advisory_available","cache_used"]}]},"MetaAffectedSystems":{"allOf":[{"$ref":"#/components/schemas/Meta"},{"$ref":"#/components/schemas/MetaPermissions"},{"type":"object","properties":{"status_id":{"type":"string","description":"Filer based on CVE status ID.","example":"1,4","nullable":true},"rule_key":{"type":"string","description":"Filters security rules by its error key.","example":"CVE_2018_3639_cpu_kernel|CVE_2018_3639_CPU_BAD_MICROCODE_2,CVE_2018_12207_cpu_kernel|CVE_2018_12207_CPU_KERNEL_FOR_SURE","nullable":true},"rule_presence":{"type":"string","description":"Filter based on presence of security rule","example":"true,false","nullable":true},"patch_access":{"type":"boolean","description":"If show_advisories=true shows access to patch service else null","example":true,"nullable":true},"rhel_version":{"type":"string","description":"Filter base on system RHEL version.","example":"8.2","nullable":true},"first_reported_from":{"type":"string","description":"Filter system-cve pairs based on first time of detection of CVE.","example":"2017-09-18T00:00:00+00:00","nullable":true},"first_reported_to":{"type":"string","description":"Filter system-cve pairs based on first time of detection of CVE.","example":"2017-09-18T00:00:00+00:00","nullable":true},"cves_without_errata":{"type":"boolean","description":"CVEs without Errata feature flag","nullable":true},"group_names":{"type":"string","description":"Name of the inventory group.","example":"Production,Stage","nullable":true},"group_ids":{"type":"string","description":"ID of the inventory group.","example":"00000000-1111-0000-0000-000000000000,00000000-2222-0000-0000-000000000000","nullable":true}},"required":["status_id","rule_key","rule_presence","patch_access","rhel_version","first_reported_from","first_reported_to","cves_without_errata","group_names","group_ids"]}]},"MetaSystems":{"allOf":[{"$ref":"#/components/schemas/Meta"},{"$ref":"#/components/schemas/MetaPermissions"},{"type":"object","properties":{"excluded":{"type":"string","description":"Display setting of opted out systems.","example":"true,false","nullable":true},"rhel_version":{"type":"string","description":"Filter base on system RHEL version.","example":"8.2","nullable":true}},"required":["excluded","rhel_version"]}]},"MetaCves":{"allOf":[{"$ref":"#/components/schemas/Meta"},{"$ref":"#/components/schemas/MetaPermissions"},{"type":"object","properties":{"business_risk_id":{"type":"string","description":"Filter based on business risk IDs.","example":"1,3","nullable":true},"cvss_from":{"type":"number","description":"Filter based on cvss score, starting from the value. Use -1 to include also CVEs with N/A cvss score.","example":4.6,"nullable":true},"cvss_to":{"type":"number","description":"Filter based on cvss score, up to the value.","example":7.2,"nullable":true},"public_from":{"type":"string","description":"Filter CVEs based on their published date, starting from the date.","example":"2017-09-18T00:00:00+00:00","nullable":true},"public_to":{"type":"string","description":"Filter CVEs based on their published date, up to the date.","example":"2017-09-18T00:00:00+00:00","nullable":true},"impact":{"type":"string","description":"Filter based on impact IDs.","example":"5,7","nullable":true},"status_id":{"type":"string","description":"Filer based on CVE status ID.","example":"1,4","nullable":true},"rule_presence":{"type":"string","description":"Filter based on presence of security rule","example":"true,false","nullable":true},"patch_access":{"type":"boolean","description":"If show_advisories=true shows access to patch service else null","example":true,"nullable":true},"first_reported_from":{"type":"string","description":"Filter system-cve pairs based on first time of detection of CVE.","example":"2017-09-18T00:00:00+00:00","nullable":true},"first_reported_to":{"type":"string","description":"Filter system-cve pairs based on first time of detection of CVE.","example":"2017-09-18T00:00:00+00:00","nullable":true},"cves_without_errata":{"type":"boolean","description":"CVEs without Errata feature flag","nullable":true}},"required":["business_risk_id","cvss_from","cvss_to","public_from","public_to","impact","status_id","rule_presence","patch_access","first_reported_from","first_reported_to","cves_without_errata"]}]},"MetaCvesSystems":{"allOf":[{"$ref":"#/components/schemas/MetaCves"},{"type":"object","properties":{"opt_out":{"type":"boolean","description":"If given system was opted out.","example":true}},"required":["opt_out"]}]},"AffectedSystemsOut":{"type":"object","properties":{"data":{"oneOf":[{"type":"string","description":"CSV export of the JSON."},{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Host id.","example":"INV-ID-0000-1234"},"type":{"type":"string","description":"Type of the record.","example":"system"},"attributes":{"type":"object","properties":{"cve_status_id":{"type":"integer","description":"Internal ID of the CVE status.","example":4},"culled_timestamp":{"type":"string","description":"Timestamp from which the host is considered deleted.","example":"2018-09-22T16:00:00+00:00","nullable":true},"display_name":{"type":"string","description":"System's name.","example":"system.example.com","nullable":true},"first_reported":{"type":"string","description":"Date of when the CVE was first reported on the system.","example":"2018-09-22T16:00:00+00:00"},"inventory_id":{"type":"string","description":"Host ID.","example":"INV-ID00-0000-1234"},"insights_id":{"type":"string","description":"Insights host ID.","example":"0035f6bc-cdb0-4763-8fcd-1dc58f716359","nullable":true},"last_evaluation":{"type":"string","description":"Date of last evaluation.","example":"2018-09-22T16:00:00+00:00","nullable":true},"os":{"type":"string","description":"Operating system.","example":"RHEL 8.4"},"reporter":{"type":"number","description":"Reporter of the vulnerability, 1 for VMaaS, 2 for security rule, 3 for both VMaaS and rule.","enum":[0,1,2,3]},"rhsm_lock":{"type":"string","description":"System is locked to following RHSM version.","example":"8.4","nullable":true},"rule":{"type":"object","description":"Details of associated security rule.","properties":{"details":{"type":"object","description":"Additional information specific to the system rule hit."},"resolution":{"type":"object","description":"Details of recommended resolution.","properties":{"resolution":{"type":"string","example":"Red Hat recommends that you update the dnsmasq package","description":"Recommended resolution of the issue.","nullable":true}},"required":["resolution"]},"rule":{"type":"object","properties":{"description":{"type":"string","example":"CVE-2017-14491 dnsmasq code execution with listening processes","description":"Description of the associated security rule.","nullable":true},"more_info":{"type":"string","example":"For more information about this specific flaw, see its ...","description":"Additional information about the issue.","nullable":true},"node_id":{"type":"integer","description":"ID of associated Red Hat knowledgebase article.","example":3199382,"nullable":true},"reason":{"type":"string","example":"This system is vulnerable because it is running a vulnerable package.","description":"Reason of why rule did hit.","nullable":true},"rule_id":{"type":"string","example":"CVE_2017_14491_dnsmasq|CVE_2017_14491_ERROR","description":"ID of associated security rule."}},"required":["description","more_info","node_id","reason","rule_id"]}},"nullable":true,"required":["details","resolution","rule"]},"rules_evaluation":{"type":"string","description":"Date of last security rules evaluation.","example":"2018-09-22T16:00:00+00:00","nullable":true},"stale_timestamp":{"type":"string","description":"Date when stale system becomes stale.","example":"2018-09-22T16:00:00+00:00","nullable":true},"stale_warning_timestamp":{"type":"string","description":"Date when stale system becomes hidden in the application.","example":"2018-09-22T16:00:00+00:00","nullable":true},"status_id":{"type":"integer","description":"Internal ID of the vulnerability status.","example":4},"status_name":{"type":"string","description":"Status of the vulnerability for the application's point of view.","example":"Resolved"},"status_text":{"type":"string","description":"Complementary text to the status.","example":"Not relevant","nullable":true},"tags":{"type":"array","items":{"type":"object","properties":{"namespace":{"type":"string","description":"Namespace of single tag.","example":"vulnerability","nullable":true},"key":{"type":"string","description":"Key of the single tag.","example":"CVE"},"value":{"type":"string","description":"Value of the single tag.","example":"CVE-2017-1","nullable":true}},"required":["namespace","key","value"]}},"advisories_list":{"type":"array","description":"List of advisories for system","items":{"type":"string","description":"Advisory id","example":"RHSA-2019:1481"}},"updated":{"type":"string","description":"Date of the lastest upload of archive taken from Inventory syndicated data.","example":"2018-09-22T16:00:00+00:00","nullable":true},"last_upload":{"type":"string","description":"Date of the latest upload of archive.","example":"2018-09-22T16:00:00+00:00"},"advisory_available":{"type":"boolean","description":"Shows whether a CVE has available advisory or not","example":true},"remediation":{"type":"number","description":"Type of available remediation, 0 for none, 1 for manual, 2 for playbook.","enum":[0,1,2]},"mitigation_reason":{"type":"string","description":"Reason why the system is not vulnerable.","example":"SELinux mitigates the issue","nullable":true},"inventory_group":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"ID of inventory group.","example":"00000000-1111-0000-0000-000000000000"},"name":{"type":"string","description":"Name of inventory group.","example":"group01"}},"required":["id","name"]}},"host_type":{"type":"string","description":"Type of the host","enum":["rpmdnf","image"]}},"required":["cve_status_id","culled_timestamp","display_name","first_reported","inventory_id","insights_id","last_evaluation","os","reporter","rhsm_lock","rule","rules_evaluation","stale_timestamp","stale_warning_timestamp","status_id","status_name","status_text","tags","updated","advisory_available","remediation","mitigation_reason","inventory_group","host_type"]}},"required":["id","type","attributes"]}}]},"links":{"$ref":"#/components/schemas/Links"},"meta":{"$ref":"#/components/schemas/MetaAffectedSystems"}},"required":["data","links","meta"]},"AffectedSystemsIdsOut":{"type":"object","properties":{"data":{"oneOf":[{"type":"string","description":"CSV export of the JSON."},{"type":"array","items":{"type":"object","description":"Smallest dataset for frontend to work.","properties":{"inventory_id":{"type":"string","description":"Host ID.","example":"INV-ID00-0000-1234"},"rule_id":{"type":"string","example":"CVE_2017_14491_dnsmasq|CVE_2017_14491_ERROR","description":"ID of associated security rule.","nullable":true},"status_id":{"type":"integer","description":"Internal ID of the vulnerability status.","example":4},"status_text":{"type":"string","description":"Complementary text to the status.","example":"Not relevant","nullable":true},"display_name":{"type":"string","description":"System's name.","example":"system.example.com"},"mitigation_reason":{"type":"string","description":"Reason why the system is not vulnerable.","example":"SELinux mitigates the issue","nullable":true},"remediation":{"type":"number","description":"Type of available remediation, 0 for none, 1 for manual, 2 for playbook.","enum":[0,1,2]}},"required":["inventory_id","rule_id","status_id","status_text","display_name","remediation"]}}]},"links":{"$ref":"#/components/schemas/Links"},"meta":{"$ref":"#/components/schemas/MetaAffectedSystems"}},"required":["data","links","meta"]},"BusinessRiskListOut":{"type":"object","properties":{"data":{"type":"array","description":"List of available business risk/business_risk_id pairs.","items":{"type":"object","properties":{"id":{"type":"integer","description":"Internal business_risk_id.","example":3},"name":{"type":"string","description":"Represenation of internal business_risk_id.","example":"Low"}},"required":["id","name"]}},"meta":{"type":"object","properties":{"total_items":{"type":"integer","description":"Total number of available business risk/business_risk_id pairs.","example":1}},"required":["total_items"]}},"required":["data","meta"]},"CveDetailOut":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","description":"CVE id.","example":"CVE-2016-0800"},"type":{"type":"string","description":"Type of the record.","example":"cve"},"attributes":{"type":"object","properties":{"business_risk":{"type":"string","description":"Business risk of the vulnerability.","example":"Low"},"business_risk_id":{"type":"integer","description":"Internal ID of the vulnerability business risk.","example":1},"business_risk_text":{"type":"string","description":"Complementary text to the business risk.","example":"QA environment => Low business risk","nullable":true},"celebrity_name":{"type":"string","description":"\"Celebrity\" name of the CVE.","example":"Spectre/Meltdown","nullable":true},"cvss2_metrics":{"type":"string","description":"cvss2 metrics of the CVE.","example":"AV:N/AC:M/Au:N/C:P/I:P/A:N","nullable":true},"cvss2_score":{"type":"string","description":"String representation of cvss2 score of the CVE.","example":"5.800","nullable":true},"cvss3_metrics":{"type":"string","description":"cvss3 metrics of the CVE.","example":"AV:N/AC:M/Au:N/C:P/I:P/A:N","nullable":true},"cvss3_score":{"type":"string","description":"String representation of cvss3 score of the CVE.","example":"4.400","nullable":true},"description":{"type":"string","description":"Description of the CVE.","example":"A padding oracle flaw was found in the Secure Sockets Layer version 2.0 (SSLv2) protocol. An attacker could..."},"modified_date":{"type":"string","description":"String representation of ISO-8601 formatted date of last modification of the CVE.","example":"2019-03-07T08:15:36+00:00","nullable":true},"impact":{"type":"string","description":"Red Hat security impact of the CVE.","example":"Important"},"public_date":{"type":"string","description":"String representation of ISO-8601 formatted date of first public disclosure of the CVE.","example":"2016-03-01T00:00:00+00:00","nullable":true},"redhat_url":{"type":"string","description":"Additional resource about the CVE, provided by Red Hat.","example":"https://access.redhat.com/security/cve/cve-2016-0800","nullable":true},"rules":{"type":"array","items":{"$ref":"#/components/schemas/InsightsRule"}},"secondary_url":{"type":"string","description":"Additional resources about the CVE.","example":"https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2016-0800","nullable":true},"status":{"type":"string","description":"Status of the vulnerability.","example":"Not Reviewed"},"status_id":{"type":"integer","description":"Internal ID of the vulnerability status.","example":1},"status_text":{"type":"string","description":"Complementary text to the status.","example":"Not relevant","nullable":true},"synopsis":{"type":"string","description":"Synopsis of the CVE.","example":"CVE-2016-0800"},"systems_status_detail":{"type":"object","description":"Counts of systems with given status type."},"systems_status_divergent":{"type":"integer","description":"How many systems-CVE pairs have different status than CVE-level.","example":20},"advisories_list":{"type":"array","description":"List of advisory names or detailed advisory information","nullable":true,"items":{"type":"string","example":"RHSA-2015:0809"}},"known_exploit":{"type":"boolean","description":"Shows whether a CVE has known exploits or not","example":true},"affected_but_not_vulnerable":{"type":"integer","nullable":true,"description":"Number of systems that are affected by given CVE but are not vulnerable.","example":0},"affected_systems":{"type":"integer","nullable":true,"description":"Number of systems that are overall affected by given CVE","example":52}},"required":["business_risk","business_risk_id","business_risk_text","celebrity_name","cvss2_metrics","cvss2_score","cvss3_metrics","cvss3_score","description","impact","modified_date","public_date","redhat_url","rules","secondary_url","status","status_id","status_text","synopsis","systems_status_detail","systems_status_divergent","advisories_list","known_exploit","affected_but_not_vulnerable"]}},"required":["id","type","attributes"]},"meta":{"$ref":"#/components/schemas/MetaPermissions"}}},"CveRiskIn":{"type":"object","properties":{"cve":{"$ref":"#/components/schemas/CveOrList"},"business_risk_id":{"type":"integer","description":"Business risk ID to be set, obtained by GET method.","example":3},"business_risk_text":{"type":"string","description":"Complementary text to the business risk.","example":"Not relevant","nullable":true}},"required":["cve"]},"CveStatusIn":{"type":"object","properties":{"cve":{"$ref":"#/components/schemas/CveOrList"},"status_id":{"type":"integer","description":"Status ID to be set, obtained by GET method.","example":3},"status_text":{"type":"string","description":"Complementary text to the status.","example":"Not relevant","nullable":true}},"required":["cve"]},"CveOrList":{"oneOf":[{"type":"string","description":"CVE name.","example":"CVE-2016-0800"},{"type":"array","items":{"type":"string","example":"CVE-2016-0800"},"description":"List of CVEs for a bulk change."}],"example":"CVE-2016-0800"},"InventoryIdOrList":{"oneOf":[{"type":"string","description":"Inventory ID.","example":"f35b1e1d-d231-43f2-8e4f-8f9cb01e3aa2"},{"type":"array","items":{"type":"string","example":"f35b1e1d-d231-43f2-8e4f-8f9cb01e3aa2"},"description":"List of inventory IDs for a bulk change."}],"example":"f35b1e1d-d231-43f2-8e4f-8f9cb01e3aa2"},"OptOutIn":{"type":"object","properties":{"inventory_id":{"$ref":"#/components/schemas/InventoryIdOrList"},"opt_out":{"type":"boolean","description":"Opt out setting to be set.","example":true}},"required":["inventory_id","opt_out"]},"BulkChangeOut":{"type":"object","properties":{"updated":{"type":"array","items":{"type":"string","example":"f35b1e1d-d231-43f2-8e4f-8f9cb01e3aa2"},"description":"List of updated objects/updated object IDs."},"meta":{"$ref":"#/components/schemas/MetaPermissions"}},"required":["updated"]},"StatusIn":{"type":"object","properties":{"inventory_id":{"$ref":"#/components/schemas/InventoryIdOrList"},"cve":{"$ref":"#/components/schemas/CveOrList"},"status_id":{"type":"integer","description":"Status ID to be set, obtained by GET method. If not specified, global CVE status is set.","example":3},"status_text":{"type":"string","description":"Complementary text to the status.","example":"Not relevant","nullable":true}},"required":["cve"]},"CvesWithoutErrataIn":{"type":"object","properties":{"enable":{"type":"boolean","description":"Enable or disable CVEs without Errata feature.","example":true}},"required":["enable"]},"ExecutiveReport":{"type":"object","properties":{"system_count_per_type":{"type":"object","description":"Number of systems managed by vulnerability application, grouped by host type.","properties":{"rpmdnf":{"type":"number","description":"Number of conventional systems.","example":26},"image":{"type":"number","description":"Number of image-mode systems.","example":3,"nullable":true},"edge":{"type":"number","description":"Number of image-mode systems. (Deprecated)","example":3,"nullable":true}}},"system_count":{"type":"integer","description":"Total number of systems managed by vulnerability application.","example":25641},"cves_total":{"type":"integer","description":"Number of unique CVEs discovered on the managed systems.","example":1902},"cves_by_severity":{"type":"object","description":"Number of CVEs discovered on the managed systems, divided into buckets based on their CVSSv3 score (CVSSv2 is used when CVSSv3 is not available).","properties":{"0to3.9":{"type":"object","properties":{"count":{"type":"integer","description":"Number of CVEs with CVSS score lower than 4.","example":1902},"percentage":{"type":"number","description":"Percentage of CVEs with CVSS score lower than 4.","example":60}},"required":["count","percentage"]},"4to7.9":{"type":"object","properties":{"count":{"type":"integer","description":"Number of CVEs with CVSS score higher or equal to 4 and lower then 8.","example":400},"percentage":{"type":"number","description":"Percentage of CVEs with CVSS score higher or equal to 4 and lower then 8.","example":15}},"required":["count","percentage"]},"8to10":{"type":"object","properties":{"count":{"type":"integer","description":"Number of CVEs with CVSS score higher or equal to 8.","example":109},"percentage":{"type":"number","description":"Percentage of CVEs with CVSS score higher or equal to 8.","example":2}},"required":["count","percentage"]}},"required":["0to3.9","4to7.9","8to10"]},"recent_cves":{"type":"object","description":"Number of recently published CVEs identified on managed systems","properties":{"last7days":{"type":"integer","description":"Number of CVEs identified on managed systems published in last 7 days.","example":14},"last30days":{"type":"integer","description":"Number of CVEs identified on managed systems published in last 30 days.","example":62},"last90days":{"type":"integer","description":"Number of CVEs identified on managed systems published in last 90 days.","example":156}},"required":["last7days","last30days","last90days"]},"rules_by_severity":{"type":"object","description":"Information about how much systems are affected by a security rule, broken down by rule severity.","properties":{"1":{"type":"object","properties":{"rule_count":{"type":"integer","description":"How many unique rules with at least system affected are present.","example":12},"systems_affected":{"type":"integer","description":"How many unique systems are affected by at least one rules with given severity","example":443}},"required":["rule_count","systems_affected"]},"2":{"type":"object","properties":{"rule_count":{"type":"integer","description":"How many unique rules with at least system affected are present.","example":12},"systems_affected":{"type":"integer","description":"How many unique systems are affected by at least one rules with given severity","example":443}},"required":["rule_count","systems_affected"]},"3":{"type":"object","properties":{"rule_count":{"type":"integer","description":"How many unique rules with at least system affected are present.","example":12},"systems_affected":{"type":"integer","description":"How many unique systems are affected by at least one rules with given severity","example":443}},"required":["rule_count","systems_affected"]},"4":{"type":"object","properties":{"rule_count":{"type":"integer","description":"How many unique rules with at least system affected are present.","example":12},"systems_affected":{"type":"integer","description":"How many unique systems are affected by at least one rules with given severity","example":443}},"required":["rule_count","systems_affected"]}},"required":["1","2","3","4"]},"rules_total":{"type":"integer","description":"Number of unique CVEs discovered on the managed systems.","example":1902},"top_cves":{"type":"array","items":{"type":"object","properties":{"synopsis":{"type":"string","description":"CVE synopsis","example":"CVE-2016-0800"},"cvss2_score":{"type":"string","description":"String representation of cvss2 score of the CVE.","example":"5.800","nullable":true},"cvss3_score":{"type":"string","description":"String representation of cvss3 score of the CVE.","example":"4.400","nullable":true},"description":{"type":"string","description":"Description of the CVE.","example":"A padding oracle flaw was found in the Secure Sockets Layer version 2.0 (SSLv2) protocol. An attacker could..."},"security_rule":{"type":"boolean","description":"Indicator of security rule presence","example":true,"deprecated":true},"rule_presence":{"type":"boolean","description":"Indicator of security rule presence","example":true},"systems_affected":{"type":"integer","description":"Systems affected by the CVE.","example":1795},"known_exploit":{"type":"boolean","description":"Shows whether a CVE has known exploits or not","example":true}},"required":["synopsis","cvss2_score","cvss3_score","description","systems_affected","known_exploit"]}},"top_rules":{"type":"array","items":{"type":"object","properties":{"associated_cves":{"type":"array","description":"All CVEs associated with the rule","items":{"type":"string","example":"CVE-2019-1125"}},"description":{"type":"string","example":"Privilege Escalation with running service (no fix available for this version)","description":"Brief description of the issue."},"rule_id":{"type":"string","example":"CVE_2017_14491_dnsmasq|CVE_2017_14491_ERROR","description":"ID of associated security rule."},"name":{"type":"string","description":"Name of the security rule.","example":"httpd denial of service with running services"},"severity":{"type":"integer","description":"Severity of the security rule.","example":3},"systems_affected":{"type":"integer","description":"Number of systems affected by the rule.","example":443}},"required":["associated_cves","description","name","rule_id","severity","systems_affected"]}},"meta":{"$ref":"#/components/schemas/MetaPermissions"}},"required":["system_count","cves_total","cves_by_severity","rules_by_severity","rules_total","recent_cves"]},"OSExposureReport":{"type":"object","properties":{"data":{"oneOf":[{"type":"string","description":"CSV export of the JSON."},{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Name of the operating system.","example":"RHEL"},"major":{"type":"integer","description":"Operating system major version.","example":9},"minor":{"type":"integer","description":"Operating system minor version.","example":5},"lifecycle_phase":{"type":"string","description":"Lifecycle phase of the given version.","example":"eus"},"cves_critical":{"type":"integer","description":"Number of CVEs with Critical severity.","example":2},"cves_important":{"type":"integer","description":"Number of CVEs with Important severity.","example":16},"cves_moderate":{"type":"integer","description":"Number of CVEs with Moderate severity.","example":57},"cves_low":{"type":"integer","description":"Number of CVEs with Low severity.","example":12},"cves_unpatched_critical":{"type":"integer","description":"Number of unpatched CVEs with Critical severity.","example":2},"cves_unpatched_important":{"type":"integer","description":"Number of unpatched CVEs with Important severity.","example":16},"cves_unpatched_moderate":{"type":"integer","description":"Number of unpatched CVEs with Moderate severity.","example":57},"cves_unpatched_low":{"type":"integer","description":"Number of unpatched CVEs with Low severity.","example":12}},"required":["name","major","minor","lifecycle_phase","cves_critical","cves_important","cves_moderate","cves_low","cves_unpatched_critical","cves_unpatched_important","cves_unpatched_moderate","cves_unpatched_low"]}}]}},"required":["data"]},"Dashboard":{"type":"object","properties":{"cves_total":{"type":"integer","description":"Number of unique CVEs discovered on the managed systems.","example":1902},"cves_by_severity":{"type":"object","description":"Number of CVEs discovered on the managed systems, divided into buckets based on their CVSSv3 score (CVSSv2 is used when CVSSv3 is not available).","properties":{"0to3.9":{"type":"object","properties":{"count":{"type":"integer","description":"Number of CVEs with CVSS score lower than 4.","example":1902},"percentage":{"type":"number","description":"Percentage of CVEs with CVSS score lower than 4.","example":60},"known_exploits":{"type":"number","description":"Number of CVEs in given bracket with a known exploit.","example":6}},"required":["count","percentage"]},"4to7.9":{"type":"object","properties":{"count":{"type":"integer","description":"Number of CVEs with CVSS score higher or equal to 4 and lower then 8.","example":400},"percentage":{"type":"number","description":"Percentage of CVEs with CVSS score higher or equal to 4 and lower then 8.","example":15},"known_exploits":{"type":"number","description":"Number of CVEs in given bracket with a known exploit.","example":6}},"required":["count","percentage"]},"8to10":{"type":"object","properties":{"count":{"type":"integer","description":"Number of CVEs with CVSS score higher or equal to 8.","example":109},"percentage":{"type":"number","description":"Percentage of CVEs with CVSS score higher or equal to 8.","example":2},"known_exploits":{"type":"number","description":"Number of CVEs in given bracket with a known exploit.","example":6}},"required":["count","percentage"]}},"required":["0to3.9","4to7.9","8to10"]},"recent_cves":{"type":"object","description":"Number of recently published CVEs identified on managed systems","properties":{"last7days":{"type":"integer","description":"Number of CVEs identified on managed systems published in last 7 days.","example":14},"last30days":{"type":"integer","description":"Number of CVEs identified on managed systems published in last 30 days.","example":62},"last90days":{"type":"integer","description":"Number of CVEs identified on managed systems published in last 90 days.","example":156}},"required":["last7days","last30days","last90days"]},"recent_rules":{"type":"array","description":"List of recently (14 days) released security rules.","items":{"type":"object","description":"Security rule.","properties":{"associated_cves":{"type":"array","description":"List of CVEs associated with the security rule.","items":{"type":"string","description":"CVE name.","example":"CVE-2016-0800"}},"description":{"type":"string","example":"A heap-based buffer overflow was found in the way ...","description":"Description of the issue related with the security rule."},"id":{"type":"string","description":"ID of the security rule.","example":"CVE_2019_11135_cpu_taa|CVE_2019_11135_CPU_TAA_KERNEL"},"name":{"type":"string","description":"Name of the security rule.","example":"sudo privilege escalation"},"node_id":{"type":"number","description":"Node id of access.redhat.com/node/* article.","example":5737621,"nullable":true},"public_date":{"type":"string","description":"String representation of ISO-8601 formatted date of release of the security rule.","example":"2016-03-01T00:00:00+00:00","nullable":true},"severity":{"type":"number","description":"Number representation of the security rule severity.","example":3},"systems_affected":{"type":"number","description":"Number of systems triggering the security rule.","example":178}}},"required":["associated_cves","description","name","node_id","severity","systems_affected"]},"rules_cves_total":{"type":"integer","description":"Total number of CVEs with associated security rules affecting given account.","example":12},"system_count":{"type":"integer","description":"Total systems registered to Vulnerability service (with applied filtering).","example":241},"exploited_cves_count":{"type":"integer","description":"unique number of CVEs having known exploit affecting at least one system","example":5}},"required":["cves_total","cves_by_severity","recent_cves","recent_rules","rules_cves_total","system_count","exploited_cves_count"]},"PlaybookTemplate":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"description":{"type":"string","description":"Playbook template description.","example":"Fix issues caused by CVE_2017_6074_kernel|KERNEL_CVE_2017_6074."},"play":{"type":"string","description":"Actual playbook template."},"version":{"type":"string","description":"Revision of the playbook template.","example":"93a1ced8a259666f0505cd20b7cb8e7a1c65b868"},"reboot_required":{"type":"boolean","description":"Indicator whter reboot is required to mitigate vulnerability.","example":false,"nullable":true},"resolution_type":{"type":"string","description":"Type of the resolution provided by playbook."}},"required":["description","play","version","resolution_type"]}}}},"StatusOut":{"type":"object","properties":{"updated":{"type":"array","items":{"type":"object","properties":{"inventory_id":{"type":"string","example":"f35b1e1d-d231-43f2-8e4f-8f9cb01e3aa2"},"cve":{"type":"string","example":"CVE-2016-0800"}},"required":["inventory_id","cve"]},"description":"List of updated objects/updated object IDs."},"meta":{"$ref":"#/components/schemas/MetaPermissions"}},"required":["updated"]},"StatusListOut":{"type":"object","properties":{"data":{"type":"array","description":"List of available status/status_id pairs.","items":{"type":"object","properties":{"id":{"type":"integer","description":"Internal status_id.","example":3},"name":{"type":"string","description":"Represenation of internal status_id.","example":"Scheduled for Patch"}},"required":["id","name"]}},"meta":{"type":"object","properties":{"total_items":{"type":"integer","description":"Total number of available status/status_id pairs.","example":1}},"required":["total_items"]}},"required":["data","meta"]},"SystemCvesOut":{"type":"object","properties":{"data":{"oneOf":[{"type":"string","description":"CSV export of the JSON."},{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"CVE id.","example":"CVE-2016-0800"},"type":{"type":"string","description":"Type of the record.","example":"cve"},"attributes":{"type":"object","properties":{"business_risk":{"type":"string","description":"Business risk of the vulnerability.","example":"Low"},"business_risk_id":{"type":"integer","description":"Internal ID of the vulnerability business risk.","example":1},"business_risk_text":{"type":"string","description":"Complementary text to the business risk.","example":"QA environment => Low business risk","nullable":true},"cve_status_id":{"type":"integer","description":"Internal ID of the CVE status.","example":4},"cvss2_score":{"type":"string","description":"String representation of cvss2 score of the CVE.","example":"5.800","nullable":true},"cvss3_score":{"type":"string","description":"String representation of cvss3 score of the CVE.","example":"4.400","nullable":true},"description":{"type":"string","description":"Description of the CVE.","example":"A padding oracle flaw was found in the Secure Sockets Layer version 2.0 (SSLv2) protocol. An attacker could..."},"first_reported":{"type":"string","description":"Date of when the CVE was first reported on the system.","example":"2018-09-22T16:00:00+00:00"},"impact":{"type":"string","description":"Red Hat security impact of the CVE.","example":"Important"},"public_date":{"type":"string","description":"String representation of ISO-8601 formatted date of first public disclosure of the CVE.","example":"2016-03-01T00:00:00+00:00","nullable":true},"reporter":{"type":"number","description":"Reporter of the vulnerability, 1 for VMaaS, 2 for security rule, 3 for both VMaaS and rule.","enum":[0,1,2,3]},"rule":{"type":"object","nullable":true,"properties":{"rule_id":{"type":"string","example":"CVE_2017_14491_dnsmasq|CVE_2017_14491_ERROR","description":"ID(s) of associated security rule(s)."},"description":{"type":"string","description":"Description of the rule.","example":"CVE-2017-14491 dnsmasq code execution with listening processes","nullable":true},"summary":{"type":"string","description":"Summary of the rule.","example":"A buffer overflow vulnerability was found in `Dnsmasq`, a popular lightweight DNS and DHCP server....","nullable":true},"reboot_required":{"type":"boolean","description":"Indicator whter reboot is required to mitigate vulnerability.","example":false,"nullable":true},"playbook_count":{"type":"integer","description":"Number of available Ansible playbooks for remediation/mitigation.","example":1,"nullable":true},"change_risk":{"type":"integer","description":"Indicates how likely remediation can change environment on the remediatied system.","example":1,"nullable":true},"kbase_node_id":{"type":"integer","description":"ID of associated Red Hat knowledgebase article.","example":3199382,"nullable":true},"generate_autoplaybook":{"type":"boolean","description":"Indicates whether a playbook should be auto-generated.","example":true,"nullable":true}},"required":["change_risk","description","kbase_node_id","playbook_count","reboot_required","rule_id","summary","generate_autoplaybook"]},"status":{"type":"string","description":"Status of the vulnerability for the application's point of view.","example":"Resolved"},"status_id":{"type":"integer","description":"Internal ID of the vulnerability status.","example":4},"status_text":{"type":"string","description":"Complementary text to the status.","example":"Not relevant","nullable":true},"cve_status_text":{"type":"string","description":"Status text to the whole cve.","example":"Not relevant for all","nullable":true},"synopsis":{"type":"string","description":"Synopsis of the CVE.","example":"CVE-2016-0800"},"advisories_list":{"type":"array","description":"List of advisories for CVE","items":{"type":"string","description":"Advisory id","example":"RHSA-2019:1481"}},"known_exploit":{"type":"boolean","description":"Shows whether a CVE has known exploits or not","example":true},"advisory_available":{"type":"boolean","description":"Shows whether a CVE has available advisory or not","example":true},"remediation":{"type":"number","description":"Type of available remediation, 0 for none, 1 for manual, 2 for playbook.","enum":[0,1,2]}},"required":["business_risk","business_risk_id","business_risk_text","cve_status_id","cve_status_text","cvss2_score","cvss3_score","description","first_reported","impact","public_date","reporter","rule","status","status_id","status_text","synopsis","known_exploit","advisory_available","remediation"]}},"required":["id","type","attributes"]}}]},"links":{"$ref":"#/components/schemas/Links"},"meta":{"$ref":"#/components/schemas/MetaCves"}},"required":["data","links","meta"]},"SystemCvesIdsOut":{"type":"object","properties":{"data":{"oneOf":[{"type":"string","description":"CSV export of the JSON."},{"type":"array","items":{"type":"object","description":"CVE id and minimal information for frontend","properties":{"id":{"type":"string","description":"CVE id.","example":"CVE-2016-0800"},"rule_id":{"type":"string","example":"CVE_2017_14491_dnsmasq|CVE_2017_14491_ERROR","description":"ID(s) of associated security rule(s)..","nullable":true},"status_id":{"type":"integer","description":"Internal ID of the vulnerability status.","example":4},"status_text":{"type":"string","description":"Complementary text to the status.","example":"Not relevant","nullable":true},"cve_status_id":{"type":"integer","description":"Internal ID of the CVE status.","example":4},"cve_status_text":{"type":"string","description":"Status text to the whole cve.","example":"Not relevant for all","nullable":true},"remediation":{"type":"number","description":"Type of available remediation, 0 for none, 1 for manual, 2 for playbook.","enum":[0,1,2]}},"required":["id","rule_id","status_id","status_text","cve_status_id","cve_status_text","remediation"]}}]},"links":{"$ref":"#/components/schemas/Links"},"meta":{"$ref":"#/components/schemas/MetaCves"}},"required":["data","links","meta"]},"SystemDetailsOut":{"type":"object","properties":{"data":{"type":"object","properties":{"last_evaluation":{"type":"string","description":"Date of last evaluation.","example":"2018-09-22T16:00:00+00:00","nullable":true},"rules_evaluation":{"type":"string","description":"Date of last security rules evaluation.","example":"2018-09-22T16:00:00+00:00","nullable":true},"opt_out":{"type":"boolean","description":"System opt out status.","example":true},"last_upload":{"type":"string","description":"Date of the latest upload of archive.","example":"2018-09-22T16:00:00+00:00","nullable":true},"stale":{"type":"boolean","description":"System stale status.","example":true},"updated":{"type":"string","description":"Date of the lastest upload of archive taken from Inventory syndicated data.","example":"2018-09-22T16:00:00+00:00","nullable":true},"os":{"type":"string","description":"Operating system.","example":"RHEL 8.4"},"rhsm_lock":{"type":"string","description":"System is locked to following RHSM version.","example":"8.4","nullable":true},"tags":{"type":"array","items":{"type":"object","properties":{"namespace":{"type":"string","description":"Namespace of single tag.","example":"vulnerability","nullable":true},"key":{"type":"string","description":"Key of the single tag.","example":"CVE"},"value":{"type":"string","description":"Value of the single tag.","example":"CVE-2017-1","nullable":true}},"required":["namespace","key","value"]}},"host_type":{"type":"string","description":"Type of the host","enum":["rpmdnf","image"]}},"required":["last_evaluation","rules_evaluation","opt_out","last_upload","tags","os","rhsm_lock","host_type"]},"meta":{"$ref":"#/components/schemas/MetaPermissions"}},"required":["data","meta"]},"SystemListOut":{"type":"object","properties":{"data":{"oneOf":[{"type":"string","description":"CSV export of the JSON."},{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Host ID.","example":"INV-ID00-0000-1234"},"type":{"type":"string","description":"Type of the record.","example":"system"},"attributes":{"type":"object","properties":{"cve_count":{"type":"integer","description":"Number of CVE exposures for the system.","example":7,"nullable":true},"display_name":{"type":"string","description":"System's name,","example":"system.example.com","nullable":true},"inventory_id":{"type":"string","description":"Host ID.","example":"INV-ID00-0000-1234"},"insights_id":{"type":"string","description":"Insights host ID.","example":"0035f6bc-cdb0-4763-8fcd-1dc58f716359","nullable":true},"last_evaluation":{"type":"string","description":"Date of last evaluation.","example":"2018-09-22T16:00:00+00:00","nullable":true},"rules_evaluation":{"type":"string","description":"Date of last security rules evaluation.","example":"2018-09-22T16:00:00+00:00","nullable":true},"opt_out":{"type":"boolean","description":"Opt out status of the system.","example":false},"last_upload":{"type":"string","description":"Date of the latest upload of archive.","example":"2018-09-22T16:00:00+00:00","nullable":true},"os":{"type":"string","description":"Operating system.","example":"RHEL 8.4"},"rhsm_lock":{"type":"string","description":"System is locked to following RHSM version.","example":"8.4","nullable":true},"stale_timestamp":{"type":"string","description":"Date when stale system becomes stale.","example":"2018-09-22T16:00:00+00:00","nullable":true},"stale_warning_timestamp":{"type":"string","description":"Date when stale system becomes hidden in the application.","example":"2018-09-22T16:00:00+00:00","nullable":true},"updated":{"type":"string","description":"Date of the lastest upload of archive taken from Inventory syndicated data.","example":"2018-09-22T16:00:00+00:00","nullable":true},"tags":{"type":"array","items":{"type":"object","properties":{"namespace":{"type":"string","description":"Namespace of single tag.","example":"vulnerability","nullable":true},"key":{"type":"string","description":"Key of the single tag.","example":"CVE"},"value":{"type":"string","description":"Value of the single tag.","example":"CVE-2017-1","nullable":true}},"required":["namespace","key","value"]},"description":"Tags given to the system.","nullable":true},"culled_timestamp":{"type":"string","description":"Timestamp from which the host is considered deleted.","example":"2018-09-22T16:00:00+00:00","nullable":true},"inventory_group":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"ID of inventory group.","example":"00000000-1111-0000-0000-000000000000"},"name":{"type":"string","description":"Name of inventory group.","example":"group01"}},"required":["id","name"]}},"host_type":{"type":"string","description":"Type of the host","enum":["rpmdnf","image"]}},"required":["cve_count","display_name","inventory_id","insights_id","last_evaluation","rules_evaluation","opt_out","last_upload","os","rhsm_lock","stale_timestamp","stale_warning_timestamp","tags","culled_timestamp","inventory_group","host_type"]}},"required":["id","type","attributes"]}}]},"links":{"$ref":"#/components/schemas/Links"},"meta":{"$ref":"#/components/schemas/MetaSystems"}},"required":["data","links","meta"]},"SystemIdsOut":{"type":"object","properties":{"data":{"oneOf":[{"type":"string","description":"CSV export of the JSON."},{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Inventory ID.","example":"INV-ID00-0000-1234"},"opt_out":{"type":"boolean","description":"Whether the system is active or not.","example":false,"nullable":true},"display_name":{"type":"string","description":"System's name.","example":"system.example.com","nullable":true}}}}]},"links":{"$ref":"#/components/schemas/Links"},"meta":{"$ref":"#/components/schemas/MetaSystems"}},"required":["data","links","meta"]},"VulnerabilitiesOut":{"type":"object","properties":{"data":{"oneOf":[{"type":"string","description":"CSV export of the JSON."},{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"CVE id.","example":"CVE-2016-0800"},"type":{"type":"string","description":"Type of the record.","example":"cve"},"attributes":{"type":"object","properties":{"business_risk":{"type":"string","description":"Business risk of the vulnerability.","example":"Low"},"business_risk_id":{"type":"integer","description":"Internal ID of the vulnerability business risk.","example":1},"business_risk_text":{"type":"string","description":"Complementary text to the business risk.","example":"QA environment => Low business risk","nullable":true},"cvss2_score":{"type":"string","description":"String representation of cvss2 score of the CVE.","example":"5.800","nullable":true},"cvss3_score":{"type":"string","description":"String representation of cvss3 score of the CVE.","example":"4.400","nullable":true},"description":{"type":"string","description":"Description of the CVE.","example":"A padding oracle flaw was found in the Secure Sockets Layer version 2.0 (SSLv2) protocol. An attacker could..."},"impact":{"type":"string","description":"Red Hat security impact of the CVE.","example":"Important"},"public_date":{"type":"string","description":"String representation of ISO-8601 formatted date of first public disclosure of the CVE.","example":"2016-03-01T00:00:00+00:00","nullable":true},"rules":{"type":"array","items":{"$ref":"#/components/schemas/InsightsRule"}},"status":{"type":"string","description":"Status of the vulnerability.","example":"Not Reviewed"},"status_id":{"type":"integer","description":"Internal ID of the vulnerability status.","example":1},"status_text":{"type":"string","description":"Complementary text to the status.","example":"Not Relevant","nullable":true},"synopsis":{"type":"string","description":"Synopsis of the CVE.","example":"CVE-2016-0800"},"systems_affected":{"type":"integer","description":"Number of systems affected by the CVE.","example":7},"systems_status_divergent":{"type":"integer","description":"How many systems-CVE pairs have different status than CVE-level.","example":20},"known_exploit":{"type":"boolean","description":"Shows whether a CVE has known exploits or not","example":true},"advisory_available":{"type":"boolean","description":"Shows whether a CVE has available advisory or not","example":true},"rhel_versions":{"type":"array","items":{"type":"string","description":"Applicable RHEL version across your entire system inventory.","example":"9.4"}}},"required":["business_risk","business_risk_id","business_risk_text","cvss2_score","cvss3_score","description","impact","public_date","rules","status","status_id","status_text","synopsis","systems_affected","systems_status_divergent","known_exploit","advisory_available","rhel_versions"]}},"required":["id","type","attributes"]}}]},"links":{"$ref":"#/components/schemas/Links"},"meta":{"$ref":"#/components/schemas/MetaVulnerabilitiesOut"}},"required":["data","links","meta"]},"VulnerabilitiesIdsOut":{"type":"object","properties":{"data":{"oneOf":[{"type":"string","description":"CSV export of the JSON."},{"type":"array","items":{"type":"object","description":"CVE id and minimal information.","properties":{"business_risk_id":{"type":"integer","description":"Internal ID of the vulnerability business risk.","example":1},"business_risk_text":{"type":"string","description":"Complementary text to the business risk.","example":"QA environment => Low business risk","nullable":true},"id":{"type":"string","description":"CVE id.","example":"CVE-2016-0800"},"status_id":{"type":"integer","description":"Internal ID of the vulnerability status.","example":1},"status_text":{"type":"string","description":"Complementary text to the status.","example":"Not Relevant","nullable":true}}},"required":["business_risk_id","business_risk_text","id","status_id","status_text"]}]},"links":{"$ref":"#/components/schemas/Links"},"meta":{"$ref":"#/components/schemas/MetaVulnerabilitiesOut"}},"required":["data","links","meta"]},"VersionOut":{"type":"object","properties":{"application_version":{"type":"string","description":"Version of application.","example":"0.1.2"},"database_version":{"oneOf":[{"type":"string"},{"type":"number"}],"description":"Version of database schema.","example":1}},"required":["application_version","database_version"]},"InsightsRule":{"type":"object","properties":{"rule_id":{"type":"string","example":"CVE_2017_14491_dnsmasq|CVE_2017_14491_ERROR","description":"ID(s) of associated security rule(s)."},"description":{"type":"string","description":"Description of the rule.","example":"CVE-2017-14491 dnsmasq code execution with listening processes","nullable":true},"summary":{"type":"string","description":"Summary of the rule.","example":"A buffer overflow vulnerability was found in `Dnsmasq`, a popular lightweight DNS and DHCP server....","nullable":true},"reboot_required":{"type":"boolean","description":"Indicator whter reboot is required to mitigate vulnerability.","example":false,"nullable":true},"playbook_count":{"type":"integer","description":"Number of available Ansible playbooks for remediation/mitigation.","example":1,"nullable":true},"change_risk":{"type":"integer","description":"Indicates how likely remediation can change environment on the remediatied system.","example":1,"nullable":true},"kbase_node_id":{"type":"integer","description":"ID of associated Red Hat knowledgebase article.","example":3199382,"nullable":true},"associated_cves":{"type":"array","items":{"type":"string","example":"CVE-2016-0800"},"description":"List of CVEs associated with the rule."},"rule_impact":{"type":"integer","description":"Shows rules impact number from 1 to 4","example":1,"nullable":true},"systems_affected":{"type":"integer","description":"Number of systems affected by the rule.","example":72},"publish_date":{"type":"string","description":"Date when the rule was published.","example":"2018-05-15T13:00:00Z","nullable":true}},"required":["associated_cves","change_risk","description","kbase_node_id","playbook_count","reboot_required","rule_id","summary","rule_impact","publish_date"]},"VulnerabilitiesPostIn":{"type":"object","properties":{"cve_list":{"type":"array","description":"Array of CVEs to provide info about","items":{"type":"string","example":"CVE-2016-0800","description":"CVE id."}}},"required":["cve_list"]},"VulnerabilitiesPostOut":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"CVE id.","example":"CVE-2016-0800"},"type":{"type":"string","description":"Type of the record.","example":"cve"},"attributes":{"type":"object","properties":{"cvss_score":{"type":"string","description":"String representation of cvss3 or cvvs2 (if v3 is not present) score of the CVE.","example":"5.800","nullable":true},"impact":{"type":"string","description":"Red Hat security impact of the CVE.","example":"Important"},"synopsis":{"type":"string","description":"Synopsis of the CVE.","example":"CVE-2016-0800"}},"required":["cvss_score","impact","synopsis"]}},"required":["id","type","attributes"]}},"links":{"$ref":"#/components/schemas/Links"},"meta":{"allOf":[{"$ref":"#/components/schemas/Meta"},{"$ref":"#/components/schemas/MetaPermissions"}]}},"required":["data","links","meta"]},"AnnouncementOut":{"type":"object","properties":{"message":{"type":"string","description":"Announcement message.","example":"Hello from Vulnerability team :)."},"last_updated":{"type":"string","description":"Datetime string.","example":"2004-10-19 10:23:54+02"}},"required":["message","last_updated"]},"DashbarOut":{"type":"object","properties":{"exploitable_cves":{"type":"number"},"cves_with_rule":{"type":"number"},"critical_cves":{"type":"number"},"important_cves":{"type":"number"}}},"CvesWithoutErrataOut":{"type":"object","properties":{"updated":{"type":"object","properties":{"org_id":{"type":"string"},"cves_without_errata":{"type":"object","properties":{"enabled":{"type":"boolean"}}}}},"meta":{"$ref":"#/components/schemas/MetaPermissions"}},"required":["updated","meta"]},"NotificationsOut":{"type":"object","properties":{"deleted":{"type":"number","description":"Number of deleted notifications for CVEs","example":50}},"required":["deleted"]}}},"servers":[{"url":"/api/vulnerability/v1"}]} \ No newline at end of file +{"openapi":"3.0.0","info":{"title":"Vulnerability Engine Manager","version":"2.74.1"},"paths":{"/apistatus":{"get":{"summary":"Determine the health of the application","description":"Checks database availability and API response threshold time.","operationId":"getApiStatus","x-methodName":"getApiStatus","responses":{"200":{"description":"API is healthy"},"503":{"description":"Database is unavaiable"}}}},"/version":{"get":{"summary":"Get application version","description":"This endpoint will provide you with the application version. Use this endpoint to track application changes.\n","operationId":"getVersion","x-methodName":"getVersion","responses":{"200":{"description":"Application version.","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"application_version":{"type":"string","description":"Version of application.","example":"0.1.2"},"database_version":{"oneOf":[{"type":"string"},{"type":"number"}],"description":"Version of database schema.","example":1}},"required":["application_version","database_version"]}}}}}}},"/business_risk":{"get":{"summary":"Access business risk values","description":"This endpoint helps you determine the numeric business risk for a given CVE. A business risk is a label you can set for a given CVE. Choose one of five business risk options ranging from 0-4, where 0 is not defined and 4 indicates a critical risk. You must call this endpoint to choose a numerical value before calling the *PATCH/cves/business_risk* endpoint.\n","operationId":"getBusinessRiskList","x-methodName":"getBusinessRiskList","security":[{"ApiKeyAuth":[]},{"BasicAuth":[]}],"responses":{"200":{"description":"List of business risk/business_risk_id pairs.","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"type":"array","description":"List of available business risk/business_risk_id pairs.","items":{"type":"object","properties":{"id":{"type":"integer","description":"Internal business_risk_id.","example":3},"name":{"type":"string","description":"Represenation of internal business_risk_id.","example":"Low"}},"required":["id","name"]}},"meta":{"type":"object","properties":{"total_items":{"type":"integer","description":"Total number of available business risk/business_risk_id pairs.","example":1}},"required":["total_items"]}},"required":["data","meta"]}}}}}}},"/cves/{cve_id}":{"get":{"summary":"Get CVE details","description":"This endpoint returns the CVE identification number, description, scores and other metadata. The metadata includes the description, CVSS 2/3 Score, CVSS 2/3 attack vector, severity, public date, modified date, business risk, status, a URL to Red Hat web pages, a list of advisories remediating the CVE, and information regarding known exploits for the CVE.\n","operationId":"getCveDetails","x-methodName":"getCveDetails","security":[{"ApiKeyAuth":[]},{"BasicAuth":[]}],"responses":{"200":{"description":"CVE details","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","description":"CVE id.","example":"CVE-2016-0800"},"type":{"type":"string","description":"Type of the record.","example":"cve"},"attributes":{"type":"object","properties":{"business_risk":{"type":"string","description":"Business risk of the vulnerability.","example":"Low"},"business_risk_id":{"type":"integer","description":"Internal ID of the vulnerability business risk.","example":1},"business_risk_text":{"type":"string","description":"Complementary text to the business risk.","example":"QA environment => Low business risk","nullable":true},"celebrity_name":{"type":"string","description":"\"Celebrity\" name of the CVE.","example":"Spectre/Meltdown","nullable":true},"cvss2_metrics":{"type":"string","description":"cvss2 metrics of the CVE.","example":"AV:N/AC:M/Au:N/C:P/I:P/A:N","nullable":true},"cvss2_score":{"type":"string","description":"String representation of cvss2 score of the CVE.","example":"5.800","nullable":true},"cvss3_metrics":{"type":"string","description":"cvss3 metrics of the CVE.","example":"AV:N/AC:M/Au:N/C:P/I:P/A:N","nullable":true},"cvss3_score":{"type":"string","description":"String representation of cvss3 score of the CVE.","example":"4.400","nullable":true},"description":{"type":"string","description":"Description of the CVE.","example":"A padding oracle flaw was found in the Secure Sockets Layer version 2.0 (SSLv2) protocol. An attacker could..."},"modified_date":{"type":"string","description":"String representation of ISO-8601 formatted date of last modification of the CVE.","example":"2019-03-07T08:15:36+00:00","nullable":true},"impact":{"type":"string","description":"Red Hat security impact of the CVE.","example":"Important"},"public_date":{"type":"string","description":"String representation of ISO-8601 formatted date of first public disclosure of the CVE.","example":"2016-03-01T00:00:00+00:00","nullable":true},"redhat_url":{"type":"string","description":"Additional resource about the CVE, provided by Red Hat.","example":"https://access.redhat.com/security/cve/cve-2016-0800","nullable":true},"rules":{"type":"array","items":{"type":"object","properties":{"rule_id":{"type":"string","example":"CVE_2017_14491_dnsmasq|CVE_2017_14491_ERROR","description":"ID(s) of associated security rule(s)."},"description":{"type":"string","description":"Description of the rule.","example":"CVE-2017-14491 dnsmasq code execution with listening processes","nullable":true},"summary":{"type":"string","description":"Summary of the rule.","example":"A buffer overflow vulnerability was found in `Dnsmasq`, a popular lightweight DNS and DHCP server....","nullable":true},"reboot_required":{"type":"boolean","description":"Indicator whter reboot is required to mitigate vulnerability.","example":false,"nullable":true},"playbook_count":{"type":"integer","description":"Number of available Ansible playbooks for remediation/mitigation.","example":1,"nullable":true},"change_risk":{"type":"integer","description":"Indicates how likely remediation can change environment on the remediatied system.","example":1,"nullable":true},"kbase_node_id":{"type":"integer","description":"ID of associated Red Hat knowledgebase article.","example":3199382,"nullable":true},"associated_cves":{"type":"array","items":{"type":"string","example":"CVE-2016-0800"},"description":"List of CVEs associated with the rule."},"rule_impact":{"type":"integer","description":"Shows rules impact number from 1 to 4","example":1,"nullable":true},"systems_affected":{"type":"integer","description":"Number of systems affected by the rule.","example":72},"publish_date":{"type":"string","description":"Date when the rule was published.","example":"2018-05-15T13:00:00Z","nullable":true}},"required":["associated_cves","change_risk","description","kbase_node_id","playbook_count","reboot_required","rule_id","summary","rule_impact","publish_date"]}},"secondary_url":{"type":"string","description":"Additional resources about the CVE.","example":"https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2016-0800","nullable":true},"status":{"type":"string","description":"Status of the vulnerability.","example":"Not Reviewed"},"status_id":{"type":"integer","description":"Internal ID of the vulnerability status.","example":1},"status_text":{"type":"string","description":"Complementary text to the status.","example":"Not relevant","nullable":true},"synopsis":{"type":"string","description":"Synopsis of the CVE.","example":"CVE-2016-0800"},"systems_status_detail":{"type":"object","description":"Counts of systems with given status type."},"systems_status_divergent":{"type":"integer","description":"How many systems-CVE pairs have different status than CVE-level.","example":20},"advisories_list":{"type":"array","description":"List of advisory names or detailed advisory information","nullable":true,"items":{"type":"string","example":"RHSA-2015:0809"}},"known_exploit":{"type":"boolean","description":"Shows whether a CVE has known exploits or not","example":true},"affected_but_not_vulnerable":{"type":"integer","nullable":true,"description":"Number of systems that are affected by given CVE but are not vulnerable.","example":0},"affected_systems":{"type":"integer","nullable":true,"description":"Number of systems that are overall affected by given CVE","example":52}},"required":["business_risk","business_risk_id","business_risk_text","celebrity_name","cvss2_metrics","cvss2_score","cvss3_metrics","cvss3_score","description","impact","modified_date","public_date","redhat_url","rules","secondary_url","status","status_id","status_text","synopsis","systems_status_detail","systems_status_divergent","advisories_list","known_exploit","affected_but_not_vulnerable"]}},"required":["id","type","attributes"]},"meta":{"type":"object","properties":{"permissions":{"type":"array","description":"Fetched permissions from RBAC for given user","nullable":false,"items":{"type":"string","example":"vulnerability:vulnerability_results:read"}}},"required":["permissions"]}}}}}},"404":{"description":"Given CVE does not exist.","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"oneOf":[{"type":"string","description":"Error detail.","example":"Record not found."},{"type":"object","description":"Returned with RBAC (user permissions) related issue","properties":{"msg":{"type":"string","description":"Error detail related to RBAC problem"},"permissions":{"type":"array","items":{"type":"string"},"description":"Array with RBAC permissions of user"}}}]},"status":{"type":"string","description":"String representation of HTTP status code.","example":404}},"required":["detail","status"]},"minItems":1}},"required":["errors"]}}}}},"parameters":[{"in":"path","name":"cve_id","description":"CVE id.","required":true,"schema":{"type":"string"},"example":"CVE-2016-0800"},{"in":"query","name":"advisory_available","description":"String of booleans (array of booleans), where true shows CVE-system pairs with available advisory, false shows CVE-system pairs without available advisory.","schema":{"type":"array","items":{"type":"boolean"},"maxItems":2},"example":"true,false"}]}},"/cves/{cve_id}/affected_systems":{"get":{"summary":"Determine affected systems for a given CVE","description":"This is a report of affected systems for a given CVE. Use this request to obtain server identification numbers of all affected servers along with last check-in, system name and more.\n","operationId":"getAffectedSystemsByCve","x-methodName":"getAffectedSystemsByCve","security":[{"ApiKeyAuth":[]},{"BasicAuth":[]}],"responses":{"200":{"description":"Report of affected systems for a given CVE.","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"oneOf":[{"type":"string","description":"CSV export of the JSON."},{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Host id.","example":"INV-ID-0000-1234"},"type":{"type":"string","description":"Type of the record.","example":"system"},"attributes":{"type":"object","properties":{"cve_status_id":{"type":"integer","description":"Internal ID of the CVE status.","example":4},"culled_timestamp":{"type":"string","description":"Timestamp from which the host is considered deleted.","example":"2018-09-22T16:00:00+00:00","nullable":true},"display_name":{"type":"string","description":"System's name.","example":"system.example.com","nullable":true},"first_reported":{"type":"string","description":"Date of when the CVE was first reported on the system.","example":"2018-09-22T16:00:00+00:00"},"inventory_id":{"type":"string","description":"Host ID.","example":"INV-ID00-0000-1234"},"insights_id":{"type":"string","description":"Insights host ID.","example":"0035f6bc-cdb0-4763-8fcd-1dc58f716359","nullable":true},"last_evaluation":{"type":"string","description":"Date of last evaluation.","example":"2018-09-22T16:00:00+00:00","nullable":true},"os":{"type":"string","description":"Operating system.","example":"RHEL 8.4"},"reporter":{"type":"number","description":"Reporter of the vulnerability, 1 for VMaaS, 2 for security rule, 3 for both VMaaS and rule.","enum":[0,1,2,3]},"rhsm_lock":{"type":"string","description":"System is locked to following RHSM version.","example":"8.4","nullable":true},"rule":{"type":"object","description":"Details of associated security rule.","properties":{"details":{"type":"object","description":"Additional information specific to the system rule hit."},"resolution":{"type":"object","description":"Details of recommended resolution.","properties":{"resolution":{"type":"string","example":"Red Hat recommends that you update the dnsmasq package","description":"Recommended resolution of the issue.","nullable":true}},"required":["resolution"]},"rule":{"type":"object","properties":{"description":{"type":"string","example":"CVE-2017-14491 dnsmasq code execution with listening processes","description":"Description of the associated security rule.","nullable":true},"more_info":{"type":"string","example":"For more information about this specific flaw, see its ...","description":"Additional information about the issue.","nullable":true},"node_id":{"type":"integer","description":"ID of associated Red Hat knowledgebase article.","example":3199382,"nullable":true},"reason":{"type":"string","example":"This system is vulnerable because it is running a vulnerable package.","description":"Reason of why rule did hit.","nullable":true},"rule_id":{"type":"string","example":"CVE_2017_14491_dnsmasq|CVE_2017_14491_ERROR","description":"ID of associated security rule."}},"required":["description","more_info","node_id","reason","rule_id"]}},"nullable":true,"required":["details","resolution","rule"]},"rules_evaluation":{"type":"string","description":"Date of last security rules evaluation.","example":"2018-09-22T16:00:00+00:00","nullable":true},"stale_timestamp":{"type":"string","description":"Date when stale system becomes stale.","example":"2018-09-22T16:00:00+00:00","nullable":true},"stale_warning_timestamp":{"type":"string","description":"Date when stale system becomes hidden in the application.","example":"2018-09-22T16:00:00+00:00","nullable":true},"status_id":{"type":"integer","description":"Internal ID of the vulnerability status.","example":4},"status_name":{"type":"string","description":"Status of the vulnerability for the application's point of view.","example":"Resolved"},"status_text":{"type":"string","description":"Complementary text to the status.","example":"Not relevant","nullable":true},"tags":{"type":"array","items":{"type":"object","properties":{"namespace":{"type":"string","description":"Namespace of single tag.","example":"vulnerability","nullable":true},"key":{"type":"string","description":"Key of the single tag.","example":"CVE"},"value":{"type":"string","description":"Value of the single tag.","example":"CVE-2017-1","nullable":true}},"required":["namespace","key","value"]}},"advisories_list":{"type":"array","description":"List of advisories for system","items":{"type":"string","description":"Advisory id","example":"RHSA-2019:1481"}},"updated":{"type":"string","description":"Date of the lastest upload of archive taken from Inventory syndicated data.","example":"2018-09-22T16:00:00+00:00","nullable":true},"last_upload":{"type":"string","description":"Date of the latest upload of archive.","example":"2018-09-22T16:00:00+00:00"},"advisory_available":{"type":"boolean","description":"Shows whether a CVE has available advisory or not","example":true},"remediation":{"type":"number","description":"Type of available remediation, 0 for none, 1 for manual, 2 for playbook.","enum":[0,1,2]},"mitigation_reason":{"type":"string","description":"Reason why the system is not vulnerable.","example":"SELinux mitigates the issue","nullable":true},"inventory_group":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"ID of inventory group.","example":"00000000-1111-0000-0000-000000000000"},"name":{"type":"string","description":"Name of inventory group.","example":"group01"}},"required":["id","name"]}},"host_type":{"type":"string","description":"Type of the host","enum":["rpmdnf","image"]}},"required":["cve_status_id","culled_timestamp","display_name","first_reported","inventory_id","insights_id","last_evaluation","os","reporter","rhsm_lock","rule","rules_evaluation","stale_timestamp","stale_warning_timestamp","status_id","status_name","status_text","tags","updated","advisory_available","remediation","mitigation_reason","inventory_group","host_type"]}},"required":["id","type","attributes"]}}]},"links":{"type":"object","properties":{"first":{"type":"string","description":"Link to first page.","example":"/api?offset=0&limit=1"},"last":{"type":"string","description":"Link to last page.","example":"/api?offset=7&limit=1"},"next":{"type":"string","description":"Link to next page.","example":"/api?offset=5&limit=1","nullable":true},"previous":{"type":"string","description":"Link to next page.","example":"/api?offset=3&limit=1","nullable":true}},"required":["first","last","next","previous"]},"meta":{"allOf":[{"type":"object","properties":{"filter":{"type":"string","description":"Full text filter","example":"CVE-2016-0800","nullable":true},"limit":{"type":"integer","description":"Maximum number of paginated results.","example":25},"offset":{"type":"integer","description":"First record of paginated response.","example":0},"page":{"type":"integer","description":"Page number of paginated response.","example":1},"page_size":{"type":"integer","description":"Number of records per page of paginated response.","example":25},"pages":{"type":"integer","description":"Total number of pages of paginated response.","example":1},"sort":{"type":"string","description":"Sorting filter.","example":"-inventory_id","nullable":true},"total_items":{"type":"integer","description":"Total number of records.","example":37},"data_format":{"type":"string","description":"Format of the output data, either JSON (default) or CSV.","example":"JSON"}},"required":["filter","limit","offset","page","page_size","pages","sort","total_items","data_format"]},{"type":"object","properties":{"permissions":{"type":"array","description":"Fetched permissions from RBAC for given user","nullable":false,"items":{"type":"string","example":"vulnerability:vulnerability_results:read"}}},"required":["permissions"]},{"type":"object","properties":{"status_id":{"type":"string","description":"Filer based on CVE status ID.","example":"1,4","nullable":true},"rule_key":{"type":"string","description":"Filters security rules by its error key.","example":"CVE_2018_3639_cpu_kernel|CVE_2018_3639_CPU_BAD_MICROCODE_2,CVE_2018_12207_cpu_kernel|CVE_2018_12207_CPU_KERNEL_FOR_SURE","nullable":true},"rule_presence":{"type":"string","description":"Filter based on presence of security rule","example":"true,false","nullable":true},"patch_access":{"type":"boolean","description":"If show_advisories=true shows access to patch service else null","example":true,"nullable":true},"rhel_version":{"type":"string","description":"Filter base on system RHEL version.","example":"8.2","nullable":true},"first_reported_from":{"type":"string","description":"Filter system-cve pairs based on first time of detection of CVE.","example":"2017-09-18T00:00:00+00:00","nullable":true},"first_reported_to":{"type":"string","description":"Filter system-cve pairs based on first time of detection of CVE.","example":"2017-09-18T00:00:00+00:00","nullable":true},"cves_without_errata":{"type":"boolean","description":"CVEs without Errata feature flag","nullable":true},"group_names":{"type":"string","description":"Name of the inventory group.","example":"Production,Stage","nullable":true},"group_ids":{"type":"string","description":"ID of the inventory group.","example":"00000000-1111-0000-0000-000000000000,00000000-2222-0000-0000-000000000000","nullable":true}},"required":["status_id","rule_key","rule_presence","patch_access","rhel_version","first_reported_from","first_reported_to","cves_without_errata","group_names","group_ids"]}]}},"required":["data","links","meta"]}}}},"404":{"description":"Given CVE does not exist.","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"oneOf":[{"type":"string","description":"Error detail.","example":"Record not found."},{"type":"object","description":"Returned with RBAC (user permissions) related issue","properties":{"msg":{"type":"string","description":"Error detail related to RBAC problem"},"permissions":{"type":"array","items":{"type":"string"},"description":"Array with RBAC permissions of user"}}}]},"status":{"type":"string","description":"String representation of HTTP status code.","example":404}},"required":["detail","status"]},"minItems":1}},"required":["errors"]}}}}},"parameters":[{"in":"query","name":"filter","description":"Full text filter for the display name of system.","schema":{"type":"string"},"example":"INV-ID-1234"},{"in":"query","name":"limit","description":"Maximum number of records per page. Limit/Offset pagination wins over page/page_size pagination.","schema":{"type":"integer","maximum":9007199254740991,"minimum":1},"example":25},{"in":"query","name":"offset","description":"Offset of first record of paginated response. Limit/Offset pagination wins over page/page_size pagination.","schema":{"type":"integer","maximum":9007199254740991,"minimum":0},"example":1},{"in":"query","name":"page","description":"Page number of paginated response. Limit/Offset pagination wins over page/page_size pagination.","schema":{"type":"integer","maximum":9007199254740991,"minimum":1},"example":1},{"in":"query","name":"page_size","description":"Page size of paginated response. Limit/Offset pagination wins over page/page_size pagination.","schema":{"type":"integer","maximum":9007199254740991,"minimum":1},"example":25},{"in":"query","name":"sort","description":"Sorting used for response.","schema":{"type":"string"},"example":"-inventory_id"},{"in":"path","name":"cve_id","description":"CVE id.","required":true,"schema":{"type":"string"},"example":"CVE-2016-0800"},{"in":"query","name":"status_id","description":"Filer based on CVE status ID.","schema":{"type":"string","example":"1,4"}},{"in":"query","name":"data_format","description":"Format of the output data, either JSON (default) or CSV.","schema":{"type":"string","example":"json"}},{"in":"query","name":"uuid","description":"Filter based on UUID of inventory.","schema":{"type":"string"},"example":"2ee58c62-809f-11ea-bc55-0242ac130003"},{"in":"query","name":"rule_key","description":"Filters security rules by its error key.","schema":{"type":"array","items":{"type":"string"}},"deprecated":true,"example":"CVE_2018_3639_cpu_kernel|CVE_2018_3639_CPU_BAD_MICROCODE_2,CVE_2018_12207_cpu_kernel|CVE_2018_12207_CPU_KERNEL_FOR_SURE"},{"in":"query","name":"rule_presence","description":"Comma seprated string with bools. If true shows only CVEs with security rule associated, if false shows CVEs without rules. true, false shows all.","schema":{"type":"array","items":{"type":"boolean"},"maxItems":2},"deprecated":true,"example":"true,false"},{"in":"query","name":"rule","description":"Filters CVEs or systems by security rule, has two functionalities. If value is false, shows results without security rules, every other value is taken as rule error key.","schema":{"type":"array","items":{"type":"string","minLength":1}},"example":"CVE_2018_3639_cpu_kernel|CVE_2018_3639_CPU_BAD_MICROCODE_2,CVE_2018_12207_cpu_kernel|CVE_2018_12207_CPU_KERNEL_FOR_SURE"},{"in":"query","name":"tags","description":"Filter based on hosts tags. Tags needs to be in query format, that means /= or / if value is null. Characters '/', '=' in tag values needs to be escaped by url encoding.","schema":{"type":"array","items":{"type":"string","pattern":"^([^=/]+\\/){1}([^=/])+(=[^=/]+)?$"}},"example":"vulnerability/usage=server"},{"in":"query","name":"sap_sids","description":"List of SAP IDs to filter with","schema":{"type":"array","items":{"type":"string"}},"example":"ABC,CDE"},{"in":"query","name":"sap_system","description":"Boolean value which shows systems managed by SAP.","schema":{"type":"boolean"},"example":false},{"in":"query","name":"show_advisories","description":"If true shows advisories list","schema":{"type":"boolean"},"example":false},{"in":"query","name":"advisory","description":"Filter by advisory name, works only with show_advisories=true","schema":{"type":"string"},"example":"RHSA-2019:1481"},{"in":"query","name":"rhel_version","description":"Filters results by RHEL OS version. Automatically flters out systems which are not RHEL or have uknown OS.","required":false,"schema":{"type":"string","description":"List of RHEL versions. E.g. 7,8.1 will filter out everything which is not RHEL 7.x or RHEL 8.1"}},{"in":"query","name":"first_reported_from","description":"Filter for CVEs/Systems where the vulnerability appeared after given date.","required":false,"schema":{"type":"string","description":"Datetime string"},"example":"2017-09-18T00:00:00+00:00"},{"in":"query","name":"first_reported_to","description":"Filter for CVEs/Systems where the vulnerability appeared before given date.","required":false,"schema":{"type":"string","description":"Datetime string"},"example":"2017-09-18T00:00:00+00:00"},{"in":"query","name":"advisory_available","description":"String of booleans (array of booleans), where true shows CVE-system pairs with available advisory, false shows CVE-system pairs without available advisory.","schema":{"type":"array","items":{"type":"boolean"},"maxItems":2},"example":"true,false"},{"in":"query","name":"remediation","description":"Filer based on available remediation type id.","schema":{"type":"string","example":1}},{"in":"query","name":"report","description":"Needs to be used when endpoint data is used for report generation, checks RBAC permission for report and export feature.","required":false,"schema":{"type":"boolean"},"example":false},{"in":"query","name":"ansible","description":"Boolean value which shows systems managed by Ansible Automation Platform.","schema":{"type":"boolean"},"example":false},{"in":"query","name":"mssql","description":"Boolean value which shows systems managed by MSSQL.","schema":{"type":"boolean"},"example":false},{"in":"query","name":"group_names","description":"Names of the inventory groups.","schema":{"type":"array","items":{"type":"string"}},"example":"Production,Stage"},{"in":"query","name":"group_ids","description":"IDs of the inventory groups.","schema":{"type":"array","items":{"type":"string"}},"example":"00000000-1111-0000-0000-000000000000,00000000-2222-0000-0000-000000000000"},{"in":"query","name":"host_type","description":"For filtering out the systems based on their type. Value \"rpmdnf\" for RPMDNF systems, \"image\" for image-mode systems.","schema":{"type":"array","items":{"type":"string","enum":["rpmdnf","image","edge"]},"maxItems":2}}]}},"/cves/{cve_id}/affected_systems/ids":{"get":{"summary":"Get identification numbers of affected systems for a given CVE","description":"This is a report of identification numbers of affected systems for a given CVE. Use this request to obtain server identification numbers of all affected systems.\n","operationId":"getAffectedSystemsIdsByCve","x-methodName":"getAffectedSystemsIdsByCve","security":[{"ApiKeyAuth":[]},{"BasicAuth":[]}],"responses":{"200":{"description":"Report of IDs of affected systems for a given CVE.","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"oneOf":[{"type":"string","description":"CSV export of the JSON."},{"type":"array","items":{"type":"object","description":"Smallest dataset for frontend to work.","properties":{"inventory_id":{"type":"string","description":"Host ID.","example":"INV-ID00-0000-1234"},"rule_id":{"type":"string","example":"CVE_2017_14491_dnsmasq|CVE_2017_14491_ERROR","description":"ID of associated security rule.","nullable":true},"status_id":{"type":"integer","description":"Internal ID of the vulnerability status.","example":4},"status_text":{"type":"string","description":"Complementary text to the status.","example":"Not relevant","nullable":true},"display_name":{"type":"string","description":"System's name.","example":"system.example.com"},"mitigation_reason":{"type":"string","description":"Reason why the system is not vulnerable.","example":"SELinux mitigates the issue","nullable":true},"remediation":{"type":"number","description":"Type of available remediation, 0 for none, 1 for manual, 2 for playbook.","enum":[0,1,2]}},"required":["inventory_id","rule_id","status_id","status_text","display_name","remediation"]}}]},"links":{"type":"object","properties":{"first":{"type":"string","description":"Link to first page.","example":"/api?offset=0&limit=1"},"last":{"type":"string","description":"Link to last page.","example":"/api?offset=7&limit=1"},"next":{"type":"string","description":"Link to next page.","example":"/api?offset=5&limit=1","nullable":true},"previous":{"type":"string","description":"Link to next page.","example":"/api?offset=3&limit=1","nullable":true}},"required":["first","last","next","previous"]},"meta":{"allOf":[{"type":"object","properties":{"filter":{"type":"string","description":"Full text filter","example":"CVE-2016-0800","nullable":true},"limit":{"type":"integer","description":"Maximum number of paginated results.","example":25},"offset":{"type":"integer","description":"First record of paginated response.","example":0},"page":{"type":"integer","description":"Page number of paginated response.","example":1},"page_size":{"type":"integer","description":"Number of records per page of paginated response.","example":25},"pages":{"type":"integer","description":"Total number of pages of paginated response.","example":1},"sort":{"type":"string","description":"Sorting filter.","example":"-inventory_id","nullable":true},"total_items":{"type":"integer","description":"Total number of records.","example":37},"data_format":{"type":"string","description":"Format of the output data, either JSON (default) or CSV.","example":"JSON"}},"required":["filter","limit","offset","page","page_size","pages","sort","total_items","data_format"]},{"type":"object","properties":{"permissions":{"type":"array","description":"Fetched permissions from RBAC for given user","nullable":false,"items":{"type":"string","example":"vulnerability:vulnerability_results:read"}}},"required":["permissions"]},{"type":"object","properties":{"status_id":{"type":"string","description":"Filer based on CVE status ID.","example":"1,4","nullable":true},"rule_key":{"type":"string","description":"Filters security rules by its error key.","example":"CVE_2018_3639_cpu_kernel|CVE_2018_3639_CPU_BAD_MICROCODE_2,CVE_2018_12207_cpu_kernel|CVE_2018_12207_CPU_KERNEL_FOR_SURE","nullable":true},"rule_presence":{"type":"string","description":"Filter based on presence of security rule","example":"true,false","nullable":true},"patch_access":{"type":"boolean","description":"If show_advisories=true shows access to patch service else null","example":true,"nullable":true},"rhel_version":{"type":"string","description":"Filter base on system RHEL version.","example":"8.2","nullable":true},"first_reported_from":{"type":"string","description":"Filter system-cve pairs based on first time of detection of CVE.","example":"2017-09-18T00:00:00+00:00","nullable":true},"first_reported_to":{"type":"string","description":"Filter system-cve pairs based on first time of detection of CVE.","example":"2017-09-18T00:00:00+00:00","nullable":true},"cves_without_errata":{"type":"boolean","description":"CVEs without Errata feature flag","nullable":true},"group_names":{"type":"string","description":"Name of the inventory group.","example":"Production,Stage","nullable":true},"group_ids":{"type":"string","description":"ID of the inventory group.","example":"00000000-1111-0000-0000-000000000000,00000000-2222-0000-0000-000000000000","nullable":true}},"required":["status_id","rule_key","rule_presence","patch_access","rhel_version","first_reported_from","first_reported_to","cves_without_errata","group_names","group_ids"]}]}},"required":["data","links","meta"]}}}},"404":{"description":"Given CVE does not exist.","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"oneOf":[{"type":"string","description":"Error detail.","example":"Record not found."},{"type":"object","description":"Returned with RBAC (user permissions) related issue","properties":{"msg":{"type":"string","description":"Error detail related to RBAC problem"},"permissions":{"type":"array","items":{"type":"string"},"description":"Array with RBAC permissions of user"}}}]},"status":{"type":"string","description":"String representation of HTTP status code.","example":404}},"required":["detail","status"]},"minItems":1}},"required":["errors"]}}}}},"parameters":[{"in":"query","name":"filter","description":"Full text filter for the display name of system.","schema":{"type":"string"},"example":"INV-ID-1234"},{"in":"query","name":"limit","description":"Maximum number of records per page. Limit/Offset pagination wins over page/page_size pagination.","schema":{"type":"integer","maximum":9007199254740991,"minimum":1},"example":25},{"in":"query","name":"offset","description":"Offset of first record of paginated response. Limit/Offset pagination wins over page/page_size pagination.","schema":{"type":"integer","maximum":9007199254740991,"minimum":0},"example":1},{"in":"query","name":"page","description":"Page number of paginated response. Limit/Offset pagination wins over page/page_size pagination.","schema":{"type":"integer","maximum":9007199254740991,"minimum":1},"example":1},{"in":"query","name":"page_size","description":"Page size of paginated response. Limit/Offset pagination wins over page/page_size pagination.","schema":{"type":"integer","maximum":9007199254740991,"minimum":1},"example":25},{"in":"query","name":"sort","description":"Sorting used for response.","schema":{"type":"string"},"example":"-inventory_id"},{"in":"path","name":"cve_id","description":"CVE id.","required":true,"schema":{"type":"string"},"example":"CVE-2016-0800"},{"in":"query","name":"status_id","description":"Filer based on CVE status ID.","schema":{"type":"string","example":"1,4"}},{"in":"query","name":"data_format","description":"Format of the output data, either JSON (default) or CSV.","schema":{"type":"string","example":"json"}},{"in":"query","name":"uuid","description":"Filter based on UUID of inventory.","schema":{"type":"string"},"example":"2ee58c62-809f-11ea-bc55-0242ac130003"},{"in":"query","name":"rule_key","description":"Filters security rules by its error key.","schema":{"type":"array","items":{"type":"string"}},"deprecated":true,"example":"CVE_2018_3639_cpu_kernel|CVE_2018_3639_CPU_BAD_MICROCODE_2,CVE_2018_12207_cpu_kernel|CVE_2018_12207_CPU_KERNEL_FOR_SURE"},{"in":"query","name":"rule_presence","description":"Comma seprated string with bools. If true shows only CVEs with security rule associated, if false shows CVEs without rules. true, false shows all.","schema":{"type":"array","items":{"type":"boolean"},"maxItems":2},"deprecated":true,"example":"true,false"},{"in":"query","name":"rule","description":"Filters CVEs or systems by security rule, has two functionalities. If value is false, shows results without security rules, every other value is taken as rule error key.","schema":{"type":"array","items":{"type":"string","minLength":1}},"example":"CVE_2018_3639_cpu_kernel|CVE_2018_3639_CPU_BAD_MICROCODE_2,CVE_2018_12207_cpu_kernel|CVE_2018_12207_CPU_KERNEL_FOR_SURE"},{"in":"query","name":"tags","description":"Filter based on hosts tags. Tags needs to be in query format, that means /= or / if value is null. Characters '/', '=' in tag values needs to be escaped by url encoding.","schema":{"type":"array","items":{"type":"string","pattern":"^([^=/]+\\/){1}([^=/])+(=[^=/]+)?$"}},"example":"vulnerability/usage=server"},{"in":"query","name":"sap_sids","description":"List of SAP IDs to filter with","schema":{"type":"array","items":{"type":"string"}},"example":"ABC,CDE"},{"in":"query","name":"sap_system","description":"Boolean value which shows systems managed by SAP.","schema":{"type":"boolean"},"example":false},{"in":"query","name":"show_advisories","description":"If true shows advisories list","schema":{"type":"boolean"},"example":false},{"in":"query","name":"advisory","description":"Filter by advisory name, works only with show_advisories=true","schema":{"type":"string"},"example":"RHSA-2019:1481"},{"in":"query","name":"rhel_version","description":"Filters results by RHEL OS version. Automatically flters out systems which are not RHEL or have uknown OS.","required":false,"schema":{"type":"string","description":"List of RHEL versions. E.g. 7,8.1 will filter out everything which is not RHEL 7.x or RHEL 8.1"}},{"in":"query","name":"first_reported_from","description":"Filter for CVEs/Systems where the vulnerability appeared after given date.","required":false,"schema":{"type":"string","description":"Datetime string"},"example":"2017-09-18T00:00:00+00:00"},{"in":"query","name":"first_reported_to","description":"Filter for CVEs/Systems where the vulnerability appeared before given date.","required":false,"schema":{"type":"string","description":"Datetime string"},"example":"2017-09-18T00:00:00+00:00"},{"in":"query","name":"advisory_available","description":"String of booleans (array of booleans), where true shows CVE-system pairs with available advisory, false shows CVE-system pairs without available advisory.","schema":{"type":"array","items":{"type":"boolean"},"maxItems":2},"example":"true,false"},{"in":"query","name":"remediation","description":"Filer based on available remediation type id.","schema":{"type":"string","example":1}},{"in":"query","name":"ansible","description":"Boolean value which shows systems managed by Ansible Automation Platform.","schema":{"type":"boolean"},"example":false},{"in":"query","name":"mssql","description":"Boolean value which shows systems managed by MSSQL.","schema":{"type":"boolean"},"example":false},{"in":"query","name":"group_names","description":"Names of the inventory groups.","schema":{"type":"array","items":{"type":"string"}},"example":"Production,Stage"},{"in":"query","name":"group_ids","description":"IDs of the inventory groups.","schema":{"type":"array","items":{"type":"string"}},"example":"00000000-1111-0000-0000-000000000000,00000000-2222-0000-0000-000000000000"},{"in":"query","name":"host_type","description":"For filtering out the systems based on their type. Value \"rpmdnf\" for RPMDNF systems, \"image\" for image-mode systems.","schema":{"type":"array","items":{"type":"string","enum":["rpmdnf","image","edge"]},"maxItems":2}}]}},"/cves/business_risk":{"patch":{"summary":"Set business risk for a CVE","description":"This sets a business risk for a specific CVE. Set a value of low, medium, high or critical for a given CVE. These values are obtained by the business risk path *GET/business_risk*. To set a business risk, you must call the GET/business_risk endpoint first, followed by the *PATCH/cves/business_risk* path.\n","operationId":"setCveBusinessRisk","x-methodName":"setCveBusinessRisk","security":[{"ApiKeyAuth":[]},{"BasicAuth":[]}],"requestBody":{"description":"Values to be set. At least one of the \"business_risk_id\" or \"business_risk_text\" parameters is required.","required":true,"content":{"application/vnd.api+json":{"schema":{"x-body-name":"data","type":"object","properties":{"cve":{"oneOf":[{"type":"string","description":"CVE name.","example":"CVE-2016-0800"},{"type":"array","items":{"type":"string","example":"CVE-2016-0800"},"description":"List of CVEs for a bulk change."}],"example":"CVE-2016-0800"},"business_risk_id":{"type":"integer","description":"Business risk ID to be set, obtained by GET method.","example":3},"business_risk_text":{"type":"string","description":"Complementary text to the business risk.","example":"Not relevant","nullable":true}},"required":["cve"]}}}},"responses":{"200":{"description":"Business risk successfully updated.","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"updated":{"type":"array","items":{"type":"string","example":"f35b1e1d-d231-43f2-8e4f-8f9cb01e3aa2"},"description":"List of updated objects/updated object IDs."},"meta":{"type":"object","properties":{"permissions":{"type":"array","description":"Fetched permissions from RBAC for given user","nullable":false,"items":{"type":"string","example":"vulnerability:vulnerability_results:read"}}},"required":["permissions"]}},"required":["updated"]}}}},"404":{"description":"Given CVE does not exist.","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"oneOf":[{"type":"string","description":"Error detail.","example":"Record not found."},{"type":"object","description":"Returned with RBAC (user permissions) related issue","properties":{"msg":{"type":"string","description":"Error detail related to RBAC problem"},"permissions":{"type":"array","items":{"type":"string"},"description":"Array with RBAC permissions of user"}}}]},"status":{"type":"string","description":"String representation of HTTP status code.","example":404}},"required":["detail","status"]},"minItems":1}},"required":["errors"]}}}},"503":{"description":"Service is running in read-only mode.","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"oneOf":[{"type":"string","description":"Error detail.","example":"Record not found."},{"type":"object","description":"Returned with RBAC (user permissions) related issue","properties":{"msg":{"type":"string","description":"Error detail related to RBAC problem"},"permissions":{"type":"array","items":{"type":"string"},"description":"Array with RBAC permissions of user"}}}]},"status":{"type":"string","description":"String representation of HTTP status code.","example":404}},"required":["detail","status"]},"minItems":1}},"required":["errors"]}}}}}}},"/cves/status":{"patch":{"summary":"Set status for a CVE","description":"This sets the status for a specific CVE. Set a status value for a given CVE (e.g. in-review, on-hold, scheduled for a patch, or resolved). These values are obtained by sending a *GET/status* request. To set a status, you must call the *GET/business_risk* first, followed by the *PATCH/cves/status* path.\n","operationId":"setCveStatus","x-methodName":"setCveStatus","security":[{"ApiKeyAuth":[]},{"BasicAuth":[]}],"requestBody":{"description":"Values to be set. At least one of the \"status_id\" or \"status_text\" parameters is required.","required":true,"content":{"application/vnd.api+json":{"schema":{"x-body-name":"data","type":"object","properties":{"cve":{"oneOf":[{"type":"string","description":"CVE name.","example":"CVE-2016-0800"},{"type":"array","items":{"type":"string","example":"CVE-2016-0800"},"description":"List of CVEs for a bulk change."}],"example":"CVE-2016-0800"},"status_id":{"type":"integer","description":"Status ID to be set, obtained by GET method.","example":3},"status_text":{"type":"string","description":"Complementary text to the status.","example":"Not relevant","nullable":true}},"required":["cve"]}}}},"responses":{"200":{"description":"Status successfully updated.","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"updated":{"type":"array","items":{"type":"string","example":"f35b1e1d-d231-43f2-8e4f-8f9cb01e3aa2"},"description":"List of updated objects/updated object IDs."},"meta":{"type":"object","properties":{"permissions":{"type":"array","description":"Fetched permissions from RBAC for given user","nullable":false,"items":{"type":"string","example":"vulnerability:vulnerability_results:read"}}},"required":["permissions"]}},"required":["updated"]}}}},"404":{"description":"Given CVE does not exist.","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"oneOf":[{"type":"string","description":"Error detail.","example":"Record not found."},{"type":"object","description":"Returned with RBAC (user permissions) related issue","properties":{"msg":{"type":"string","description":"Error detail related to RBAC problem"},"permissions":{"type":"array","items":{"type":"string"},"description":"Array with RBAC permissions of user"}}}]},"status":{"type":"string","description":"String representation of HTTP status code.","example":404}},"required":["detail","status"]},"minItems":1}},"required":["errors"]}}}},"503":{"description":"Service is running in read-only mode.","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"oneOf":[{"type":"string","description":"Error detail.","example":"Record not found."},{"type":"object","description":"Returned with RBAC (user permissions) related issue","properties":{"msg":{"type":"string","description":"Error detail related to RBAC problem"},"permissions":{"type":"array","items":{"type":"string"},"description":"Array with RBAC permissions of user"}}}]},"status":{"type":"string","description":"String representation of HTTP status code.","example":404}},"required":["detail","status"]},"minItems":1}},"required":["errors"]}}}}}}},"/dashboard":{"get":{"summary":"Get a macro level overview of aggregated vulnerabilities","description":"These are aggregations summarizing your account such as number of unique CVEs, list of security rules, CVEs by severity, and more. Use this endpoint to obtain a snapshot of all the CVES and details about their prevalence and severity.\n","operationId":"getDashboard","x-methodName":"getDashboard","security":[{"ApiKeyAuth":[]},{"BasicAuth":[]}],"responses":{"200":{"description":"Dashboard.","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"cves_total":{"type":"integer","description":"Number of unique CVEs discovered on the managed systems.","example":1902},"cves_by_severity":{"type":"object","description":"Number of CVEs discovered on the managed systems, divided into buckets based on their CVSSv3 score (CVSSv2 is used when CVSSv3 is not available).","properties":{"0to3.9":{"type":"object","properties":{"count":{"type":"integer","description":"Number of CVEs with CVSS score lower than 4.","example":1902},"percentage":{"type":"number","description":"Percentage of CVEs with CVSS score lower than 4.","example":60},"known_exploits":{"type":"number","description":"Number of CVEs in given bracket with a known exploit.","example":6}},"required":["count","percentage"]},"4to7.9":{"type":"object","properties":{"count":{"type":"integer","description":"Number of CVEs with CVSS score higher or equal to 4 and lower then 8.","example":400},"percentage":{"type":"number","description":"Percentage of CVEs with CVSS score higher or equal to 4 and lower then 8.","example":15},"known_exploits":{"type":"number","description":"Number of CVEs in given bracket with a known exploit.","example":6}},"required":["count","percentage"]},"8to10":{"type":"object","properties":{"count":{"type":"integer","description":"Number of CVEs with CVSS score higher or equal to 8.","example":109},"percentage":{"type":"number","description":"Percentage of CVEs with CVSS score higher or equal to 8.","example":2},"known_exploits":{"type":"number","description":"Number of CVEs in given bracket with a known exploit.","example":6}},"required":["count","percentage"]}},"required":["0to3.9","4to7.9","8to10"]},"recent_cves":{"type":"object","description":"Number of recently published CVEs identified on managed systems","properties":{"last7days":{"type":"integer","description":"Number of CVEs identified on managed systems published in last 7 days.","example":14},"last30days":{"type":"integer","description":"Number of CVEs identified on managed systems published in last 30 days.","example":62},"last90days":{"type":"integer","description":"Number of CVEs identified on managed systems published in last 90 days.","example":156}},"required":["last7days","last30days","last90days"]},"recent_rules":{"type":"array","description":"List of recently (14 days) released security rules.","items":{"type":"object","description":"Security rule.","properties":{"associated_cves":{"type":"array","description":"List of CVEs associated with the security rule.","items":{"type":"string","description":"CVE name.","example":"CVE-2016-0800"}},"description":{"type":"string","example":"A heap-based buffer overflow was found in the way ...","description":"Description of the issue related with the security rule."},"id":{"type":"string","description":"ID of the security rule.","example":"CVE_2019_11135_cpu_taa|CVE_2019_11135_CPU_TAA_KERNEL"},"name":{"type":"string","description":"Name of the security rule.","example":"sudo privilege escalation"},"node_id":{"type":"number","description":"Node id of access.redhat.com/node/* article.","example":5737621,"nullable":true},"public_date":{"type":"string","description":"String representation of ISO-8601 formatted date of release of the security rule.","example":"2016-03-01T00:00:00+00:00","nullable":true},"severity":{"type":"number","description":"Number representation of the security rule severity.","example":3},"systems_affected":{"type":"number","description":"Number of systems triggering the security rule.","example":178}}},"required":["associated_cves","description","name","node_id","severity","systems_affected"]},"rules_cves_total":{"type":"integer","description":"Total number of CVEs with associated security rules affecting given account.","example":12},"system_count":{"type":"integer","description":"Total systems registered to Vulnerability service (with applied filtering).","example":241},"exploited_cves_count":{"type":"integer","description":"unique number of CVEs having known exploit affecting at least one system","example":5}},"required":["cves_total","cves_by_severity","recent_cves","recent_rules","rules_cves_total","system_count","exploited_cves_count"]}}}}},"parameters":[{"in":"query","name":"tags","description":"Filter based on hosts tags. Tags needs to be in query format, that means /= or / if value is null. Characters '/', '=' in tag values needs to be escaped by url encoding.","schema":{"type":"array","items":{"type":"string","pattern":"^([^=/]+\\/){1}([^=/])+(=[^=/]+)?$"}},"example":"vulnerability/usage=server"},{"in":"query","name":"sap_sids","description":"List of SAP IDs to filter with","schema":{"type":"array","items":{"type":"string"}},"example":"ABC,CDE"},{"in":"query","name":"sap_system","description":"Boolean value which shows systems managed by SAP.","schema":{"type":"boolean"},"example":false},{"in":"query","name":"ansible","description":"Boolean value which shows systems managed by Ansible Automation Platform.","schema":{"type":"boolean"},"example":false},{"in":"query","name":"mssql","description":"Boolean value which shows systems managed by MSSQL.","schema":{"type":"boolean"},"example":false}]}},"/playbooks/templates/{rule_id}":{"get":{"summary":"Get an Ansible Playbook template for CVEs with security rules","description":"This returns an Ansible playbook template for a given rule identification number. Use this endpoint to return an Ansible playbook template for a given rule error key. The template is used to remediate issues on your system.\n","operationId":"getPlaybookTemplate","x-methodName":"getPlaybookTemplate","security":[{"ApiKeyAuth":[]},{"BasicAuth":[]}],"responses":{"200":{"description":"Playbook template response","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"description":{"type":"string","description":"Playbook template description.","example":"Fix issues caused by CVE_2017_6074_kernel|KERNEL_CVE_2017_6074."},"play":{"type":"string","description":"Actual playbook template."},"version":{"type":"string","description":"Revision of the playbook template.","example":"93a1ced8a259666f0505cd20b7cb8e7a1c65b868"},"reboot_required":{"type":"boolean","description":"Indicator whter reboot is required to mitigate vulnerability.","example":false,"nullable":true},"resolution_type":{"type":"string","description":"Type of the resolution provided by playbook."}},"required":["description","play","version","resolution_type"]}}}}}}},"404":{"description":"Given rule id does not exist.","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"oneOf":[{"type":"string","description":"Error detail.","example":"Record not found."},{"type":"object","description":"Returned with RBAC (user permissions) related issue","properties":{"msg":{"type":"string","description":"Error detail related to RBAC problem"},"permissions":{"type":"array","items":{"type":"string"},"description":"Array with RBAC permissions of user"}}}]},"status":{"type":"string","description":"String representation of HTTP status code.","example":404}},"required":["detail","status"]},"minItems":1}},"required":["errors"]}}}}},"parameters":[{"in":"path","name":"rule_id","description":"Insights security rule ID.","required":true,"schema":{"type":"string"},"example":"CVE_2017_8779_rpc|CVE_2017_8779_WARN"}]}},"/report/executive":{"get":{"summary":"Generate an executive report","description":"This returns an overview of vulnerabilities affecting a given account. Use this request when you need to download a high-level, executive report summarizing the security exposure of your infrastructure. These reports are designed for an executive audience and include data such as the number of RHEL systems analyzed, the number of security rules in your infrastructure, percentage of CVEs with a certain severity and more.\n","operationId":"getExecutiveReport","x-methodName":"getExecutiveReport","security":[{"ApiKeyAuth":[]},{"BasicAuth":[]}],"responses":{"200":{"description":"Executive report.","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"system_count_per_type":{"type":"object","description":"Number of systems managed by vulnerability application, grouped by host type.","properties":{"rpmdnf":{"type":"number","description":"Number of conventional systems.","example":26},"image":{"type":"number","description":"Number of image-mode systems.","example":3,"nullable":true},"edge":{"type":"number","description":"Number of image-mode systems. (Deprecated)","example":3,"nullable":true}}},"system_count":{"type":"integer","description":"Total number of systems managed by vulnerability application.","example":25641},"cves_total":{"type":"integer","description":"Number of unique CVEs discovered on the managed systems.","example":1902},"cves_by_severity":{"type":"object","description":"Number of CVEs discovered on the managed systems, divided into buckets based on their CVSSv3 score (CVSSv2 is used when CVSSv3 is not available).","properties":{"0to3.9":{"type":"object","properties":{"count":{"type":"integer","description":"Number of CVEs with CVSS score lower than 4.","example":1902},"percentage":{"type":"number","description":"Percentage of CVEs with CVSS score lower than 4.","example":60}},"required":["count","percentage"]},"4to7.9":{"type":"object","properties":{"count":{"type":"integer","description":"Number of CVEs with CVSS score higher or equal to 4 and lower then 8.","example":400},"percentage":{"type":"number","description":"Percentage of CVEs with CVSS score higher or equal to 4 and lower then 8.","example":15}},"required":["count","percentage"]},"8to10":{"type":"object","properties":{"count":{"type":"integer","description":"Number of CVEs with CVSS score higher or equal to 8.","example":109},"percentage":{"type":"number","description":"Percentage of CVEs with CVSS score higher or equal to 8.","example":2}},"required":["count","percentage"]}},"required":["0to3.9","4to7.9","8to10"]},"recent_cves":{"type":"object","description":"Number of recently published CVEs identified on managed systems","properties":{"last7days":{"type":"integer","description":"Number of CVEs identified on managed systems published in last 7 days.","example":14},"last30days":{"type":"integer","description":"Number of CVEs identified on managed systems published in last 30 days.","example":62},"last90days":{"type":"integer","description":"Number of CVEs identified on managed systems published in last 90 days.","example":156}},"required":["last7days","last30days","last90days"]},"rules_by_severity":{"type":"object","description":"Information about how much systems are affected by a security rule, broken down by rule severity.","properties":{"1":{"type":"object","properties":{"rule_count":{"type":"integer","description":"How many unique rules with at least system affected are present.","example":12},"systems_affected":{"type":"integer","description":"How many unique systems are affected by at least one rules with given severity","example":443}},"required":["rule_count","systems_affected"]},"2":{"type":"object","properties":{"rule_count":{"type":"integer","description":"How many unique rules with at least system affected are present.","example":12},"systems_affected":{"type":"integer","description":"How many unique systems are affected by at least one rules with given severity","example":443}},"required":["rule_count","systems_affected"]},"3":{"type":"object","properties":{"rule_count":{"type":"integer","description":"How many unique rules with at least system affected are present.","example":12},"systems_affected":{"type":"integer","description":"How many unique systems are affected by at least one rules with given severity","example":443}},"required":["rule_count","systems_affected"]},"4":{"type":"object","properties":{"rule_count":{"type":"integer","description":"How many unique rules with at least system affected are present.","example":12},"systems_affected":{"type":"integer","description":"How many unique systems are affected by at least one rules with given severity","example":443}},"required":["rule_count","systems_affected"]}},"required":["1","2","3","4"]},"rules_total":{"type":"integer","description":"Number of unique CVEs discovered on the managed systems.","example":1902},"top_cves":{"type":"array","items":{"type":"object","properties":{"synopsis":{"type":"string","description":"CVE synopsis","example":"CVE-2016-0800"},"cvss2_score":{"type":"string","description":"String representation of cvss2 score of the CVE.","example":"5.800","nullable":true},"cvss3_score":{"type":"string","description":"String representation of cvss3 score of the CVE.","example":"4.400","nullable":true},"description":{"type":"string","description":"Description of the CVE.","example":"A padding oracle flaw was found in the Secure Sockets Layer version 2.0 (SSLv2) protocol. An attacker could..."},"security_rule":{"type":"boolean","description":"Indicator of security rule presence","example":true,"deprecated":true},"rule_presence":{"type":"boolean","description":"Indicator of security rule presence","example":true},"systems_affected":{"type":"integer","description":"Systems affected by the CVE.","example":1795},"known_exploit":{"type":"boolean","description":"Shows whether a CVE has known exploits or not","example":true}},"required":["synopsis","cvss2_score","cvss3_score","description","systems_affected","known_exploit"]}},"top_rules":{"type":"array","items":{"type":"object","properties":{"associated_cves":{"type":"array","description":"All CVEs associated with the rule","items":{"type":"string","example":"CVE-2019-1125"}},"description":{"type":"string","example":"Privilege Escalation with running service (no fix available for this version)","description":"Brief description of the issue."},"rule_id":{"type":"string","example":"CVE_2017_14491_dnsmasq|CVE_2017_14491_ERROR","description":"ID of associated security rule."},"name":{"type":"string","description":"Name of the security rule.","example":"httpd denial of service with running services"},"severity":{"type":"integer","description":"Severity of the security rule.","example":3},"systems_affected":{"type":"integer","description":"Number of systems affected by the rule.","example":443}},"required":["associated_cves","description","name","rule_id","severity","systems_affected"]}},"meta":{"type":"object","properties":{"permissions":{"type":"array","description":"Fetched permissions from RBAC for given user","nullable":false,"items":{"type":"string","example":"vulnerability:vulnerability_results:read"}}},"required":["permissions"]}},"required":["system_count","cves_total","cves_by_severity","rules_by_severity","rules_total","recent_cves"]}}}}}}},"/report/os":{"get":{"summary":"Generate CVE exposure report by RHEL version","description":"List RHEL versions and number of CVEs exposing each of these versions. Each RHEL version represents system with base and core group packages installed.\n","operationId":"getOSExposure","x-methodName":"getOSExposure","security":[{"ApiKeyAuth":[]},{"BasicAuth":[]}],"responses":{"200":{"description":"RHEL version CVE exposure list","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"oneOf":[{"type":"string","description":"CSV export of the JSON."},{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Name of the operating system.","example":"RHEL"},"major":{"type":"integer","description":"Operating system major version.","example":9},"minor":{"type":"integer","description":"Operating system minor version.","example":5},"lifecycle_phase":{"type":"string","description":"Lifecycle phase of the given version.","example":"eus"},"cves_critical":{"type":"integer","description":"Number of CVEs with Critical severity.","example":2},"cves_important":{"type":"integer","description":"Number of CVEs with Important severity.","example":16},"cves_moderate":{"type":"integer","description":"Number of CVEs with Moderate severity.","example":57},"cves_low":{"type":"integer","description":"Number of CVEs with Low severity.","example":12},"cves_unpatched_critical":{"type":"integer","description":"Number of unpatched CVEs with Critical severity.","example":2},"cves_unpatched_important":{"type":"integer","description":"Number of unpatched CVEs with Important severity.","example":16},"cves_unpatched_moderate":{"type":"integer","description":"Number of unpatched CVEs with Moderate severity.","example":57},"cves_unpatched_low":{"type":"integer","description":"Number of unpatched CVEs with Low severity.","example":12}},"required":["name","major","minor","lifecycle_phase","cves_critical","cves_important","cves_moderate","cves_low","cves_unpatched_critical","cves_unpatched_important","cves_unpatched_moderate","cves_unpatched_low"]}}]}},"required":["data"]}}}}},"parameters":[{"in":"query","name":"data_format","description":"Format of the output data, either JSON (default) or CSV.","schema":{"type":"string","example":"json"}}]}},"/status":{"get":{"summary":"Access available status values","description":"This endpoint returns a list of possible values for setting status for a CVE or system-CVE pair. Call this api when you want to know which values are available for setting a status. A list of numbers will be returned. You must call this endpoint before calling the *PATCH/cves/status* endpoint.\n","operationId":"getStatusList","x-methodName":"getStatusList","security":[{"ApiKeyAuth":[]},{"BasicAuth":[]}],"responses":{"200":{"description":"List of status/status_id pairs.","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"type":"array","description":"List of available status/status_id pairs.","items":{"type":"object","properties":{"id":{"type":"integer","description":"Internal status_id.","example":3},"name":{"type":"string","description":"Represenation of internal status_id.","example":"Scheduled for Patch"}},"required":["id","name"]}},"meta":{"type":"object","properties":{"total_items":{"type":"integer","description":"Total number of available status/status_id pairs.","example":1}},"required":["total_items"]}},"required":["data","meta"]}}}}}},"patch":{"summary":"Set status for system vulnerabilities","description":"This endpoint sets status for given systems and CVEs. Use this endpoint when you need to set a status value for system-CVE pairs.\n","operationId":"setStatus","x-methodName":"setStatus","security":[{"ApiKeyAuth":[]},{"BasicAuth":[]}],"requestBody":{"description":"Values to be set.","required":true,"content":{"application/vnd.api+json":{"schema":{"x-body-name":"data","type":"object","properties":{"inventory_id":{"oneOf":[{"type":"string","description":"Inventory ID.","example":"f35b1e1d-d231-43f2-8e4f-8f9cb01e3aa2"},{"type":"array","items":{"type":"string","example":"f35b1e1d-d231-43f2-8e4f-8f9cb01e3aa2"},"description":"List of inventory IDs for a bulk change."}],"example":"f35b1e1d-d231-43f2-8e4f-8f9cb01e3aa2"},"cve":{"oneOf":[{"type":"string","description":"CVE name.","example":"CVE-2016-0800"},{"type":"array","items":{"type":"string","example":"CVE-2016-0800"},"description":"List of CVEs for a bulk change."}],"example":"CVE-2016-0800"},"status_id":{"type":"integer","description":"Status ID to be set, obtained by GET method. If not specified, global CVE status is set.","example":3},"status_text":{"type":"string","description":"Complementary text to the status.","example":"Not relevant","nullable":true}},"required":["cve"]}}}},"responses":{"200":{"description":"Status successfully updated.","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"updated":{"type":"array","items":{"type":"object","properties":{"inventory_id":{"type":"string","example":"f35b1e1d-d231-43f2-8e4f-8f9cb01e3aa2"},"cve":{"type":"string","example":"CVE-2016-0800"}},"required":["inventory_id","cve"]},"description":"List of updated objects/updated object IDs."},"meta":{"type":"object","properties":{"permissions":{"type":"array","description":"Fetched permissions from RBAC for given user","nullable":false,"items":{"type":"string","example":"vulnerability:vulnerability_results:read"}}},"required":["permissions"]}},"required":["updated"]}}}},"404":{"description":"Given host/CVE does not exist.","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"oneOf":[{"type":"string","description":"Error detail.","example":"Record not found."},{"type":"object","description":"Returned with RBAC (user permissions) related issue","properties":{"msg":{"type":"string","description":"Error detail related to RBAC problem"},"permissions":{"type":"array","items":{"type":"string"},"description":"Array with RBAC permissions of user"}}}]},"status":{"type":"string","description":"String representation of HTTP status code.","example":404}},"required":["detail","status"]},"minItems":1}},"required":["errors"]}}}},"503":{"description":"Service is running in read-only mode.","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"oneOf":[{"type":"string","description":"Error detail.","example":"Record not found."},{"type":"object","description":"Returned with RBAC (user permissions) related issue","properties":{"msg":{"type":"string","description":"Error detail related to RBAC problem"},"permissions":{"type":"array","items":{"type":"string"},"description":"Array with RBAC permissions of user"}}}]},"status":{"type":"string","description":"String representation of HTTP status code.","example":404}},"required":["detail","status"]},"minItems":1}},"required":["errors"]}}}}}}},"/systems":{"get":{"summary":"List systems","description":"List systems that are accessible when you are logged into your account. Use this endpoint to view basic system attributes such as display name and system type.\n","operationId":"getSystemsList","x-methodName":"getSystemsList","security":[{"ApiKeyAuth":[]},{"BasicAuth":[]}],"responses":{"200":{"description":"System list","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"oneOf":[{"type":"string","description":"CSV export of the JSON."},{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Host ID.","example":"INV-ID00-0000-1234"},"type":{"type":"string","description":"Type of the record.","example":"system"},"attributes":{"type":"object","properties":{"cve_count":{"type":"integer","description":"Number of CVE exposures for the system.","example":7,"nullable":true},"display_name":{"type":"string","description":"System's name,","example":"system.example.com","nullable":true},"inventory_id":{"type":"string","description":"Host ID.","example":"INV-ID00-0000-1234"},"insights_id":{"type":"string","description":"Insights host ID.","example":"0035f6bc-cdb0-4763-8fcd-1dc58f716359","nullable":true},"last_evaluation":{"type":"string","description":"Date of last evaluation.","example":"2018-09-22T16:00:00+00:00","nullable":true},"rules_evaluation":{"type":"string","description":"Date of last security rules evaluation.","example":"2018-09-22T16:00:00+00:00","nullable":true},"opt_out":{"type":"boolean","description":"Opt out status of the system.","example":false},"last_upload":{"type":"string","description":"Date of the latest upload of archive.","example":"2018-09-22T16:00:00+00:00","nullable":true},"os":{"type":"string","description":"Operating system.","example":"RHEL 8.4"},"rhsm_lock":{"type":"string","description":"System is locked to following RHSM version.","example":"8.4","nullable":true},"stale_timestamp":{"type":"string","description":"Date when stale system becomes stale.","example":"2018-09-22T16:00:00+00:00","nullable":true},"stale_warning_timestamp":{"type":"string","description":"Date when stale system becomes hidden in the application.","example":"2018-09-22T16:00:00+00:00","nullable":true},"updated":{"type":"string","description":"Date of the lastest upload of archive taken from Inventory syndicated data.","example":"2018-09-22T16:00:00+00:00","nullable":true},"tags":{"type":"array","items":{"type":"object","properties":{"namespace":{"type":"string","description":"Namespace of single tag.","example":"vulnerability","nullable":true},"key":{"type":"string","description":"Key of the single tag.","example":"CVE"},"value":{"type":"string","description":"Value of the single tag.","example":"CVE-2017-1","nullable":true}},"required":["namespace","key","value"]},"description":"Tags given to the system.","nullable":true},"culled_timestamp":{"type":"string","description":"Timestamp from which the host is considered deleted.","example":"2018-09-22T16:00:00+00:00","nullable":true},"inventory_group":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"ID of inventory group.","example":"00000000-1111-0000-0000-000000000000"},"name":{"type":"string","description":"Name of inventory group.","example":"group01"}},"required":["id","name"]}},"host_type":{"type":"string","description":"Type of the host","enum":["rpmdnf","image"]}},"required":["cve_count","display_name","inventory_id","insights_id","last_evaluation","rules_evaluation","opt_out","last_upload","os","rhsm_lock","stale_timestamp","stale_warning_timestamp","tags","culled_timestamp","inventory_group","host_type"]}},"required":["id","type","attributes"]}}]},"links":{"type":"object","properties":{"first":{"type":"string","description":"Link to first page.","example":"/api?offset=0&limit=1"},"last":{"type":"string","description":"Link to last page.","example":"/api?offset=7&limit=1"},"next":{"type":"string","description":"Link to next page.","example":"/api?offset=5&limit=1","nullable":true},"previous":{"type":"string","description":"Link to next page.","example":"/api?offset=3&limit=1","nullable":true}},"required":["first","last","next","previous"]},"meta":{"allOf":[{"type":"object","properties":{"filter":{"type":"string","description":"Full text filter","example":"CVE-2016-0800","nullable":true},"limit":{"type":"integer","description":"Maximum number of paginated results.","example":25},"offset":{"type":"integer","description":"First record of paginated response.","example":0},"page":{"type":"integer","description":"Page number of paginated response.","example":1},"page_size":{"type":"integer","description":"Number of records per page of paginated response.","example":25},"pages":{"type":"integer","description":"Total number of pages of paginated response.","example":1},"sort":{"type":"string","description":"Sorting filter.","example":"-inventory_id","nullable":true},"total_items":{"type":"integer","description":"Total number of records.","example":37},"data_format":{"type":"string","description":"Format of the output data, either JSON (default) or CSV.","example":"JSON"}},"required":["filter","limit","offset","page","page_size","pages","sort","total_items","data_format"]},{"type":"object","properties":{"permissions":{"type":"array","description":"Fetched permissions from RBAC for given user","nullable":false,"items":{"type":"string","example":"vulnerability:vulnerability_results:read"}}},"required":["permissions"]},{"type":"object","properties":{"excluded":{"type":"string","description":"Display setting of opted out systems.","example":"true,false","nullable":true},"rhel_version":{"type":"string","description":"Filter base on system RHEL version.","example":"8.2","nullable":true}},"required":["excluded","rhel_version"]}]}},"required":["data","links","meta"]}}}}},"parameters":[{"in":"query","name":"filter","description":"Full text filter for the display name of system.","schema":{"type":"string"},"example":"INV-ID-1234"},{"in":"query","name":"limit","description":"Maximum number of records per page. Limit/Offset pagination wins over page/page_size pagination.","schema":{"type":"integer","maximum":9007199254740991,"minimum":1},"example":25},{"in":"query","name":"offset","description":"Offset of first record of paginated response. Limit/Offset pagination wins over page/page_size pagination.","schema":{"type":"integer","maximum":9007199254740991,"minimum":0},"example":1},{"in":"query","name":"page","description":"Page number of paginated response. Limit/Offset pagination wins over page/page_size pagination.","schema":{"type":"integer","maximum":9007199254740991,"minimum":1},"example":1},{"in":"query","name":"page_size","description":"Page size of paginated response. Limit/Offset pagination wins over page/page_size pagination.","schema":{"type":"integer","maximum":9007199254740991,"minimum":1},"example":25},{"in":"query","name":"sort","description":"Sorting used for response.","schema":{"type":"string"},"example":"-inventory_id"},{"in":"query","name":"data_format","description":"Format of the output data, either JSON (default) or CSV.","schema":{"type":"string","example":"json"}},{"in":"query","name":"stale","description":"If set to true, shows stale systems. If not set defaults to false.","schema":{"type":"boolean"}},{"in":"query","name":"uuid","description":"Filter based on UUID of inventory.","schema":{"type":"string"},"example":"2ee58c62-809f-11ea-bc55-0242ac130003"},{"in":"query","name":"tags","description":"Filter based on hosts tags. Tags needs to be in query format, that means /= or / if value is null. Characters '/', '=' in tag values needs to be escaped by url encoding.","schema":{"type":"array","items":{"type":"string","pattern":"^([^=/]+\\/){1}([^=/])+(=[^=/]+)?$"}},"example":"vulnerability/usage=server"},{"in":"query","name":"sap_sids","description":"List of SAP IDs to filter with","schema":{"type":"array","items":{"type":"string"}},"example":"ABC,CDE"},{"in":"query","name":"sap_system","description":"Boolean value which shows systems managed by SAP.","schema":{"type":"boolean"},"example":false},{"in":"query","name":"excluded","description":"Comma seprated string with bools (array of bools). True boolean value displays systems which are excluded. False value displays systems excluded from vulnerability analysis. Defaults to showing only those systems which are not excluded.","schema":{"type":"array","items":{"type":"boolean"},"maxItems":2},"example":"true,false"},{"in":"query","name":"rhel_version","description":"Filters results by RHEL OS version. Automatically flters out systems which are not RHEL or have uknown OS.","required":false,"schema":{"type":"string","description":"List of RHEL versions. E.g. 7,8.1 will filter out everything which is not RHEL 7.x or RHEL 8.1"}},{"in":"query","name":"report","description":"Needs to be used when endpoint data is used for report generation, checks RBAC permission for report and export feature.","required":false,"schema":{"type":"boolean"},"example":false},{"in":"query","name":"ansible","description":"Boolean value which shows systems managed by Ansible Automation Platform.","schema":{"type":"boolean"},"example":false},{"in":"query","name":"mssql","description":"Boolean value which shows systems managed by MSSQL.","schema":{"type":"boolean"},"example":false},{"in":"query","name":"group_names","description":"Names of the inventory groups.","schema":{"type":"array","items":{"type":"string"}},"example":"Production,Stage"},{"in":"query","name":"group_ids","description":"IDs of the inventory groups.","schema":{"type":"array","items":{"type":"string"}},"example":"00000000-1111-0000-0000-000000000000,00000000-2222-0000-0000-000000000000"},{"in":"query","name":"host_type","description":"For filtering out the systems based on their type. Value \"rpmdnf\" for RPMDNF systems, \"image\" for image-mode systems.","schema":{"type":"array","items":{"type":"string","enum":["rpmdnf","image","edge"]},"maxItems":2}}]}},"/systems/ids":{"get":{"summary":"List systems identification numbers along with opt out state","description":"This lists systems including those that have opted out of the current query. Use this when you do not want to see a registered system or systems in your reports.\n","operationId":"getSystemsIds","x-methodName":"getSystemsIds","security":[{"ApiKeyAuth":[]},{"BasicAuth":[]}],"responses":{"200":{"description":"System list","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"oneOf":[{"type":"string","description":"CSV export of the JSON."},{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Inventory ID.","example":"INV-ID00-0000-1234"},"opt_out":{"type":"boolean","description":"Whether the system is active or not.","example":false,"nullable":true},"display_name":{"type":"string","description":"System's name.","example":"system.example.com","nullable":true}}}}]},"links":{"type":"object","properties":{"first":{"type":"string","description":"Link to first page.","example":"/api?offset=0&limit=1"},"last":{"type":"string","description":"Link to last page.","example":"/api?offset=7&limit=1"},"next":{"type":"string","description":"Link to next page.","example":"/api?offset=5&limit=1","nullable":true},"previous":{"type":"string","description":"Link to next page.","example":"/api?offset=3&limit=1","nullable":true}},"required":["first","last","next","previous"]},"meta":{"allOf":[{"type":"object","properties":{"filter":{"type":"string","description":"Full text filter","example":"CVE-2016-0800","nullable":true},"limit":{"type":"integer","description":"Maximum number of paginated results.","example":25},"offset":{"type":"integer","description":"First record of paginated response.","example":0},"page":{"type":"integer","description":"Page number of paginated response.","example":1},"page_size":{"type":"integer","description":"Number of records per page of paginated response.","example":25},"pages":{"type":"integer","description":"Total number of pages of paginated response.","example":1},"sort":{"type":"string","description":"Sorting filter.","example":"-inventory_id","nullable":true},"total_items":{"type":"integer","description":"Total number of records.","example":37},"data_format":{"type":"string","description":"Format of the output data, either JSON (default) or CSV.","example":"JSON"}},"required":["filter","limit","offset","page","page_size","pages","sort","total_items","data_format"]},{"type":"object","properties":{"permissions":{"type":"array","description":"Fetched permissions from RBAC for given user","nullable":false,"items":{"type":"string","example":"vulnerability:vulnerability_results:read"}}},"required":["permissions"]},{"type":"object","properties":{"excluded":{"type":"string","description":"Display setting of opted out systems.","example":"true,false","nullable":true},"rhel_version":{"type":"string","description":"Filter base on system RHEL version.","example":"8.2","nullable":true}},"required":["excluded","rhel_version"]}]}},"required":["data","links","meta"]}}}}},"parameters":[{"in":"query","name":"filter","description":"Full text filter for the display name of system.","schema":{"type":"string"},"example":"INV-ID-1234"},{"in":"query","name":"limit","description":"Maximum number of records per page. Limit/Offset pagination wins over page/page_size pagination.","schema":{"type":"integer","maximum":9007199254740991,"minimum":1},"example":25},{"in":"query","name":"offset","description":"Offset of first record of paginated response. Limit/Offset pagination wins over page/page_size pagination.","schema":{"type":"integer","maximum":9007199254740991,"minimum":0},"example":1},{"in":"query","name":"page","description":"Page number of paginated response. Limit/Offset pagination wins over page/page_size pagination.","schema":{"type":"integer","maximum":9007199254740991,"minimum":1},"example":1},{"in":"query","name":"page_size","description":"Page size of paginated response. Limit/Offset pagination wins over page/page_size pagination.","schema":{"type":"integer","maximum":9007199254740991,"minimum":1},"example":25},{"in":"query","name":"sort","description":"Sorting used for response.","schema":{"type":"string"},"example":"-inventory_id"},{"in":"query","name":"data_format","description":"Format of the output data, either JSON (default) or CSV.","schema":{"type":"string","example":"json"}},{"in":"query","name":"stale","description":"If set to true, shows stale systems. If not set defaults to false.","schema":{"type":"boolean"}},{"in":"query","name":"uuid","description":"Filter based on UUID of inventory.","schema":{"type":"string"},"example":"2ee58c62-809f-11ea-bc55-0242ac130003"},{"in":"query","name":"tags","description":"Filter based on hosts tags. Tags needs to be in query format, that means /= or / if value is null. Characters '/', '=' in tag values needs to be escaped by url encoding.","schema":{"type":"array","items":{"type":"string","pattern":"^([^=/]+\\/){1}([^=/])+(=[^=/]+)?$"}},"example":"vulnerability/usage=server"},{"in":"query","name":"sap_sids","description":"List of SAP IDs to filter with","schema":{"type":"array","items":{"type":"string"}},"example":"ABC,CDE"},{"in":"query","name":"sap_system","description":"Boolean value which shows systems managed by SAP.","schema":{"type":"boolean"},"example":false},{"in":"query","name":"excluded","description":"Comma seprated string with bools (array of bools). True boolean value displays systems which are excluded. False value displays systems excluded from vulnerability analysis. Defaults to showing only those systems which are not excluded.","schema":{"type":"array","items":{"type":"boolean"},"maxItems":2},"example":"true,false"},{"in":"query","name":"rhel_version","description":"Filters results by RHEL OS version. Automatically flters out systems which are not RHEL or have uknown OS.","required":false,"schema":{"type":"string","description":"List of RHEL versions. E.g. 7,8.1 will filter out everything which is not RHEL 7.x or RHEL 8.1"}},{"in":"query","name":"ansible","description":"Boolean value which shows systems managed by Ansible Automation Platform.","schema":{"type":"boolean"},"example":false},{"in":"query","name":"mssql","description":"Boolean value which shows systems managed by MSSQL.","schema":{"type":"boolean"},"example":false},{"in":"query","name":"group_names","description":"Names of the inventory groups.","schema":{"type":"array","items":{"type":"string"}},"example":"Production,Stage"},{"in":"query","name":"group_ids","description":"IDs of the inventory groups.","schema":{"type":"array","items":{"type":"string"}},"example":"00000000-1111-0000-0000-000000000000,00000000-2222-0000-0000-000000000000"},{"in":"query","name":"host_type","description":"For filtering out the systems based on their type. Value \"rpmdnf\" for RPMDNF systems, \"image\" for image-mode systems.","schema":{"type":"array","items":{"type":"string","enum":["rpmdnf","image","edge"]},"maxItems":2}}]}},"/systems/{inventory_id}":{"get":{"summary":"Get system details","description":"This allows you to get information about systems related to an inventory identification number. This includes details such as operating system, inventory tags, last update, opt-out status, and more.\n","operationId":"getSystemDetails","x-methodName":"getSystemDetails","security":[{"ApiKeyAuth":[]},{"BasicAuth":[]}],"responses":{"200":{"description":"System details","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"last_evaluation":{"type":"string","description":"Date of last evaluation.","example":"2018-09-22T16:00:00+00:00","nullable":true},"rules_evaluation":{"type":"string","description":"Date of last security rules evaluation.","example":"2018-09-22T16:00:00+00:00","nullable":true},"opt_out":{"type":"boolean","description":"System opt out status.","example":true},"last_upload":{"type":"string","description":"Date of the latest upload of archive.","example":"2018-09-22T16:00:00+00:00","nullable":true},"stale":{"type":"boolean","description":"System stale status.","example":true},"updated":{"type":"string","description":"Date of the lastest upload of archive taken from Inventory syndicated data.","example":"2018-09-22T16:00:00+00:00","nullable":true},"os":{"type":"string","description":"Operating system.","example":"RHEL 8.4"},"rhsm_lock":{"type":"string","description":"System is locked to following RHSM version.","example":"8.4","nullable":true},"tags":{"type":"array","items":{"type":"object","properties":{"namespace":{"type":"string","description":"Namespace of single tag.","example":"vulnerability","nullable":true},"key":{"type":"string","description":"Key of the single tag.","example":"CVE"},"value":{"type":"string","description":"Value of the single tag.","example":"CVE-2017-1","nullable":true}},"required":["namespace","key","value"]}},"host_type":{"type":"string","description":"Type of the host","enum":["rpmdnf","image"]}},"required":["last_evaluation","rules_evaluation","opt_out","last_upload","tags","os","rhsm_lock","host_type"]},"meta":{"type":"object","properties":{"permissions":{"type":"array","description":"Fetched permissions from RBAC for given user","nullable":false,"items":{"type":"string","example":"vulnerability:vulnerability_results:read"}}},"required":["permissions"]}},"required":["data","meta"]}}}},"404":{"description":"System has not been found in the database.","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"oneOf":[{"type":"string","description":"Error detail.","example":"Record not found."},{"type":"object","description":"Returned with RBAC (user permissions) related issue","properties":{"msg":{"type":"string","description":"Error detail related to RBAC problem"},"permissions":{"type":"array","items":{"type":"string"},"description":"Array with RBAC permissions of user"}}}]},"status":{"type":"string","description":"String representation of HTTP status code.","example":404}},"required":["detail","status"]},"minItems":1}},"required":["errors"]}}}}},"parameters":[{"in":"path","name":"inventory_id","description":"Inventory ID.","required":true,"schema":{"type":"string","format":"uuid"},"example":"INV-ID-0000-1234"},{"in":"query","name":"tags","description":"Filter based on hosts tags. Tags needs to be in query format, that means /= or / if value is null. Characters '/', '=' in tag values needs to be escaped by url encoding.","schema":{"type":"array","items":{"type":"string","pattern":"^([^=/]+\\/){1}([^=/])+(=[^=/]+)?$"}},"example":"vulnerability/usage=server"}]}},"/systems/{inventory_id}/cves":{"get":{"summary":"Get a CVE report for a system","description":"This endpoint displays detailed information about all CVEs for which a system is exposed. Use this endpoint to discover which CVEs are affecting a given system. CVE metadata is included.\n","operationId":"getCveListBySystem","x-methodName":"getCveListBySystem","security":[{"ApiKeyAuth":[]},{"BasicAuth":[]}],"responses":{"200":{"description":"CVE report.","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"oneOf":[{"type":"string","description":"CSV export of the JSON."},{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"CVE id.","example":"CVE-2016-0800"},"type":{"type":"string","description":"Type of the record.","example":"cve"},"attributes":{"type":"object","properties":{"business_risk":{"type":"string","description":"Business risk of the vulnerability.","example":"Low"},"business_risk_id":{"type":"integer","description":"Internal ID of the vulnerability business risk.","example":1},"business_risk_text":{"type":"string","description":"Complementary text to the business risk.","example":"QA environment => Low business risk","nullable":true},"cve_status_id":{"type":"integer","description":"Internal ID of the CVE status.","example":4},"cvss2_score":{"type":"string","description":"String representation of cvss2 score of the CVE.","example":"5.800","nullable":true},"cvss3_score":{"type":"string","description":"String representation of cvss3 score of the CVE.","example":"4.400","nullable":true},"description":{"type":"string","description":"Description of the CVE.","example":"A padding oracle flaw was found in the Secure Sockets Layer version 2.0 (SSLv2) protocol. An attacker could..."},"first_reported":{"type":"string","description":"Date of when the CVE was first reported on the system.","example":"2018-09-22T16:00:00+00:00"},"impact":{"type":"string","description":"Red Hat security impact of the CVE.","example":"Important"},"public_date":{"type":"string","description":"String representation of ISO-8601 formatted date of first public disclosure of the CVE.","example":"2016-03-01T00:00:00+00:00","nullable":true},"reporter":{"type":"number","description":"Reporter of the vulnerability, 1 for VMaaS, 2 for security rule, 3 for both VMaaS and rule.","enum":[0,1,2,3]},"rule":{"type":"object","nullable":true,"properties":{"rule_id":{"type":"string","example":"CVE_2017_14491_dnsmasq|CVE_2017_14491_ERROR","description":"ID(s) of associated security rule(s)."},"description":{"type":"string","description":"Description of the rule.","example":"CVE-2017-14491 dnsmasq code execution with listening processes","nullable":true},"summary":{"type":"string","description":"Summary of the rule.","example":"A buffer overflow vulnerability was found in `Dnsmasq`, a popular lightweight DNS and DHCP server....","nullable":true},"reboot_required":{"type":"boolean","description":"Indicator whter reboot is required to mitigate vulnerability.","example":false,"nullable":true},"playbook_count":{"type":"integer","description":"Number of available Ansible playbooks for remediation/mitigation.","example":1,"nullable":true},"change_risk":{"type":"integer","description":"Indicates how likely remediation can change environment on the remediatied system.","example":1,"nullable":true},"kbase_node_id":{"type":"integer","description":"ID of associated Red Hat knowledgebase article.","example":3199382,"nullable":true},"generate_autoplaybook":{"type":"boolean","description":"Indicates whether a playbook should be auto-generated.","example":true,"nullable":true}},"required":["change_risk","description","kbase_node_id","playbook_count","reboot_required","rule_id","summary","generate_autoplaybook"]},"status":{"type":"string","description":"Status of the vulnerability for the application's point of view.","example":"Resolved"},"status_id":{"type":"integer","description":"Internal ID of the vulnerability status.","example":4},"status_text":{"type":"string","description":"Complementary text to the status.","example":"Not relevant","nullable":true},"cve_status_text":{"type":"string","description":"Status text to the whole cve.","example":"Not relevant for all","nullable":true},"synopsis":{"type":"string","description":"Synopsis of the CVE.","example":"CVE-2016-0800"},"advisories_list":{"type":"array","description":"List of advisories for CVE","items":{"type":"string","description":"Advisory id","example":"RHSA-2019:1481"}},"known_exploit":{"type":"boolean","description":"Shows whether a CVE has known exploits or not","example":true},"advisory_available":{"type":"boolean","description":"Shows whether a CVE has available advisory or not","example":true},"remediation":{"type":"number","description":"Type of available remediation, 0 for none, 1 for manual, 2 for playbook.","enum":[0,1,2]}},"required":["business_risk","business_risk_id","business_risk_text","cve_status_id","cve_status_text","cvss2_score","cvss3_score","description","first_reported","impact","public_date","reporter","rule","status","status_id","status_text","synopsis","known_exploit","advisory_available","remediation"]}},"required":["id","type","attributes"]}}]},"links":{"type":"object","properties":{"first":{"type":"string","description":"Link to first page.","example":"/api?offset=0&limit=1"},"last":{"type":"string","description":"Link to last page.","example":"/api?offset=7&limit=1"},"next":{"type":"string","description":"Link to next page.","example":"/api?offset=5&limit=1","nullable":true},"previous":{"type":"string","description":"Link to next page.","example":"/api?offset=3&limit=1","nullable":true}},"required":["first","last","next","previous"]},"meta":{"allOf":[{"type":"object","properties":{"filter":{"type":"string","description":"Full text filter","example":"CVE-2016-0800","nullable":true},"limit":{"type":"integer","description":"Maximum number of paginated results.","example":25},"offset":{"type":"integer","description":"First record of paginated response.","example":0},"page":{"type":"integer","description":"Page number of paginated response.","example":1},"page_size":{"type":"integer","description":"Number of records per page of paginated response.","example":25},"pages":{"type":"integer","description":"Total number of pages of paginated response.","example":1},"sort":{"type":"string","description":"Sorting filter.","example":"-inventory_id","nullable":true},"total_items":{"type":"integer","description":"Total number of records.","example":37},"data_format":{"type":"string","description":"Format of the output data, either JSON (default) or CSV.","example":"JSON"}},"required":["filter","limit","offset","page","page_size","pages","sort","total_items","data_format"]},{"type":"object","properties":{"permissions":{"type":"array","description":"Fetched permissions from RBAC for given user","nullable":false,"items":{"type":"string","example":"vulnerability:vulnerability_results:read"}}},"required":["permissions"]},{"type":"object","properties":{"business_risk_id":{"type":"string","description":"Filter based on business risk IDs.","example":"1,3","nullable":true},"cvss_from":{"type":"number","description":"Filter based on cvss score, starting from the value. Use -1 to include also CVEs with N/A cvss score.","example":4.6,"nullable":true},"cvss_to":{"type":"number","description":"Filter based on cvss score, up to the value.","example":7.2,"nullable":true},"public_from":{"type":"string","description":"Filter CVEs based on their published date, starting from the date.","example":"2017-09-18T00:00:00+00:00","nullable":true},"public_to":{"type":"string","description":"Filter CVEs based on their published date, up to the date.","example":"2017-09-18T00:00:00+00:00","nullable":true},"impact":{"type":"string","description":"Filter based on impact IDs.","example":"5,7","nullable":true},"status_id":{"type":"string","description":"Filer based on CVE status ID.","example":"1,4","nullable":true},"rule_presence":{"type":"string","description":"Filter based on presence of security rule","example":"true,false","nullable":true},"patch_access":{"type":"boolean","description":"If show_advisories=true shows access to patch service else null","example":true,"nullable":true},"first_reported_from":{"type":"string","description":"Filter system-cve pairs based on first time of detection of CVE.","example":"2017-09-18T00:00:00+00:00","nullable":true},"first_reported_to":{"type":"string","description":"Filter system-cve pairs based on first time of detection of CVE.","example":"2017-09-18T00:00:00+00:00","nullable":true},"cves_without_errata":{"type":"boolean","description":"CVEs without Errata feature flag","nullable":true}},"required":["business_risk_id","cvss_from","cvss_to","public_from","public_to","impact","status_id","rule_presence","patch_access","first_reported_from","first_reported_to","cves_without_errata"]}]}},"required":["data","links","meta"]}}}},"404":{"description":"System has not been found in the database.","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"oneOf":[{"type":"string","description":"Error detail.","example":"Record not found."},{"type":"object","description":"Returned with RBAC (user permissions) related issue","properties":{"msg":{"type":"string","description":"Error detail related to RBAC problem"},"permissions":{"type":"array","items":{"type":"string"},"description":"Array with RBAC permissions of user"}}}]},"status":{"type":"string","description":"String representation of HTTP status code.","example":404}},"required":["detail","status"]},"minItems":1}},"required":["errors"]}}}}},"parameters":[{"in":"path","name":"inventory_id","description":"Inventory ID.","required":true,"schema":{"type":"string","format":"uuid"},"example":"INV-ID-0000-1234"},{"in":"query","name":"filter","description":"Full text filter for CVE and it's description text.","schema":{"type":"string"},"example":"CVE-2017"},{"in":"query","name":"limit","description":"Maximum number of records per page. Limit/Offset pagination wins over page/page_size pagination.","schema":{"type":"integer","maximum":9007199254740991,"minimum":1},"example":25},{"in":"query","name":"offset","description":"Offset of first record of paginated response. Limit/Offset pagination wins over page/page_size pagination.","schema":{"type":"integer","maximum":9007199254740991,"minimum":0},"example":1},{"in":"query","name":"page","description":"Page number of paginated response. Limit/Offset pagination wins over page/page_size pagination.","schema":{"type":"integer","maximum":9007199254740991,"minimum":1},"example":1},{"in":"query","name":"page_size","description":"Page size of paginated response. Limit/Offset pagination wins over page/page_size pagination.","schema":{"type":"integer","maximum":9007199254740991,"minimum":1},"example":25},{"in":"query","name":"sort","description":"Sorting used for response.","schema":{"type":"string"},"example":"-synopsis"},{"in":"query","name":"cvss_from","description":"Filter based on cvss score, starting from the value. Use -1 to include also CVEs with N/A cvss score.","schema":{"type":"number"},"example":4.6},{"in":"query","name":"cvss_to","description":"Filter based on cvss score, up to the value.","schema":{"type":"number"},"example":7.2},{"in":"query","name":"public_from","description":"Filter CVEs based on their published date, starting from the date.","schema":{"type":"string"},"example":"2017-09-18T00:00:00+00:00"},{"in":"query","name":"public_to","description":"Filter CVEs based on their published date, up to the date.","schema":{"type":"string"},"example":"2017-09-18T00:00:00+00:00"},{"in":"query","name":"impact","description":"Filter based on impact IDs.","schema":{"type":"string"},"example":"5,7"},{"in":"query","name":"status_id","description":"Filer based on CVE status ID.","schema":{"type":"string","example":"1,4"}},{"in":"query","name":"data_format","description":"Format of the output data, either JSON (default) or CSV.","schema":{"type":"string","example":"json"}},{"in":"query","name":"business_risk_id","description":"Filter based on business risk IDs.","schema":{"type":"string","example":"1,3"}},{"in":"query","name":"rule_presence","description":"Comma seprated string with bools. If true shows only CVEs with security rule associated, if false shows CVEs without rules. true, false shows all.","schema":{"type":"array","items":{"type":"boolean"},"maxItems":2},"example":"true,false"},{"in":"query","name":"show_advisories","description":"If true shows advisories list","schema":{"type":"boolean"},"example":false},{"in":"query","name":"advisory","description":"Filter by advisory name, works only with show_advisories=true","schema":{"type":"string"},"example":"RHSA-2019:1481"},{"in":"query","name":"rule_key","description":"Filters security rules by its error key.","schema":{"type":"array","items":{"type":"string"}},"example":"CVE_2018_3639_cpu_kernel|CVE_2018_3639_CPU_BAD_MICROCODE_2,CVE_2018_12207_cpu_kernel|CVE_2018_12207_CPU_KERNEL_FOR_SURE"},{"in":"query","name":"known_exploit","description":"String of booleans (array of booleans), where true shows CVEs with known exploits, false shows CVEs without known exploits.","schema":{"type":"array","items":{"type":"boolean"},"maxItems":2},"example":"true,false"},{"in":"query","name":"first_reported_from","description":"Filter for CVEs/Systems where the vulnerability appeared after given date.","required":false,"schema":{"type":"string","description":"Datetime string"},"example":"2017-09-18T00:00:00+00:00"},{"in":"query","name":"first_reported_to","description":"Filter for CVEs/Systems where the vulnerability appeared before given date.","required":false,"schema":{"type":"string","description":"Datetime string"},"example":"2017-09-18T00:00:00+00:00"},{"in":"query","name":"advisory_available","description":"String of booleans (array of booleans), where true shows CVE-system pairs with available advisory, false shows CVE-system pairs without available advisory.","schema":{"type":"array","items":{"type":"boolean"},"maxItems":2},"example":"true,false"},{"in":"query","name":"remediation","description":"Filer based on available remediation type id.","schema":{"type":"string","example":1}},{"in":"query","name":"report","description":"Needs to be used when endpoint data is used for report generation, checks RBAC permission for report and export feature.","required":false,"schema":{"type":"boolean"},"example":false},{"in":"query","name":"tags","description":"Filter based on hosts tags. Tags needs to be in query format, that means /= or / if value is null. Characters '/', '=' in tag values needs to be escaped by url encoding.","schema":{"type":"array","items":{"type":"string","pattern":"^([^=/]+\\/){1}([^=/])+(=[^=/]+)?$"}},"example":"vulnerability/usage=server"}]}},"/systems/{inventory_id}/cves/ids":{"get":{"summary":"Get a CVE identification number report for a system","description":"This endpoint displays identification numbers of all CVEs for which a system is exposed. Use this endpoint to learn which CVEs are affecting a given system.\n","operationId":"getCveIdsBySystem","x-methodName":"getCveIdsBySystem","security":[{"ApiKeyAuth":[]},{"BasicAuth":[]}],"responses":{"200":{"description":"CVE Ids report.","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"oneOf":[{"type":"string","description":"CSV export of the JSON."},{"type":"array","items":{"type":"object","description":"CVE id and minimal information for frontend","properties":{"id":{"type":"string","description":"CVE id.","example":"CVE-2016-0800"},"rule_id":{"type":"string","example":"CVE_2017_14491_dnsmasq|CVE_2017_14491_ERROR","description":"ID(s) of associated security rule(s)..","nullable":true},"status_id":{"type":"integer","description":"Internal ID of the vulnerability status.","example":4},"status_text":{"type":"string","description":"Complementary text to the status.","example":"Not relevant","nullable":true},"cve_status_id":{"type":"integer","description":"Internal ID of the CVE status.","example":4},"cve_status_text":{"type":"string","description":"Status text to the whole cve.","example":"Not relevant for all","nullable":true},"remediation":{"type":"number","description":"Type of available remediation, 0 for none, 1 for manual, 2 for playbook.","enum":[0,1,2]}},"required":["id","rule_id","status_id","status_text","cve_status_id","cve_status_text","remediation"]}}]},"links":{"type":"object","properties":{"first":{"type":"string","description":"Link to first page.","example":"/api?offset=0&limit=1"},"last":{"type":"string","description":"Link to last page.","example":"/api?offset=7&limit=1"},"next":{"type":"string","description":"Link to next page.","example":"/api?offset=5&limit=1","nullable":true},"previous":{"type":"string","description":"Link to next page.","example":"/api?offset=3&limit=1","nullable":true}},"required":["first","last","next","previous"]},"meta":{"allOf":[{"type":"object","properties":{"filter":{"type":"string","description":"Full text filter","example":"CVE-2016-0800","nullable":true},"limit":{"type":"integer","description":"Maximum number of paginated results.","example":25},"offset":{"type":"integer","description":"First record of paginated response.","example":0},"page":{"type":"integer","description":"Page number of paginated response.","example":1},"page_size":{"type":"integer","description":"Number of records per page of paginated response.","example":25},"pages":{"type":"integer","description":"Total number of pages of paginated response.","example":1},"sort":{"type":"string","description":"Sorting filter.","example":"-inventory_id","nullable":true},"total_items":{"type":"integer","description":"Total number of records.","example":37},"data_format":{"type":"string","description":"Format of the output data, either JSON (default) or CSV.","example":"JSON"}},"required":["filter","limit","offset","page","page_size","pages","sort","total_items","data_format"]},{"type":"object","properties":{"permissions":{"type":"array","description":"Fetched permissions from RBAC for given user","nullable":false,"items":{"type":"string","example":"vulnerability:vulnerability_results:read"}}},"required":["permissions"]},{"type":"object","properties":{"business_risk_id":{"type":"string","description":"Filter based on business risk IDs.","example":"1,3","nullable":true},"cvss_from":{"type":"number","description":"Filter based on cvss score, starting from the value. Use -1 to include also CVEs with N/A cvss score.","example":4.6,"nullable":true},"cvss_to":{"type":"number","description":"Filter based on cvss score, up to the value.","example":7.2,"nullable":true},"public_from":{"type":"string","description":"Filter CVEs based on their published date, starting from the date.","example":"2017-09-18T00:00:00+00:00","nullable":true},"public_to":{"type":"string","description":"Filter CVEs based on their published date, up to the date.","example":"2017-09-18T00:00:00+00:00","nullable":true},"impact":{"type":"string","description":"Filter based on impact IDs.","example":"5,7","nullable":true},"status_id":{"type":"string","description":"Filer based on CVE status ID.","example":"1,4","nullable":true},"rule_presence":{"type":"string","description":"Filter based on presence of security rule","example":"true,false","nullable":true},"patch_access":{"type":"boolean","description":"If show_advisories=true shows access to patch service else null","example":true,"nullable":true},"first_reported_from":{"type":"string","description":"Filter system-cve pairs based on first time of detection of CVE.","example":"2017-09-18T00:00:00+00:00","nullable":true},"first_reported_to":{"type":"string","description":"Filter system-cve pairs based on first time of detection of CVE.","example":"2017-09-18T00:00:00+00:00","nullable":true},"cves_without_errata":{"type":"boolean","description":"CVEs without Errata feature flag","nullable":true}},"required":["business_risk_id","cvss_from","cvss_to","public_from","public_to","impact","status_id","rule_presence","patch_access","first_reported_from","first_reported_to","cves_without_errata"]}]}},"required":["data","links","meta"]}}}},"404":{"description":"System has not been found in the database.","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"oneOf":[{"type":"string","description":"Error detail.","example":"Record not found."},{"type":"object","description":"Returned with RBAC (user permissions) related issue","properties":{"msg":{"type":"string","description":"Error detail related to RBAC problem"},"permissions":{"type":"array","items":{"type":"string"},"description":"Array with RBAC permissions of user"}}}]},"status":{"type":"string","description":"String representation of HTTP status code.","example":404}},"required":["detail","status"]},"minItems":1}},"required":["errors"]}}}}},"parameters":[{"in":"path","name":"inventory_id","description":"Inventory ID.","required":true,"schema":{"type":"string","format":"uuid"},"example":"INV-ID-0000-1234"},{"in":"query","name":"filter","description":"Full text filter for CVE and it's description text.","schema":{"type":"string"},"example":"CVE-2017"},{"in":"query","name":"limit","description":"Maximum number of records per page. Limit/Offset pagination wins over page/page_size pagination.","schema":{"type":"integer","maximum":9007199254740991,"minimum":1},"example":25},{"in":"query","name":"offset","description":"Offset of first record of paginated response. Limit/Offset pagination wins over page/page_size pagination.","schema":{"type":"integer","maximum":9007199254740991,"minimum":0},"example":1},{"in":"query","name":"page","description":"Page number of paginated response. Limit/Offset pagination wins over page/page_size pagination.","schema":{"type":"integer","maximum":9007199254740991,"minimum":1},"example":1},{"in":"query","name":"page_size","description":"Page size of paginated response. Limit/Offset pagination wins over page/page_size pagination.","schema":{"type":"integer","maximum":9007199254740991,"minimum":1},"example":25},{"in":"query","name":"sort","description":"Sorting used for response.","schema":{"type":"string"},"example":"-synopsis"},{"in":"query","name":"cvss_from","description":"Filter based on cvss score, starting from the value. Use -1 to include also CVEs with N/A cvss score.","schema":{"type":"number"},"example":4.6},{"in":"query","name":"cvss_to","description":"Filter based on cvss score, up to the value.","schema":{"type":"number"},"example":7.2},{"in":"query","name":"public_from","description":"Filter CVEs based on their published date, starting from the date.","schema":{"type":"string"},"example":"2017-09-18T00:00:00+00:00"},{"in":"query","name":"public_to","description":"Filter CVEs based on their published date, up to the date.","schema":{"type":"string"},"example":"2017-09-18T00:00:00+00:00"},{"in":"query","name":"impact","description":"Filter based on impact IDs.","schema":{"type":"string"},"example":"5,7"},{"in":"query","name":"status_id","description":"Filer based on CVE status ID.","schema":{"type":"string","example":"1,4"}},{"in":"query","name":"data_format","description":"Format of the output data, either JSON (default) or CSV.","schema":{"type":"string","example":"json"}},{"in":"query","name":"business_risk_id","description":"Filter based on business risk IDs.","schema":{"type":"string","example":"1,3"}},{"in":"query","name":"rule_presence","description":"Comma seprated string with bools. If true shows only CVEs with security rule associated, if false shows CVEs without rules. true, false shows all.","schema":{"type":"array","items":{"type":"boolean"},"maxItems":2},"example":"true,false"},{"in":"query","name":"show_advisories","description":"If true shows advisories list","schema":{"type":"boolean"},"example":false},{"in":"query","name":"advisory","description":"Filter by advisory name, works only with show_advisories=true","schema":{"type":"string"},"example":"RHSA-2019:1481"},{"in":"query","name":"rule_key","description":"Filters security rules by its error key.","schema":{"type":"array","items":{"type":"string"}},"example":"CVE_2018_3639_cpu_kernel|CVE_2018_3639_CPU_BAD_MICROCODE_2,CVE_2018_12207_cpu_kernel|CVE_2018_12207_CPU_KERNEL_FOR_SURE"},{"in":"query","name":"known_exploit","description":"String of booleans (array of booleans), where true shows CVEs with known exploits, false shows CVEs without known exploits.","schema":{"type":"array","items":{"type":"boolean"},"maxItems":2},"example":"true,false"},{"in":"query","name":"first_reported_from","description":"Filter for CVEs/Systems where the vulnerability appeared after given date.","required":false,"schema":{"type":"string","description":"Datetime string"},"example":"2017-09-18T00:00:00+00:00"},{"in":"query","name":"first_reported_to","description":"Filter for CVEs/Systems where the vulnerability appeared before given date.","required":false,"schema":{"type":"string","description":"Datetime string"},"example":"2017-09-18T00:00:00+00:00"},{"in":"query","name":"advisory_available","description":"String of booleans (array of booleans), where true shows CVE-system pairs with available advisory, false shows CVE-system pairs without available advisory.","schema":{"type":"array","items":{"type":"boolean"},"maxItems":2},"example":"true,false"},{"in":"query","name":"remediation","description":"Filer based on available remediation type id.","schema":{"type":"string","example":1}},{"in":"query","name":"tags","description":"Filter based on hosts tags. Tags needs to be in query format, that means /= or / if value is null. Characters '/', '=' in tag values needs to be escaped by url encoding.","schema":{"type":"array","items":{"type":"string","pattern":"^([^=/]+\\/){1}([^=/])+(=[^=/]+)?$"}},"example":"vulnerability/usage=server"}]}},"/systems/opt_out":{"patch":{"summary":"Opt a system in or out of the vulnerability service","description":"Opt a specific system in or out of vulnerability analysis. Use this when you want to use other Insights services but do not want to see specific systems in vulnerability reports. This allows you to hide select systems.\n","operationId":"setSystemsOptOut","x-methodName":"setSystemsOptOut","security":[{"ApiKeyAuth":[]},{"BasicAuth":[]}],"requestBody":{"description":"Values to be set.","required":true,"content":{"application/vnd.api+json":{"schema":{"x-body-name":"data","type":"object","properties":{"inventory_id":{"oneOf":[{"type":"string","description":"Inventory ID.","example":"f35b1e1d-d231-43f2-8e4f-8f9cb01e3aa2"},{"type":"array","items":{"type":"string","example":"f35b1e1d-d231-43f2-8e4f-8f9cb01e3aa2"},"description":"List of inventory IDs for a bulk change."}],"example":"f35b1e1d-d231-43f2-8e4f-8f9cb01e3aa2"},"opt_out":{"type":"boolean","description":"Opt out setting to be set.","example":true}},"required":["inventory_id","opt_out"]}}}},"responses":{"200":{"description":"System(s) setting has been updated.","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"updated":{"type":"array","items":{"type":"string","example":"f35b1e1d-d231-43f2-8e4f-8f9cb01e3aa2"},"description":"List of updated objects/updated object IDs."},"meta":{"type":"object","properties":{"permissions":{"type":"array","description":"Fetched permissions from RBAC for given user","nullable":false,"items":{"type":"string","example":"vulnerability:vulnerability_results:read"}}},"required":["permissions"]}},"required":["updated"]}}}},"503":{"description":"Service is running in read-only mode.","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"oneOf":[{"type":"string","description":"Error detail.","example":"Record not found."},{"type":"object","description":"Returned with RBAC (user permissions) related issue","properties":{"msg":{"type":"string","description":"Error detail related to RBAC problem"},"permissions":{"type":"array","items":{"type":"string"},"description":"Array with RBAC permissions of user"}}}]},"status":{"type":"string","description":"String representation of HTTP status code.","example":404}},"required":["detail","status"]},"minItems":1}},"required":["errors"]}}}}}}},"/vulnerabilities/cves":{"get":{"summary":"Get a vulnerabilities overview","description":"This provides an overview of vulnerabilities across your entire system inventory. Use this endpoint to get an overview of which CVEs are affecting your account, including some CVE metadata, how many systems are affected by each CVE, and more.\n","operationId":"getCveList","x-methodName":"getCveList","security":[{"ApiKeyAuth":[]},{"BasicAuth":[]}],"responses":{"200":{"description":"Vulnerabilities overview.","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"oneOf":[{"type":"string","description":"CSV export of the JSON."},{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"CVE id.","example":"CVE-2016-0800"},"type":{"type":"string","description":"Type of the record.","example":"cve"},"attributes":{"type":"object","properties":{"business_risk":{"type":"string","description":"Business risk of the vulnerability.","example":"Low"},"business_risk_id":{"type":"integer","description":"Internal ID of the vulnerability business risk.","example":1},"business_risk_text":{"type":"string","description":"Complementary text to the business risk.","example":"QA environment => Low business risk","nullable":true},"cvss2_score":{"type":"string","description":"String representation of cvss2 score of the CVE.","example":"5.800","nullable":true},"cvss3_score":{"type":"string","description":"String representation of cvss3 score of the CVE.","example":"4.400","nullable":true},"description":{"type":"string","description":"Description of the CVE.","example":"A padding oracle flaw was found in the Secure Sockets Layer version 2.0 (SSLv2) protocol. An attacker could..."},"impact":{"type":"string","description":"Red Hat security impact of the CVE.","example":"Important"},"public_date":{"type":"string","description":"String representation of ISO-8601 formatted date of first public disclosure of the CVE.","example":"2016-03-01T00:00:00+00:00","nullable":true},"rules":{"type":"array","items":{"type":"object","properties":{"rule_id":{"type":"string","example":"CVE_2017_14491_dnsmasq|CVE_2017_14491_ERROR","description":"ID(s) of associated security rule(s)."},"description":{"type":"string","description":"Description of the rule.","example":"CVE-2017-14491 dnsmasq code execution with listening processes","nullable":true},"summary":{"type":"string","description":"Summary of the rule.","example":"A buffer overflow vulnerability was found in `Dnsmasq`, a popular lightweight DNS and DHCP server....","nullable":true},"reboot_required":{"type":"boolean","description":"Indicator whter reboot is required to mitigate vulnerability.","example":false,"nullable":true},"playbook_count":{"type":"integer","description":"Number of available Ansible playbooks for remediation/mitigation.","example":1,"nullable":true},"change_risk":{"type":"integer","description":"Indicates how likely remediation can change environment on the remediatied system.","example":1,"nullable":true},"kbase_node_id":{"type":"integer","description":"ID of associated Red Hat knowledgebase article.","example":3199382,"nullable":true},"associated_cves":{"type":"array","items":{"type":"string","example":"CVE-2016-0800"},"description":"List of CVEs associated with the rule."},"rule_impact":{"type":"integer","description":"Shows rules impact number from 1 to 4","example":1,"nullable":true},"systems_affected":{"type":"integer","description":"Number of systems affected by the rule.","example":72},"publish_date":{"type":"string","description":"Date when the rule was published.","example":"2018-05-15T13:00:00Z","nullable":true}},"required":["associated_cves","change_risk","description","kbase_node_id","playbook_count","reboot_required","rule_id","summary","rule_impact","publish_date"]}},"status":{"type":"string","description":"Status of the vulnerability.","example":"Not Reviewed"},"status_id":{"type":"integer","description":"Internal ID of the vulnerability status.","example":1},"status_text":{"type":"string","description":"Complementary text to the status.","example":"Not Relevant","nullable":true},"synopsis":{"type":"string","description":"Synopsis of the CVE.","example":"CVE-2016-0800"},"systems_affected":{"type":"integer","description":"Number of systems affected by the CVE.","example":7},"systems_status_divergent":{"type":"integer","description":"How many systems-CVE pairs have different status than CVE-level.","example":20},"known_exploit":{"type":"boolean","description":"Shows whether a CVE has known exploits or not","example":true},"advisory_available":{"type":"boolean","description":"Shows whether a CVE has available advisory or not","example":true},"rhel_versions":{"type":"array","items":{"type":"string","description":"Applicable RHEL version across your entire system inventory.","example":"9.4"}}},"required":["business_risk","business_risk_id","business_risk_text","cvss2_score","cvss3_score","description","impact","public_date","rules","status","status_id","status_text","synopsis","systems_affected","systems_status_divergent","known_exploit","advisory_available","rhel_versions"]}},"required":["id","type","attributes"]}}]},"links":{"type":"object","properties":{"first":{"type":"string","description":"Link to first page.","example":"/api?offset=0&limit=1"},"last":{"type":"string","description":"Link to last page.","example":"/api?offset=7&limit=1"},"next":{"type":"string","description":"Link to next page.","example":"/api?offset=5&limit=1","nullable":true},"previous":{"type":"string","description":"Link to next page.","example":"/api?offset=3&limit=1","nullable":true}},"required":["first","last","next","previous"]},"meta":{"allOf":[{"type":"object","properties":{"filter":{"type":"string","description":"Full text filter","example":"CVE-2016-0800","nullable":true},"limit":{"type":"integer","description":"Maximum number of paginated results.","example":25},"offset":{"type":"integer","description":"First record of paginated response.","example":0},"page":{"type":"integer","description":"Page number of paginated response.","example":1},"page_size":{"type":"integer","description":"Number of records per page of paginated response.","example":25},"pages":{"type":"integer","description":"Total number of pages of paginated response.","example":1},"sort":{"type":"string","description":"Sorting filter.","example":"-inventory_id","nullable":true},"total_items":{"type":"integer","description":"Total number of records.","example":37},"data_format":{"type":"string","description":"Format of the output data, either JSON (default) or CSV.","example":"JSON"}},"required":["filter","limit","offset","page","page_size","pages","sort","total_items","data_format"]},{"type":"object","properties":{"permissions":{"type":"array","description":"Fetched permissions from RBAC for given user","nullable":false,"items":{"type":"string","example":"vulnerability:vulnerability_results:read"}}},"required":["permissions"]},{"type":"object","properties":{"affecting":{"type":"string","description":"Description of CVE showing preferences","example":"True,False","nullable":true},"business_risk_id":{"type":"string","description":"Filter based on business risk IDs.","example":"1,3","nullable":true},"cvss_from":{"type":"number","description":"Filter based on cvss score, starting from the value. Use -1 to include also CVEs with N/A cvss score.","example":4.6,"nullable":true},"cvss_to":{"type":"number","description":"Filter based on cvss score, up to the value.","example":7.2,"nullable":true},"public_from":{"type":"string","description":"Filter CVEs based on their published date, starting from the date.","example":"2017-09-18T00:00:00+00:00","nullable":true},"public_to":{"type":"string","description":"Filter CVEs based on their published date, up to the date.","example":"2017-09-18T00:00:00+00:00","nullable":true},"impact":{"type":"string","description":"Filter based on impact IDs.","example":"5,7","nullable":true},"system_count_per_type":{"type":"object","description":"Number of systems managed by vulnerability application, grouped by host type.","properties":{"rpmdnf":{"type":"number","description":"Number of conventional systems.","example":26},"image":{"type":"number","description":"Number of image-mode systems.","example":3,"nullable":true},"edge":{"type":"number","description":"Number of image-mode systems. (Deprecated)","example":3,"nullable":true}}},"system_count":{"type":"integer","description":"Total number of systems managed by vulnerability application.","example":25641},"rhel_version":{"type":"string","description":"Filter base on system RHEL version.","example":"8.2","nullable":true},"rule_presence":{"type":"string","description":"Filter based on presence of security rule","example":"true,false","nullable":true},"cves_without_errata":{"type":"boolean","description":"CVEs without Errata feature flag","nullable":true},"advisory_available":{"type":"string","description":"Shows whether a CVE has available advisory or not","example":"true,false","nullable":true},"cache_used":{"type":"boolean","description":"Flag if cached data was used to produce the response.","example":false}},"required":["affecting","business_risk_id","cvss_from","cvss_to","public_from","public_to","impact","rhel_version","rule_presence","cves_without_errata","advisory_available","cache_used"]}]}},"required":["data","links","meta"]}}}}},"parameters":[{"in":"query","name":"filter","description":"Full text filter for CVE and it's description text.","schema":{"type":"string"},"example":"CVE-2017"},{"in":"query","name":"limit","description":"Maximum number of records per page. Limit/Offset pagination wins over page/page_size pagination.","schema":{"type":"integer","maximum":9007199254740991,"minimum":1},"example":25},{"in":"query","name":"offset","description":"Offset of first record of paginated response. Limit/Offset pagination wins over page/page_size pagination.","schema":{"type":"integer","maximum":9007199254740991,"minimum":0},"example":1},{"in":"query","name":"page","description":"Page number of paginated response. Limit/Offset pagination wins over page/page_size pagination.","schema":{"type":"integer","maximum":9007199254740991,"minimum":1},"example":1},{"in":"query","name":"page_size","description":"Page size of paginated response. Limit/Offset pagination wins over page/page_size pagination.","schema":{"type":"integer","maximum":9007199254740991,"minimum":1},"example":25},{"in":"query","name":"sort","description":"Sorting used for response.","schema":{"type":"string"},"example":"-synopsis"},{"in":"query","name":"cvss_from","description":"Filter based on cvss score, starting from the value. Use -1 to include also CVEs with N/A cvss score.","schema":{"type":"number"},"example":4.6},{"in":"query","name":"cvss_to","description":"Filter based on cvss score, up to the value.","schema":{"type":"number"},"example":7.2},{"in":"query","name":"public_from","description":"Filter CVEs based on their published date, starting from the date.","schema":{"type":"string"},"example":"2017-09-18T00:00:00+00:00"},{"in":"query","name":"public_to","description":"Filter CVEs based on their published date, up to the date.","schema":{"type":"string"},"example":"2017-09-18T00:00:00+00:00"},{"in":"query","name":"impact","description":"Filter based on impact IDs.","schema":{"type":"string"},"example":"5,7"},{"in":"query","name":"data_format","description":"Format of the output data, either JSON (default) or CSV.","schema":{"type":"string","example":"json"}},{"in":"query","name":"business_risk_id","description":"Filter based on business risk IDs.","schema":{"type":"string","example":"1,3"}},{"in":"query","name":"status_id","description":"Filer based on CVE status ID.","schema":{"type":"string","example":"1,4"}},{"in":"query","name":"rule_presence","description":"Comma seprated string with bools. If true shows only CVEs with security rule associated, if false shows CVEs without rules. true, false shows all.","schema":{"type":"array","items":{"type":"boolean"},"maxItems":2},"example":"true,false"},{"in":"query","name":"tags","description":"Filter based on hosts tags. Tags needs to be in query format, that means /= or / if value is null. Characters '/', '=' in tag values needs to be escaped by url encoding.","schema":{"type":"array","items":{"type":"string","pattern":"^([^=/]+\\/){1}([^=/])+(=[^=/]+)?$"}},"example":"vulnerability/usage=server"},{"in":"query","name":"sap_sids","description":"List of SAP IDs to filter with","schema":{"type":"array","items":{"type":"string"}},"example":"ABC,CDE"},{"in":"query","name":"sap_system","description":"Boolean value which shows systems managed by SAP.","schema":{"type":"boolean"},"example":false},{"in":"query","name":"known_exploit","description":"String of booleans (array of booleans), where true shows CVEs with known exploits, false shows CVEs without known exploits.","schema":{"type":"array","items":{"type":"boolean"},"maxItems":2},"example":"true,false"},{"in":"query","name":"affecting","description":"Comma seprated string with bools (array of bools). True value controls displaying CVEs with at least one system affected. False value toggles CVEs with no systems affected. Defaults to showing only CVEs with at least one system affected.","schema":{"type":"array","items":{"type":"boolean"},"maxItems":2},"example":"true,false"},{"in":"query","name":"rhel_version","description":"Filters results by RHEL OS version. Automatically flters out systems which are not RHEL or have uknown OS.","required":false,"schema":{"type":"string","description":"List of RHEL versions. E.g. 7,8.1 will filter out everything which is not RHEL 7.x or RHEL 8.1"}},{"in":"query","name":"report","description":"Needs to be used when endpoint data is used for report generation, checks RBAC permission for report and export feature.","required":false,"schema":{"type":"boolean"},"example":false},{"in":"query","name":"advanced_report","description":"Needs to be used when endpoint data is used for Report by CVEs feature, checks RBAC permission for advanced report.","schema":{"type":"boolean"},"example":false},{"in":"query","name":"ansible","description":"Boolean value which shows systems managed by Ansible Automation Platform.","schema":{"type":"boolean"},"example":false},{"in":"query","name":"mssql","description":"Boolean value which shows systems managed by MSSQL.","schema":{"type":"boolean"},"example":false},{"in":"query","name":"advisory_available","description":"String of booleans (array of booleans), where true shows CVE-system pairs with available advisory, false shows CVE-system pairs without available advisory.","schema":{"type":"array","items":{"type":"boolean"},"maxItems":2},"example":"true,false"},{"in":"query","name":"group_names","description":"Names of the inventory groups.","schema":{"type":"array","items":{"type":"string"}},"example":"Production,Stage"},{"in":"query","name":"group_ids","description":"IDs of the inventory groups.","schema":{"type":"array","items":{"type":"string"}},"example":"00000000-1111-0000-0000-000000000000,00000000-2222-0000-0000-000000000000"},{"in":"query","name":"affecting_host_type","description":"Controls, whenever CVE has 1 or more affecting systems. Value \"image\" returns CVEs with one or more vulnerable image-mode systems, value \"rpmdnf\" returns CVEs with one or more vulnerable conventional systems. Value \"none\" returns CVEs not affecting systems of any kind.","schema":{"type":"array","items":{"type":"string","enum":["rpmdnf","image","edge","none"]},"maxItems":3},"example":"image,none"}]},"post":{"summary":"Send a vulnerabilities overview","description":"This is an overview of vulnerabilities for specific CVEs provided in the body. Use this endpoint to get a CVSS score, and learn the severity for a list of CVEs provided in the request.\n","operationId":"getCveList","x-methodName":"getCveList","security":[{"ApiKeyAuth":[]},{"BasicAuth":[]}],"requestBody":{"description":"List of CVEs to provide info about.","required":true,"content":{"application/vnd.api+json":{"schema":{"x-body-name":"data","type":"object","properties":{"cve_list":{"type":"array","description":"Array of CVEs to provide info about","items":{"type":"string","example":"CVE-2016-0800","description":"CVE id."}}},"required":["cve_list"]}}}},"responses":{"200":{"description":"Vulnerabilities overview.","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"CVE id.","example":"CVE-2016-0800"},"type":{"type":"string","description":"Type of the record.","example":"cve"},"attributes":{"type":"object","properties":{"cvss_score":{"type":"string","description":"String representation of cvss3 or cvvs2 (if v3 is not present) score of the CVE.","example":"5.800","nullable":true},"impact":{"type":"string","description":"Red Hat security impact of the CVE.","example":"Important"},"synopsis":{"type":"string","description":"Synopsis of the CVE.","example":"CVE-2016-0800"}},"required":["cvss_score","impact","synopsis"]}},"required":["id","type","attributes"]}},"links":{"type":"object","properties":{"first":{"type":"string","description":"Link to first page.","example":"/api?offset=0&limit=1"},"last":{"type":"string","description":"Link to last page.","example":"/api?offset=7&limit=1"},"next":{"type":"string","description":"Link to next page.","example":"/api?offset=5&limit=1","nullable":true},"previous":{"type":"string","description":"Link to next page.","example":"/api?offset=3&limit=1","nullable":true}},"required":["first","last","next","previous"]},"meta":{"allOf":[{"type":"object","properties":{"filter":{"type":"string","description":"Full text filter","example":"CVE-2016-0800","nullable":true},"limit":{"type":"integer","description":"Maximum number of paginated results.","example":25},"offset":{"type":"integer","description":"First record of paginated response.","example":0},"page":{"type":"integer","description":"Page number of paginated response.","example":1},"page_size":{"type":"integer","description":"Number of records per page of paginated response.","example":25},"pages":{"type":"integer","description":"Total number of pages of paginated response.","example":1},"sort":{"type":"string","description":"Sorting filter.","example":"-inventory_id","nullable":true},"total_items":{"type":"integer","description":"Total number of records.","example":37},"data_format":{"type":"string","description":"Format of the output data, either JSON (default) or CSV.","example":"JSON"}},"required":["filter","limit","offset","page","page_size","pages","sort","total_items","data_format"]},{"type":"object","properties":{"permissions":{"type":"array","description":"Fetched permissions from RBAC for given user","nullable":false,"items":{"type":"string","example":"vulnerability:vulnerability_results:read"}}},"required":["permissions"]}]}},"required":["data","links","meta"]}}}}},"parameters":[{"in":"query","name":"filter","description":"Full text filter for CVE and it's description text.","schema":{"type":"string"},"example":"CVE-2017"},{"in":"query","name":"limit","description":"Maximum number of records per page. Limit/Offset pagination wins over page/page_size pagination.","schema":{"type":"integer","maximum":9007199254740991,"minimum":1},"example":25},{"in":"query","name":"offset","description":"Offset of first record of paginated response. Limit/Offset pagination wins over page/page_size pagination.","schema":{"type":"integer","maximum":9007199254740991,"minimum":0},"example":1},{"in":"query","name":"page","description":"Page number of paginated response. Limit/Offset pagination wins over page/page_size pagination.","schema":{"type":"integer","maximum":9007199254740991,"minimum":1},"example":1},{"in":"query","name":"page_size","description":"Page size of paginated response. Limit/Offset pagination wins over page/page_size pagination.","schema":{"type":"integer","maximum":9007199254740991,"minimum":1},"example":25},{"in":"query","name":"sort","description":"Sorting used for response.","schema":{"type":"string"},"example":"-inventory_id"}]}},"/vulnerabilities/cves/ids":{"get":{"summary":"Get an overview of Vulnerabilities' identification numbers","description":"This is an overview of vulnerabilities identification numbers across your entire system inventory. Use this endpoint to get an overview of which CVEs are affecting your account.\n","operationId":"getCveIdsList","x-methodName":"getCveIdsList","security":[{"ApiKeyAuth":[]},{"BasicAuth":[]}],"responses":{"200":{"description":"Vulnerabilities IDs overview.","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"oneOf":[{"type":"string","description":"CSV export of the JSON."},{"type":"array","items":{"type":"object","description":"CVE id and minimal information.","properties":{"business_risk_id":{"type":"integer","description":"Internal ID of the vulnerability business risk.","example":1},"business_risk_text":{"type":"string","description":"Complementary text to the business risk.","example":"QA environment => Low business risk","nullable":true},"id":{"type":"string","description":"CVE id.","example":"CVE-2016-0800"},"status_id":{"type":"integer","description":"Internal ID of the vulnerability status.","example":1},"status_text":{"type":"string","description":"Complementary text to the status.","example":"Not Relevant","nullable":true}}},"required":["business_risk_id","business_risk_text","id","status_id","status_text"]}]},"links":{"type":"object","properties":{"first":{"type":"string","description":"Link to first page.","example":"/api?offset=0&limit=1"},"last":{"type":"string","description":"Link to last page.","example":"/api?offset=7&limit=1"},"next":{"type":"string","description":"Link to next page.","example":"/api?offset=5&limit=1","nullable":true},"previous":{"type":"string","description":"Link to next page.","example":"/api?offset=3&limit=1","nullable":true}},"required":["first","last","next","previous"]},"meta":{"allOf":[{"type":"object","properties":{"filter":{"type":"string","description":"Full text filter","example":"CVE-2016-0800","nullable":true},"limit":{"type":"integer","description":"Maximum number of paginated results.","example":25},"offset":{"type":"integer","description":"First record of paginated response.","example":0},"page":{"type":"integer","description":"Page number of paginated response.","example":1},"page_size":{"type":"integer","description":"Number of records per page of paginated response.","example":25},"pages":{"type":"integer","description":"Total number of pages of paginated response.","example":1},"sort":{"type":"string","description":"Sorting filter.","example":"-inventory_id","nullable":true},"total_items":{"type":"integer","description":"Total number of records.","example":37},"data_format":{"type":"string","description":"Format of the output data, either JSON (default) or CSV.","example":"JSON"}},"required":["filter","limit","offset","page","page_size","pages","sort","total_items","data_format"]},{"type":"object","properties":{"permissions":{"type":"array","description":"Fetched permissions from RBAC for given user","nullable":false,"items":{"type":"string","example":"vulnerability:vulnerability_results:read"}}},"required":["permissions"]},{"type":"object","properties":{"affecting":{"type":"string","description":"Description of CVE showing preferences","example":"True,False","nullable":true},"business_risk_id":{"type":"string","description":"Filter based on business risk IDs.","example":"1,3","nullable":true},"cvss_from":{"type":"number","description":"Filter based on cvss score, starting from the value. Use -1 to include also CVEs with N/A cvss score.","example":4.6,"nullable":true},"cvss_to":{"type":"number","description":"Filter based on cvss score, up to the value.","example":7.2,"nullable":true},"public_from":{"type":"string","description":"Filter CVEs based on their published date, starting from the date.","example":"2017-09-18T00:00:00+00:00","nullable":true},"public_to":{"type":"string","description":"Filter CVEs based on their published date, up to the date.","example":"2017-09-18T00:00:00+00:00","nullable":true},"impact":{"type":"string","description":"Filter based on impact IDs.","example":"5,7","nullable":true},"system_count_per_type":{"type":"object","description":"Number of systems managed by vulnerability application, grouped by host type.","properties":{"rpmdnf":{"type":"number","description":"Number of conventional systems.","example":26},"image":{"type":"number","description":"Number of image-mode systems.","example":3,"nullable":true},"edge":{"type":"number","description":"Number of image-mode systems. (Deprecated)","example":3,"nullable":true}}},"system_count":{"type":"integer","description":"Total number of systems managed by vulnerability application.","example":25641},"rhel_version":{"type":"string","description":"Filter base on system RHEL version.","example":"8.2","nullable":true},"rule_presence":{"type":"string","description":"Filter based on presence of security rule","example":"true,false","nullable":true},"cves_without_errata":{"type":"boolean","description":"CVEs without Errata feature flag","nullable":true},"advisory_available":{"type":"string","description":"Shows whether a CVE has available advisory or not","example":"true,false","nullable":true},"cache_used":{"type":"boolean","description":"Flag if cached data was used to produce the response.","example":false}},"required":["affecting","business_risk_id","cvss_from","cvss_to","public_from","public_to","impact","rhel_version","rule_presence","cves_without_errata","advisory_available","cache_used"]}]}},"required":["data","links","meta"]}}}}},"parameters":[{"in":"query","name":"filter","description":"Full text filter for CVE and it's description text.","schema":{"type":"string"},"example":"CVE-2017"},{"in":"query","name":"limit","description":"Maximum number of records per page. Limit/Offset pagination wins over page/page_size pagination.","schema":{"type":"integer","maximum":9007199254740991,"minimum":1},"example":25},{"in":"query","name":"offset","description":"Offset of first record of paginated response. Limit/Offset pagination wins over page/page_size pagination.","schema":{"type":"integer","maximum":9007199254740991,"minimum":0},"example":1},{"in":"query","name":"page","description":"Page number of paginated response. Limit/Offset pagination wins over page/page_size pagination.","schema":{"type":"integer","maximum":9007199254740991,"minimum":1},"example":1},{"in":"query","name":"page_size","description":"Page size of paginated response. Limit/Offset pagination wins over page/page_size pagination.","schema":{"type":"integer","maximum":9007199254740991,"minimum":1},"example":25},{"in":"query","name":"sort","description":"Sorting used for response.","schema":{"type":"string"},"example":"-synopsis"},{"in":"query","name":"cvss_from","description":"Filter based on cvss score, starting from the value. Use -1 to include also CVEs with N/A cvss score.","schema":{"type":"number"},"example":4.6},{"in":"query","name":"cvss_to","description":"Filter based on cvss score, up to the value.","schema":{"type":"number"},"example":7.2},{"in":"query","name":"public_from","description":"Filter CVEs based on their published date, starting from the date.","schema":{"type":"string"},"example":"2017-09-18T00:00:00+00:00"},{"in":"query","name":"public_to","description":"Filter CVEs based on their published date, up to the date.","schema":{"type":"string"},"example":"2017-09-18T00:00:00+00:00"},{"in":"query","name":"impact","description":"Filter based on impact IDs.","schema":{"type":"string"},"example":"5,7"},{"in":"query","name":"data_format","description":"Format of the output data, either JSON (default) or CSV.","schema":{"type":"string","example":"json"}},{"in":"query","name":"business_risk_id","description":"Filter based on business risk IDs.","schema":{"type":"string","example":"1,3"}},{"in":"query","name":"status_id","description":"Filer based on CVE status ID.","schema":{"type":"string","example":"1,4"}},{"in":"query","name":"rule_presence","description":"Comma seprated string with bools. If true shows only CVEs with security rule associated, if false shows CVEs without rules. true, false shows all.","schema":{"type":"array","items":{"type":"boolean"},"maxItems":2},"example":"true,false"},{"in":"query","name":"tags","description":"Filter based on hosts tags. Tags needs to be in query format, that means /= or / if value is null. Characters '/', '=' in tag values needs to be escaped by url encoding.","schema":{"type":"array","items":{"type":"string","pattern":"^([^=/]+\\/){1}([^=/])+(=[^=/]+)?$"}},"example":"vulnerability/usage=server"},{"in":"query","name":"sap_sids","description":"List of SAP IDs to filter with","schema":{"type":"array","items":{"type":"string"}},"example":"ABC,CDE"},{"in":"query","name":"sap_system","description":"Boolean value which shows systems managed by SAP.","schema":{"type":"boolean"},"example":false},{"in":"query","name":"known_exploit","description":"String of booleans (array of booleans), where true shows CVEs with known exploits, false shows CVEs without known exploits.","schema":{"type":"array","items":{"type":"boolean"},"maxItems":2},"example":"true,false"},{"in":"query","name":"affecting","description":"Comma seprated string with bools (array of bools). True value controls displaying CVEs with at least one system affected. False value toggles CVEs with no systems affected. Defaults to showing only CVEs with at least one system affected.","schema":{"type":"array","items":{"type":"boolean"},"maxItems":2},"example":"true,false"},{"in":"query","name":"rhel_version","description":"Filters results by RHEL OS version. Automatically flters out systems which are not RHEL or have uknown OS.","required":false,"schema":{"type":"string","description":"List of RHEL versions. E.g. 7,8.1 will filter out everything which is not RHEL 7.x or RHEL 8.1"}},{"in":"query","name":"ansible","description":"Boolean value which shows systems managed by Ansible Automation Platform.","schema":{"type":"boolean"},"example":false},{"in":"query","name":"mssql","description":"Boolean value which shows systems managed by MSSQL.","schema":{"type":"boolean"},"example":false},{"in":"query","name":"advisory_available","description":"String of booleans (array of booleans), where true shows CVE-system pairs with available advisory, false shows CVE-system pairs without available advisory.","schema":{"type":"array","items":{"type":"boolean"},"maxItems":2},"example":"true,false"}]}},"/announcement":{"get":{"summary":"Announce important updates","description":"This endpoint provides vulnerability service announcements. Remain informed about important alerts for the vulnerability service. Announcements are issued by Insights Product Managers and other subject matter experts.\n","operationId":"getAnnouncement","x-methodName":"getAnnouncement","responses":{"200":{"description":"Announcement.","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Announcement message.","example":"Hello from Vulnerability team :)."},"last_updated":{"type":"string","description":"Datetime string.","example":"2004-10-19 10:23:54+02"}},"required":["message","last_updated"]}}}}}}},"/dashbar":{"get":{"summary":"Get aggregations for the dashbar","description":"These are aggregations summarizing your account such as number of unique CVEs, list of security rules, CVEs by severity and more. Use this endpoint to obtain a snapshot of all the CVES and details about their prevalence, severity and other details.\n","operationId":"getDashbar","x-methodName":"getDashbar","security":[{"ApiKeyAuth":[]},{"BasicAuth":[]}],"responses":{"200":{"description":"Dashbar aggregations.","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"exploitable_cves":{"type":"number"},"cves_with_rule":{"type":"number"},"critical_cves":{"type":"number"},"important_cves":{"type":"number"}}}}}}},"parameters":[{"in":"query","name":"tags","description":"Filter based on hosts tags. Tags needs to be in query format, that means /= or / if value is null. Characters '/', '=' in tag values needs to be escaped by url encoding.","schema":{"type":"array","items":{"type":"string","pattern":"^([^=/]+\\/){1}([^=/])+(=[^=/]+)?$"}},"example":"vulnerability/usage=server"},{"in":"query","name":"sap_sids","description":"List of SAP IDs to filter with","schema":{"type":"array","items":{"type":"string"}},"example":"ABC,CDE"},{"in":"query","name":"sap_system","description":"Boolean value which shows systems managed by SAP.","schema":{"type":"boolean"},"example":false},{"in":"query","name":"ansible","description":"Boolean value which shows systems managed by Ansible Automation Platform.","schema":{"type":"boolean"},"example":false},{"in":"query","name":"mssql","description":"Boolean value which shows systems managed by MSSQL.","schema":{"type":"boolean"},"example":false}]}},"/feature/cves_without_errata":{"get":{"summary":"Get a feature flag status for CVEs without errata","description":"Use this endpoint to get an enablement status of reporting CVEs that do not have advisories (errata) for your customer account. If the feature is disabled, CVEs without advisories will be hidden in outputs of all endpoints.\n","operationId":"getCvesWithoutErrata","x-methodName":"getCvesWithoutErrata","security":[{"ApiKeyAuth":[]},{"BasicAuth":[]}],"responses":{"200":{"description":"CVEs without Errata feature enablement status.","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"cves_without_errata":{"type":"object","properties":{"enabled":{"type":"boolean"}}}},"required":["cves_without_errata","org_id"]}}}}}},"patch":{"summary":"Set a feature flag for CVEs without errata","description":"Use this endpoint to enable/disable reporting CVEs that do not have advisories (errata) for your customer account. If the feature is disabled, CVEs without advisories will be hidden in outputs of all endpoints.\n","operationId":"setCvesWithoutErrata","x-methodName":"setCvesWithoutErrata","security":[{"ApiKeyAuth":[]},{"BasicAuth":[]}],"requestBody":{"description":"Values to be set.","required":true,"content":{"application/vnd.api+json":{"schema":{"x-body-name":"data","type":"object","properties":{"enable":{"type":"boolean","description":"Enable or disable CVEs without Errata feature.","example":true}},"required":["enable"]}}}},"responses":{"200":{"description":"CVEs without Errata feature successfully updated.","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"updated":{"type":"object","properties":{"org_id":{"type":"string"},"cves_without_errata":{"type":"object","properties":{"enabled":{"type":"boolean"}}}}},"meta":{"type":"object","properties":{"permissions":{"type":"array","description":"Fetched permissions from RBAC for given user","nullable":false,"items":{"type":"string","example":"vulnerability:vulnerability_results:read"}}},"required":["permissions"]}},"required":["updated","meta"]}}}}}}},"/notifications":{"delete":{"summary":"Delete already sent notifications for CVEs","description":"Use this endpoint for restarting your already obtained notifications for CVEs.\n","operationId":"deleteNotifications","x-methodName":"deleteNotifications","security":[{"ApiKeyAuth":[]},{"BasicAuth":[]}],"responses":{"200":{"description":"Sent notifications deleted.","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"deleted":{"type":"number","description":"Number of deleted notifications for CVEs","example":50}},"required":["deleted"]}}}},"403":{"description":"Non-existing account."}}}}},"components":{"parameters":{"filter":{"in":"query","name":"filter","description":"Full text filter for the display name of system.","schema":{"type":"string"},"example":"INV-ID-1234"},"cve_filter":{"in":"query","name":"filter","description":"Full text filter for CVE and it's description text.","schema":{"type":"string"},"example":"CVE-2017"},"limit":{"in":"query","name":"limit","description":"Maximum number of records per page. Limit/Offset pagination wins over page/page_size pagination.","schema":{"type":"integer","maximum":9007199254740991,"minimum":1},"example":25},"offset":{"in":"query","name":"offset","description":"Offset of first record of paginated response. Limit/Offset pagination wins over page/page_size pagination.","schema":{"type":"integer","maximum":9007199254740991,"minimum":0},"example":1},"page":{"in":"query","name":"page","description":"Page number of paginated response. Limit/Offset pagination wins over page/page_size pagination.","schema":{"type":"integer","maximum":9007199254740991,"minimum":1},"example":1},"page_size":{"in":"query","name":"page_size","description":"Page size of paginated response. Limit/Offset pagination wins over page/page_size pagination.","schema":{"type":"integer","maximum":9007199254740991,"minimum":1},"example":25},"sort":{"in":"query","name":"sort","description":"Sorting used for response.","schema":{"type":"string"},"example":"-inventory_id"},"cve_sort":{"in":"query","name":"sort","description":"Sorting used for response.","schema":{"type":"string"},"example":"-synopsis"},"inventory_id":{"in":"path","name":"inventory_id","description":"Inventory ID.","required":true,"schema":{"type":"string","format":"uuid"},"example":"INV-ID-0000-1234"},"cve_id":{"in":"path","name":"cve_id","description":"CVE id.","required":true,"schema":{"type":"string"},"example":"CVE-2016-0800"},"public_from":{"in":"query","name":"public_from","description":"Filter CVEs based on their published date, starting from the date.","schema":{"type":"string"},"example":"2017-09-18T00:00:00+00:00"},"public_to":{"in":"query","name":"public_to","description":"Filter CVEs based on their published date, up to the date.","schema":{"type":"string"},"example":"2017-09-18T00:00:00+00:00"},"cvss_from":{"in":"query","name":"cvss_from","description":"Filter based on cvss score, starting from the value. Use -1 to include also CVEs with N/A cvss score.","schema":{"type":"number"},"example":4.6},"cvss_to":{"in":"query","name":"cvss_to","description":"Filter based on cvss score, up to the value.","schema":{"type":"number"},"example":7.2},"impact":{"in":"query","name":"impact","description":"Filter based on impact IDs.","schema":{"type":"string"},"example":"5,7"},"status_id":{"in":"query","name":"status_id","description":"Filer based on CVE status ID.","schema":{"type":"string","example":"1,4"}},"business_risk_id":{"in":"query","name":"business_risk_id","description":"Filter based on business risk IDs.","schema":{"type":"string","example":"1,3"}},"data_format":{"in":"query","name":"data_format","description":"Format of the output data, either JSON (default) or CSV.","schema":{"type":"string","example":"json"}},"account_id":{"in":"path","name":"account_id","description":"Account ID of user.","required":true,"schema":{"type":"string"},"example":"123456"},"stale":{"in":"query","name":"stale","description":"If set to true, shows stale systems. If not set defaults to false.","schema":{"type":"boolean"}},"rule_presence":{"in":"query","name":"rule_presence","description":"Comma seprated string with bools. If true shows only CVEs with security rule associated, if false shows CVEs without rules. true, false shows all.","schema":{"type":"array","items":{"type":"boolean"},"maxItems":2},"example":"true,false"},"rule_presence_deprecated":{"in":"query","name":"rule_presence","description":"Comma seprated string with bools. If true shows only CVEs with security rule associated, if false shows CVEs without rules. true, false shows all.","schema":{"type":"array","items":{"type":"boolean"},"maxItems":2},"deprecated":true,"example":"true,false"},"rule_key":{"in":"query","name":"rule_key","description":"Filters security rules by its error key.","schema":{"type":"array","items":{"type":"string"}},"example":"CVE_2018_3639_cpu_kernel|CVE_2018_3639_CPU_BAD_MICROCODE_2,CVE_2018_12207_cpu_kernel|CVE_2018_12207_CPU_KERNEL_FOR_SURE"},"rule_key_deprecated":{"in":"query","name":"rule_key","description":"Filters security rules by its error key.","schema":{"type":"array","items":{"type":"string"}},"deprecated":true,"example":"CVE_2018_3639_cpu_kernel|CVE_2018_3639_CPU_BAD_MICROCODE_2,CVE_2018_12207_cpu_kernel|CVE_2018_12207_CPU_KERNEL_FOR_SURE"},"rule":{"in":"query","name":"rule","description":"Filters CVEs or systems by security rule, has two functionalities. If value is false, shows results without security rules, every other value is taken as rule error key.","schema":{"type":"array","items":{"type":"string","minLength":1}},"example":"CVE_2018_3639_cpu_kernel|CVE_2018_3639_CPU_BAD_MICROCODE_2,CVE_2018_12207_cpu_kernel|CVE_2018_12207_CPU_KERNEL_FOR_SURE"},"uuid":{"in":"query","name":"uuid","description":"Filter based on UUID of inventory.","schema":{"type":"string"},"example":"2ee58c62-809f-11ea-bc55-0242ac130003"},"tags":{"in":"query","name":"tags","description":"Filter based on hosts tags. Tags needs to be in query format, that means /= or / if value is null. Characters '/', '=' in tag values needs to be escaped by url encoding.","schema":{"type":"array","items":{"type":"string","pattern":"^([^=/]+\\/){1}([^=/])+(=[^=/]+)?$"}},"example":"vulnerability/usage=server"},"sap_system":{"in":"query","name":"sap_system","description":"Boolean value which shows systems managed by SAP.","schema":{"type":"boolean"},"example":false},"known_exploit":{"in":"query","name":"known_exploit","description":"String of booleans (array of booleans), where true shows CVEs with known exploits, false shows CVEs without known exploits.","schema":{"type":"array","items":{"type":"boolean"},"maxItems":2},"example":"true,false"},"sap_sids":{"in":"query","name":"sap_sids","description":"List of SAP IDs to filter with","schema":{"type":"array","items":{"type":"string"}},"example":"ABC,CDE"},"show_advisories":{"in":"query","name":"show_advisories","description":"If true shows advisories list","schema":{"type":"boolean"},"example":false},"advisory":{"in":"query","name":"advisory","description":"Filter by advisory name, works only with show_advisories=true","schema":{"type":"string"},"example":"RHSA-2019:1481"},"affecting":{"in":"query","name":"affecting","description":"Comma seprated string with bools (array of bools). True value controls displaying CVEs with at least one system affected. False value toggles CVEs with no systems affected. Defaults to showing only CVEs with at least one system affected.","schema":{"type":"array","items":{"type":"boolean"},"maxItems":2},"example":"true,false"},"affecting_host_type":{"in":"query","name":"affecting_host_type","description":"Controls, whenever CVE has 1 or more affecting systems. Value \"image\" returns CVEs with one or more vulnerable image-mode systems, value \"rpmdnf\" returns CVEs with one or more vulnerable conventional systems. Value \"none\" returns CVEs not affecting systems of any kind.","schema":{"type":"array","items":{"type":"string","enum":["rpmdnf","image","edge","none"]},"maxItems":3},"example":"image,none"},"excluded":{"in":"query","name":"excluded","description":"Comma seprated string with bools (array of bools). True boolean value displays systems which are excluded. False value displays systems excluded from vulnerability analysis. Defaults to showing only those systems which are not excluded.","schema":{"type":"array","items":{"type":"boolean"},"maxItems":2},"example":"true,false"},"rhel_version":{"in":"query","name":"rhel_version","description":"Filters results by RHEL OS version. Automatically flters out systems which are not RHEL or have uknown OS.","required":false,"schema":{"type":"string","description":"List of RHEL versions. E.g. 7,8.1 will filter out everything which is not RHEL 7.x or RHEL 8.1"}},"first_reported_from":{"in":"query","name":"first_reported_from","description":"Filter for CVEs/Systems where the vulnerability appeared after given date.","required":false,"schema":{"type":"string","description":"Datetime string"},"example":"2017-09-18T00:00:00+00:00"},"first_reported_to":{"in":"query","name":"first_reported_to","description":"Filter for CVEs/Systems where the vulnerability appeared before given date.","required":false,"schema":{"type":"string","description":"Datetime string"},"example":"2017-09-18T00:00:00+00:00"},"advisory_available":{"in":"query","name":"advisory_available","description":"String of booleans (array of booleans), where true shows CVE-system pairs with available advisory, false shows CVE-system pairs without available advisory.","schema":{"type":"array","items":{"type":"boolean"},"maxItems":2},"example":"true,false"},"remediation":{"in":"query","name":"remediation","description":"Filer based on available remediation type id.","schema":{"type":"string","example":1}},"report":{"in":"query","name":"report","description":"Needs to be used when endpoint data is used for report generation, checks RBAC permission for report and export feature.","required":false,"schema":{"type":"boolean"},"example":false},"advanced_report":{"in":"query","name":"advanced_report","description":"Needs to be used when endpoint data is used for Report by CVEs feature, checks RBAC permission for advanced report.","schema":{"type":"boolean"},"example":false},"ansible":{"in":"query","name":"ansible","description":"Boolean value which shows systems managed by Ansible Automation Platform.","schema":{"type":"boolean"},"example":false},"mssql":{"in":"query","name":"mssql","description":"Boolean value which shows systems managed by MSSQL.","schema":{"type":"boolean"},"example":false},"group_names":{"in":"query","name":"group_names","description":"Names of the inventory groups.","schema":{"type":"array","items":{"type":"string"}},"example":"Production,Stage"},"group_ids":{"in":"query","name":"group_ids","description":"IDs of the inventory groups.","schema":{"type":"array","items":{"type":"string"}},"example":"00000000-1111-0000-0000-000000000000,00000000-2222-0000-0000-000000000000"},"host_type":{"in":"query","name":"host_type","description":"For filtering out the systems based on their type. Value \"rpmdnf\" for RPMDNF systems, \"image\" for image-mode systems.","schema":{"type":"array","items":{"type":"string","enum":["rpmdnf","image","edge"]},"maxItems":2}}},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic","description":"Username and password login.","x-basicInfoFunc":"manager.base.basic_auth"},"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-rh-identity","description":"Identity header provided by 3scale (for non-prod testing only).","x-apikeyInfoFunc":"manager.base.auth"}},"schemas":{"Errors":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"oneOf":[{"type":"string","description":"Error detail.","example":"Record not found."},{"type":"object","description":"Returned with RBAC (user permissions) related issue","properties":{"msg":{"type":"string","description":"Error detail related to RBAC problem"},"permissions":{"type":"array","items":{"type":"string"},"description":"Array with RBAC permissions of user"}}}]},"status":{"type":"string","description":"String representation of HTTP status code.","example":404}},"required":["detail","status"]},"minItems":1}},"required":["errors"]},"Links":{"type":"object","properties":{"first":{"type":"string","description":"Link to first page.","example":"/api?offset=0&limit=1"},"last":{"type":"string","description":"Link to last page.","example":"/api?offset=7&limit=1"},"next":{"type":"string","description":"Link to next page.","example":"/api?offset=5&limit=1","nullable":true},"previous":{"type":"string","description":"Link to next page.","example":"/api?offset=3&limit=1","nullable":true}},"required":["first","last","next","previous"]},"Meta":{"type":"object","properties":{"filter":{"type":"string","description":"Full text filter","example":"CVE-2016-0800","nullable":true},"limit":{"type":"integer","description":"Maximum number of paginated results.","example":25},"offset":{"type":"integer","description":"First record of paginated response.","example":0},"page":{"type":"integer","description":"Page number of paginated response.","example":1},"page_size":{"type":"integer","description":"Number of records per page of paginated response.","example":25},"pages":{"type":"integer","description":"Total number of pages of paginated response.","example":1},"sort":{"type":"string","description":"Sorting filter.","example":"-inventory_id","nullable":true},"total_items":{"type":"integer","description":"Total number of records.","example":37},"data_format":{"type":"string","description":"Format of the output data, either JSON (default) or CSV.","example":"JSON"}},"required":["filter","limit","offset","page","page_size","pages","sort","total_items","data_format"]},"MetaPermissions":{"type":"object","properties":{"permissions":{"type":"array","description":"Fetched permissions from RBAC for given user","nullable":false,"items":{"type":"string","example":"vulnerability:vulnerability_results:read"}}},"required":["permissions"]},"MetaVulnerabilitiesOut":{"allOf":[{"type":"object","properties":{"filter":{"type":"string","description":"Full text filter","example":"CVE-2016-0800","nullable":true},"limit":{"type":"integer","description":"Maximum number of paginated results.","example":25},"offset":{"type":"integer","description":"First record of paginated response.","example":0},"page":{"type":"integer","description":"Page number of paginated response.","example":1},"page_size":{"type":"integer","description":"Number of records per page of paginated response.","example":25},"pages":{"type":"integer","description":"Total number of pages of paginated response.","example":1},"sort":{"type":"string","description":"Sorting filter.","example":"-inventory_id","nullable":true},"total_items":{"type":"integer","description":"Total number of records.","example":37},"data_format":{"type":"string","description":"Format of the output data, either JSON (default) or CSV.","example":"JSON"}},"required":["filter","limit","offset","page","page_size","pages","sort","total_items","data_format"]},{"type":"object","properties":{"permissions":{"type":"array","description":"Fetched permissions from RBAC for given user","nullable":false,"items":{"type":"string","example":"vulnerability:vulnerability_results:read"}}},"required":["permissions"]},{"type":"object","properties":{"affecting":{"type":"string","description":"Description of CVE showing preferences","example":"True,False","nullable":true},"business_risk_id":{"type":"string","description":"Filter based on business risk IDs.","example":"1,3","nullable":true},"cvss_from":{"type":"number","description":"Filter based on cvss score, starting from the value. Use -1 to include also CVEs with N/A cvss score.","example":4.6,"nullable":true},"cvss_to":{"type":"number","description":"Filter based on cvss score, up to the value.","example":7.2,"nullable":true},"public_from":{"type":"string","description":"Filter CVEs based on their published date, starting from the date.","example":"2017-09-18T00:00:00+00:00","nullable":true},"public_to":{"type":"string","description":"Filter CVEs based on their published date, up to the date.","example":"2017-09-18T00:00:00+00:00","nullable":true},"impact":{"type":"string","description":"Filter based on impact IDs.","example":"5,7","nullable":true},"system_count_per_type":{"type":"object","description":"Number of systems managed by vulnerability application, grouped by host type.","properties":{"rpmdnf":{"type":"number","description":"Number of conventional systems.","example":26},"image":{"type":"number","description":"Number of image-mode systems.","example":3,"nullable":true},"edge":{"type":"number","description":"Number of image-mode systems. (Deprecated)","example":3,"nullable":true}}},"system_count":{"type":"integer","description":"Total number of systems managed by vulnerability application.","example":25641},"rhel_version":{"type":"string","description":"Filter base on system RHEL version.","example":"8.2","nullable":true},"rule_presence":{"type":"string","description":"Filter based on presence of security rule","example":"true,false","nullable":true},"cves_without_errata":{"type":"boolean","description":"CVEs without Errata feature flag","nullable":true},"advisory_available":{"type":"string","description":"Shows whether a CVE has available advisory or not","example":"true,false","nullable":true},"cache_used":{"type":"boolean","description":"Flag if cached data was used to produce the response.","example":false}},"required":["affecting","business_risk_id","cvss_from","cvss_to","public_from","public_to","impact","rhel_version","rule_presence","cves_without_errata","advisory_available","cache_used"]}]},"MetaAffectedSystems":{"allOf":[{"type":"object","properties":{"filter":{"type":"string","description":"Full text filter","example":"CVE-2016-0800","nullable":true},"limit":{"type":"integer","description":"Maximum number of paginated results.","example":25},"offset":{"type":"integer","description":"First record of paginated response.","example":0},"page":{"type":"integer","description":"Page number of paginated response.","example":1},"page_size":{"type":"integer","description":"Number of records per page of paginated response.","example":25},"pages":{"type":"integer","description":"Total number of pages of paginated response.","example":1},"sort":{"type":"string","description":"Sorting filter.","example":"-inventory_id","nullable":true},"total_items":{"type":"integer","description":"Total number of records.","example":37},"data_format":{"type":"string","description":"Format of the output data, either JSON (default) or CSV.","example":"JSON"}},"required":["filter","limit","offset","page","page_size","pages","sort","total_items","data_format"]},{"type":"object","properties":{"permissions":{"type":"array","description":"Fetched permissions from RBAC for given user","nullable":false,"items":{"type":"string","example":"vulnerability:vulnerability_results:read"}}},"required":["permissions"]},{"type":"object","properties":{"status_id":{"type":"string","description":"Filer based on CVE status ID.","example":"1,4","nullable":true},"rule_key":{"type":"string","description":"Filters security rules by its error key.","example":"CVE_2018_3639_cpu_kernel|CVE_2018_3639_CPU_BAD_MICROCODE_2,CVE_2018_12207_cpu_kernel|CVE_2018_12207_CPU_KERNEL_FOR_SURE","nullable":true},"rule_presence":{"type":"string","description":"Filter based on presence of security rule","example":"true,false","nullable":true},"patch_access":{"type":"boolean","description":"If show_advisories=true shows access to patch service else null","example":true,"nullable":true},"rhel_version":{"type":"string","description":"Filter base on system RHEL version.","example":"8.2","nullable":true},"first_reported_from":{"type":"string","description":"Filter system-cve pairs based on first time of detection of CVE.","example":"2017-09-18T00:00:00+00:00","nullable":true},"first_reported_to":{"type":"string","description":"Filter system-cve pairs based on first time of detection of CVE.","example":"2017-09-18T00:00:00+00:00","nullable":true},"cves_without_errata":{"type":"boolean","description":"CVEs without Errata feature flag","nullable":true},"group_names":{"type":"string","description":"Name of the inventory group.","example":"Production,Stage","nullable":true},"group_ids":{"type":"string","description":"ID of the inventory group.","example":"00000000-1111-0000-0000-000000000000,00000000-2222-0000-0000-000000000000","nullable":true}},"required":["status_id","rule_key","rule_presence","patch_access","rhel_version","first_reported_from","first_reported_to","cves_without_errata","group_names","group_ids"]}]},"MetaSystems":{"allOf":[{"type":"object","properties":{"filter":{"type":"string","description":"Full text filter","example":"CVE-2016-0800","nullable":true},"limit":{"type":"integer","description":"Maximum number of paginated results.","example":25},"offset":{"type":"integer","description":"First record of paginated response.","example":0},"page":{"type":"integer","description":"Page number of paginated response.","example":1},"page_size":{"type":"integer","description":"Number of records per page of paginated response.","example":25},"pages":{"type":"integer","description":"Total number of pages of paginated response.","example":1},"sort":{"type":"string","description":"Sorting filter.","example":"-inventory_id","nullable":true},"total_items":{"type":"integer","description":"Total number of records.","example":37},"data_format":{"type":"string","description":"Format of the output data, either JSON (default) or CSV.","example":"JSON"}},"required":["filter","limit","offset","page","page_size","pages","sort","total_items","data_format"]},{"type":"object","properties":{"permissions":{"type":"array","description":"Fetched permissions from RBAC for given user","nullable":false,"items":{"type":"string","example":"vulnerability:vulnerability_results:read"}}},"required":["permissions"]},{"type":"object","properties":{"excluded":{"type":"string","description":"Display setting of opted out systems.","example":"true,false","nullable":true},"rhel_version":{"type":"string","description":"Filter base on system RHEL version.","example":"8.2","nullable":true}},"required":["excluded","rhel_version"]}]},"MetaCves":{"allOf":[{"type":"object","properties":{"filter":{"type":"string","description":"Full text filter","example":"CVE-2016-0800","nullable":true},"limit":{"type":"integer","description":"Maximum number of paginated results.","example":25},"offset":{"type":"integer","description":"First record of paginated response.","example":0},"page":{"type":"integer","description":"Page number of paginated response.","example":1},"page_size":{"type":"integer","description":"Number of records per page of paginated response.","example":25},"pages":{"type":"integer","description":"Total number of pages of paginated response.","example":1},"sort":{"type":"string","description":"Sorting filter.","example":"-inventory_id","nullable":true},"total_items":{"type":"integer","description":"Total number of records.","example":37},"data_format":{"type":"string","description":"Format of the output data, either JSON (default) or CSV.","example":"JSON"}},"required":["filter","limit","offset","page","page_size","pages","sort","total_items","data_format"]},{"type":"object","properties":{"permissions":{"type":"array","description":"Fetched permissions from RBAC for given user","nullable":false,"items":{"type":"string","example":"vulnerability:vulnerability_results:read"}}},"required":["permissions"]},{"type":"object","properties":{"business_risk_id":{"type":"string","description":"Filter based on business risk IDs.","example":"1,3","nullable":true},"cvss_from":{"type":"number","description":"Filter based on cvss score, starting from the value. Use -1 to include also CVEs with N/A cvss score.","example":4.6,"nullable":true},"cvss_to":{"type":"number","description":"Filter based on cvss score, up to the value.","example":7.2,"nullable":true},"public_from":{"type":"string","description":"Filter CVEs based on their published date, starting from the date.","example":"2017-09-18T00:00:00+00:00","nullable":true},"public_to":{"type":"string","description":"Filter CVEs based on their published date, up to the date.","example":"2017-09-18T00:00:00+00:00","nullable":true},"impact":{"type":"string","description":"Filter based on impact IDs.","example":"5,7","nullable":true},"status_id":{"type":"string","description":"Filer based on CVE status ID.","example":"1,4","nullable":true},"rule_presence":{"type":"string","description":"Filter based on presence of security rule","example":"true,false","nullable":true},"patch_access":{"type":"boolean","description":"If show_advisories=true shows access to patch service else null","example":true,"nullable":true},"first_reported_from":{"type":"string","description":"Filter system-cve pairs based on first time of detection of CVE.","example":"2017-09-18T00:00:00+00:00","nullable":true},"first_reported_to":{"type":"string","description":"Filter system-cve pairs based on first time of detection of CVE.","example":"2017-09-18T00:00:00+00:00","nullable":true},"cves_without_errata":{"type":"boolean","description":"CVEs without Errata feature flag","nullable":true}},"required":["business_risk_id","cvss_from","cvss_to","public_from","public_to","impact","status_id","rule_presence","patch_access","first_reported_from","first_reported_to","cves_without_errata"]}]},"MetaCvesSystems":{"allOf":[{"allOf":[{"type":"object","properties":{"filter":{"type":"string","description":"Full text filter","example":"CVE-2016-0800","nullable":true},"limit":{"type":"integer","description":"Maximum number of paginated results.","example":25},"offset":{"type":"integer","description":"First record of paginated response.","example":0},"page":{"type":"integer","description":"Page number of paginated response.","example":1},"page_size":{"type":"integer","description":"Number of records per page of paginated response.","example":25},"pages":{"type":"integer","description":"Total number of pages of paginated response.","example":1},"sort":{"type":"string","description":"Sorting filter.","example":"-inventory_id","nullable":true},"total_items":{"type":"integer","description":"Total number of records.","example":37},"data_format":{"type":"string","description":"Format of the output data, either JSON (default) or CSV.","example":"JSON"}},"required":["filter","limit","offset","page","page_size","pages","sort","total_items","data_format"]},{"type":"object","properties":{"permissions":{"type":"array","description":"Fetched permissions from RBAC for given user","nullable":false,"items":{"type":"string","example":"vulnerability:vulnerability_results:read"}}},"required":["permissions"]},{"type":"object","properties":{"business_risk_id":{"type":"string","description":"Filter based on business risk IDs.","example":"1,3","nullable":true},"cvss_from":{"type":"number","description":"Filter based on cvss score, starting from the value. Use -1 to include also CVEs with N/A cvss score.","example":4.6,"nullable":true},"cvss_to":{"type":"number","description":"Filter based on cvss score, up to the value.","example":7.2,"nullable":true},"public_from":{"type":"string","description":"Filter CVEs based on their published date, starting from the date.","example":"2017-09-18T00:00:00+00:00","nullable":true},"public_to":{"type":"string","description":"Filter CVEs based on their published date, up to the date.","example":"2017-09-18T00:00:00+00:00","nullable":true},"impact":{"type":"string","description":"Filter based on impact IDs.","example":"5,7","nullable":true},"status_id":{"type":"string","description":"Filer based on CVE status ID.","example":"1,4","nullable":true},"rule_presence":{"type":"string","description":"Filter based on presence of security rule","example":"true,false","nullable":true},"patch_access":{"type":"boolean","description":"If show_advisories=true shows access to patch service else null","example":true,"nullable":true},"first_reported_from":{"type":"string","description":"Filter system-cve pairs based on first time of detection of CVE.","example":"2017-09-18T00:00:00+00:00","nullable":true},"first_reported_to":{"type":"string","description":"Filter system-cve pairs based on first time of detection of CVE.","example":"2017-09-18T00:00:00+00:00","nullable":true},"cves_without_errata":{"type":"boolean","description":"CVEs without Errata feature flag","nullable":true}},"required":["business_risk_id","cvss_from","cvss_to","public_from","public_to","impact","status_id","rule_presence","patch_access","first_reported_from","first_reported_to","cves_without_errata"]}]},{"type":"object","properties":{"opt_out":{"type":"boolean","description":"If given system was opted out.","example":true}},"required":["opt_out"]}]},"AffectedSystemsOut":{"type":"object","properties":{"data":{"oneOf":[{"type":"string","description":"CSV export of the JSON."},{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Host id.","example":"INV-ID-0000-1234"},"type":{"type":"string","description":"Type of the record.","example":"system"},"attributes":{"type":"object","properties":{"cve_status_id":{"type":"integer","description":"Internal ID of the CVE status.","example":4},"culled_timestamp":{"type":"string","description":"Timestamp from which the host is considered deleted.","example":"2018-09-22T16:00:00+00:00","nullable":true},"display_name":{"type":"string","description":"System's name.","example":"system.example.com","nullable":true},"first_reported":{"type":"string","description":"Date of when the CVE was first reported on the system.","example":"2018-09-22T16:00:00+00:00"},"inventory_id":{"type":"string","description":"Host ID.","example":"INV-ID00-0000-1234"},"insights_id":{"type":"string","description":"Insights host ID.","example":"0035f6bc-cdb0-4763-8fcd-1dc58f716359","nullable":true},"last_evaluation":{"type":"string","description":"Date of last evaluation.","example":"2018-09-22T16:00:00+00:00","nullable":true},"os":{"type":"string","description":"Operating system.","example":"RHEL 8.4"},"reporter":{"type":"number","description":"Reporter of the vulnerability, 1 for VMaaS, 2 for security rule, 3 for both VMaaS and rule.","enum":[0,1,2,3]},"rhsm_lock":{"type":"string","description":"System is locked to following RHSM version.","example":"8.4","nullable":true},"rule":{"type":"object","description":"Details of associated security rule.","properties":{"details":{"type":"object","description":"Additional information specific to the system rule hit."},"resolution":{"type":"object","description":"Details of recommended resolution.","properties":{"resolution":{"type":"string","example":"Red Hat recommends that you update the dnsmasq package","description":"Recommended resolution of the issue.","nullable":true}},"required":["resolution"]},"rule":{"type":"object","properties":{"description":{"type":"string","example":"CVE-2017-14491 dnsmasq code execution with listening processes","description":"Description of the associated security rule.","nullable":true},"more_info":{"type":"string","example":"For more information about this specific flaw, see its ...","description":"Additional information about the issue.","nullable":true},"node_id":{"type":"integer","description":"ID of associated Red Hat knowledgebase article.","example":3199382,"nullable":true},"reason":{"type":"string","example":"This system is vulnerable because it is running a vulnerable package.","description":"Reason of why rule did hit.","nullable":true},"rule_id":{"type":"string","example":"CVE_2017_14491_dnsmasq|CVE_2017_14491_ERROR","description":"ID of associated security rule."}},"required":["description","more_info","node_id","reason","rule_id"]}},"nullable":true,"required":["details","resolution","rule"]},"rules_evaluation":{"type":"string","description":"Date of last security rules evaluation.","example":"2018-09-22T16:00:00+00:00","nullable":true},"stale_timestamp":{"type":"string","description":"Date when stale system becomes stale.","example":"2018-09-22T16:00:00+00:00","nullable":true},"stale_warning_timestamp":{"type":"string","description":"Date when stale system becomes hidden in the application.","example":"2018-09-22T16:00:00+00:00","nullable":true},"status_id":{"type":"integer","description":"Internal ID of the vulnerability status.","example":4},"status_name":{"type":"string","description":"Status of the vulnerability for the application's point of view.","example":"Resolved"},"status_text":{"type":"string","description":"Complementary text to the status.","example":"Not relevant","nullable":true},"tags":{"type":"array","items":{"type":"object","properties":{"namespace":{"type":"string","description":"Namespace of single tag.","example":"vulnerability","nullable":true},"key":{"type":"string","description":"Key of the single tag.","example":"CVE"},"value":{"type":"string","description":"Value of the single tag.","example":"CVE-2017-1","nullable":true}},"required":["namespace","key","value"]}},"advisories_list":{"type":"array","description":"List of advisories for system","items":{"type":"string","description":"Advisory id","example":"RHSA-2019:1481"}},"updated":{"type":"string","description":"Date of the lastest upload of archive taken from Inventory syndicated data.","example":"2018-09-22T16:00:00+00:00","nullable":true},"last_upload":{"type":"string","description":"Date of the latest upload of archive.","example":"2018-09-22T16:00:00+00:00"},"advisory_available":{"type":"boolean","description":"Shows whether a CVE has available advisory or not","example":true},"remediation":{"type":"number","description":"Type of available remediation, 0 for none, 1 for manual, 2 for playbook.","enum":[0,1,2]},"mitigation_reason":{"type":"string","description":"Reason why the system is not vulnerable.","example":"SELinux mitigates the issue","nullable":true},"inventory_group":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"ID of inventory group.","example":"00000000-1111-0000-0000-000000000000"},"name":{"type":"string","description":"Name of inventory group.","example":"group01"}},"required":["id","name"]}},"host_type":{"type":"string","description":"Type of the host","enum":["rpmdnf","image"]}},"required":["cve_status_id","culled_timestamp","display_name","first_reported","inventory_id","insights_id","last_evaluation","os","reporter","rhsm_lock","rule","rules_evaluation","stale_timestamp","stale_warning_timestamp","status_id","status_name","status_text","tags","updated","advisory_available","remediation","mitigation_reason","inventory_group","host_type"]}},"required":["id","type","attributes"]}}]},"links":{"type":"object","properties":{"first":{"type":"string","description":"Link to first page.","example":"/api?offset=0&limit=1"},"last":{"type":"string","description":"Link to last page.","example":"/api?offset=7&limit=1"},"next":{"type":"string","description":"Link to next page.","example":"/api?offset=5&limit=1","nullable":true},"previous":{"type":"string","description":"Link to next page.","example":"/api?offset=3&limit=1","nullable":true}},"required":["first","last","next","previous"]},"meta":{"allOf":[{"type":"object","properties":{"filter":{"type":"string","description":"Full text filter","example":"CVE-2016-0800","nullable":true},"limit":{"type":"integer","description":"Maximum number of paginated results.","example":25},"offset":{"type":"integer","description":"First record of paginated response.","example":0},"page":{"type":"integer","description":"Page number of paginated response.","example":1},"page_size":{"type":"integer","description":"Number of records per page of paginated response.","example":25},"pages":{"type":"integer","description":"Total number of pages of paginated response.","example":1},"sort":{"type":"string","description":"Sorting filter.","example":"-inventory_id","nullable":true},"total_items":{"type":"integer","description":"Total number of records.","example":37},"data_format":{"type":"string","description":"Format of the output data, either JSON (default) or CSV.","example":"JSON"}},"required":["filter","limit","offset","page","page_size","pages","sort","total_items","data_format"]},{"type":"object","properties":{"permissions":{"type":"array","description":"Fetched permissions from RBAC for given user","nullable":false,"items":{"type":"string","example":"vulnerability:vulnerability_results:read"}}},"required":["permissions"]},{"type":"object","properties":{"status_id":{"type":"string","description":"Filer based on CVE status ID.","example":"1,4","nullable":true},"rule_key":{"type":"string","description":"Filters security rules by its error key.","example":"CVE_2018_3639_cpu_kernel|CVE_2018_3639_CPU_BAD_MICROCODE_2,CVE_2018_12207_cpu_kernel|CVE_2018_12207_CPU_KERNEL_FOR_SURE","nullable":true},"rule_presence":{"type":"string","description":"Filter based on presence of security rule","example":"true,false","nullable":true},"patch_access":{"type":"boolean","description":"If show_advisories=true shows access to patch service else null","example":true,"nullable":true},"rhel_version":{"type":"string","description":"Filter base on system RHEL version.","example":"8.2","nullable":true},"first_reported_from":{"type":"string","description":"Filter system-cve pairs based on first time of detection of CVE.","example":"2017-09-18T00:00:00+00:00","nullable":true},"first_reported_to":{"type":"string","description":"Filter system-cve pairs based on first time of detection of CVE.","example":"2017-09-18T00:00:00+00:00","nullable":true},"cves_without_errata":{"type":"boolean","description":"CVEs without Errata feature flag","nullable":true},"group_names":{"type":"string","description":"Name of the inventory group.","example":"Production,Stage","nullable":true},"group_ids":{"type":"string","description":"ID of the inventory group.","example":"00000000-1111-0000-0000-000000000000,00000000-2222-0000-0000-000000000000","nullable":true}},"required":["status_id","rule_key","rule_presence","patch_access","rhel_version","first_reported_from","first_reported_to","cves_without_errata","group_names","group_ids"]}]}},"required":["data","links","meta"]},"AffectedSystemsIdsOut":{"type":"object","properties":{"data":{"oneOf":[{"type":"string","description":"CSV export of the JSON."},{"type":"array","items":{"type":"object","description":"Smallest dataset for frontend to work.","properties":{"inventory_id":{"type":"string","description":"Host ID.","example":"INV-ID00-0000-1234"},"rule_id":{"type":"string","example":"CVE_2017_14491_dnsmasq|CVE_2017_14491_ERROR","description":"ID of associated security rule.","nullable":true},"status_id":{"type":"integer","description":"Internal ID of the vulnerability status.","example":4},"status_text":{"type":"string","description":"Complementary text to the status.","example":"Not relevant","nullable":true},"display_name":{"type":"string","description":"System's name.","example":"system.example.com"},"mitigation_reason":{"type":"string","description":"Reason why the system is not vulnerable.","example":"SELinux mitigates the issue","nullable":true},"remediation":{"type":"number","description":"Type of available remediation, 0 for none, 1 for manual, 2 for playbook.","enum":[0,1,2]}},"required":["inventory_id","rule_id","status_id","status_text","display_name","remediation"]}}]},"links":{"type":"object","properties":{"first":{"type":"string","description":"Link to first page.","example":"/api?offset=0&limit=1"},"last":{"type":"string","description":"Link to last page.","example":"/api?offset=7&limit=1"},"next":{"type":"string","description":"Link to next page.","example":"/api?offset=5&limit=1","nullable":true},"previous":{"type":"string","description":"Link to next page.","example":"/api?offset=3&limit=1","nullable":true}},"required":["first","last","next","previous"]},"meta":{"allOf":[{"type":"object","properties":{"filter":{"type":"string","description":"Full text filter","example":"CVE-2016-0800","nullable":true},"limit":{"type":"integer","description":"Maximum number of paginated results.","example":25},"offset":{"type":"integer","description":"First record of paginated response.","example":0},"page":{"type":"integer","description":"Page number of paginated response.","example":1},"page_size":{"type":"integer","description":"Number of records per page of paginated response.","example":25},"pages":{"type":"integer","description":"Total number of pages of paginated response.","example":1},"sort":{"type":"string","description":"Sorting filter.","example":"-inventory_id","nullable":true},"total_items":{"type":"integer","description":"Total number of records.","example":37},"data_format":{"type":"string","description":"Format of the output data, either JSON (default) or CSV.","example":"JSON"}},"required":["filter","limit","offset","page","page_size","pages","sort","total_items","data_format"]},{"type":"object","properties":{"permissions":{"type":"array","description":"Fetched permissions from RBAC for given user","nullable":false,"items":{"type":"string","example":"vulnerability:vulnerability_results:read"}}},"required":["permissions"]},{"type":"object","properties":{"status_id":{"type":"string","description":"Filer based on CVE status ID.","example":"1,4","nullable":true},"rule_key":{"type":"string","description":"Filters security rules by its error key.","example":"CVE_2018_3639_cpu_kernel|CVE_2018_3639_CPU_BAD_MICROCODE_2,CVE_2018_12207_cpu_kernel|CVE_2018_12207_CPU_KERNEL_FOR_SURE","nullable":true},"rule_presence":{"type":"string","description":"Filter based on presence of security rule","example":"true,false","nullable":true},"patch_access":{"type":"boolean","description":"If show_advisories=true shows access to patch service else null","example":true,"nullable":true},"rhel_version":{"type":"string","description":"Filter base on system RHEL version.","example":"8.2","nullable":true},"first_reported_from":{"type":"string","description":"Filter system-cve pairs based on first time of detection of CVE.","example":"2017-09-18T00:00:00+00:00","nullable":true},"first_reported_to":{"type":"string","description":"Filter system-cve pairs based on first time of detection of CVE.","example":"2017-09-18T00:00:00+00:00","nullable":true},"cves_without_errata":{"type":"boolean","description":"CVEs without Errata feature flag","nullable":true},"group_names":{"type":"string","description":"Name of the inventory group.","example":"Production,Stage","nullable":true},"group_ids":{"type":"string","description":"ID of the inventory group.","example":"00000000-1111-0000-0000-000000000000,00000000-2222-0000-0000-000000000000","nullable":true}},"required":["status_id","rule_key","rule_presence","patch_access","rhel_version","first_reported_from","first_reported_to","cves_without_errata","group_names","group_ids"]}]}},"required":["data","links","meta"]},"BusinessRiskListOut":{"type":"object","properties":{"data":{"type":"array","description":"List of available business risk/business_risk_id pairs.","items":{"type":"object","properties":{"id":{"type":"integer","description":"Internal business_risk_id.","example":3},"name":{"type":"string","description":"Represenation of internal business_risk_id.","example":"Low"}},"required":["id","name"]}},"meta":{"type":"object","properties":{"total_items":{"type":"integer","description":"Total number of available business risk/business_risk_id pairs.","example":1}},"required":["total_items"]}},"required":["data","meta"]},"CveDetailOut":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","description":"CVE id.","example":"CVE-2016-0800"},"type":{"type":"string","description":"Type of the record.","example":"cve"},"attributes":{"type":"object","properties":{"business_risk":{"type":"string","description":"Business risk of the vulnerability.","example":"Low"},"business_risk_id":{"type":"integer","description":"Internal ID of the vulnerability business risk.","example":1},"business_risk_text":{"type":"string","description":"Complementary text to the business risk.","example":"QA environment => Low business risk","nullable":true},"celebrity_name":{"type":"string","description":"\"Celebrity\" name of the CVE.","example":"Spectre/Meltdown","nullable":true},"cvss2_metrics":{"type":"string","description":"cvss2 metrics of the CVE.","example":"AV:N/AC:M/Au:N/C:P/I:P/A:N","nullable":true},"cvss2_score":{"type":"string","description":"String representation of cvss2 score of the CVE.","example":"5.800","nullable":true},"cvss3_metrics":{"type":"string","description":"cvss3 metrics of the CVE.","example":"AV:N/AC:M/Au:N/C:P/I:P/A:N","nullable":true},"cvss3_score":{"type":"string","description":"String representation of cvss3 score of the CVE.","example":"4.400","nullable":true},"description":{"type":"string","description":"Description of the CVE.","example":"A padding oracle flaw was found in the Secure Sockets Layer version 2.0 (SSLv2) protocol. An attacker could..."},"modified_date":{"type":"string","description":"String representation of ISO-8601 formatted date of last modification of the CVE.","example":"2019-03-07T08:15:36+00:00","nullable":true},"impact":{"type":"string","description":"Red Hat security impact of the CVE.","example":"Important"},"public_date":{"type":"string","description":"String representation of ISO-8601 formatted date of first public disclosure of the CVE.","example":"2016-03-01T00:00:00+00:00","nullable":true},"redhat_url":{"type":"string","description":"Additional resource about the CVE, provided by Red Hat.","example":"https://access.redhat.com/security/cve/cve-2016-0800","nullable":true},"rules":{"type":"array","items":{"type":"object","properties":{"rule_id":{"type":"string","example":"CVE_2017_14491_dnsmasq|CVE_2017_14491_ERROR","description":"ID(s) of associated security rule(s)."},"description":{"type":"string","description":"Description of the rule.","example":"CVE-2017-14491 dnsmasq code execution with listening processes","nullable":true},"summary":{"type":"string","description":"Summary of the rule.","example":"A buffer overflow vulnerability was found in `Dnsmasq`, a popular lightweight DNS and DHCP server....","nullable":true},"reboot_required":{"type":"boolean","description":"Indicator whter reboot is required to mitigate vulnerability.","example":false,"nullable":true},"playbook_count":{"type":"integer","description":"Number of available Ansible playbooks for remediation/mitigation.","example":1,"nullable":true},"change_risk":{"type":"integer","description":"Indicates how likely remediation can change environment on the remediatied system.","example":1,"nullable":true},"kbase_node_id":{"type":"integer","description":"ID of associated Red Hat knowledgebase article.","example":3199382,"nullable":true},"associated_cves":{"type":"array","items":{"type":"string","example":"CVE-2016-0800"},"description":"List of CVEs associated with the rule."},"rule_impact":{"type":"integer","description":"Shows rules impact number from 1 to 4","example":1,"nullable":true},"systems_affected":{"type":"integer","description":"Number of systems affected by the rule.","example":72},"publish_date":{"type":"string","description":"Date when the rule was published.","example":"2018-05-15T13:00:00Z","nullable":true}},"required":["associated_cves","change_risk","description","kbase_node_id","playbook_count","reboot_required","rule_id","summary","rule_impact","publish_date"]}},"secondary_url":{"type":"string","description":"Additional resources about the CVE.","example":"https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2016-0800","nullable":true},"status":{"type":"string","description":"Status of the vulnerability.","example":"Not Reviewed"},"status_id":{"type":"integer","description":"Internal ID of the vulnerability status.","example":1},"status_text":{"type":"string","description":"Complementary text to the status.","example":"Not relevant","nullable":true},"synopsis":{"type":"string","description":"Synopsis of the CVE.","example":"CVE-2016-0800"},"systems_status_detail":{"type":"object","description":"Counts of systems with given status type."},"systems_status_divergent":{"type":"integer","description":"How many systems-CVE pairs have different status than CVE-level.","example":20},"advisories_list":{"type":"array","description":"List of advisory names or detailed advisory information","nullable":true,"items":{"type":"string","example":"RHSA-2015:0809"}},"known_exploit":{"type":"boolean","description":"Shows whether a CVE has known exploits or not","example":true},"affected_but_not_vulnerable":{"type":"integer","nullable":true,"description":"Number of systems that are affected by given CVE but are not vulnerable.","example":0},"affected_systems":{"type":"integer","nullable":true,"description":"Number of systems that are overall affected by given CVE","example":52}},"required":["business_risk","business_risk_id","business_risk_text","celebrity_name","cvss2_metrics","cvss2_score","cvss3_metrics","cvss3_score","description","impact","modified_date","public_date","redhat_url","rules","secondary_url","status","status_id","status_text","synopsis","systems_status_detail","systems_status_divergent","advisories_list","known_exploit","affected_but_not_vulnerable"]}},"required":["id","type","attributes"]},"meta":{"type":"object","properties":{"permissions":{"type":"array","description":"Fetched permissions from RBAC for given user","nullable":false,"items":{"type":"string","example":"vulnerability:vulnerability_results:read"}}},"required":["permissions"]}}},"CveRiskIn":{"type":"object","properties":{"cve":{"oneOf":[{"type":"string","description":"CVE name.","example":"CVE-2016-0800"},{"type":"array","items":{"type":"string","example":"CVE-2016-0800"},"description":"List of CVEs for a bulk change."}],"example":"CVE-2016-0800"},"business_risk_id":{"type":"integer","description":"Business risk ID to be set, obtained by GET method.","example":3},"business_risk_text":{"type":"string","description":"Complementary text to the business risk.","example":"Not relevant","nullable":true}},"required":["cve"]},"CveStatusIn":{"type":"object","properties":{"cve":{"oneOf":[{"type":"string","description":"CVE name.","example":"CVE-2016-0800"},{"type":"array","items":{"type":"string","example":"CVE-2016-0800"},"description":"List of CVEs for a bulk change."}],"example":"CVE-2016-0800"},"status_id":{"type":"integer","description":"Status ID to be set, obtained by GET method.","example":3},"status_text":{"type":"string","description":"Complementary text to the status.","example":"Not relevant","nullable":true}},"required":["cve"]},"CveOrList":{"oneOf":[{"type":"string","description":"CVE name.","example":"CVE-2016-0800"},{"type":"array","items":{"type":"string","example":"CVE-2016-0800"},"description":"List of CVEs for a bulk change."}],"example":"CVE-2016-0800"},"InventoryIdOrList":{"oneOf":[{"type":"string","description":"Inventory ID.","example":"f35b1e1d-d231-43f2-8e4f-8f9cb01e3aa2"},{"type":"array","items":{"type":"string","example":"f35b1e1d-d231-43f2-8e4f-8f9cb01e3aa2"},"description":"List of inventory IDs for a bulk change."}],"example":"f35b1e1d-d231-43f2-8e4f-8f9cb01e3aa2"},"OptOutIn":{"type":"object","properties":{"inventory_id":{"oneOf":[{"type":"string","description":"Inventory ID.","example":"f35b1e1d-d231-43f2-8e4f-8f9cb01e3aa2"},{"type":"array","items":{"type":"string","example":"f35b1e1d-d231-43f2-8e4f-8f9cb01e3aa2"},"description":"List of inventory IDs for a bulk change."}],"example":"f35b1e1d-d231-43f2-8e4f-8f9cb01e3aa2"},"opt_out":{"type":"boolean","description":"Opt out setting to be set.","example":true}},"required":["inventory_id","opt_out"]},"BulkChangeOut":{"type":"object","properties":{"updated":{"type":"array","items":{"type":"string","example":"f35b1e1d-d231-43f2-8e4f-8f9cb01e3aa2"},"description":"List of updated objects/updated object IDs."},"meta":{"type":"object","properties":{"permissions":{"type":"array","description":"Fetched permissions from RBAC for given user","nullable":false,"items":{"type":"string","example":"vulnerability:vulnerability_results:read"}}},"required":["permissions"]}},"required":["updated"]},"StatusIn":{"type":"object","properties":{"inventory_id":{"oneOf":[{"type":"string","description":"Inventory ID.","example":"f35b1e1d-d231-43f2-8e4f-8f9cb01e3aa2"},{"type":"array","items":{"type":"string","example":"f35b1e1d-d231-43f2-8e4f-8f9cb01e3aa2"},"description":"List of inventory IDs for a bulk change."}],"example":"f35b1e1d-d231-43f2-8e4f-8f9cb01e3aa2"},"cve":{"oneOf":[{"type":"string","description":"CVE name.","example":"CVE-2016-0800"},{"type":"array","items":{"type":"string","example":"CVE-2016-0800"},"description":"List of CVEs for a bulk change."}],"example":"CVE-2016-0800"},"status_id":{"type":"integer","description":"Status ID to be set, obtained by GET method. If not specified, global CVE status is set.","example":3},"status_text":{"type":"string","description":"Complementary text to the status.","example":"Not relevant","nullable":true}},"required":["cve"]},"CvesWithoutErrataIn":{"type":"object","properties":{"enable":{"type":"boolean","description":"Enable or disable CVEs without Errata feature.","example":true}},"required":["enable"]},"ExecutiveReport":{"type":"object","properties":{"system_count_per_type":{"type":"object","description":"Number of systems managed by vulnerability application, grouped by host type.","properties":{"rpmdnf":{"type":"number","description":"Number of conventional systems.","example":26},"image":{"type":"number","description":"Number of image-mode systems.","example":3,"nullable":true},"edge":{"type":"number","description":"Number of image-mode systems. (Deprecated)","example":3,"nullable":true}}},"system_count":{"type":"integer","description":"Total number of systems managed by vulnerability application.","example":25641},"cves_total":{"type":"integer","description":"Number of unique CVEs discovered on the managed systems.","example":1902},"cves_by_severity":{"type":"object","description":"Number of CVEs discovered on the managed systems, divided into buckets based on their CVSSv3 score (CVSSv2 is used when CVSSv3 is not available).","properties":{"0to3.9":{"type":"object","properties":{"count":{"type":"integer","description":"Number of CVEs with CVSS score lower than 4.","example":1902},"percentage":{"type":"number","description":"Percentage of CVEs with CVSS score lower than 4.","example":60}},"required":["count","percentage"]},"4to7.9":{"type":"object","properties":{"count":{"type":"integer","description":"Number of CVEs with CVSS score higher or equal to 4 and lower then 8.","example":400},"percentage":{"type":"number","description":"Percentage of CVEs with CVSS score higher or equal to 4 and lower then 8.","example":15}},"required":["count","percentage"]},"8to10":{"type":"object","properties":{"count":{"type":"integer","description":"Number of CVEs with CVSS score higher or equal to 8.","example":109},"percentage":{"type":"number","description":"Percentage of CVEs with CVSS score higher or equal to 8.","example":2}},"required":["count","percentage"]}},"required":["0to3.9","4to7.9","8to10"]},"recent_cves":{"type":"object","description":"Number of recently published CVEs identified on managed systems","properties":{"last7days":{"type":"integer","description":"Number of CVEs identified on managed systems published in last 7 days.","example":14},"last30days":{"type":"integer","description":"Number of CVEs identified on managed systems published in last 30 days.","example":62},"last90days":{"type":"integer","description":"Number of CVEs identified on managed systems published in last 90 days.","example":156}},"required":["last7days","last30days","last90days"]},"rules_by_severity":{"type":"object","description":"Information about how much systems are affected by a security rule, broken down by rule severity.","properties":{"1":{"type":"object","properties":{"rule_count":{"type":"integer","description":"How many unique rules with at least system affected are present.","example":12},"systems_affected":{"type":"integer","description":"How many unique systems are affected by at least one rules with given severity","example":443}},"required":["rule_count","systems_affected"]},"2":{"type":"object","properties":{"rule_count":{"type":"integer","description":"How many unique rules with at least system affected are present.","example":12},"systems_affected":{"type":"integer","description":"How many unique systems are affected by at least one rules with given severity","example":443}},"required":["rule_count","systems_affected"]},"3":{"type":"object","properties":{"rule_count":{"type":"integer","description":"How many unique rules with at least system affected are present.","example":12},"systems_affected":{"type":"integer","description":"How many unique systems are affected by at least one rules with given severity","example":443}},"required":["rule_count","systems_affected"]},"4":{"type":"object","properties":{"rule_count":{"type":"integer","description":"How many unique rules with at least system affected are present.","example":12},"systems_affected":{"type":"integer","description":"How many unique systems are affected by at least one rules with given severity","example":443}},"required":["rule_count","systems_affected"]}},"required":["1","2","3","4"]},"rules_total":{"type":"integer","description":"Number of unique CVEs discovered on the managed systems.","example":1902},"top_cves":{"type":"array","items":{"type":"object","properties":{"synopsis":{"type":"string","description":"CVE synopsis","example":"CVE-2016-0800"},"cvss2_score":{"type":"string","description":"String representation of cvss2 score of the CVE.","example":"5.800","nullable":true},"cvss3_score":{"type":"string","description":"String representation of cvss3 score of the CVE.","example":"4.400","nullable":true},"description":{"type":"string","description":"Description of the CVE.","example":"A padding oracle flaw was found in the Secure Sockets Layer version 2.0 (SSLv2) protocol. An attacker could..."},"security_rule":{"type":"boolean","description":"Indicator of security rule presence","example":true,"deprecated":true},"rule_presence":{"type":"boolean","description":"Indicator of security rule presence","example":true},"systems_affected":{"type":"integer","description":"Systems affected by the CVE.","example":1795},"known_exploit":{"type":"boolean","description":"Shows whether a CVE has known exploits or not","example":true}},"required":["synopsis","cvss2_score","cvss3_score","description","systems_affected","known_exploit"]}},"top_rules":{"type":"array","items":{"type":"object","properties":{"associated_cves":{"type":"array","description":"All CVEs associated with the rule","items":{"type":"string","example":"CVE-2019-1125"}},"description":{"type":"string","example":"Privilege Escalation with running service (no fix available for this version)","description":"Brief description of the issue."},"rule_id":{"type":"string","example":"CVE_2017_14491_dnsmasq|CVE_2017_14491_ERROR","description":"ID of associated security rule."},"name":{"type":"string","description":"Name of the security rule.","example":"httpd denial of service with running services"},"severity":{"type":"integer","description":"Severity of the security rule.","example":3},"systems_affected":{"type":"integer","description":"Number of systems affected by the rule.","example":443}},"required":["associated_cves","description","name","rule_id","severity","systems_affected"]}},"meta":{"type":"object","properties":{"permissions":{"type":"array","description":"Fetched permissions from RBAC for given user","nullable":false,"items":{"type":"string","example":"vulnerability:vulnerability_results:read"}}},"required":["permissions"]}},"required":["system_count","cves_total","cves_by_severity","rules_by_severity","rules_total","recent_cves"]},"OSExposureReport":{"type":"object","properties":{"data":{"oneOf":[{"type":"string","description":"CSV export of the JSON."},{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Name of the operating system.","example":"RHEL"},"major":{"type":"integer","description":"Operating system major version.","example":9},"minor":{"type":"integer","description":"Operating system minor version.","example":5},"lifecycle_phase":{"type":"string","description":"Lifecycle phase of the given version.","example":"eus"},"cves_critical":{"type":"integer","description":"Number of CVEs with Critical severity.","example":2},"cves_important":{"type":"integer","description":"Number of CVEs with Important severity.","example":16},"cves_moderate":{"type":"integer","description":"Number of CVEs with Moderate severity.","example":57},"cves_low":{"type":"integer","description":"Number of CVEs with Low severity.","example":12},"cves_unpatched_critical":{"type":"integer","description":"Number of unpatched CVEs with Critical severity.","example":2},"cves_unpatched_important":{"type":"integer","description":"Number of unpatched CVEs with Important severity.","example":16},"cves_unpatched_moderate":{"type":"integer","description":"Number of unpatched CVEs with Moderate severity.","example":57},"cves_unpatched_low":{"type":"integer","description":"Number of unpatched CVEs with Low severity.","example":12}},"required":["name","major","minor","lifecycle_phase","cves_critical","cves_important","cves_moderate","cves_low","cves_unpatched_critical","cves_unpatched_important","cves_unpatched_moderate","cves_unpatched_low"]}}]}},"required":["data"]},"Dashboard":{"type":"object","properties":{"cves_total":{"type":"integer","description":"Number of unique CVEs discovered on the managed systems.","example":1902},"cves_by_severity":{"type":"object","description":"Number of CVEs discovered on the managed systems, divided into buckets based on their CVSSv3 score (CVSSv2 is used when CVSSv3 is not available).","properties":{"0to3.9":{"type":"object","properties":{"count":{"type":"integer","description":"Number of CVEs with CVSS score lower than 4.","example":1902},"percentage":{"type":"number","description":"Percentage of CVEs with CVSS score lower than 4.","example":60},"known_exploits":{"type":"number","description":"Number of CVEs in given bracket with a known exploit.","example":6}},"required":["count","percentage"]},"4to7.9":{"type":"object","properties":{"count":{"type":"integer","description":"Number of CVEs with CVSS score higher or equal to 4 and lower then 8.","example":400},"percentage":{"type":"number","description":"Percentage of CVEs with CVSS score higher or equal to 4 and lower then 8.","example":15},"known_exploits":{"type":"number","description":"Number of CVEs in given bracket with a known exploit.","example":6}},"required":["count","percentage"]},"8to10":{"type":"object","properties":{"count":{"type":"integer","description":"Number of CVEs with CVSS score higher or equal to 8.","example":109},"percentage":{"type":"number","description":"Percentage of CVEs with CVSS score higher or equal to 8.","example":2},"known_exploits":{"type":"number","description":"Number of CVEs in given bracket with a known exploit.","example":6}},"required":["count","percentage"]}},"required":["0to3.9","4to7.9","8to10"]},"recent_cves":{"type":"object","description":"Number of recently published CVEs identified on managed systems","properties":{"last7days":{"type":"integer","description":"Number of CVEs identified on managed systems published in last 7 days.","example":14},"last30days":{"type":"integer","description":"Number of CVEs identified on managed systems published in last 30 days.","example":62},"last90days":{"type":"integer","description":"Number of CVEs identified on managed systems published in last 90 days.","example":156}},"required":["last7days","last30days","last90days"]},"recent_rules":{"type":"array","description":"List of recently (14 days) released security rules.","items":{"type":"object","description":"Security rule.","properties":{"associated_cves":{"type":"array","description":"List of CVEs associated with the security rule.","items":{"type":"string","description":"CVE name.","example":"CVE-2016-0800"}},"description":{"type":"string","example":"A heap-based buffer overflow was found in the way ...","description":"Description of the issue related with the security rule."},"id":{"type":"string","description":"ID of the security rule.","example":"CVE_2019_11135_cpu_taa|CVE_2019_11135_CPU_TAA_KERNEL"},"name":{"type":"string","description":"Name of the security rule.","example":"sudo privilege escalation"},"node_id":{"type":"number","description":"Node id of access.redhat.com/node/* article.","example":5737621,"nullable":true},"public_date":{"type":"string","description":"String representation of ISO-8601 formatted date of release of the security rule.","example":"2016-03-01T00:00:00+00:00","nullable":true},"severity":{"type":"number","description":"Number representation of the security rule severity.","example":3},"systems_affected":{"type":"number","description":"Number of systems triggering the security rule.","example":178}}},"required":["associated_cves","description","name","node_id","severity","systems_affected"]},"rules_cves_total":{"type":"integer","description":"Total number of CVEs with associated security rules affecting given account.","example":12},"system_count":{"type":"integer","description":"Total systems registered to Vulnerability service (with applied filtering).","example":241},"exploited_cves_count":{"type":"integer","description":"unique number of CVEs having known exploit affecting at least one system","example":5}},"required":["cves_total","cves_by_severity","recent_cves","recent_rules","rules_cves_total","system_count","exploited_cves_count"]},"PlaybookTemplate":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"description":{"type":"string","description":"Playbook template description.","example":"Fix issues caused by CVE_2017_6074_kernel|KERNEL_CVE_2017_6074."},"play":{"type":"string","description":"Actual playbook template."},"version":{"type":"string","description":"Revision of the playbook template.","example":"93a1ced8a259666f0505cd20b7cb8e7a1c65b868"},"reboot_required":{"type":"boolean","description":"Indicator whter reboot is required to mitigate vulnerability.","example":false,"nullable":true},"resolution_type":{"type":"string","description":"Type of the resolution provided by playbook."}},"required":["description","play","version","resolution_type"]}}}},"StatusOut":{"type":"object","properties":{"updated":{"type":"array","items":{"type":"object","properties":{"inventory_id":{"type":"string","example":"f35b1e1d-d231-43f2-8e4f-8f9cb01e3aa2"},"cve":{"type":"string","example":"CVE-2016-0800"}},"required":["inventory_id","cve"]},"description":"List of updated objects/updated object IDs."},"meta":{"type":"object","properties":{"permissions":{"type":"array","description":"Fetched permissions from RBAC for given user","nullable":false,"items":{"type":"string","example":"vulnerability:vulnerability_results:read"}}},"required":["permissions"]}},"required":["updated"]},"StatusListOut":{"type":"object","properties":{"data":{"type":"array","description":"List of available status/status_id pairs.","items":{"type":"object","properties":{"id":{"type":"integer","description":"Internal status_id.","example":3},"name":{"type":"string","description":"Represenation of internal status_id.","example":"Scheduled for Patch"}},"required":["id","name"]}},"meta":{"type":"object","properties":{"total_items":{"type":"integer","description":"Total number of available status/status_id pairs.","example":1}},"required":["total_items"]}},"required":["data","meta"]},"SystemCvesOut":{"type":"object","properties":{"data":{"oneOf":[{"type":"string","description":"CSV export of the JSON."},{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"CVE id.","example":"CVE-2016-0800"},"type":{"type":"string","description":"Type of the record.","example":"cve"},"attributes":{"type":"object","properties":{"business_risk":{"type":"string","description":"Business risk of the vulnerability.","example":"Low"},"business_risk_id":{"type":"integer","description":"Internal ID of the vulnerability business risk.","example":1},"business_risk_text":{"type":"string","description":"Complementary text to the business risk.","example":"QA environment => Low business risk","nullable":true},"cve_status_id":{"type":"integer","description":"Internal ID of the CVE status.","example":4},"cvss2_score":{"type":"string","description":"String representation of cvss2 score of the CVE.","example":"5.800","nullable":true},"cvss3_score":{"type":"string","description":"String representation of cvss3 score of the CVE.","example":"4.400","nullable":true},"description":{"type":"string","description":"Description of the CVE.","example":"A padding oracle flaw was found in the Secure Sockets Layer version 2.0 (SSLv2) protocol. An attacker could..."},"first_reported":{"type":"string","description":"Date of when the CVE was first reported on the system.","example":"2018-09-22T16:00:00+00:00"},"impact":{"type":"string","description":"Red Hat security impact of the CVE.","example":"Important"},"public_date":{"type":"string","description":"String representation of ISO-8601 formatted date of first public disclosure of the CVE.","example":"2016-03-01T00:00:00+00:00","nullable":true},"reporter":{"type":"number","description":"Reporter of the vulnerability, 1 for VMaaS, 2 for security rule, 3 for both VMaaS and rule.","enum":[0,1,2,3]},"rule":{"type":"object","nullable":true,"properties":{"rule_id":{"type":"string","example":"CVE_2017_14491_dnsmasq|CVE_2017_14491_ERROR","description":"ID(s) of associated security rule(s)."},"description":{"type":"string","description":"Description of the rule.","example":"CVE-2017-14491 dnsmasq code execution with listening processes","nullable":true},"summary":{"type":"string","description":"Summary of the rule.","example":"A buffer overflow vulnerability was found in `Dnsmasq`, a popular lightweight DNS and DHCP server....","nullable":true},"reboot_required":{"type":"boolean","description":"Indicator whter reboot is required to mitigate vulnerability.","example":false,"nullable":true},"playbook_count":{"type":"integer","description":"Number of available Ansible playbooks for remediation/mitigation.","example":1,"nullable":true},"change_risk":{"type":"integer","description":"Indicates how likely remediation can change environment on the remediatied system.","example":1,"nullable":true},"kbase_node_id":{"type":"integer","description":"ID of associated Red Hat knowledgebase article.","example":3199382,"nullable":true},"generate_autoplaybook":{"type":"boolean","description":"Indicates whether a playbook should be auto-generated.","example":true,"nullable":true}},"required":["change_risk","description","kbase_node_id","playbook_count","reboot_required","rule_id","summary","generate_autoplaybook"]},"status":{"type":"string","description":"Status of the vulnerability for the application's point of view.","example":"Resolved"},"status_id":{"type":"integer","description":"Internal ID of the vulnerability status.","example":4},"status_text":{"type":"string","description":"Complementary text to the status.","example":"Not relevant","nullable":true},"cve_status_text":{"type":"string","description":"Status text to the whole cve.","example":"Not relevant for all","nullable":true},"synopsis":{"type":"string","description":"Synopsis of the CVE.","example":"CVE-2016-0800"},"advisories_list":{"type":"array","description":"List of advisories for CVE","items":{"type":"string","description":"Advisory id","example":"RHSA-2019:1481"}},"known_exploit":{"type":"boolean","description":"Shows whether a CVE has known exploits or not","example":true},"advisory_available":{"type":"boolean","description":"Shows whether a CVE has available advisory or not","example":true},"remediation":{"type":"number","description":"Type of available remediation, 0 for none, 1 for manual, 2 for playbook.","enum":[0,1,2]}},"required":["business_risk","business_risk_id","business_risk_text","cve_status_id","cve_status_text","cvss2_score","cvss3_score","description","first_reported","impact","public_date","reporter","rule","status","status_id","status_text","synopsis","known_exploit","advisory_available","remediation"]}},"required":["id","type","attributes"]}}]},"links":{"type":"object","properties":{"first":{"type":"string","description":"Link to first page.","example":"/api?offset=0&limit=1"},"last":{"type":"string","description":"Link to last page.","example":"/api?offset=7&limit=1"},"next":{"type":"string","description":"Link to next page.","example":"/api?offset=5&limit=1","nullable":true},"previous":{"type":"string","description":"Link to next page.","example":"/api?offset=3&limit=1","nullable":true}},"required":["first","last","next","previous"]},"meta":{"allOf":[{"type":"object","properties":{"filter":{"type":"string","description":"Full text filter","example":"CVE-2016-0800","nullable":true},"limit":{"type":"integer","description":"Maximum number of paginated results.","example":25},"offset":{"type":"integer","description":"First record of paginated response.","example":0},"page":{"type":"integer","description":"Page number of paginated response.","example":1},"page_size":{"type":"integer","description":"Number of records per page of paginated response.","example":25},"pages":{"type":"integer","description":"Total number of pages of paginated response.","example":1},"sort":{"type":"string","description":"Sorting filter.","example":"-inventory_id","nullable":true},"total_items":{"type":"integer","description":"Total number of records.","example":37},"data_format":{"type":"string","description":"Format of the output data, either JSON (default) or CSV.","example":"JSON"}},"required":["filter","limit","offset","page","page_size","pages","sort","total_items","data_format"]},{"type":"object","properties":{"permissions":{"type":"array","description":"Fetched permissions from RBAC for given user","nullable":false,"items":{"type":"string","example":"vulnerability:vulnerability_results:read"}}},"required":["permissions"]},{"type":"object","properties":{"business_risk_id":{"type":"string","description":"Filter based on business risk IDs.","example":"1,3","nullable":true},"cvss_from":{"type":"number","description":"Filter based on cvss score, starting from the value. Use -1 to include also CVEs with N/A cvss score.","example":4.6,"nullable":true},"cvss_to":{"type":"number","description":"Filter based on cvss score, up to the value.","example":7.2,"nullable":true},"public_from":{"type":"string","description":"Filter CVEs based on their published date, starting from the date.","example":"2017-09-18T00:00:00+00:00","nullable":true},"public_to":{"type":"string","description":"Filter CVEs based on their published date, up to the date.","example":"2017-09-18T00:00:00+00:00","nullable":true},"impact":{"type":"string","description":"Filter based on impact IDs.","example":"5,7","nullable":true},"status_id":{"type":"string","description":"Filer based on CVE status ID.","example":"1,4","nullable":true},"rule_presence":{"type":"string","description":"Filter based on presence of security rule","example":"true,false","nullable":true},"patch_access":{"type":"boolean","description":"If show_advisories=true shows access to patch service else null","example":true,"nullable":true},"first_reported_from":{"type":"string","description":"Filter system-cve pairs based on first time of detection of CVE.","example":"2017-09-18T00:00:00+00:00","nullable":true},"first_reported_to":{"type":"string","description":"Filter system-cve pairs based on first time of detection of CVE.","example":"2017-09-18T00:00:00+00:00","nullable":true},"cves_without_errata":{"type":"boolean","description":"CVEs without Errata feature flag","nullable":true}},"required":["business_risk_id","cvss_from","cvss_to","public_from","public_to","impact","status_id","rule_presence","patch_access","first_reported_from","first_reported_to","cves_without_errata"]}]}},"required":["data","links","meta"]},"SystemCvesIdsOut":{"type":"object","properties":{"data":{"oneOf":[{"type":"string","description":"CSV export of the JSON."},{"type":"array","items":{"type":"object","description":"CVE id and minimal information for frontend","properties":{"id":{"type":"string","description":"CVE id.","example":"CVE-2016-0800"},"rule_id":{"type":"string","example":"CVE_2017_14491_dnsmasq|CVE_2017_14491_ERROR","description":"ID(s) of associated security rule(s)..","nullable":true},"status_id":{"type":"integer","description":"Internal ID of the vulnerability status.","example":4},"status_text":{"type":"string","description":"Complementary text to the status.","example":"Not relevant","nullable":true},"cve_status_id":{"type":"integer","description":"Internal ID of the CVE status.","example":4},"cve_status_text":{"type":"string","description":"Status text to the whole cve.","example":"Not relevant for all","nullable":true},"remediation":{"type":"number","description":"Type of available remediation, 0 for none, 1 for manual, 2 for playbook.","enum":[0,1,2]}},"required":["id","rule_id","status_id","status_text","cve_status_id","cve_status_text","remediation"]}}]},"links":{"type":"object","properties":{"first":{"type":"string","description":"Link to first page.","example":"/api?offset=0&limit=1"},"last":{"type":"string","description":"Link to last page.","example":"/api?offset=7&limit=1"},"next":{"type":"string","description":"Link to next page.","example":"/api?offset=5&limit=1","nullable":true},"previous":{"type":"string","description":"Link to next page.","example":"/api?offset=3&limit=1","nullable":true}},"required":["first","last","next","previous"]},"meta":{"allOf":[{"type":"object","properties":{"filter":{"type":"string","description":"Full text filter","example":"CVE-2016-0800","nullable":true},"limit":{"type":"integer","description":"Maximum number of paginated results.","example":25},"offset":{"type":"integer","description":"First record of paginated response.","example":0},"page":{"type":"integer","description":"Page number of paginated response.","example":1},"page_size":{"type":"integer","description":"Number of records per page of paginated response.","example":25},"pages":{"type":"integer","description":"Total number of pages of paginated response.","example":1},"sort":{"type":"string","description":"Sorting filter.","example":"-inventory_id","nullable":true},"total_items":{"type":"integer","description":"Total number of records.","example":37},"data_format":{"type":"string","description":"Format of the output data, either JSON (default) or CSV.","example":"JSON"}},"required":["filter","limit","offset","page","page_size","pages","sort","total_items","data_format"]},{"type":"object","properties":{"permissions":{"type":"array","description":"Fetched permissions from RBAC for given user","nullable":false,"items":{"type":"string","example":"vulnerability:vulnerability_results:read"}}},"required":["permissions"]},{"type":"object","properties":{"business_risk_id":{"type":"string","description":"Filter based on business risk IDs.","example":"1,3","nullable":true},"cvss_from":{"type":"number","description":"Filter based on cvss score, starting from the value. Use -1 to include also CVEs with N/A cvss score.","example":4.6,"nullable":true},"cvss_to":{"type":"number","description":"Filter based on cvss score, up to the value.","example":7.2,"nullable":true},"public_from":{"type":"string","description":"Filter CVEs based on their published date, starting from the date.","example":"2017-09-18T00:00:00+00:00","nullable":true},"public_to":{"type":"string","description":"Filter CVEs based on their published date, up to the date.","example":"2017-09-18T00:00:00+00:00","nullable":true},"impact":{"type":"string","description":"Filter based on impact IDs.","example":"5,7","nullable":true},"status_id":{"type":"string","description":"Filer based on CVE status ID.","example":"1,4","nullable":true},"rule_presence":{"type":"string","description":"Filter based on presence of security rule","example":"true,false","nullable":true},"patch_access":{"type":"boolean","description":"If show_advisories=true shows access to patch service else null","example":true,"nullable":true},"first_reported_from":{"type":"string","description":"Filter system-cve pairs based on first time of detection of CVE.","example":"2017-09-18T00:00:00+00:00","nullable":true},"first_reported_to":{"type":"string","description":"Filter system-cve pairs based on first time of detection of CVE.","example":"2017-09-18T00:00:00+00:00","nullable":true},"cves_without_errata":{"type":"boolean","description":"CVEs without Errata feature flag","nullable":true}},"required":["business_risk_id","cvss_from","cvss_to","public_from","public_to","impact","status_id","rule_presence","patch_access","first_reported_from","first_reported_to","cves_without_errata"]}]}},"required":["data","links","meta"]},"SystemDetailsOut":{"type":"object","properties":{"data":{"type":"object","properties":{"last_evaluation":{"type":"string","description":"Date of last evaluation.","example":"2018-09-22T16:00:00+00:00","nullable":true},"rules_evaluation":{"type":"string","description":"Date of last security rules evaluation.","example":"2018-09-22T16:00:00+00:00","nullable":true},"opt_out":{"type":"boolean","description":"System opt out status.","example":true},"last_upload":{"type":"string","description":"Date of the latest upload of archive.","example":"2018-09-22T16:00:00+00:00","nullable":true},"stale":{"type":"boolean","description":"System stale status.","example":true},"updated":{"type":"string","description":"Date of the lastest upload of archive taken from Inventory syndicated data.","example":"2018-09-22T16:00:00+00:00","nullable":true},"os":{"type":"string","description":"Operating system.","example":"RHEL 8.4"},"rhsm_lock":{"type":"string","description":"System is locked to following RHSM version.","example":"8.4","nullable":true},"tags":{"type":"array","items":{"type":"object","properties":{"namespace":{"type":"string","description":"Namespace of single tag.","example":"vulnerability","nullable":true},"key":{"type":"string","description":"Key of the single tag.","example":"CVE"},"value":{"type":"string","description":"Value of the single tag.","example":"CVE-2017-1","nullable":true}},"required":["namespace","key","value"]}},"host_type":{"type":"string","description":"Type of the host","enum":["rpmdnf","image"]}},"required":["last_evaluation","rules_evaluation","opt_out","last_upload","tags","os","rhsm_lock","host_type"]},"meta":{"type":"object","properties":{"permissions":{"type":"array","description":"Fetched permissions from RBAC for given user","nullable":false,"items":{"type":"string","example":"vulnerability:vulnerability_results:read"}}},"required":["permissions"]}},"required":["data","meta"]},"SystemListOut":{"type":"object","properties":{"data":{"oneOf":[{"type":"string","description":"CSV export of the JSON."},{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Host ID.","example":"INV-ID00-0000-1234"},"type":{"type":"string","description":"Type of the record.","example":"system"},"attributes":{"type":"object","properties":{"cve_count":{"type":"integer","description":"Number of CVE exposures for the system.","example":7,"nullable":true},"display_name":{"type":"string","description":"System's name,","example":"system.example.com","nullable":true},"inventory_id":{"type":"string","description":"Host ID.","example":"INV-ID00-0000-1234"},"insights_id":{"type":"string","description":"Insights host ID.","example":"0035f6bc-cdb0-4763-8fcd-1dc58f716359","nullable":true},"last_evaluation":{"type":"string","description":"Date of last evaluation.","example":"2018-09-22T16:00:00+00:00","nullable":true},"rules_evaluation":{"type":"string","description":"Date of last security rules evaluation.","example":"2018-09-22T16:00:00+00:00","nullable":true},"opt_out":{"type":"boolean","description":"Opt out status of the system.","example":false},"last_upload":{"type":"string","description":"Date of the latest upload of archive.","example":"2018-09-22T16:00:00+00:00","nullable":true},"os":{"type":"string","description":"Operating system.","example":"RHEL 8.4"},"rhsm_lock":{"type":"string","description":"System is locked to following RHSM version.","example":"8.4","nullable":true},"stale_timestamp":{"type":"string","description":"Date when stale system becomes stale.","example":"2018-09-22T16:00:00+00:00","nullable":true},"stale_warning_timestamp":{"type":"string","description":"Date when stale system becomes hidden in the application.","example":"2018-09-22T16:00:00+00:00","nullable":true},"updated":{"type":"string","description":"Date of the lastest upload of archive taken from Inventory syndicated data.","example":"2018-09-22T16:00:00+00:00","nullable":true},"tags":{"type":"array","items":{"type":"object","properties":{"namespace":{"type":"string","description":"Namespace of single tag.","example":"vulnerability","nullable":true},"key":{"type":"string","description":"Key of the single tag.","example":"CVE"},"value":{"type":"string","description":"Value of the single tag.","example":"CVE-2017-1","nullable":true}},"required":["namespace","key","value"]},"description":"Tags given to the system.","nullable":true},"culled_timestamp":{"type":"string","description":"Timestamp from which the host is considered deleted.","example":"2018-09-22T16:00:00+00:00","nullable":true},"inventory_group":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"ID of inventory group.","example":"00000000-1111-0000-0000-000000000000"},"name":{"type":"string","description":"Name of inventory group.","example":"group01"}},"required":["id","name"]}},"host_type":{"type":"string","description":"Type of the host","enum":["rpmdnf","image"]}},"required":["cve_count","display_name","inventory_id","insights_id","last_evaluation","rules_evaluation","opt_out","last_upload","os","rhsm_lock","stale_timestamp","stale_warning_timestamp","tags","culled_timestamp","inventory_group","host_type"]}},"required":["id","type","attributes"]}}]},"links":{"type":"object","properties":{"first":{"type":"string","description":"Link to first page.","example":"/api?offset=0&limit=1"},"last":{"type":"string","description":"Link to last page.","example":"/api?offset=7&limit=1"},"next":{"type":"string","description":"Link to next page.","example":"/api?offset=5&limit=1","nullable":true},"previous":{"type":"string","description":"Link to next page.","example":"/api?offset=3&limit=1","nullable":true}},"required":["first","last","next","previous"]},"meta":{"allOf":[{"type":"object","properties":{"filter":{"type":"string","description":"Full text filter","example":"CVE-2016-0800","nullable":true},"limit":{"type":"integer","description":"Maximum number of paginated results.","example":25},"offset":{"type":"integer","description":"First record of paginated response.","example":0},"page":{"type":"integer","description":"Page number of paginated response.","example":1},"page_size":{"type":"integer","description":"Number of records per page of paginated response.","example":25},"pages":{"type":"integer","description":"Total number of pages of paginated response.","example":1},"sort":{"type":"string","description":"Sorting filter.","example":"-inventory_id","nullable":true},"total_items":{"type":"integer","description":"Total number of records.","example":37},"data_format":{"type":"string","description":"Format of the output data, either JSON (default) or CSV.","example":"JSON"}},"required":["filter","limit","offset","page","page_size","pages","sort","total_items","data_format"]},{"type":"object","properties":{"permissions":{"type":"array","description":"Fetched permissions from RBAC for given user","nullable":false,"items":{"type":"string","example":"vulnerability:vulnerability_results:read"}}},"required":["permissions"]},{"type":"object","properties":{"excluded":{"type":"string","description":"Display setting of opted out systems.","example":"true,false","nullable":true},"rhel_version":{"type":"string","description":"Filter base on system RHEL version.","example":"8.2","nullable":true}},"required":["excluded","rhel_version"]}]}},"required":["data","links","meta"]},"SystemIdsOut":{"type":"object","properties":{"data":{"oneOf":[{"type":"string","description":"CSV export of the JSON."},{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Inventory ID.","example":"INV-ID00-0000-1234"},"opt_out":{"type":"boolean","description":"Whether the system is active or not.","example":false,"nullable":true},"display_name":{"type":"string","description":"System's name.","example":"system.example.com","nullable":true}}}}]},"links":{"type":"object","properties":{"first":{"type":"string","description":"Link to first page.","example":"/api?offset=0&limit=1"},"last":{"type":"string","description":"Link to last page.","example":"/api?offset=7&limit=1"},"next":{"type":"string","description":"Link to next page.","example":"/api?offset=5&limit=1","nullable":true},"previous":{"type":"string","description":"Link to next page.","example":"/api?offset=3&limit=1","nullable":true}},"required":["first","last","next","previous"]},"meta":{"allOf":[{"type":"object","properties":{"filter":{"type":"string","description":"Full text filter","example":"CVE-2016-0800","nullable":true},"limit":{"type":"integer","description":"Maximum number of paginated results.","example":25},"offset":{"type":"integer","description":"First record of paginated response.","example":0},"page":{"type":"integer","description":"Page number of paginated response.","example":1},"page_size":{"type":"integer","description":"Number of records per page of paginated response.","example":25},"pages":{"type":"integer","description":"Total number of pages of paginated response.","example":1},"sort":{"type":"string","description":"Sorting filter.","example":"-inventory_id","nullable":true},"total_items":{"type":"integer","description":"Total number of records.","example":37},"data_format":{"type":"string","description":"Format of the output data, either JSON (default) or CSV.","example":"JSON"}},"required":["filter","limit","offset","page","page_size","pages","sort","total_items","data_format"]},{"type":"object","properties":{"permissions":{"type":"array","description":"Fetched permissions from RBAC for given user","nullable":false,"items":{"type":"string","example":"vulnerability:vulnerability_results:read"}}},"required":["permissions"]},{"type":"object","properties":{"excluded":{"type":"string","description":"Display setting of opted out systems.","example":"true,false","nullable":true},"rhel_version":{"type":"string","description":"Filter base on system RHEL version.","example":"8.2","nullable":true}},"required":["excluded","rhel_version"]}]}},"required":["data","links","meta"]},"VulnerabilitiesOut":{"type":"object","properties":{"data":{"oneOf":[{"type":"string","description":"CSV export of the JSON."},{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"CVE id.","example":"CVE-2016-0800"},"type":{"type":"string","description":"Type of the record.","example":"cve"},"attributes":{"type":"object","properties":{"business_risk":{"type":"string","description":"Business risk of the vulnerability.","example":"Low"},"business_risk_id":{"type":"integer","description":"Internal ID of the vulnerability business risk.","example":1},"business_risk_text":{"type":"string","description":"Complementary text to the business risk.","example":"QA environment => Low business risk","nullable":true},"cvss2_score":{"type":"string","description":"String representation of cvss2 score of the CVE.","example":"5.800","nullable":true},"cvss3_score":{"type":"string","description":"String representation of cvss3 score of the CVE.","example":"4.400","nullable":true},"description":{"type":"string","description":"Description of the CVE.","example":"A padding oracle flaw was found in the Secure Sockets Layer version 2.0 (SSLv2) protocol. An attacker could..."},"impact":{"type":"string","description":"Red Hat security impact of the CVE.","example":"Important"},"public_date":{"type":"string","description":"String representation of ISO-8601 formatted date of first public disclosure of the CVE.","example":"2016-03-01T00:00:00+00:00","nullable":true},"rules":{"type":"array","items":{"type":"object","properties":{"rule_id":{"type":"string","example":"CVE_2017_14491_dnsmasq|CVE_2017_14491_ERROR","description":"ID(s) of associated security rule(s)."},"description":{"type":"string","description":"Description of the rule.","example":"CVE-2017-14491 dnsmasq code execution with listening processes","nullable":true},"summary":{"type":"string","description":"Summary of the rule.","example":"A buffer overflow vulnerability was found in `Dnsmasq`, a popular lightweight DNS and DHCP server....","nullable":true},"reboot_required":{"type":"boolean","description":"Indicator whter reboot is required to mitigate vulnerability.","example":false,"nullable":true},"playbook_count":{"type":"integer","description":"Number of available Ansible playbooks for remediation/mitigation.","example":1,"nullable":true},"change_risk":{"type":"integer","description":"Indicates how likely remediation can change environment on the remediatied system.","example":1,"nullable":true},"kbase_node_id":{"type":"integer","description":"ID of associated Red Hat knowledgebase article.","example":3199382,"nullable":true},"associated_cves":{"type":"array","items":{"type":"string","example":"CVE-2016-0800"},"description":"List of CVEs associated with the rule."},"rule_impact":{"type":"integer","description":"Shows rules impact number from 1 to 4","example":1,"nullable":true},"systems_affected":{"type":"integer","description":"Number of systems affected by the rule.","example":72},"publish_date":{"type":"string","description":"Date when the rule was published.","example":"2018-05-15T13:00:00Z","nullable":true}},"required":["associated_cves","change_risk","description","kbase_node_id","playbook_count","reboot_required","rule_id","summary","rule_impact","publish_date"]}},"status":{"type":"string","description":"Status of the vulnerability.","example":"Not Reviewed"},"status_id":{"type":"integer","description":"Internal ID of the vulnerability status.","example":1},"status_text":{"type":"string","description":"Complementary text to the status.","example":"Not Relevant","nullable":true},"synopsis":{"type":"string","description":"Synopsis of the CVE.","example":"CVE-2016-0800"},"systems_affected":{"type":"integer","description":"Number of systems affected by the CVE.","example":7},"systems_status_divergent":{"type":"integer","description":"How many systems-CVE pairs have different status than CVE-level.","example":20},"known_exploit":{"type":"boolean","description":"Shows whether a CVE has known exploits or not","example":true},"advisory_available":{"type":"boolean","description":"Shows whether a CVE has available advisory or not","example":true},"rhel_versions":{"type":"array","items":{"type":"string","description":"Applicable RHEL version across your entire system inventory.","example":"9.4"}}},"required":["business_risk","business_risk_id","business_risk_text","cvss2_score","cvss3_score","description","impact","public_date","rules","status","status_id","status_text","synopsis","systems_affected","systems_status_divergent","known_exploit","advisory_available","rhel_versions"]}},"required":["id","type","attributes"]}}]},"links":{"type":"object","properties":{"first":{"type":"string","description":"Link to first page.","example":"/api?offset=0&limit=1"},"last":{"type":"string","description":"Link to last page.","example":"/api?offset=7&limit=1"},"next":{"type":"string","description":"Link to next page.","example":"/api?offset=5&limit=1","nullable":true},"previous":{"type":"string","description":"Link to next page.","example":"/api?offset=3&limit=1","nullable":true}},"required":["first","last","next","previous"]},"meta":{"allOf":[{"type":"object","properties":{"filter":{"type":"string","description":"Full text filter","example":"CVE-2016-0800","nullable":true},"limit":{"type":"integer","description":"Maximum number of paginated results.","example":25},"offset":{"type":"integer","description":"First record of paginated response.","example":0},"page":{"type":"integer","description":"Page number of paginated response.","example":1},"page_size":{"type":"integer","description":"Number of records per page of paginated response.","example":25},"pages":{"type":"integer","description":"Total number of pages of paginated response.","example":1},"sort":{"type":"string","description":"Sorting filter.","example":"-inventory_id","nullable":true},"total_items":{"type":"integer","description":"Total number of records.","example":37},"data_format":{"type":"string","description":"Format of the output data, either JSON (default) or CSV.","example":"JSON"}},"required":["filter","limit","offset","page","page_size","pages","sort","total_items","data_format"]},{"type":"object","properties":{"permissions":{"type":"array","description":"Fetched permissions from RBAC for given user","nullable":false,"items":{"type":"string","example":"vulnerability:vulnerability_results:read"}}},"required":["permissions"]},{"type":"object","properties":{"affecting":{"type":"string","description":"Description of CVE showing preferences","example":"True,False","nullable":true},"business_risk_id":{"type":"string","description":"Filter based on business risk IDs.","example":"1,3","nullable":true},"cvss_from":{"type":"number","description":"Filter based on cvss score, starting from the value. Use -1 to include also CVEs with N/A cvss score.","example":4.6,"nullable":true},"cvss_to":{"type":"number","description":"Filter based on cvss score, up to the value.","example":7.2,"nullable":true},"public_from":{"type":"string","description":"Filter CVEs based on their published date, starting from the date.","example":"2017-09-18T00:00:00+00:00","nullable":true},"public_to":{"type":"string","description":"Filter CVEs based on their published date, up to the date.","example":"2017-09-18T00:00:00+00:00","nullable":true},"impact":{"type":"string","description":"Filter based on impact IDs.","example":"5,7","nullable":true},"system_count_per_type":{"type":"object","description":"Number of systems managed by vulnerability application, grouped by host type.","properties":{"rpmdnf":{"type":"number","description":"Number of conventional systems.","example":26},"image":{"type":"number","description":"Number of image-mode systems.","example":3,"nullable":true},"edge":{"type":"number","description":"Number of image-mode systems. (Deprecated)","example":3,"nullable":true}}},"system_count":{"type":"integer","description":"Total number of systems managed by vulnerability application.","example":25641},"rhel_version":{"type":"string","description":"Filter base on system RHEL version.","example":"8.2","nullable":true},"rule_presence":{"type":"string","description":"Filter based on presence of security rule","example":"true,false","nullable":true},"cves_without_errata":{"type":"boolean","description":"CVEs without Errata feature flag","nullable":true},"advisory_available":{"type":"string","description":"Shows whether a CVE has available advisory or not","example":"true,false","nullable":true},"cache_used":{"type":"boolean","description":"Flag if cached data was used to produce the response.","example":false}},"required":["affecting","business_risk_id","cvss_from","cvss_to","public_from","public_to","impact","rhel_version","rule_presence","cves_without_errata","advisory_available","cache_used"]}]}},"required":["data","links","meta"]},"VulnerabilitiesIdsOut":{"type":"object","properties":{"data":{"oneOf":[{"type":"string","description":"CSV export of the JSON."},{"type":"array","items":{"type":"object","description":"CVE id and minimal information.","properties":{"business_risk_id":{"type":"integer","description":"Internal ID of the vulnerability business risk.","example":1},"business_risk_text":{"type":"string","description":"Complementary text to the business risk.","example":"QA environment => Low business risk","nullable":true},"id":{"type":"string","description":"CVE id.","example":"CVE-2016-0800"},"status_id":{"type":"integer","description":"Internal ID of the vulnerability status.","example":1},"status_text":{"type":"string","description":"Complementary text to the status.","example":"Not Relevant","nullable":true}}},"required":["business_risk_id","business_risk_text","id","status_id","status_text"]}]},"links":{"type":"object","properties":{"first":{"type":"string","description":"Link to first page.","example":"/api?offset=0&limit=1"},"last":{"type":"string","description":"Link to last page.","example":"/api?offset=7&limit=1"},"next":{"type":"string","description":"Link to next page.","example":"/api?offset=5&limit=1","nullable":true},"previous":{"type":"string","description":"Link to next page.","example":"/api?offset=3&limit=1","nullable":true}},"required":["first","last","next","previous"]},"meta":{"allOf":[{"type":"object","properties":{"filter":{"type":"string","description":"Full text filter","example":"CVE-2016-0800","nullable":true},"limit":{"type":"integer","description":"Maximum number of paginated results.","example":25},"offset":{"type":"integer","description":"First record of paginated response.","example":0},"page":{"type":"integer","description":"Page number of paginated response.","example":1},"page_size":{"type":"integer","description":"Number of records per page of paginated response.","example":25},"pages":{"type":"integer","description":"Total number of pages of paginated response.","example":1},"sort":{"type":"string","description":"Sorting filter.","example":"-inventory_id","nullable":true},"total_items":{"type":"integer","description":"Total number of records.","example":37},"data_format":{"type":"string","description":"Format of the output data, either JSON (default) or CSV.","example":"JSON"}},"required":["filter","limit","offset","page","page_size","pages","sort","total_items","data_format"]},{"type":"object","properties":{"permissions":{"type":"array","description":"Fetched permissions from RBAC for given user","nullable":false,"items":{"type":"string","example":"vulnerability:vulnerability_results:read"}}},"required":["permissions"]},{"type":"object","properties":{"affecting":{"type":"string","description":"Description of CVE showing preferences","example":"True,False","nullable":true},"business_risk_id":{"type":"string","description":"Filter based on business risk IDs.","example":"1,3","nullable":true},"cvss_from":{"type":"number","description":"Filter based on cvss score, starting from the value. Use -1 to include also CVEs with N/A cvss score.","example":4.6,"nullable":true},"cvss_to":{"type":"number","description":"Filter based on cvss score, up to the value.","example":7.2,"nullable":true},"public_from":{"type":"string","description":"Filter CVEs based on their published date, starting from the date.","example":"2017-09-18T00:00:00+00:00","nullable":true},"public_to":{"type":"string","description":"Filter CVEs based on their published date, up to the date.","example":"2017-09-18T00:00:00+00:00","nullable":true},"impact":{"type":"string","description":"Filter based on impact IDs.","example":"5,7","nullable":true},"system_count_per_type":{"type":"object","description":"Number of systems managed by vulnerability application, grouped by host type.","properties":{"rpmdnf":{"type":"number","description":"Number of conventional systems.","example":26},"image":{"type":"number","description":"Number of image-mode systems.","example":3,"nullable":true},"edge":{"type":"number","description":"Number of image-mode systems. (Deprecated)","example":3,"nullable":true}}},"system_count":{"type":"integer","description":"Total number of systems managed by vulnerability application.","example":25641},"rhel_version":{"type":"string","description":"Filter base on system RHEL version.","example":"8.2","nullable":true},"rule_presence":{"type":"string","description":"Filter based on presence of security rule","example":"true,false","nullable":true},"cves_without_errata":{"type":"boolean","description":"CVEs without Errata feature flag","nullable":true},"advisory_available":{"type":"string","description":"Shows whether a CVE has available advisory or not","example":"true,false","nullable":true},"cache_used":{"type":"boolean","description":"Flag if cached data was used to produce the response.","example":false}},"required":["affecting","business_risk_id","cvss_from","cvss_to","public_from","public_to","impact","rhel_version","rule_presence","cves_without_errata","advisory_available","cache_used"]}]}},"required":["data","links","meta"]},"VersionOut":{"type":"object","properties":{"application_version":{"type":"string","description":"Version of application.","example":"0.1.2"},"database_version":{"oneOf":[{"type":"string"},{"type":"number"}],"description":"Version of database schema.","example":1}},"required":["application_version","database_version"]},"InsightsRule":{"type":"object","properties":{"rule_id":{"type":"string","example":"CVE_2017_14491_dnsmasq|CVE_2017_14491_ERROR","description":"ID(s) of associated security rule(s)."},"description":{"type":"string","description":"Description of the rule.","example":"CVE-2017-14491 dnsmasq code execution with listening processes","nullable":true},"summary":{"type":"string","description":"Summary of the rule.","example":"A buffer overflow vulnerability was found in `Dnsmasq`, a popular lightweight DNS and DHCP server....","nullable":true},"reboot_required":{"type":"boolean","description":"Indicator whter reboot is required to mitigate vulnerability.","example":false,"nullable":true},"playbook_count":{"type":"integer","description":"Number of available Ansible playbooks for remediation/mitigation.","example":1,"nullable":true},"change_risk":{"type":"integer","description":"Indicates how likely remediation can change environment on the remediatied system.","example":1,"nullable":true},"kbase_node_id":{"type":"integer","description":"ID of associated Red Hat knowledgebase article.","example":3199382,"nullable":true},"associated_cves":{"type":"array","items":{"type":"string","example":"CVE-2016-0800"},"description":"List of CVEs associated with the rule."},"rule_impact":{"type":"integer","description":"Shows rules impact number from 1 to 4","example":1,"nullable":true},"systems_affected":{"type":"integer","description":"Number of systems affected by the rule.","example":72},"publish_date":{"type":"string","description":"Date when the rule was published.","example":"2018-05-15T13:00:00Z","nullable":true}},"required":["associated_cves","change_risk","description","kbase_node_id","playbook_count","reboot_required","rule_id","summary","rule_impact","publish_date"]},"VulnerabilitiesPostIn":{"type":"object","properties":{"cve_list":{"type":"array","description":"Array of CVEs to provide info about","items":{"type":"string","example":"CVE-2016-0800","description":"CVE id."}}},"required":["cve_list"]},"VulnerabilitiesPostOut":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"CVE id.","example":"CVE-2016-0800"},"type":{"type":"string","description":"Type of the record.","example":"cve"},"attributes":{"type":"object","properties":{"cvss_score":{"type":"string","description":"String representation of cvss3 or cvvs2 (if v3 is not present) score of the CVE.","example":"5.800","nullable":true},"impact":{"type":"string","description":"Red Hat security impact of the CVE.","example":"Important"},"synopsis":{"type":"string","description":"Synopsis of the CVE.","example":"CVE-2016-0800"}},"required":["cvss_score","impact","synopsis"]}},"required":["id","type","attributes"]}},"links":{"type":"object","properties":{"first":{"type":"string","description":"Link to first page.","example":"/api?offset=0&limit=1"},"last":{"type":"string","description":"Link to last page.","example":"/api?offset=7&limit=1"},"next":{"type":"string","description":"Link to next page.","example":"/api?offset=5&limit=1","nullable":true},"previous":{"type":"string","description":"Link to next page.","example":"/api?offset=3&limit=1","nullable":true}},"required":["first","last","next","previous"]},"meta":{"allOf":[{"type":"object","properties":{"filter":{"type":"string","description":"Full text filter","example":"CVE-2016-0800","nullable":true},"limit":{"type":"integer","description":"Maximum number of paginated results.","example":25},"offset":{"type":"integer","description":"First record of paginated response.","example":0},"page":{"type":"integer","description":"Page number of paginated response.","example":1},"page_size":{"type":"integer","description":"Number of records per page of paginated response.","example":25},"pages":{"type":"integer","description":"Total number of pages of paginated response.","example":1},"sort":{"type":"string","description":"Sorting filter.","example":"-inventory_id","nullable":true},"total_items":{"type":"integer","description":"Total number of records.","example":37},"data_format":{"type":"string","description":"Format of the output data, either JSON (default) or CSV.","example":"JSON"}},"required":["filter","limit","offset","page","page_size","pages","sort","total_items","data_format"]},{"type":"object","properties":{"permissions":{"type":"array","description":"Fetched permissions from RBAC for given user","nullable":false,"items":{"type":"string","example":"vulnerability:vulnerability_results:read"}}},"required":["permissions"]}]}},"required":["data","links","meta"]},"AnnouncementOut":{"type":"object","properties":{"message":{"type":"string","description":"Announcement message.","example":"Hello from Vulnerability team :)."},"last_updated":{"type":"string","description":"Datetime string.","example":"2004-10-19 10:23:54+02"}},"required":["message","last_updated"]},"DashbarOut":{"type":"object","properties":{"exploitable_cves":{"type":"number"},"cves_with_rule":{"type":"number"},"critical_cves":{"type":"number"},"important_cves":{"type":"number"}}},"CvesWithoutErrataOut":{"type":"object","properties":{"cves_without_errata":{"type":"object","properties":{"enabled":{"type":"boolean"}}}},"required":["cves_without_errata","org_id"]},"CvesWithoutErrataPatchOut":{"type":"object","properties":{"updated":{"type":"object","properties":{"org_id":{"type":"string"},"cves_without_errata":{"type":"object","properties":{"enabled":{"type":"boolean"}}}}},"meta":{"type":"object","properties":{"permissions":{"type":"array","description":"Fetched permissions from RBAC for given user","nullable":false,"items":{"type":"string","example":"vulnerability:vulnerability_results:read"}}},"required":["permissions"]}},"required":["updated","meta"]},"NotificationsOut":{"type":"object","properties":{"deleted":{"type":"number","description":"Number of deleted notifications for CVEs","example":50}},"required":["deleted"]}}},"servers":[{"url":"/api/vulnerability/v1"}]} \ No newline at end of file diff --git a/packages/vulnerabilities/base.ts b/packages/vulnerabilities/base.ts index 53d914ed3..e607631d9 100644 --- a/packages/vulnerabilities/base.ts +++ b/packages/vulnerabilities/base.ts @@ -3,7 +3,7 @@ * Vulnerability Engine Manager * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * - * The version of the OpenAPI document: 2.70.8 + * The version of the OpenAPI document: 2.74.1 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/packages/vulnerabilities/configuration.ts b/packages/vulnerabilities/configuration.ts index ea4436a6d..da7e7b06d 100644 --- a/packages/vulnerabilities/configuration.ts +++ b/packages/vulnerabilities/configuration.ts @@ -3,7 +3,7 @@ * Vulnerability Engine Manager * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * - * The version of the OpenAPI document: 2.70.8 + * The version of the OpenAPI document: 2.74.1 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/packages/vulnerabilities/git-api/api.ts b/packages/vulnerabilities/git-api/api.ts index 1c6530874..ec72b5d62 100644 --- a/packages/vulnerabilities/git-api/api.ts +++ b/packages/vulnerabilities/git-api/api.ts @@ -3,7 +3,7 @@ * Vulnerability Engine Manager * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * - * The version of the OpenAPI document: 2.70.8 + * The version of the OpenAPI document: 2.74.1 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -33,1041 +33,2170 @@ export interface AffectedSystemsIdsOut { data: string | Array; /** * - * @type {Links} + * @type {InlineResponse2003Links} * @memberof AffectedSystemsIdsOut */ - links: Links; + links: InlineResponse2003Links; /** * - * @type {MetaAffectedSystems} + * @type {object} * @memberof AffectedSystemsIdsOut */ - meta: MetaAffectedSystems; + meta: object; +} +/** + * + * @export + * @interface AffectedSystemsOut + */ +export interface AffectedSystemsOut { + /** + * + * @type {string | Array} + * @memberof AffectedSystemsOut + */ + data: string | Array; + /** + * + * @type {InlineResponse2003Links} + * @memberof AffectedSystemsOut + */ + links: InlineResponse2003Links; + /** + * + * @type {object} + * @memberof AffectedSystemsOut + */ + meta: object; +} +/** + * + * @export + * @interface AnnouncementOut + */ +export interface AnnouncementOut { + /** + * Announcement message. + * @type {string} + * @memberof AnnouncementOut + */ + message: string; + /** + * Datetime string. + * @type {string} + * @memberof AnnouncementOut + */ + last_updated: string; +} +/** + * + * @export + * @interface BulkChangeOut + */ +export interface BulkChangeOut { + /** + * List of updated objects/updated object IDs. + * @type {Array} + * @memberof BulkChangeOut + */ + updated: Array; + /** + * + * @type {InlineResponse2002Meta} + * @memberof BulkChangeOut + */ + meta?: InlineResponse2002Meta; +} +/** + * + * @export + * @interface BusinessRiskListOut + */ +export interface BusinessRiskListOut { + /** + * List of available business risk/business_risk_id pairs. + * @type {Array} + * @memberof BusinessRiskListOut + */ + data: Array; + /** + * + * @type {InlineResponse2001Meta} + * @memberof BusinessRiskListOut + */ + meta: InlineResponse2001Meta; +} +/** + * + * @export + * @interface CveDetailOut + */ +export interface CveDetailOut { + /** + * + * @type {InlineResponse2002Data} + * @memberof CveDetailOut + */ + data?: InlineResponse2002Data; + /** + * + * @type {InlineResponse2002Meta} + * @memberof CveDetailOut + */ + meta?: InlineResponse2002Meta; +} +/** + * @type CveOrList + * @export + */ +export type CveOrList = Array | string; + +/** + * + * @export + * @interface CveRiskIn + */ +export interface CveRiskIn { + /** + * + * @type {string | Array} + * @memberof CveRiskIn + */ + cve: string | Array; + /** + * Business risk ID to be set, obtained by GET method. + * @type {number} + * @memberof CveRiskIn + */ + business_risk_id?: number; + /** + * Complementary text to the business risk. + * @type {string} + * @memberof CveRiskIn + */ + business_risk_text?: string | null; +} +/** + * + * @export + * @interface CveStatusIn + */ +export interface CveStatusIn { + /** + * + * @type {string | Array} + * @memberof CveStatusIn + */ + cve: string | Array; + /** + * Status ID to be set, obtained by GET method. + * @type {number} + * @memberof CveStatusIn + */ + status_id?: number; + /** + * Complementary text to the status. + * @type {string} + * @memberof CveStatusIn + */ + status_text?: string | null; +} +/** + * + * @export + * @interface CvesWithoutErrataIn + */ +export interface CvesWithoutErrataIn { + /** + * Enable or disable CVEs without Errata feature. + * @type {boolean} + * @memberof CvesWithoutErrataIn + */ + enable: boolean; +} +/** + * + * @export + * @interface CvesWithoutErrataOut + */ +export interface CvesWithoutErrataOut { + /** + * + * @type {InlineResponse20022CvesWithoutErrata} + * @memberof CvesWithoutErrataOut + */ + cves_without_errata: InlineResponse20022CvesWithoutErrata; +} +/** + * + * @export + * @interface CvesWithoutErrataPatchOut + */ +export interface CvesWithoutErrataPatchOut { + /** + * + * @type {InlineResponse20023Updated} + * @memberof CvesWithoutErrataPatchOut + */ + updated: InlineResponse20023Updated; + /** + * + * @type {InlineResponse2002Meta} + * @memberof CvesWithoutErrataPatchOut + */ + meta: InlineResponse2002Meta; +} +/** + * + * @export + * @interface DashbarOut + */ +export interface DashbarOut { + /** + * + * @type {number} + * @memberof DashbarOut + */ + exploitable_cves?: number; + /** + * + * @type {number} + * @memberof DashbarOut + */ + cves_with_rule?: number; + /** + * + * @type {number} + * @memberof DashbarOut + */ + critical_cves?: number; + /** + * + * @type {number} + * @memberof DashbarOut + */ + important_cves?: number; +} +/** + * + * @export + * @interface Dashboard + */ +export interface Dashboard { + /** + * Number of unique CVEs discovered on the managed systems. + * @type {number} + * @memberof Dashboard + */ + cves_total: number; + /** + * + * @type {InlineResponse2006CvesBySeverity} + * @memberof Dashboard + */ + cves_by_severity: InlineResponse2006CvesBySeverity; + /** + * + * @type {InlineResponse2006RecentCves} + * @memberof Dashboard + */ + recent_cves: InlineResponse2006RecentCves; + /** + * List of recently (14 days) released security rules. + * @type {Array} + * @memberof Dashboard + */ + recent_rules: Array; + /** + * Total number of CVEs with associated security rules affecting given account. + * @type {number} + * @memberof Dashboard + */ + rules_cves_total: number; + /** + * Total systems registered to Vulnerability service (with applied filtering). + * @type {number} + * @memberof Dashboard + */ + system_count: number; + /** + * unique number of CVEs having known exploit affecting at least one system + * @type {number} + * @memberof Dashboard + */ + exploited_cves_count: number; +} +/** + * + * @export + * @interface Errors + */ +export interface Errors { + /** + * + * @type {Array} + * @memberof Errors + */ + errors: Array; +} +/** + * + * @export + * @interface ExecutiveReport + */ +export interface ExecutiveReport { + /** + * + * @type {InlineResponse2008SystemCountPerType} + * @memberof ExecutiveReport + */ + system_count_per_type?: InlineResponse2008SystemCountPerType; + /** + * Total number of systems managed by vulnerability application. + * @type {number} + * @memberof ExecutiveReport + */ + system_count: number; + /** + * Number of unique CVEs discovered on the managed systems. + * @type {number} + * @memberof ExecutiveReport + */ + cves_total: number; + /** + * + * @type {InlineResponse2008CvesBySeverity} + * @memberof ExecutiveReport + */ + cves_by_severity: InlineResponse2008CvesBySeverity; + /** + * + * @type {InlineResponse2006RecentCves} + * @memberof ExecutiveReport + */ + recent_cves: InlineResponse2006RecentCves; + /** + * + * @type {InlineResponse2008RulesBySeverity} + * @memberof ExecutiveReport + */ + rules_by_severity: InlineResponse2008RulesBySeverity; + /** + * Number of unique CVEs discovered on the managed systems. + * @type {number} + * @memberof ExecutiveReport + */ + rules_total: number; + /** + * + * @type {Array} + * @memberof ExecutiveReport + */ + top_cves?: Array; + /** + * + * @type {Array} + * @memberof ExecutiveReport + */ + top_rules?: Array; + /** + * + * @type {InlineResponse2002Meta} + * @memberof ExecutiveReport + */ + meta?: InlineResponse2002Meta; +} +/** + * + * @export + * @interface InlineObject + */ +export interface InlineObject { + /** + * + * @type {string | Array} + * @memberof InlineObject + */ + cve: string | Array; + /** + * Business risk ID to be set, obtained by GET method. + * @type {number} + * @memberof InlineObject + */ + business_risk_id?: number; + /** + * Complementary text to the business risk. + * @type {string} + * @memberof InlineObject + */ + business_risk_text?: string | null; +} +/** + * + * @export + * @interface InlineObject1 + */ +export interface InlineObject1 { + /** + * + * @type {string | Array} + * @memberof InlineObject1 + */ + cve: string | Array; + /** + * Status ID to be set, obtained by GET method. + * @type {number} + * @memberof InlineObject1 + */ + status_id?: number; + /** + * Complementary text to the status. + * @type {string} + * @memberof InlineObject1 + */ + status_text?: string | null; +} +/** + * + * @export + * @interface InlineObject2 + */ +export interface InlineObject2 { + /** + * + * @type {string | Array} + * @memberof InlineObject2 + */ + inventory_id?: string | Array; + /** + * + * @type {string | Array} + * @memberof InlineObject2 + */ + cve: string | Array; + /** + * Status ID to be set, obtained by GET method. If not specified, global CVE status is set. + * @type {number} + * @memberof InlineObject2 + */ + status_id?: number; + /** + * Complementary text to the status. + * @type {string} + * @memberof InlineObject2 + */ + status_text?: string | null; +} +/** + * + * @export + * @interface InlineObject3 + */ +export interface InlineObject3 { + /** + * + * @type {string | Array} + * @memberof InlineObject3 + */ + inventory_id: string | Array; + /** + * Opt out setting to be set. + * @type {boolean} + * @memberof InlineObject3 + */ + opt_out: boolean; +} +/** + * + * @export + * @interface InlineObject4 + */ +export interface InlineObject4 { + /** + * Array of CVEs to provide info about + * @type {Array} + * @memberof InlineObject4 + */ + cve_list: Array; +} +/** + * + * @export + * @interface InlineObject5 + */ +export interface InlineObject5 { + /** + * Enable or disable CVEs without Errata feature. + * @type {boolean} + * @memberof InlineObject5 + */ + enable: boolean; +} +/** + * + * @export + * @interface InlineResponse200 + */ +export interface InlineResponse200 { + /** + * Version of application. + * @type {string} + * @memberof InlineResponse200 + */ + application_version: string; + /** + * Version of database schema. + * @type {string | number} + * @memberof InlineResponse200 + */ + database_version: string | number; +} +/** + * + * @export + * @interface InlineResponse2001 + */ +export interface InlineResponse2001 { + /** + * List of available business risk/business_risk_id pairs. + * @type {Array} + * @memberof InlineResponse2001 + */ + data: Array; + /** + * + * @type {InlineResponse2001Meta} + * @memberof InlineResponse2001 + */ + meta: InlineResponse2001Meta; +} +/** + * + * @export + * @interface InlineResponse20010 + */ +export interface InlineResponse20010 { + /** + * List of available status/status_id pairs. + * @type {Array} + * @memberof InlineResponse20010 + */ + data: Array; + /** + * + * @type {InlineResponse20010Meta} + * @memberof InlineResponse20010 + */ + meta: InlineResponse20010Meta; +} +/** + * + * @export + * @interface InlineResponse20010Data + */ +export interface InlineResponse20010Data { + /** + * Internal status_id. + * @type {number} + * @memberof InlineResponse20010Data + */ + id: number; + /** + * Represenation of internal status_id. + * @type {string} + * @memberof InlineResponse20010Data + */ + name: string; +} +/** + * + * @export + * @interface InlineResponse20010Meta + */ +export interface InlineResponse20010Meta { + /** + * Total number of available status/status_id pairs. + * @type {number} + * @memberof InlineResponse20010Meta + */ + total_items: number; +} +/** + * + * @export + * @interface InlineResponse20011 + */ +export interface InlineResponse20011 { + /** + * List of updated objects/updated object IDs. + * @type {Array} + * @memberof InlineResponse20011 + */ + updated: Array; + /** + * + * @type {InlineResponse2002Meta} + * @memberof InlineResponse20011 + */ + meta?: InlineResponse2002Meta; +} +/** + * + * @export + * @interface InlineResponse20011Updated + */ +export interface InlineResponse20011Updated { + /** + * + * @type {string} + * @memberof InlineResponse20011Updated + */ + inventory_id: string; + /** + * + * @type {string} + * @memberof InlineResponse20011Updated + */ + cve: string; +} +/** + * + * @export + * @interface InlineResponse20012 + */ +export interface InlineResponse20012 { + /** + * + * @type {string | Array} + * @memberof InlineResponse20012 + */ + data: string | Array; + /** + * + * @type {InlineResponse2003Links} + * @memberof InlineResponse20012 + */ + links: InlineResponse2003Links; + /** + * + * @type {object} + * @memberof InlineResponse20012 + */ + meta: object; +} +/** + * + * @export + * @interface InlineResponse20013 + */ +export interface InlineResponse20013 { + /** + * + * @type {string | Array} + * @memberof InlineResponse20013 + */ + data: string | Array; + /** + * + * @type {InlineResponse2003Links} + * @memberof InlineResponse20013 + */ + links: InlineResponse2003Links; + /** + * + * @type {object} + * @memberof InlineResponse20013 + */ + meta: object; +} +/** + * + * @export + * @interface InlineResponse20014 + */ +export interface InlineResponse20014 { + /** + * + * @type {InlineResponse20014Data} + * @memberof InlineResponse20014 + */ + data: InlineResponse20014Data; + /** + * + * @type {InlineResponse2002Meta} + * @memberof InlineResponse20014 + */ + meta: InlineResponse2002Meta; +} +/** + * + * @export + * @interface InlineResponse20014Data + */ +export interface InlineResponse20014Data { + /** + * Date of last evaluation. + * @type {string} + * @memberof InlineResponse20014Data + */ + last_evaluation: string | null; + /** + * Date of last security rules evaluation. + * @type {string} + * @memberof InlineResponse20014Data + */ + rules_evaluation: string | null; + /** + * System opt out status. + * @type {boolean} + * @memberof InlineResponse20014Data + */ + opt_out: boolean; + /** + * Date of the latest upload of archive. + * @type {string} + * @memberof InlineResponse20014Data + */ + last_upload: string | null; + /** + * System stale status. + * @type {boolean} + * @memberof InlineResponse20014Data + */ + stale?: boolean; + /** + * Date of the lastest upload of archive taken from Inventory syndicated data. + * @type {string} + * @memberof InlineResponse20014Data + */ + updated?: string | null; + /** + * Operating system. + * @type {string} + * @memberof InlineResponse20014Data + */ + os: string; + /** + * System is locked to following RHSM version. + * @type {string} + * @memberof InlineResponse20014Data + */ + rhsm_lock: string | null; + /** + * + * @type {Array} + * @memberof InlineResponse20014Data + */ + tags: Array; + /** + * Type of the host + * @type {string} + * @memberof InlineResponse20014Data + */ + host_type: InlineResponse20014DataHostTypeEnum; +} + +/** + * @export + * @enum {string} + */ +export enum InlineResponse20014DataHostTypeEnum { + Rpmdnf = 'rpmdnf', + Image = 'image' +} + +/** + * + * @export + * @interface InlineResponse20014DataTags + */ +export interface InlineResponse20014DataTags { + /** + * Namespace of single tag. + * @type {string} + * @memberof InlineResponse20014DataTags + */ + namespace: string | null; + /** + * Key of the single tag. + * @type {string} + * @memberof InlineResponse20014DataTags + */ + key: string; + /** + * Value of the single tag. + * @type {string} + * @memberof InlineResponse20014DataTags + */ + value: string | null; +} +/** + * + * @export + * @interface InlineResponse20015 + */ +export interface InlineResponse20015 { + /** + * + * @type {string | Array} + * @memberof InlineResponse20015 + */ + data: string | Array; + /** + * + * @type {InlineResponse2003Links} + * @memberof InlineResponse20015 + */ + links: InlineResponse2003Links; + /** + * + * @type {object} + * @memberof InlineResponse20015 + */ + meta: object; +} +/** + * + * @export + * @interface InlineResponse20016 + */ +export interface InlineResponse20016 { + /** + * + * @type {string | Array} + * @memberof InlineResponse20016 + */ + data: string | Array; + /** + * + * @type {InlineResponse2003Links} + * @memberof InlineResponse20016 + */ + links: InlineResponse2003Links; + /** + * + * @type {object} + * @memberof InlineResponse20016 + */ + meta: object; +} +/** + * + * @export + * @interface InlineResponse20017 + */ +export interface InlineResponse20017 { + /** + * + * @type {string | Array} + * @memberof InlineResponse20017 + */ + data: string | Array; + /** + * + * @type {InlineResponse2003Links} + * @memberof InlineResponse20017 + */ + links: InlineResponse2003Links; + /** + * + * @type {object} + * @memberof InlineResponse20017 + */ + meta: object; +} +/** + * + * @export + * @interface InlineResponse20018 + */ +export interface InlineResponse20018 { + /** + * + * @type {Array} + * @memberof InlineResponse20018 + */ + data: Array; + /** + * + * @type {InlineResponse2003Links} + * @memberof InlineResponse20018 + */ + links: InlineResponse2003Links; + /** + * + * @type {object} + * @memberof InlineResponse20018 + */ + meta: object; +} +/** + * + * @export + * @interface InlineResponse20018Attributes + */ +export interface InlineResponse20018Attributes { + /** + * String representation of cvss3 or cvvs2 (if v3 is not present) score of the CVE. + * @type {string} + * @memberof InlineResponse20018Attributes + */ + cvss_score: string | null; + /** + * Red Hat security impact of the CVE. + * @type {string} + * @memberof InlineResponse20018Attributes + */ + impact: string; + /** + * Synopsis of the CVE. + * @type {string} + * @memberof InlineResponse20018Attributes + */ + synopsis: string; +} +/** + * + * @export + * @interface InlineResponse20018Data + */ +export interface InlineResponse20018Data { + /** + * CVE id. + * @type {string} + * @memberof InlineResponse20018Data + */ + id: string; + /** + * Type of the record. + * @type {string} + * @memberof InlineResponse20018Data + */ + type: string; + /** + * + * @type {InlineResponse20018Attributes} + * @memberof InlineResponse20018Data + */ + attributes: InlineResponse20018Attributes; } /** * * @export - * @interface AffectedSystemsOut + * @interface InlineResponse20019 */ -export interface AffectedSystemsOut { +export interface InlineResponse20019 { /** * * @type {string | Array} - * @memberof AffectedSystemsOut + * @memberof InlineResponse20019 */ data: string | Array; /** * - * @type {Links} - * @memberof AffectedSystemsOut + * @type {InlineResponse2003Links} + * @memberof InlineResponse20019 */ - links: Links; + links: InlineResponse2003Links; /** * - * @type {MetaAffectedSystems} - * @memberof AffectedSystemsOut + * @type {object} + * @memberof InlineResponse20019 */ - meta: MetaAffectedSystems; + meta: object; } /** * * @export - * @interface AnnouncementOut + * @interface InlineResponse2001Data */ -export interface AnnouncementOut { +export interface InlineResponse2001Data { + /** + * Internal business_risk_id. + * @type {number} + * @memberof InlineResponse2001Data + */ + id: number; + /** + * Represenation of internal business_risk_id. + * @type {string} + * @memberof InlineResponse2001Data + */ + name: string; +} +/** + * + * @export + * @interface InlineResponse2001Meta + */ +export interface InlineResponse2001Meta { + /** + * Total number of available business risk/business_risk_id pairs. + * @type {number} + * @memberof InlineResponse2001Meta + */ + total_items: number; +} +/** + * + * @export + * @interface InlineResponse2002 + */ +export interface InlineResponse2002 { + /** + * + * @type {InlineResponse2002Data} + * @memberof InlineResponse2002 + */ + data?: InlineResponse2002Data; + /** + * + * @type {InlineResponse2002Meta} + * @memberof InlineResponse2002 + */ + meta?: InlineResponse2002Meta; +} +/** + * + * @export + * @interface InlineResponse20020 + */ +export interface InlineResponse20020 { /** * Announcement message. * @type {string} - * @memberof AnnouncementOut + * @memberof InlineResponse20020 */ message: string; /** * Datetime string. * @type {string} - * @memberof AnnouncementOut + * @memberof InlineResponse20020 */ last_updated: string; } /** * * @export - * @interface BulkChangeOut + * @interface InlineResponse20021 */ -export interface BulkChangeOut { +export interface InlineResponse20021 { /** - * List of updated objects/updated object IDs. - * @type {Array} - * @memberof BulkChangeOut + * + * @type {number} + * @memberof InlineResponse20021 */ - updated: Array; + exploitable_cves?: number; /** * - * @type {MetaPermissions} - * @memberof BulkChangeOut + * @type {number} + * @memberof InlineResponse20021 + */ + cves_with_rule?: number; + /** + * + * @type {number} + * @memberof InlineResponse20021 + */ + critical_cves?: number; + /** + * + * @type {number} + * @memberof InlineResponse20021 */ - meta?: MetaPermissions; + important_cves?: number; } /** * * @export - * @interface BusinessRiskListOut + * @interface InlineResponse20022 */ -export interface BusinessRiskListOut { - /** - * List of available business risk/business_risk_id pairs. - * @type {Array} - * @memberof BusinessRiskListOut - */ - data: Array; +export interface InlineResponse20022 { /** * - * @type {BusinessRiskListOutMeta} - * @memberof BusinessRiskListOut + * @type {InlineResponse20022CvesWithoutErrata} + * @memberof InlineResponse20022 */ - meta: BusinessRiskListOutMeta; + cves_without_errata: InlineResponse20022CvesWithoutErrata; } /** * * @export - * @interface BusinessRiskListOutData + * @interface InlineResponse20022CvesWithoutErrata */ -export interface BusinessRiskListOutData { - /** - * Internal business_risk_id. - * @type {number} - * @memberof BusinessRiskListOutData - */ - id: number; +export interface InlineResponse20022CvesWithoutErrata { /** - * Represenation of internal business_risk_id. - * @type {string} - * @memberof BusinessRiskListOutData + * + * @type {boolean} + * @memberof InlineResponse20022CvesWithoutErrata */ - name: string; + enabled?: boolean; } /** * * @export - * @interface BusinessRiskListOutMeta + * @interface InlineResponse20023 */ -export interface BusinessRiskListOutMeta { +export interface InlineResponse20023 { /** - * Total number of available business risk/business_risk_id pairs. - * @type {number} - * @memberof BusinessRiskListOutMeta + * + * @type {InlineResponse20023Updated} + * @memberof InlineResponse20023 */ - total_items: number; + updated: InlineResponse20023Updated; + /** + * + * @type {InlineResponse2002Meta} + * @memberof InlineResponse20023 + */ + meta: InlineResponse2002Meta; } /** * * @export - * @interface CveDetailOut + * @interface InlineResponse20023Updated */ -export interface CveDetailOut { +export interface InlineResponse20023Updated { /** * - * @type {CveDetailOutData} - * @memberof CveDetailOut + * @type {string} + * @memberof InlineResponse20023Updated */ - data?: CveDetailOutData; + org_id?: string; /** * - * @type {MetaPermissions} - * @memberof CveDetailOut + * @type {InlineResponse20022CvesWithoutErrata} + * @memberof InlineResponse20023Updated + */ + cves_without_errata?: InlineResponse20022CvesWithoutErrata; +} +/** + * + * @export + * @interface InlineResponse20024 + */ +export interface InlineResponse20024 { + /** + * Number of deleted notifications for CVEs + * @type {number} + * @memberof InlineResponse20024 */ - meta?: MetaPermissions; + deleted: number; } /** * * @export - * @interface CveDetailOutData + * @interface InlineResponse2002Data */ -export interface CveDetailOutData { +export interface InlineResponse2002Data { /** * CVE id. * @type {string} - * @memberof CveDetailOutData + * @memberof InlineResponse2002Data */ id: string; /** * Type of the record. * @type {string} - * @memberof CveDetailOutData + * @memberof InlineResponse2002Data */ type: string; /** * - * @type {CveDetailOutDataAttributes} - * @memberof CveDetailOutData + * @type {InlineResponse2002DataAttributes} + * @memberof InlineResponse2002Data */ - attributes: CveDetailOutDataAttributes; + attributes: InlineResponse2002DataAttributes; } /** * * @export - * @interface CveDetailOutDataAttributes + * @interface InlineResponse2002DataAttributes */ -export interface CveDetailOutDataAttributes { +export interface InlineResponse2002DataAttributes { /** * Business risk of the vulnerability. * @type {string} - * @memberof CveDetailOutDataAttributes + * @memberof InlineResponse2002DataAttributes */ business_risk: string; /** * Internal ID of the vulnerability business risk. * @type {number} - * @memberof CveDetailOutDataAttributes + * @memberof InlineResponse2002DataAttributes */ business_risk_id: number; /** * Complementary text to the business risk. * @type {string} - * @memberof CveDetailOutDataAttributes + * @memberof InlineResponse2002DataAttributes */ business_risk_text: string | null; /** * \"Celebrity\" name of the CVE. * @type {string} - * @memberof CveDetailOutDataAttributes + * @memberof InlineResponse2002DataAttributes */ celebrity_name: string | null; /** * cvss2 metrics of the CVE. * @type {string} - * @memberof CveDetailOutDataAttributes + * @memberof InlineResponse2002DataAttributes */ cvss2_metrics: string | null; /** * String representation of cvss2 score of the CVE. * @type {string} - * @memberof CveDetailOutDataAttributes + * @memberof InlineResponse2002DataAttributes */ cvss2_score: string | null; /** * cvss3 metrics of the CVE. * @type {string} - * @memberof CveDetailOutDataAttributes + * @memberof InlineResponse2002DataAttributes */ cvss3_metrics: string | null; /** * String representation of cvss3 score of the CVE. * @type {string} - * @memberof CveDetailOutDataAttributes + * @memberof InlineResponse2002DataAttributes */ cvss3_score: string | null; /** * Description of the CVE. * @type {string} - * @memberof CveDetailOutDataAttributes + * @memberof InlineResponse2002DataAttributes */ description: string; /** * String representation of ISO-8601 formatted date of last modification of the CVE. * @type {string} - * @memberof CveDetailOutDataAttributes + * @memberof InlineResponse2002DataAttributes */ modified_date: string | null; /** * Red Hat security impact of the CVE. * @type {string} - * @memberof CveDetailOutDataAttributes + * @memberof InlineResponse2002DataAttributes */ impact: string; /** * String representation of ISO-8601 formatted date of first public disclosure of the CVE. * @type {string} - * @memberof CveDetailOutDataAttributes + * @memberof InlineResponse2002DataAttributes */ public_date: string | null; /** * Additional resource about the CVE, provided by Red Hat. * @type {string} - * @memberof CveDetailOutDataAttributes + * @memberof InlineResponse2002DataAttributes */ redhat_url: string | null; /** * - * @type {Array} - * @memberof CveDetailOutDataAttributes + * @type {Array} + * @memberof InlineResponse2002DataAttributes */ - rules: Array; + rules: Array; /** * Additional resources about the CVE. * @type {string} - * @memberof CveDetailOutDataAttributes + * @memberof InlineResponse2002DataAttributes */ secondary_url: string | null; /** * Status of the vulnerability. * @type {string} - * @memberof CveDetailOutDataAttributes + * @memberof InlineResponse2002DataAttributes */ status: string; /** * Internal ID of the vulnerability status. * @type {number} - * @memberof CveDetailOutDataAttributes + * @memberof InlineResponse2002DataAttributes */ status_id: number; /** * Complementary text to the status. * @type {string} - * @memberof CveDetailOutDataAttributes + * @memberof InlineResponse2002DataAttributes */ status_text: string | null; /** * Synopsis of the CVE. * @type {string} - * @memberof CveDetailOutDataAttributes + * @memberof InlineResponse2002DataAttributes */ synopsis: string; /** * Counts of systems with given status type. * @type {object} - * @memberof CveDetailOutDataAttributes + * @memberof InlineResponse2002DataAttributes */ systems_status_detail: object; /** * How many systems-CVE pairs have different status than CVE-level. * @type {number} - * @memberof CveDetailOutDataAttributes + * @memberof InlineResponse2002DataAttributes */ systems_status_divergent: number; /** * List of advisory names or detailed advisory information * @type {Array} - * @memberof CveDetailOutDataAttributes + * @memberof InlineResponse2002DataAttributes */ advisories_list: Array | null; /** * Shows whether a CVE has known exploits or not * @type {boolean} - * @memberof CveDetailOutDataAttributes + * @memberof InlineResponse2002DataAttributes */ known_exploit: boolean; /** * Number of systems that are affected by given CVE but are not vulnerable. * @type {number} - * @memberof CveDetailOutDataAttributes + * @memberof InlineResponse2002DataAttributes */ affected_but_not_vulnerable: number | null; /** * Number of systems that are overall affected by given CVE * @type {number} - * @memberof CveDetailOutDataAttributes + * @memberof InlineResponse2002DataAttributes */ affected_systems?: number | null; } -/** - * @type CveOrList - * @export - */ -export type CveOrList = Array | string; - /** * * @export - * @interface CveRiskIn + * @interface InlineResponse2002DataAttributesRules */ -export interface CveRiskIn { +export interface InlineResponse2002DataAttributesRules { /** - * - * @type {CveOrList} - * @memberof CveRiskIn + * ID(s) of associated security rule(s). + * @type {string} + * @memberof InlineResponse2002DataAttributesRules */ - cve: CveOrList; + rule_id: string; /** - * Business risk ID to be set, obtained by GET method. - * @type {number} - * @memberof CveRiskIn + * Description of the rule. + * @type {string} + * @memberof InlineResponse2002DataAttributesRules */ - business_risk_id?: number; + description: string | null; /** - * Complementary text to the business risk. + * Summary of the rule. * @type {string} - * @memberof CveRiskIn + * @memberof InlineResponse2002DataAttributesRules */ - business_risk_text?: string | null; -} -/** - * - * @export - * @interface CveStatusIn - */ -export interface CveStatusIn { + summary: string | null; /** - * - * @type {CveOrList} - * @memberof CveStatusIn + * Indicator whter reboot is required to mitigate vulnerability. + * @type {boolean} + * @memberof InlineResponse2002DataAttributesRules */ - cve: CveOrList; + reboot_required: boolean | null; /** - * Status ID to be set, obtained by GET method. + * Number of available Ansible playbooks for remediation/mitigation. * @type {number} - * @memberof CveStatusIn + * @memberof InlineResponse2002DataAttributesRules */ - status_id?: number; + playbook_count: number | null; /** - * Complementary text to the status. + * Indicates how likely remediation can change environment on the remediatied system. + * @type {number} + * @memberof InlineResponse2002DataAttributesRules + */ + change_risk: number | null; + /** + * ID of associated Red Hat knowledgebase article. + * @type {number} + * @memberof InlineResponse2002DataAttributesRules + */ + kbase_node_id: number | null; + /** + * List of CVEs associated with the rule. + * @type {Array} + * @memberof InlineResponse2002DataAttributesRules + */ + associated_cves: Array; + /** + * Shows rules impact number from 1 to 4 + * @type {number} + * @memberof InlineResponse2002DataAttributesRules + */ + rule_impact: number | null; + /** + * Number of systems affected by the rule. + * @type {number} + * @memberof InlineResponse2002DataAttributesRules + */ + systems_affected?: number; + /** + * Date when the rule was published. * @type {string} - * @memberof CveStatusIn + * @memberof InlineResponse2002DataAttributesRules */ - status_text?: string | null; + publish_date: string | null; } /** * * @export - * @interface CvesWithoutErrataIn + * @interface InlineResponse2002Meta */ -export interface CvesWithoutErrataIn { +export interface InlineResponse2002Meta { /** - * Enable or disable CVEs without Errata feature. - * @type {boolean} - * @memberof CvesWithoutErrataIn + * Fetched permissions from RBAC for given user + * @type {Array} + * @memberof InlineResponse2002Meta */ - enable: boolean; + permissions: Array; } /** * * @export - * @interface CvesWithoutErrataOut + * @interface InlineResponse2003 */ -export interface CvesWithoutErrataOut { +export interface InlineResponse2003 { /** * - * @type {CvesWithoutErrataOutUpdated} - * @memberof CvesWithoutErrataOut + * @type {string | Array} + * @memberof InlineResponse2003 */ - updated: CvesWithoutErrataOutUpdated; + data: string | Array; /** * - * @type {MetaPermissions} - * @memberof CvesWithoutErrataOut + * @type {InlineResponse2003Links} + * @memberof InlineResponse2003 + */ + links: InlineResponse2003Links; + /** + * + * @type {object} + * @memberof InlineResponse2003 */ - meta: MetaPermissions; + meta: object; } /** * * @export - * @interface CvesWithoutErrataOutUpdated + * @interface InlineResponse2003Links */ -export interface CvesWithoutErrataOutUpdated { +export interface InlineResponse2003Links { /** - * + * Link to first page. * @type {string} - * @memberof CvesWithoutErrataOutUpdated + * @memberof InlineResponse2003Links */ - org_id?: string; + first: string; /** - * - * @type {CvesWithoutErrataOutUpdatedCvesWithoutErrata} - * @memberof CvesWithoutErrataOutUpdated + * Link to last page. + * @type {string} + * @memberof InlineResponse2003Links */ - cves_without_errata?: CvesWithoutErrataOutUpdatedCvesWithoutErrata; -} -/** - * - * @export - * @interface CvesWithoutErrataOutUpdatedCvesWithoutErrata - */ -export interface CvesWithoutErrataOutUpdatedCvesWithoutErrata { + last: string; /** - * - * @type {boolean} - * @memberof CvesWithoutErrataOutUpdatedCvesWithoutErrata + * Link to next page. + * @type {string} + * @memberof InlineResponse2003Links */ - enabled?: boolean; + next: string | null; + /** + * Link to next page. + * @type {string} + * @memberof InlineResponse2003Links + */ + previous: string | null; } /** * * @export - * @interface DashbarOut + * @interface InlineResponse2004 */ -export interface DashbarOut { +export interface InlineResponse2004 { /** * - * @type {number} - * @memberof DashbarOut + * @type {string | Array} + * @memberof InlineResponse2004 */ - exploitable_cves?: number; + data: string | Array; /** * - * @type {number} - * @memberof DashbarOut + * @type {InlineResponse2003Links} + * @memberof InlineResponse2004 */ - cves_with_rule?: number; + links: InlineResponse2003Links; /** * - * @type {number} - * @memberof DashbarOut + * @type {object} + * @memberof InlineResponse2004 */ - critical_cves?: number; + meta: object; +} +/** + * + * @export + * @interface InlineResponse2005 + */ +export interface InlineResponse2005 { + /** + * List of updated objects/updated object IDs. + * @type {Array} + * @memberof InlineResponse2005 + */ + updated: Array; /** * - * @type {number} - * @memberof DashbarOut + * @type {InlineResponse2002Meta} + * @memberof InlineResponse2005 */ - important_cves?: number; + meta?: InlineResponse2002Meta; } /** * * @export - * @interface Dashboard + * @interface InlineResponse2006 */ -export interface Dashboard { +export interface InlineResponse2006 { /** * Number of unique CVEs discovered on the managed systems. * @type {number} - * @memberof Dashboard + * @memberof InlineResponse2006 */ cves_total: number; /** * - * @type {DashboardCvesBySeverity} - * @memberof Dashboard + * @type {InlineResponse2006CvesBySeverity} + * @memberof InlineResponse2006 */ - cves_by_severity: DashboardCvesBySeverity; + cves_by_severity: InlineResponse2006CvesBySeverity; /** * - * @type {ExecutiveReportRecentCves} - * @memberof Dashboard + * @type {InlineResponse2006RecentCves} + * @memberof InlineResponse2006 */ - recent_cves: ExecutiveReportRecentCves; + recent_cves: InlineResponse2006RecentCves; /** * List of recently (14 days) released security rules. - * @type {Array} - * @memberof Dashboard + * @type {Array} + * @memberof InlineResponse2006 */ - recent_rules: Array; + recent_rules: Array; /** * Total number of CVEs with associated security rules affecting given account. * @type {number} - * @memberof Dashboard + * @memberof InlineResponse2006 */ rules_cves_total: number; /** * Total systems registered to Vulnerability service (with applied filtering). * @type {number} - * @memberof Dashboard + * @memberof InlineResponse2006 */ system_count: number; /** * unique number of CVEs having known exploit affecting at least one system * @type {number} - * @memberof Dashboard + * @memberof InlineResponse2006 */ exploited_cves_count: number; } /** * Number of CVEs discovered on the managed systems, divided into buckets based on their CVSSv3 score (CVSSv2 is used when CVSSv3 is not available). * @export - * @interface DashboardCvesBySeverity + * @interface InlineResponse2006CvesBySeverity */ -export interface DashboardCvesBySeverity { +export interface InlineResponse2006CvesBySeverity { /** * - * @type {DashboardCvesBySeverity0to39} - * @memberof DashboardCvesBySeverity + * @type {InlineResponse2006CvesBySeverity0to39} + * @memberof InlineResponse2006CvesBySeverity */ - _0to3_9: DashboardCvesBySeverity0to39; + _0to3_9: InlineResponse2006CvesBySeverity0to39; /** * - * @type {DashboardCvesBySeverity4to79} - * @memberof DashboardCvesBySeverity + * @type {InlineResponse2006CvesBySeverity4to79} + * @memberof InlineResponse2006CvesBySeverity */ - _4to7_9: DashboardCvesBySeverity4to79; + _4to7_9: InlineResponse2006CvesBySeverity4to79; /** * - * @type {DashboardCvesBySeverity8to10} - * @memberof DashboardCvesBySeverity + * @type {InlineResponse2006CvesBySeverity8to10} + * @memberof InlineResponse2006CvesBySeverity */ - _8to10: DashboardCvesBySeverity8to10; + _8to10: InlineResponse2006CvesBySeverity8to10; } /** * * @export - * @interface DashboardCvesBySeverity0to39 + * @interface InlineResponse2006CvesBySeverity0to39 */ -export interface DashboardCvesBySeverity0to39 { +export interface InlineResponse2006CvesBySeverity0to39 { /** * Number of CVEs with CVSS score lower than 4. * @type {number} - * @memberof DashboardCvesBySeverity0to39 + * @memberof InlineResponse2006CvesBySeverity0to39 */ count: number; /** * Percentage of CVEs with CVSS score lower than 4. * @type {number} - * @memberof DashboardCvesBySeverity0to39 + * @memberof InlineResponse2006CvesBySeverity0to39 */ percentage: number; /** * Number of CVEs in given bracket with a known exploit. * @type {number} - * @memberof DashboardCvesBySeverity0to39 + * @memberof InlineResponse2006CvesBySeverity0to39 */ known_exploits?: number; } /** * * @export - * @interface DashboardCvesBySeverity4to79 + * @interface InlineResponse2006CvesBySeverity4to79 */ -export interface DashboardCvesBySeverity4to79 { +export interface InlineResponse2006CvesBySeverity4to79 { /** * Number of CVEs with CVSS score higher or equal to 4 and lower then 8. * @type {number} - * @memberof DashboardCvesBySeverity4to79 + * @memberof InlineResponse2006CvesBySeverity4to79 */ count: number; /** * Percentage of CVEs with CVSS score higher or equal to 4 and lower then 8. * @type {number} - * @memberof DashboardCvesBySeverity4to79 + * @memberof InlineResponse2006CvesBySeverity4to79 */ percentage: number; /** * Number of CVEs in given bracket with a known exploit. * @type {number} - * @memberof DashboardCvesBySeverity4to79 + * @memberof InlineResponse2006CvesBySeverity4to79 */ known_exploits?: number; } /** * * @export - * @interface DashboardCvesBySeverity8to10 + * @interface InlineResponse2006CvesBySeverity8to10 */ -export interface DashboardCvesBySeverity8to10 { +export interface InlineResponse2006CvesBySeverity8to10 { /** * Number of CVEs with CVSS score higher or equal to 8. * @type {number} - * @memberof DashboardCvesBySeverity8to10 + * @memberof InlineResponse2006CvesBySeverity8to10 */ count: number; /** * Percentage of CVEs with CVSS score higher or equal to 8. * @type {number} - * @memberof DashboardCvesBySeverity8to10 + * @memberof InlineResponse2006CvesBySeverity8to10 */ percentage: number; /** * Number of CVEs in given bracket with a known exploit. * @type {number} - * @memberof DashboardCvesBySeverity8to10 + * @memberof InlineResponse2006CvesBySeverity8to10 */ known_exploits?: number; } +/** + * Number of recently published CVEs identified on managed systems + * @export + * @interface InlineResponse2006RecentCves + */ +export interface InlineResponse2006RecentCves { + /** + * Number of CVEs identified on managed systems published in last 7 days. + * @type {number} + * @memberof InlineResponse2006RecentCves + */ + last7days: number; + /** + * Number of CVEs identified on managed systems published in last 30 days. + * @type {number} + * @memberof InlineResponse2006RecentCves + */ + last30days: number; + /** + * Number of CVEs identified on managed systems published in last 90 days. + * @type {number} + * @memberof InlineResponse2006RecentCves + */ + last90days: number; +} /** * Security rule. * @export - * @interface DashboardRecentRules + * @interface InlineResponse2006RecentRules */ -export interface DashboardRecentRules { +export interface InlineResponse2006RecentRules { /** * List of CVEs associated with the security rule. * @type {Array} - * @memberof DashboardRecentRules + * @memberof InlineResponse2006RecentRules */ associated_cves?: Array; /** * Description of the issue related with the security rule. * @type {string} - * @memberof DashboardRecentRules + * @memberof InlineResponse2006RecentRules */ description?: string; /** * ID of the security rule. * @type {string} - * @memberof DashboardRecentRules + * @memberof InlineResponse2006RecentRules */ id?: string; /** * Name of the security rule. * @type {string} - * @memberof DashboardRecentRules + * @memberof InlineResponse2006RecentRules */ name?: string; /** * Node id of access.redhat.com/node/_* article. * @type {number} - * @memberof DashboardRecentRules + * @memberof InlineResponse2006RecentRules */ node_id?: number | null; /** * String representation of ISO-8601 formatted date of release of the security rule. * @type {string} - * @memberof DashboardRecentRules + * @memberof InlineResponse2006RecentRules */ public_date?: string | null; /** * Number representation of the security rule severity. * @type {number} - * @memberof DashboardRecentRules + * @memberof InlineResponse2006RecentRules */ severity?: number; /** * Number of systems triggering the security rule. * @type {number} - * @memberof DashboardRecentRules + * @memberof InlineResponse2006RecentRules */ systems_affected?: number; } /** * * @export - * @interface Errors + * @interface InlineResponse2007 */ -export interface Errors { +export interface InlineResponse2007 { /** * - * @type {Array} - * @memberof Errors + * @type {Array} + * @memberof InlineResponse2007 */ - errors: Array; + data?: Array; } /** * * @export - * @interface ErrorsErrors + * @interface InlineResponse2007Data */ -export interface ErrorsErrors { +export interface InlineResponse2007Data { /** - * - * @type {string | object} - * @memberof ErrorsErrors + * Playbook template description. + * @type {string} + * @memberof InlineResponse2007Data */ - detail: string | object; + description: string; /** - * String representation of HTTP status code. + * Actual playbook template. * @type {string} - * @memberof ErrorsErrors + * @memberof InlineResponse2007Data */ - status: string; + play: string; + /** + * Revision of the playbook template. + * @type {string} + * @memberof InlineResponse2007Data + */ + version: string; + /** + * Indicator whter reboot is required to mitigate vulnerability. + * @type {boolean} + * @memberof InlineResponse2007Data + */ + reboot_required?: boolean | null; + /** + * Type of the resolution provided by playbook. + * @type {string} + * @memberof InlineResponse2007Data + */ + resolution_type: string; } /** * * @export - * @interface ExecutiveReport + * @interface InlineResponse2008 */ -export interface ExecutiveReport { +export interface InlineResponse2008 { /** * - * @type {MetaVulnerabilitiesOutAllOfSystemCountPerType} - * @memberof ExecutiveReport + * @type {InlineResponse2008SystemCountPerType} + * @memberof InlineResponse2008 */ - system_count_per_type?: MetaVulnerabilitiesOutAllOfSystemCountPerType; + system_count_per_type?: InlineResponse2008SystemCountPerType; /** * Total number of systems managed by vulnerability application. * @type {number} - * @memberof ExecutiveReport + * @memberof InlineResponse2008 */ system_count: number; /** * Number of unique CVEs discovered on the managed systems. * @type {number} - * @memberof ExecutiveReport + * @memberof InlineResponse2008 */ cves_total: number; /** * - * @type {ExecutiveReportCvesBySeverity} - * @memberof ExecutiveReport + * @type {InlineResponse2008CvesBySeverity} + * @memberof InlineResponse2008 */ - cves_by_severity: ExecutiveReportCvesBySeverity; + cves_by_severity: InlineResponse2008CvesBySeverity; /** * - * @type {ExecutiveReportRecentCves} - * @memberof ExecutiveReport + * @type {InlineResponse2006RecentCves} + * @memberof InlineResponse2008 */ - recent_cves: ExecutiveReportRecentCves; + recent_cves: InlineResponse2006RecentCves; /** * - * @type {ExecutiveReportRulesBySeverity} - * @memberof ExecutiveReport + * @type {InlineResponse2008RulesBySeverity} + * @memberof InlineResponse2008 */ - rules_by_severity: ExecutiveReportRulesBySeverity; + rules_by_severity: InlineResponse2008RulesBySeverity; /** * Number of unique CVEs discovered on the managed systems. * @type {number} - * @memberof ExecutiveReport + * @memberof InlineResponse2008 */ rules_total: number; /** * - * @type {Array} - * @memberof ExecutiveReport + * @type {Array} + * @memberof InlineResponse2008 */ - top_cves?: Array; + top_cves?: Array; /** * - * @type {Array} - * @memberof ExecutiveReport + * @type {Array} + * @memberof InlineResponse2008 */ - top_rules?: Array; + top_rules?: Array; /** * - * @type {MetaPermissions} - * @memberof ExecutiveReport + * @type {InlineResponse2002Meta} + * @memberof InlineResponse2008 */ - meta?: MetaPermissions; + meta?: InlineResponse2002Meta; } /** * Number of CVEs discovered on the managed systems, divided into buckets based on their CVSSv3 score (CVSSv2 is used when CVSSv3 is not available). * @export - * @interface ExecutiveReportCvesBySeverity + * @interface InlineResponse2008CvesBySeverity */ -export interface ExecutiveReportCvesBySeverity { +export interface InlineResponse2008CvesBySeverity { /** * - * @type {ExecutiveReportCvesBySeverity0to39} - * @memberof ExecutiveReportCvesBySeverity + * @type {InlineResponse2008CvesBySeverity0to39} + * @memberof InlineResponse2008CvesBySeverity */ - _0to3_9: ExecutiveReportCvesBySeverity0to39; + _0to3_9: InlineResponse2008CvesBySeverity0to39; /** * - * @type {ExecutiveReportCvesBySeverity4to79} - * @memberof ExecutiveReportCvesBySeverity + * @type {InlineResponse2008CvesBySeverity4to79} + * @memberof InlineResponse2008CvesBySeverity */ - _4to7_9: ExecutiveReportCvesBySeverity4to79; + _4to7_9: InlineResponse2008CvesBySeverity4to79; /** * - * @type {ExecutiveReportCvesBySeverity8to10} - * @memberof ExecutiveReportCvesBySeverity + * @type {InlineResponse2008CvesBySeverity8to10} + * @memberof InlineResponse2008CvesBySeverity */ - _8to10: ExecutiveReportCvesBySeverity8to10; + _8to10: InlineResponse2008CvesBySeverity8to10; } /** * * @export - * @interface ExecutiveReportCvesBySeverity0to39 + * @interface InlineResponse2008CvesBySeverity0to39 */ -export interface ExecutiveReportCvesBySeverity0to39 { +export interface InlineResponse2008CvesBySeverity0to39 { /** * Number of CVEs with CVSS score lower than 4. * @type {number} - * @memberof ExecutiveReportCvesBySeverity0to39 + * @memberof InlineResponse2008CvesBySeverity0to39 */ count: number; /** * Percentage of CVEs with CVSS score lower than 4. * @type {number} - * @memberof ExecutiveReportCvesBySeverity0to39 + * @memberof InlineResponse2008CvesBySeverity0to39 */ percentage: number; } /** * * @export - * @interface ExecutiveReportCvesBySeverity4to79 + * @interface InlineResponse2008CvesBySeverity4to79 */ -export interface ExecutiveReportCvesBySeverity4to79 { +export interface InlineResponse2008CvesBySeverity4to79 { /** * Number of CVEs with CVSS score higher or equal to 4 and lower then 8. * @type {number} - * @memberof ExecutiveReportCvesBySeverity4to79 + * @memberof InlineResponse2008CvesBySeverity4to79 */ count: number; /** * Percentage of CVEs with CVSS score higher or equal to 4 and lower then 8. * @type {number} - * @memberof ExecutiveReportCvesBySeverity4to79 + * @memberof InlineResponse2008CvesBySeverity4to79 */ percentage: number; } /** * * @export - * @interface ExecutiveReportCvesBySeverity8to10 + * @interface InlineResponse2008CvesBySeverity8to10 */ -export interface ExecutiveReportCvesBySeverity8to10 { +export interface InlineResponse2008CvesBySeverity8to10 { /** * Number of CVEs with CVSS score higher or equal to 8. * @type {number} - * @memberof ExecutiveReportCvesBySeverity8to10 + * @memberof InlineResponse2008CvesBySeverity8to10 */ count: number; /** * Percentage of CVEs with CVSS score higher or equal to 8. * @type {number} - * @memberof ExecutiveReportCvesBySeverity8to10 + * @memberof InlineResponse2008CvesBySeverity8to10 */ percentage: number; } -/** - * Number of recently published CVEs identified on managed systems - * @export - * @interface ExecutiveReportRecentCves - */ -export interface ExecutiveReportRecentCves { - /** - * Number of CVEs identified on managed systems published in last 7 days. - * @type {number} - * @memberof ExecutiveReportRecentCves - */ - last7days: number; - /** - * Number of CVEs identified on managed systems published in last 30 days. - * @type {number} - * @memberof ExecutiveReportRecentCves - */ - last30days: number; - /** - * Number of CVEs identified on managed systems published in last 90 days. - * @type {number} - * @memberof ExecutiveReportRecentCves - */ - last90days: number; -} /** * Information about how much systems are affected by a security rule, broken down by rule severity. * @export - * @interface ExecutiveReportRulesBySeverity + * @interface InlineResponse2008RulesBySeverity */ -export interface ExecutiveReportRulesBySeverity { +export interface InlineResponse2008RulesBySeverity { /** * - * @type {ExecutiveReportRulesBySeverity1} - * @memberof ExecutiveReportRulesBySeverity + * @type {InlineResponse2008RulesBySeverity1} + * @memberof InlineResponse2008RulesBySeverity */ - _1: ExecutiveReportRulesBySeverity1; + _1: InlineResponse2008RulesBySeverity1; /** * - * @type {ExecutiveReportRulesBySeverity1} - * @memberof ExecutiveReportRulesBySeverity + * @type {InlineResponse2008RulesBySeverity1} + * @memberof InlineResponse2008RulesBySeverity */ - _2: ExecutiveReportRulesBySeverity1; + _2: InlineResponse2008RulesBySeverity1; /** * - * @type {ExecutiveReportRulesBySeverity1} - * @memberof ExecutiveReportRulesBySeverity + * @type {InlineResponse2008RulesBySeverity1} + * @memberof InlineResponse2008RulesBySeverity */ - _3: ExecutiveReportRulesBySeverity1; + _3: InlineResponse2008RulesBySeverity1; /** * - * @type {ExecutiveReportRulesBySeverity1} - * @memberof ExecutiveReportRulesBySeverity + * @type {InlineResponse2008RulesBySeverity1} + * @memberof InlineResponse2008RulesBySeverity */ - _4: ExecutiveReportRulesBySeverity1; + _4: InlineResponse2008RulesBySeverity1; } /** * * @export - * @interface ExecutiveReportRulesBySeverity1 + * @interface InlineResponse2008RulesBySeverity1 */ -export interface ExecutiveReportRulesBySeverity1 { +export interface InlineResponse2008RulesBySeverity1 { /** * How many unique rules with at least system affected are present. * @type {number} - * @memberof ExecutiveReportRulesBySeverity1 + * @memberof InlineResponse2008RulesBySeverity1 */ rule_count: number; /** * How many unique systems are affected by at least one rules with given severity * @type {number} - * @memberof ExecutiveReportRulesBySeverity1 + * @memberof InlineResponse2008RulesBySeverity1 */ systems_affected: number; } +/** + * Number of systems managed by vulnerability application, grouped by host type. + * @export + * @interface InlineResponse2008SystemCountPerType + */ +export interface InlineResponse2008SystemCountPerType { + /** + * Number of conventional systems. + * @type {number} + * @memberof InlineResponse2008SystemCountPerType + */ + rpmdnf?: number; + /** + * Number of image-mode systems. + * @type {number} + * @memberof InlineResponse2008SystemCountPerType + */ + image?: number | null; + /** + * Number of image-mode systems. (Deprecated) + * @type {number} + * @memberof InlineResponse2008SystemCountPerType + */ + edge?: number | null; +} /** * * @export - * @interface ExecutiveReportTopCves + * @interface InlineResponse2008TopCves */ -export interface ExecutiveReportTopCves { +export interface InlineResponse2008TopCves { /** * CVE synopsis * @type {string} - * @memberof ExecutiveReportTopCves + * @memberof InlineResponse2008TopCves */ synopsis: string; /** * String representation of cvss2 score of the CVE. * @type {string} - * @memberof ExecutiveReportTopCves + * @memberof InlineResponse2008TopCves */ cvss2_score: string | null; /** * String representation of cvss3 score of the CVE. * @type {string} - * @memberof ExecutiveReportTopCves + * @memberof InlineResponse2008TopCves */ cvss3_score: string | null; /** * Description of the CVE. * @type {string} - * @memberof ExecutiveReportTopCves + * @memberof InlineResponse2008TopCves */ description: string; /** * Indicator of security rule presence * @type {boolean} - * @memberof ExecutiveReportTopCves + * @memberof InlineResponse2008TopCves */ security_rule?: boolean; /** * Indicator of security rule presence * @type {boolean} - * @memberof ExecutiveReportTopCves + * @memberof InlineResponse2008TopCves */ rule_presence?: boolean; /** * Systems affected by the CVE. * @type {number} - * @memberof ExecutiveReportTopCves + * @memberof InlineResponse2008TopCves */ systems_affected: number; /** * Shows whether a CVE has known exploits or not * @type {boolean} - * @memberof ExecutiveReportTopCves + * @memberof InlineResponse2008TopCves */ known_exploit: boolean; } /** * * @export - * @interface ExecutiveReportTopRules + * @interface InlineResponse2008TopRules */ -export interface ExecutiveReportTopRules { +export interface InlineResponse2008TopRules { /** * All CVEs associated with the rule * @type {Array} - * @memberof ExecutiveReportTopRules + * @memberof InlineResponse2008TopRules */ associated_cves: Array; /** * Brief description of the issue. * @type {string} - * @memberof ExecutiveReportTopRules + * @memberof InlineResponse2008TopRules */ description: string; /** * ID of associated security rule. * @type {string} - * @memberof ExecutiveReportTopRules + * @memberof InlineResponse2008TopRules */ rule_id: string; /** * Name of the security rule. * @type {string} - * @memberof ExecutiveReportTopRules + * @memberof InlineResponse2008TopRules */ name: string; /** * Severity of the security rule. * @type {number} - * @memberof ExecutiveReportTopRules + * @memberof InlineResponse2008TopRules */ severity: number; /** * Number of systems affected by the rule. * @type {number} - * @memberof ExecutiveReportTopRules + * @memberof InlineResponse2008TopRules */ systems_affected: number; } +/** + * + * @export + * @interface InlineResponse2009 + */ +export interface InlineResponse2009 { + /** + * + * @type {string | Array} + * @memberof InlineResponse2009 + */ + data: string | Array; +} +/** + * + * @export + * @interface InlineResponse404 + */ +export interface InlineResponse404 { + /** + * + * @type {Array} + * @memberof InlineResponse404 + */ + errors: Array; +} +/** + * + * @export + * @interface InlineResponse404Errors + */ +export interface InlineResponse404Errors { + /** + * + * @type {string | object} + * @memberof InlineResponse404Errors + */ + detail: string | object; + /** + * String representation of HTTP status code. + * @type {string} + * @memberof InlineResponse404Errors + */ + status: string; +} /** * * @export @@ -1656,7 +2785,7 @@ export interface MetaCvesAllOf { * @export * @interface MetaCvesSystems */ -export interface MetaCvesSystems { +export interface MetaCvesSystems extends MetaCvesSystemsAllOf { /** * Full text filter * @type {string} @@ -1789,12 +2918,6 @@ export interface MetaCvesSystems { * @memberof MetaCvesSystems */ cves_without_errata: boolean | null; - /** - * If given system was opted out. - * @type {boolean} - * @memberof MetaCvesSystems - */ - opt_out: boolean; } /** * @@ -2030,10 +3153,10 @@ export interface MetaVulnerabilitiesOut { impact: string | null; /** * - * @type {MetaVulnerabilitiesOutAllOfSystemCountPerType} + * @type {InlineResponse2008SystemCountPerType} * @memberof MetaVulnerabilitiesOut */ - system_count_per_type?: MetaVulnerabilitiesOutAllOfSystemCountPerType; + system_count_per_type?: InlineResponse2008SystemCountPerType; /** * Total number of systems managed by vulnerability application. * @type {number} @@ -2078,115 +3201,151 @@ export interface MetaVulnerabilitiesOut { */ export interface MetaVulnerabilitiesOutAllOf { /** - * Description of CVE showing preferences + * Full text filter + * @type {string} + * @memberof MetaVulnerabilitiesOutAllOf + */ + filter: string | null; + /** + * Maximum number of paginated results. + * @type {number} + * @memberof MetaVulnerabilitiesOutAllOf + */ + limit: number; + /** + * First record of paginated response. + * @type {number} + * @memberof MetaVulnerabilitiesOutAllOf + */ + offset: number; + /** + * Page number of paginated response. + * @type {number} + * @memberof MetaVulnerabilitiesOutAllOf + */ + page: number; + /** + * Number of records per page of paginated response. + * @type {number} + * @memberof MetaVulnerabilitiesOutAllOf + */ + page_size: number; + /** + * Total number of pages of paginated response. + * @type {number} + * @memberof MetaVulnerabilitiesOutAllOf + */ + pages: number; + /** + * Sorting filter. + * @type {string} + * @memberof MetaVulnerabilitiesOutAllOf + */ + sort: string | null; + /** + * Total number of records. + * @type {number} + * @memberof MetaVulnerabilitiesOutAllOf + */ + total_items: number; + /** + * Format of the output data, either JSON (default) or CSV. * @type {string} * @memberof MetaVulnerabilitiesOutAllOf */ + data_format: string; +} +/** + * + * @export + * @interface MetaVulnerabilitiesOutAllOf1 + */ +export interface MetaVulnerabilitiesOutAllOf1 { + /** + * Description of CVE showing preferences + * @type {string} + * @memberof MetaVulnerabilitiesOutAllOf1 + */ affecting: string | null; /** * Filter based on business risk IDs. * @type {string} - * @memberof MetaVulnerabilitiesOutAllOf + * @memberof MetaVulnerabilitiesOutAllOf1 */ business_risk_id: string | null; /** * Filter based on cvss score, starting from the value. Use -1 to include also CVEs with N/A cvss score. * @type {number} - * @memberof MetaVulnerabilitiesOutAllOf + * @memberof MetaVulnerabilitiesOutAllOf1 */ cvss_from: number | null; /** * Filter based on cvss score, up to the value. * @type {number} - * @memberof MetaVulnerabilitiesOutAllOf + * @memberof MetaVulnerabilitiesOutAllOf1 */ cvss_to: number | null; /** * Filter CVEs based on their published date, starting from the date. * @type {string} - * @memberof MetaVulnerabilitiesOutAllOf + * @memberof MetaVulnerabilitiesOutAllOf1 */ public_from: string | null; /** * Filter CVEs based on their published date, up to the date. * @type {string} - * @memberof MetaVulnerabilitiesOutAllOf + * @memberof MetaVulnerabilitiesOutAllOf1 */ public_to: string | null; /** * Filter based on impact IDs. * @type {string} - * @memberof MetaVulnerabilitiesOutAllOf + * @memberof MetaVulnerabilitiesOutAllOf1 */ impact: string | null; /** * - * @type {MetaVulnerabilitiesOutAllOfSystemCountPerType} - * @memberof MetaVulnerabilitiesOutAllOf + * @type {InlineResponse2008SystemCountPerType} + * @memberof MetaVulnerabilitiesOutAllOf1 */ - system_count_per_type?: MetaVulnerabilitiesOutAllOfSystemCountPerType; + system_count_per_type?: InlineResponse2008SystemCountPerType; /** * Total number of systems managed by vulnerability application. * @type {number} - * @memberof MetaVulnerabilitiesOutAllOf + * @memberof MetaVulnerabilitiesOutAllOf1 */ system_count?: number; /** * Filter base on system RHEL version. * @type {string} - * @memberof MetaVulnerabilitiesOutAllOf + * @memberof MetaVulnerabilitiesOutAllOf1 */ rhel_version: string | null; /** * Filter based on presence of security rule * @type {string} - * @memberof MetaVulnerabilitiesOutAllOf + * @memberof MetaVulnerabilitiesOutAllOf1 */ rule_presence: string | null; /** * CVEs without Errata feature flag * @type {boolean} - * @memberof MetaVulnerabilitiesOutAllOf + * @memberof MetaVulnerabilitiesOutAllOf1 */ cves_without_errata: boolean | null; /** * Shows whether a CVE has available advisory or not * @type {string} - * @memberof MetaVulnerabilitiesOutAllOf + * @memberof MetaVulnerabilitiesOutAllOf1 */ advisory_available: string | null; /** * Flag if cached data was used to produce the response. * @type {boolean} - * @memberof MetaVulnerabilitiesOutAllOf + * @memberof MetaVulnerabilitiesOutAllOf1 */ cache_used: boolean; } -/** - * Number of systems managed by vulnerability application, grouped by host type. - * @export - * @interface MetaVulnerabilitiesOutAllOfSystemCountPerType - */ -export interface MetaVulnerabilitiesOutAllOfSystemCountPerType { - /** - * Number of conventional systems. - * @type {number} - * @memberof MetaVulnerabilitiesOutAllOfSystemCountPerType - */ - rpmdnf?: number; - /** - * Number of image-mode systems. - * @type {number} - * @memberof MetaVulnerabilitiesOutAllOfSystemCountPerType - */ - image?: number | null; - /** - * Number of image-mode systems. (Deprecated) - * @type {number} - * @memberof MetaVulnerabilitiesOutAllOfSystemCountPerType - */ - edge?: number | null; -} /** * * @export @@ -2221,66 +3380,29 @@ export interface OSExposureReport { export interface OptOutIn { /** * - * @type {InventoryIdOrList} + * @type {string | Array} * @memberof OptOutIn */ - inventory_id: InventoryIdOrList; + inventory_id: string | Array; /** * Opt out setting to be set. * @type {boolean} * @memberof OptOutIn */ - opt_out: boolean; -} -/** - * - * @export - * @interface PlaybookTemplate - */ -export interface PlaybookTemplate { - /** - * - * @type {Array} - * @memberof PlaybookTemplate - */ - data?: Array; + opt_out: boolean; } /** * * @export - * @interface PlaybookTemplateData + * @interface PlaybookTemplate */ -export interface PlaybookTemplateData { - /** - * Playbook template description. - * @type {string} - * @memberof PlaybookTemplateData - */ - description: string; - /** - * Actual playbook template. - * @type {string} - * @memberof PlaybookTemplateData - */ - play: string; - /** - * Revision of the playbook template. - * @type {string} - * @memberof PlaybookTemplateData - */ - version: string; - /** - * Indicator whter reboot is required to mitigate vulnerability. - * @type {boolean} - * @memberof PlaybookTemplateData - */ - reboot_required?: boolean | null; +export interface PlaybookTemplate { /** - * Type of the resolution provided by playbook. - * @type {string} - * @memberof PlaybookTemplateData + * + * @type {Array} + * @memberof PlaybookTemplate */ - resolution_type: string; + data?: Array; } /** * @@ -2290,16 +3412,16 @@ export interface PlaybookTemplateData { export interface StatusIn { /** * - * @type {InventoryIdOrList} + * @type {string | Array} * @memberof StatusIn */ - inventory_id?: InventoryIdOrList; + inventory_id?: string | Array; /** * - * @type {CveOrList} + * @type {string | Array} * @memberof StatusIn */ - cve: CveOrList; + cve: string | Array; /** * Status ID to be set, obtained by GET method. If not specified, global CVE status is set. * @type {number} @@ -2321,48 +3443,16 @@ export interface StatusIn { export interface StatusListOut { /** * List of available status/status_id pairs. - * @type {Array} + * @type {Array} * @memberof StatusListOut */ - data: Array; + data: Array; /** * - * @type {StatusListOutMeta} + * @type {InlineResponse20010Meta} * @memberof StatusListOut */ - meta: StatusListOutMeta; -} -/** - * - * @export - * @interface StatusListOutData - */ -export interface StatusListOutData { - /** - * Internal status_id. - * @type {number} - * @memberof StatusListOutData - */ - id: number; - /** - * Represenation of internal status_id. - * @type {string} - * @memberof StatusListOutData - */ - name: string; -} -/** - * - * @export - * @interface StatusListOutMeta - */ -export interface StatusListOutMeta { - /** - * Total number of available status/status_id pairs. - * @type {number} - * @memberof StatusListOutMeta - */ - total_items: number; + meta: InlineResponse20010Meta; } /** * @@ -2372,35 +3462,16 @@ export interface StatusListOutMeta { export interface StatusOut { /** * List of updated objects/updated object IDs. - * @type {Array} + * @type {Array} * @memberof StatusOut */ - updated: Array; + updated: Array; /** * - * @type {MetaPermissions} + * @type {InlineResponse2002Meta} * @memberof StatusOut */ - meta?: MetaPermissions; -} -/** - * - * @export - * @interface StatusOutUpdated - */ -export interface StatusOutUpdated { - /** - * - * @type {string} - * @memberof StatusOutUpdated - */ - inventory_id: string; - /** - * - * @type {string} - * @memberof StatusOutUpdated - */ - cve: string; + meta?: InlineResponse2002Meta; } /** * @@ -2416,16 +3487,16 @@ export interface SystemCvesIdsOut { data: string | Array; /** * - * @type {Links} + * @type {InlineResponse2003Links} * @memberof SystemCvesIdsOut */ - links: Links; + links: InlineResponse2003Links; /** * - * @type {MetaCves} + * @type {object} * @memberof SystemCvesIdsOut */ - meta: MetaCves; + meta: object; } /** * @@ -2441,16 +3512,16 @@ export interface SystemCvesOut { data: string | Array; /** * - * @type {Links} + * @type {InlineResponse2003Links} * @memberof SystemCvesOut */ - links: Links; + links: InlineResponse2003Links; /** * - * @type {MetaCves} + * @type {object} * @memberof SystemCvesOut */ - meta: MetaCves; + meta: object; } /** * @@ -2460,118 +3531,16 @@ export interface SystemCvesOut { export interface SystemDetailsOut { /** * - * @type {SystemDetailsOutData} + * @type {InlineResponse20014Data} * @memberof SystemDetailsOut */ - data: SystemDetailsOutData; + data: InlineResponse20014Data; /** * - * @type {MetaPermissions} + * @type {InlineResponse2002Meta} * @memberof SystemDetailsOut */ - meta: MetaPermissions; -} -/** - * - * @export - * @interface SystemDetailsOutData - */ -export interface SystemDetailsOutData { - /** - * Date of last evaluation. - * @type {string} - * @memberof SystemDetailsOutData - */ - last_evaluation: string | null; - /** - * Date of last security rules evaluation. - * @type {string} - * @memberof SystemDetailsOutData - */ - rules_evaluation: string | null; - /** - * System opt out status. - * @type {boolean} - * @memberof SystemDetailsOutData - */ - opt_out: boolean; - /** - * Date of the latest upload of archive. - * @type {string} - * @memberof SystemDetailsOutData - */ - last_upload: string | null; - /** - * System stale status. - * @type {boolean} - * @memberof SystemDetailsOutData - */ - stale?: boolean; - /** - * Date of the lastest upload of archive taken from Inventory syndicated data. - * @type {string} - * @memberof SystemDetailsOutData - */ - updated?: string | null; - /** - * Operating system. - * @type {string} - * @memberof SystemDetailsOutData - */ - os: string; - /** - * System is locked to following RHSM version. - * @type {string} - * @memberof SystemDetailsOutData - */ - rhsm_lock: string | null; - /** - * - * @type {Array} - * @memberof SystemDetailsOutData - */ - tags: Array; - /** - * Type of the host - * @type {string} - * @memberof SystemDetailsOutData - */ - host_type: SystemDetailsOutDataHostTypeEnum; -} - -/** - * @export - * @enum {string} - */ -export enum SystemDetailsOutDataHostTypeEnum { - Rpmdnf = 'rpmdnf', - Image = 'image' -} - -/** - * - * @export - * @interface SystemDetailsOutDataTags - */ -export interface SystemDetailsOutDataTags { - /** - * Namespace of single tag. - * @type {string} - * @memberof SystemDetailsOutDataTags - */ - namespace: string | null; - /** - * Key of the single tag. - * @type {string} - * @memberof SystemDetailsOutDataTags - */ - key: string; - /** - * Value of the single tag. - * @type {string} - * @memberof SystemDetailsOutDataTags - */ - value: string | null; + meta: InlineResponse2002Meta; } /** * @@ -2587,16 +3556,16 @@ export interface SystemIdsOut { data: string | Array; /** * - * @type {Links} + * @type {InlineResponse2003Links} * @memberof SystemIdsOut */ - links: Links; + links: InlineResponse2003Links; /** * - * @type {MetaSystems} + * @type {object} * @memberof SystemIdsOut */ - meta: MetaSystems; + meta: object; } /** * @@ -2612,16 +3581,16 @@ export interface SystemListOut { data: string | Array; /** * - * @type {Links} + * @type {InlineResponse2003Links} * @memberof SystemListOut */ - links: Links; + links: InlineResponse2003Links; /** * - * @type {MetaSystems} + * @type {object} * @memberof SystemListOut */ - meta: MetaSystems; + meta: object; } /** * @@ -2656,16 +3625,16 @@ export interface VulnerabilitiesIdsOut { data: string | Array; /** * - * @type {Links} + * @type {InlineResponse2003Links} * @memberof VulnerabilitiesIdsOut */ - links: Links; + links: InlineResponse2003Links; /** * - * @type {MetaVulnerabilitiesOut} + * @type {object} * @memberof VulnerabilitiesIdsOut */ - meta: MetaVulnerabilitiesOut; + meta: object; } /** * @@ -2681,16 +3650,16 @@ export interface VulnerabilitiesOut { data: string | Array; /** * - * @type {Links} + * @type {InlineResponse2003Links} * @memberof VulnerabilitiesOut */ - links: Links; + links: InlineResponse2003Links; /** * - * @type {MetaVulnerabilitiesOut} + * @type {object} * @memberof VulnerabilitiesOut */ - meta: MetaVulnerabilitiesOut; + meta: object; } /** * @@ -2713,72 +3682,22 @@ export interface VulnerabilitiesPostIn { export interface VulnerabilitiesPostOut { /** * - * @type {Array} + * @type {Array} * @memberof VulnerabilitiesPostOut */ - data: Array; + data: Array; /** * - * @type {Links} + * @type {InlineResponse2003Links} * @memberof VulnerabilitiesPostOut */ - links: Links; + links: InlineResponse2003Links; /** * - * @type {Meta & MetaPermissions} + * @type {object} * @memberof VulnerabilitiesPostOut */ - meta: Meta & MetaPermissions; -} -/** - * - * @export - * @interface VulnerabilitiesPostOutAttributes - */ -export interface VulnerabilitiesPostOutAttributes { - /** - * String representation of cvss3 or cvvs2 (if v3 is not present) score of the CVE. - * @type {string} - * @memberof VulnerabilitiesPostOutAttributes - */ - cvss_score: string | null; - /** - * Red Hat security impact of the CVE. - * @type {string} - * @memberof VulnerabilitiesPostOutAttributes - */ - impact: string; - /** - * Synopsis of the CVE. - * @type {string} - * @memberof VulnerabilitiesPostOutAttributes - */ - synopsis: string; -} -/** - * - * @export - * @interface VulnerabilitiesPostOutData - */ -export interface VulnerabilitiesPostOutData { - /** - * CVE id. - * @type {string} - * @memberof VulnerabilitiesPostOutData - */ - id: string; - /** - * Type of the record. - * @type {string} - * @memberof VulnerabilitiesPostOutData - */ - type: string; - /** - * - * @type {VulnerabilitiesPostOutAttributes} - * @memberof VulnerabilitiesPostOutData - */ - attributes: VulnerabilitiesPostOutAttributes; + meta: object; } /** @@ -4066,7 +4985,7 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati /** * This is an overview of vulnerabilities for specific CVEs provided in the body. Use this endpoint to get a CVSS score, and learn the severity for a list of CVEs provided in the request. * @summary Send a vulnerabilities overview - * @param {VulnerabilitiesPostIn} vulnerabilitiesPostIn List of CVEs to provide info about. + * @param {InlineObject4} inlineObject4 * @param {string} [filter] Full text filter for CVE and it\'s description text. * @param {number} [limit] Maximum number of records per page. Limit/Offset pagination wins over page/page_size pagination. * @param {number} [offset] Offset of first record of paginated response. Limit/Offset pagination wins over page/page_size pagination. @@ -4076,10 +4995,10 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getCveList_1: async (vulnerabilitiesPostIn: VulnerabilitiesPostIn, filter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sort?: string, options: any = {}): Promise => { - // verify required parameter 'vulnerabilitiesPostIn' is not null or undefined - if (vulnerabilitiesPostIn === null || vulnerabilitiesPostIn === undefined) { - throw new RequiredError('vulnerabilitiesPostIn','Required parameter vulnerabilitiesPostIn was null or undefined when calling getCveList_1.'); + getCveList_1: async (inlineObject4: InlineObject4, filter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sort?: string, options: any = {}): Promise => { + // verify required parameter 'inlineObject4' is not null or undefined + if (inlineObject4 === null || inlineObject4 === undefined) { + throw new RequiredError('inlineObject4','Required parameter inlineObject4 was null or undefined when calling getCveList_1.'); } const localVarPath = `/vulnerabilities/cves`; const localVarUrlObj = globalImportUrl.parse(localVarPath, true); @@ -4138,8 +5057,52 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati delete localVarUrlObj.search; let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - const needsSerialization = (typeof vulnerabilitiesPostIn !== "string") || localVarRequestOptions.headers['Content-Type'] === 'application/json'; - localVarRequestOptions.data = needsSerialization ? JSON.stringify(vulnerabilitiesPostIn !== undefined ? vulnerabilitiesPostIn : {}) : (vulnerabilitiesPostIn || ""); + const needsSerialization = (typeof inlineObject4 !== "string") || localVarRequestOptions.headers['Content-Type'] === 'application/json'; + localVarRequestOptions.data = needsSerialization ? JSON.stringify(inlineObject4 !== undefined ? inlineObject4 : {}) : (inlineObject4 || ""); + + return { + url: globalImportUrl.format(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Use this endpoint to get an enablement status of reporting CVEs that do not have advisories (errata) for your customer account. If the feature is disabled, CVEs without advisories will be hidden in outputs of all endpoints. + * @summary Get a feature flag status for CVEs without errata + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getCvesWithoutErrata: async (options: any = {}): Promise => { + const localVarPath = `/feature/cves_without_errata`; + const localVarUrlObj = globalImportUrl.parse(localVarPath, true); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication ApiKeyAuth required + if (configuration && configuration.apiKey) { + const localVarApiKeyValue = typeof configuration.apiKey === 'function' + ? await configuration.apiKey("x-rh-identity") + : await configuration.apiKey; + localVarHeaderParameter["x-rh-identity"] = localVarApiKeyValue; + } + + // authentication BasicAuth required + // http basic authentication required + if (configuration && (configuration.username || configuration.password)) { + localVarRequestOptions["auth"] = { username: configuration.username, password: configuration.password }; + } + + + + localVarUrlObj.query = {...localVarUrlObj.query, ...localVarQueryParameter, ...options.query}; + // fix override query string Detail: https://stackoverflow.com/a/7517673/1077943 + delete localVarUrlObj.search; + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; return { url: globalImportUrl.format(localVarUrlObj), @@ -4842,14 +5805,14 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati /** * This sets a business risk for a specific CVE. Set a value of low, medium, high or critical for a given CVE. These values are obtained by the business risk path *GET/business_risk*. To set a business risk, you must call the GET/business_risk endpoint first, followed by the *PATCH/cves/business_risk* path. * @summary Set business risk for a CVE - * @param {CveRiskIn} cveRiskIn Values to be set. At least one of the \"business_risk_id\" or \"business_risk_text\" parameters is required. + * @param {InlineObject} inlineObject * @param {*} [options] Override http request option. * @throws {RequiredError} */ - setCveBusinessRisk: async (cveRiskIn: CveRiskIn, options: any = {}): Promise => { - // verify required parameter 'cveRiskIn' is not null or undefined - if (cveRiskIn === null || cveRiskIn === undefined) { - throw new RequiredError('cveRiskIn','Required parameter cveRiskIn was null or undefined when calling setCveBusinessRisk.'); + setCveBusinessRisk: async (inlineObject: InlineObject, options: any = {}): Promise => { + // verify required parameter 'inlineObject' is not null or undefined + if (inlineObject === null || inlineObject === undefined) { + throw new RequiredError('inlineObject','Required parameter inlineObject was null or undefined when calling setCveBusinessRisk.'); } const localVarPath = `/cves/business_risk`; const localVarUrlObj = globalImportUrl.parse(localVarPath, true); @@ -4884,8 +5847,8 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati delete localVarUrlObj.search; let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - const needsSerialization = (typeof cveRiskIn !== "string") || localVarRequestOptions.headers['Content-Type'] === 'application/json'; - localVarRequestOptions.data = needsSerialization ? JSON.stringify(cveRiskIn !== undefined ? cveRiskIn : {}) : (cveRiskIn || ""); + const needsSerialization = (typeof inlineObject !== "string") || localVarRequestOptions.headers['Content-Type'] === 'application/json'; + localVarRequestOptions.data = needsSerialization ? JSON.stringify(inlineObject !== undefined ? inlineObject : {}) : (inlineObject || ""); return { url: globalImportUrl.format(localVarUrlObj), @@ -4895,14 +5858,14 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati /** * This sets the status for a specific CVE. Set a status value for a given CVE (e.g. in-review, on-hold, scheduled for a patch, or resolved). These values are obtained by sending a *GET/status* request. To set a status, you must call the *GET/business_risk* first, followed by the *PATCH/cves/status* path. * @summary Set status for a CVE - * @param {CveStatusIn} cveStatusIn Values to be set. At least one of the \"status_id\" or \"status_text\" parameters is required. + * @param {InlineObject1} inlineObject1 * @param {*} [options] Override http request option. * @throws {RequiredError} */ - setCveStatus: async (cveStatusIn: CveStatusIn, options: any = {}): Promise => { - // verify required parameter 'cveStatusIn' is not null or undefined - if (cveStatusIn === null || cveStatusIn === undefined) { - throw new RequiredError('cveStatusIn','Required parameter cveStatusIn was null or undefined when calling setCveStatus.'); + setCveStatus: async (inlineObject1: InlineObject1, options: any = {}): Promise => { + // verify required parameter 'inlineObject1' is not null or undefined + if (inlineObject1 === null || inlineObject1 === undefined) { + throw new RequiredError('inlineObject1','Required parameter inlineObject1 was null or undefined when calling setCveStatus.'); } const localVarPath = `/cves/status`; const localVarUrlObj = globalImportUrl.parse(localVarPath, true); @@ -4937,8 +5900,8 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati delete localVarUrlObj.search; let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - const needsSerialization = (typeof cveStatusIn !== "string") || localVarRequestOptions.headers['Content-Type'] === 'application/json'; - localVarRequestOptions.data = needsSerialization ? JSON.stringify(cveStatusIn !== undefined ? cveStatusIn : {}) : (cveStatusIn || ""); + const needsSerialization = (typeof inlineObject1 !== "string") || localVarRequestOptions.headers['Content-Type'] === 'application/json'; + localVarRequestOptions.data = needsSerialization ? JSON.stringify(inlineObject1 !== undefined ? inlineObject1 : {}) : (inlineObject1 || ""); return { url: globalImportUrl.format(localVarUrlObj), @@ -4948,14 +5911,14 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati /** * Use this endpoint to enable/disable reporting CVEs that do not have advisories (errata) for your customer account. If the feature is disabled, CVEs without advisories will be hidden in outputs of all endpoints. * @summary Set a feature flag for CVEs without errata - * @param {CvesWithoutErrataIn} cvesWithoutErrataIn Values to be set. + * @param {InlineObject5} inlineObject5 * @param {*} [options] Override http request option. * @throws {RequiredError} */ - setCvesWithoutErrata: async (cvesWithoutErrataIn: CvesWithoutErrataIn, options: any = {}): Promise => { - // verify required parameter 'cvesWithoutErrataIn' is not null or undefined - if (cvesWithoutErrataIn === null || cvesWithoutErrataIn === undefined) { - throw new RequiredError('cvesWithoutErrataIn','Required parameter cvesWithoutErrataIn was null or undefined when calling setCvesWithoutErrata.'); + setCvesWithoutErrata: async (inlineObject5: InlineObject5, options: any = {}): Promise => { + // verify required parameter 'inlineObject5' is not null or undefined + if (inlineObject5 === null || inlineObject5 === undefined) { + throw new RequiredError('inlineObject5','Required parameter inlineObject5 was null or undefined when calling setCvesWithoutErrata.'); } const localVarPath = `/feature/cves_without_errata`; const localVarUrlObj = globalImportUrl.parse(localVarPath, true); @@ -4990,8 +5953,8 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati delete localVarUrlObj.search; let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - const needsSerialization = (typeof cvesWithoutErrataIn !== "string") || localVarRequestOptions.headers['Content-Type'] === 'application/json'; - localVarRequestOptions.data = needsSerialization ? JSON.stringify(cvesWithoutErrataIn !== undefined ? cvesWithoutErrataIn : {}) : (cvesWithoutErrataIn || ""); + const needsSerialization = (typeof inlineObject5 !== "string") || localVarRequestOptions.headers['Content-Type'] === 'application/json'; + localVarRequestOptions.data = needsSerialization ? JSON.stringify(inlineObject5 !== undefined ? inlineObject5 : {}) : (inlineObject5 || ""); return { url: globalImportUrl.format(localVarUrlObj), @@ -5001,14 +5964,14 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati /** * This endpoint sets status for given systems and CVEs. Use this endpoint when you need to set a status value for system-CVE pairs. * @summary Set status for system vulnerabilities - * @param {StatusIn} statusIn Values to be set. + * @param {InlineObject2} inlineObject2 * @param {*} [options] Override http request option. * @throws {RequiredError} */ - setStatus: async (statusIn: StatusIn, options: any = {}): Promise => { - // verify required parameter 'statusIn' is not null or undefined - if (statusIn === null || statusIn === undefined) { - throw new RequiredError('statusIn','Required parameter statusIn was null or undefined when calling setStatus.'); + setStatus: async (inlineObject2: InlineObject2, options: any = {}): Promise => { + // verify required parameter 'inlineObject2' is not null or undefined + if (inlineObject2 === null || inlineObject2 === undefined) { + throw new RequiredError('inlineObject2','Required parameter inlineObject2 was null or undefined when calling setStatus.'); } const localVarPath = `/status`; const localVarUrlObj = globalImportUrl.parse(localVarPath, true); @@ -5043,8 +6006,8 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati delete localVarUrlObj.search; let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - const needsSerialization = (typeof statusIn !== "string") || localVarRequestOptions.headers['Content-Type'] === 'application/json'; - localVarRequestOptions.data = needsSerialization ? JSON.stringify(statusIn !== undefined ? statusIn : {}) : (statusIn || ""); + const needsSerialization = (typeof inlineObject2 !== "string") || localVarRequestOptions.headers['Content-Type'] === 'application/json'; + localVarRequestOptions.data = needsSerialization ? JSON.stringify(inlineObject2 !== undefined ? inlineObject2 : {}) : (inlineObject2 || ""); return { url: globalImportUrl.format(localVarUrlObj), @@ -5054,14 +6017,14 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati /** * Opt a specific system in or out of vulnerability analysis. Use this when you want to use other Insights services but do not want to see specific systems in vulnerability reports. This allows you to hide select systems. * @summary Opt a system in or out of the vulnerability service - * @param {OptOutIn} optOutIn Values to be set. + * @param {InlineObject3} inlineObject3 * @param {*} [options] Override http request option. * @throws {RequiredError} */ - setSystemsOptOut: async (optOutIn: OptOutIn, options: any = {}): Promise => { - // verify required parameter 'optOutIn' is not null or undefined - if (optOutIn === null || optOutIn === undefined) { - throw new RequiredError('optOutIn','Required parameter optOutIn was null or undefined when calling setSystemsOptOut.'); + setSystemsOptOut: async (inlineObject3: InlineObject3, options: any = {}): Promise => { + // verify required parameter 'inlineObject3' is not null or undefined + if (inlineObject3 === null || inlineObject3 === undefined) { + throw new RequiredError('inlineObject3','Required parameter inlineObject3 was null or undefined when calling setSystemsOptOut.'); } const localVarPath = `/systems/opt_out`; const localVarUrlObj = globalImportUrl.parse(localVarPath, true); @@ -5096,8 +6059,8 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati delete localVarUrlObj.search; let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - const needsSerialization = (typeof optOutIn !== "string") || localVarRequestOptions.headers['Content-Type'] === 'application/json'; - localVarRequestOptions.data = needsSerialization ? JSON.stringify(optOutIn !== undefined ? optOutIn : {}) : (optOutIn || ""); + const needsSerialization = (typeof inlineObject3 !== "string") || localVarRequestOptions.headers['Content-Type'] === 'application/json'; + localVarRequestOptions.data = needsSerialization ? JSON.stringify(inlineObject3 !== undefined ? inlineObject3 : {}) : (inlineObject3 || ""); return { url: globalImportUrl.format(localVarUrlObj), @@ -5119,7 +6082,7 @@ export const DefaultApiFp = function(configuration?: Configuration) { * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async deleteNotifications(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + async deleteNotifications(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await DefaultApiAxiosParamCreator(configuration).deleteNotifications(options); return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { const axiosRequestArgs = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url}; @@ -5161,7 +6124,7 @@ export const DefaultApiFp = function(configuration?: Configuration) { * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async getAffectedSystemsByCve(cveId: string, filter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sort?: string, statusId?: string, dataFormat?: string, uuid?: string, ruleKey?: Array, rulePresence?: Array, rule?: Array, tags?: Array, sapSids?: Array, sapSystem?: boolean, showAdvisories?: boolean, advisory?: string, rhelVersion?: string, firstReportedFrom?: string, firstReportedTo?: string, advisoryAvailable?: Array, remediation?: string, report?: boolean, ansible?: boolean, mssql?: boolean, groupNames?: Array, groupIds?: Array, hostType?: Array<'rpmdnf' | 'image' | 'edge'>, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + async getAffectedSystemsByCve(cveId: string, filter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sort?: string, statusId?: string, dataFormat?: string, uuid?: string, ruleKey?: Array, rulePresence?: Array, rule?: Array, tags?: Array, sapSids?: Array, sapSystem?: boolean, showAdvisories?: boolean, advisory?: string, rhelVersion?: string, firstReportedFrom?: string, firstReportedTo?: string, advisoryAvailable?: Array, remediation?: string, report?: boolean, ansible?: boolean, mssql?: boolean, groupNames?: Array, groupIds?: Array, hostType?: Array<'rpmdnf' | 'image' | 'edge'>, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await DefaultApiAxiosParamCreator(configuration).getAffectedSystemsByCve(cveId, filter, limit, offset, page, pageSize, sort, statusId, dataFormat, uuid, ruleKey, rulePresence, rule, tags, sapSids, sapSystem, showAdvisories, advisory, rhelVersion, firstReportedFrom, firstReportedTo, advisoryAvailable, remediation, report, ansible, mssql, groupNames, groupIds, hostType, options); return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { const axiosRequestArgs = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url}; @@ -5202,7 +6165,7 @@ export const DefaultApiFp = function(configuration?: Configuration) { * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async getAffectedSystemsIdsByCve(cveId: string, filter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sort?: string, statusId?: string, dataFormat?: string, uuid?: string, ruleKey?: Array, rulePresence?: Array, rule?: Array, tags?: Array, sapSids?: Array, sapSystem?: boolean, showAdvisories?: boolean, advisory?: string, rhelVersion?: string, firstReportedFrom?: string, firstReportedTo?: string, advisoryAvailable?: Array, remediation?: string, ansible?: boolean, mssql?: boolean, groupNames?: Array, groupIds?: Array, hostType?: Array<'rpmdnf' | 'image' | 'edge'>, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + async getAffectedSystemsIdsByCve(cveId: string, filter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sort?: string, statusId?: string, dataFormat?: string, uuid?: string, ruleKey?: Array, rulePresence?: Array, rule?: Array, tags?: Array, sapSids?: Array, sapSystem?: boolean, showAdvisories?: boolean, advisory?: string, rhelVersion?: string, firstReportedFrom?: string, firstReportedTo?: string, advisoryAvailable?: Array, remediation?: string, ansible?: boolean, mssql?: boolean, groupNames?: Array, groupIds?: Array, hostType?: Array<'rpmdnf' | 'image' | 'edge'>, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await DefaultApiAxiosParamCreator(configuration).getAffectedSystemsIdsByCve(cveId, filter, limit, offset, page, pageSize, sort, statusId, dataFormat, uuid, ruleKey, rulePresence, rule, tags, sapSids, sapSystem, showAdvisories, advisory, rhelVersion, firstReportedFrom, firstReportedTo, advisoryAvailable, remediation, ansible, mssql, groupNames, groupIds, hostType, options); return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { const axiosRequestArgs = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url}; @@ -5215,7 +6178,7 @@ export const DefaultApiFp = function(configuration?: Configuration) { * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async getAnnouncement(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + async getAnnouncement(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await DefaultApiAxiosParamCreator(configuration).getAnnouncement(options); return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { const axiosRequestArgs = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url}; @@ -5241,7 +6204,7 @@ export const DefaultApiFp = function(configuration?: Configuration) { * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async getBusinessRiskList(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + async getBusinessRiskList(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await DefaultApiAxiosParamCreator(configuration).getBusinessRiskList(options); return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { const axiosRequestArgs = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url}; @@ -5256,7 +6219,7 @@ export const DefaultApiFp = function(configuration?: Configuration) { * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async getCveDetails(cveId: string, advisoryAvailable?: Array, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + async getCveDetails(cveId: string, advisoryAvailable?: Array, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await DefaultApiAxiosParamCreator(configuration).getCveDetails(cveId, advisoryAvailable, options); return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { const axiosRequestArgs = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url}; @@ -5294,7 +6257,7 @@ export const DefaultApiFp = function(configuration?: Configuration) { * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async getCveIdsBySystem(inventoryId: string, filter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sort?: string, cvssFrom?: number, cvssTo?: number, publicFrom?: string, publicTo?: string, impact?: string, statusId?: string, dataFormat?: string, businessRiskId?: string, rulePresence?: Array, showAdvisories?: boolean, advisory?: string, ruleKey?: Array, knownExploit?: Array, firstReportedFrom?: string, firstReportedTo?: string, advisoryAvailable?: Array, remediation?: string, tags?: Array, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + async getCveIdsBySystem(inventoryId: string, filter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sort?: string, cvssFrom?: number, cvssTo?: number, publicFrom?: string, publicTo?: string, impact?: string, statusId?: string, dataFormat?: string, businessRiskId?: string, rulePresence?: Array, showAdvisories?: boolean, advisory?: string, ruleKey?: Array, knownExploit?: Array, firstReportedFrom?: string, firstReportedTo?: string, advisoryAvailable?: Array, remediation?: string, tags?: Array, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await DefaultApiAxiosParamCreator(configuration).getCveIdsBySystem(inventoryId, filter, limit, offset, page, pageSize, sort, cvssFrom, cvssTo, publicFrom, publicTo, impact, statusId, dataFormat, businessRiskId, rulePresence, showAdvisories, advisory, ruleKey, knownExploit, firstReportedFrom, firstReportedTo, advisoryAvailable, remediation, tags, options); return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { const axiosRequestArgs = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url}; @@ -5331,7 +6294,7 @@ export const DefaultApiFp = function(configuration?: Configuration) { * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async getCveIdsList(filter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sort?: string, cvssFrom?: number, cvssTo?: number, publicFrom?: string, publicTo?: string, impact?: string, dataFormat?: string, businessRiskId?: string, statusId?: string, rulePresence?: Array, tags?: Array, sapSids?: Array, sapSystem?: boolean, knownExploit?: Array, affecting?: Array, rhelVersion?: string, ansible?: boolean, mssql?: boolean, advisoryAvailable?: Array, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + async getCveIdsList(filter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sort?: string, cvssFrom?: number, cvssTo?: number, publicFrom?: string, publicTo?: string, impact?: string, dataFormat?: string, businessRiskId?: string, statusId?: string, rulePresence?: Array, tags?: Array, sapSids?: Array, sapSystem?: boolean, knownExploit?: Array, affecting?: Array, rhelVersion?: string, ansible?: boolean, mssql?: boolean, advisoryAvailable?: Array, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await DefaultApiAxiosParamCreator(configuration).getCveIdsList(filter, limit, offset, page, pageSize, sort, cvssFrom, cvssTo, publicFrom, publicTo, impact, dataFormat, businessRiskId, statusId, rulePresence, tags, sapSids, sapSystem, knownExploit, affecting, rhelVersion, ansible, mssql, advisoryAvailable, options); return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { const axiosRequestArgs = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url}; @@ -5373,7 +6336,7 @@ export const DefaultApiFp = function(configuration?: Configuration) { * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async getCveList(filter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sort?: string, cvssFrom?: number, cvssTo?: number, publicFrom?: string, publicTo?: string, impact?: string, dataFormat?: string, businessRiskId?: string, statusId?: string, rulePresence?: Array, tags?: Array, sapSids?: Array, sapSystem?: boolean, knownExploit?: Array, affecting?: Array, rhelVersion?: string, report?: boolean, advancedReport?: boolean, ansible?: boolean, mssql?: boolean, advisoryAvailable?: Array, groupNames?: Array, groupIds?: Array, affectingHostType?: Array<'rpmdnf' | 'image' | 'edge' | 'none'>, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + async getCveList(filter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sort?: string, cvssFrom?: number, cvssTo?: number, publicFrom?: string, publicTo?: string, impact?: string, dataFormat?: string, businessRiskId?: string, statusId?: string, rulePresence?: Array, tags?: Array, sapSids?: Array, sapSystem?: boolean, knownExploit?: Array, affecting?: Array, rhelVersion?: string, report?: boolean, advancedReport?: boolean, ansible?: boolean, mssql?: boolean, advisoryAvailable?: Array, groupNames?: Array, groupIds?: Array, affectingHostType?: Array<'rpmdnf' | 'image' | 'edge' | 'none'>, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await DefaultApiAxiosParamCreator(configuration).getCveList(filter, limit, offset, page, pageSize, sort, cvssFrom, cvssTo, publicFrom, publicTo, impact, dataFormat, businessRiskId, statusId, rulePresence, tags, sapSids, sapSystem, knownExploit, affecting, rhelVersion, report, advancedReport, ansible, mssql, advisoryAvailable, groupNames, groupIds, affectingHostType, options); return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { const axiosRequestArgs = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url}; @@ -5412,7 +6375,7 @@ export const DefaultApiFp = function(configuration?: Configuration) { * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async getCveListBySystem(inventoryId: string, filter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sort?: string, cvssFrom?: number, cvssTo?: number, publicFrom?: string, publicTo?: string, impact?: string, statusId?: string, dataFormat?: string, businessRiskId?: string, rulePresence?: Array, showAdvisories?: boolean, advisory?: string, ruleKey?: Array, knownExploit?: Array, firstReportedFrom?: string, firstReportedTo?: string, advisoryAvailable?: Array, remediation?: string, report?: boolean, tags?: Array, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + async getCveListBySystem(inventoryId: string, filter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sort?: string, cvssFrom?: number, cvssTo?: number, publicFrom?: string, publicTo?: string, impact?: string, statusId?: string, dataFormat?: string, businessRiskId?: string, rulePresence?: Array, showAdvisories?: boolean, advisory?: string, ruleKey?: Array, knownExploit?: Array, firstReportedFrom?: string, firstReportedTo?: string, advisoryAvailable?: Array, remediation?: string, report?: boolean, tags?: Array, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await DefaultApiAxiosParamCreator(configuration).getCveListBySystem(inventoryId, filter, limit, offset, page, pageSize, sort, cvssFrom, cvssTo, publicFrom, publicTo, impact, statusId, dataFormat, businessRiskId, rulePresence, showAdvisories, advisory, ruleKey, knownExploit, firstReportedFrom, firstReportedTo, advisoryAvailable, remediation, report, tags, options); return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { const axiosRequestArgs = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url}; @@ -5422,7 +6385,7 @@ export const DefaultApiFp = function(configuration?: Configuration) { /** * This is an overview of vulnerabilities for specific CVEs provided in the body. Use this endpoint to get a CVSS score, and learn the severity for a list of CVEs provided in the request. * @summary Send a vulnerabilities overview - * @param {VulnerabilitiesPostIn} vulnerabilitiesPostIn List of CVEs to provide info about. + * @param {InlineObject4} inlineObject4 * @param {string} [filter] Full text filter for CVE and it\'s description text. * @param {number} [limit] Maximum number of records per page. Limit/Offset pagination wins over page/page_size pagination. * @param {number} [offset] Offset of first record of paginated response. Limit/Offset pagination wins over page/page_size pagination. @@ -5432,8 +6395,21 @@ export const DefaultApiFp = function(configuration?: Configuration) { * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async getCveList_1(vulnerabilitiesPostIn: VulnerabilitiesPostIn, filter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sort?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await DefaultApiAxiosParamCreator(configuration).getCveList_1(vulnerabilitiesPostIn, filter, limit, offset, page, pageSize, sort, options); + async getCveList_1(inlineObject4: InlineObject4, filter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sort?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await DefaultApiAxiosParamCreator(configuration).getCveList_1(inlineObject4, filter, limit, offset, page, pageSize, sort, options); + return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { + const axiosRequestArgs = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url}; + return axios.request(axiosRequestArgs); + }; + }, + /** + * Use this endpoint to get an enablement status of reporting CVEs that do not have advisories (errata) for your customer account. If the feature is disabled, CVEs without advisories will be hidden in outputs of all endpoints. + * @summary Get a feature flag status for CVEs without errata + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async getCvesWithoutErrata(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await DefaultApiAxiosParamCreator(configuration).getCvesWithoutErrata(options); return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { const axiosRequestArgs = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url}; return axios.request(axiosRequestArgs); @@ -5450,7 +6426,7 @@ export const DefaultApiFp = function(configuration?: Configuration) { * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async getDashbar(tags?: Array, sapSids?: Array, sapSystem?: boolean, ansible?: boolean, mssql?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + async getDashbar(tags?: Array, sapSids?: Array, sapSystem?: boolean, ansible?: boolean, mssql?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await DefaultApiAxiosParamCreator(configuration).getDashbar(tags, sapSids, sapSystem, ansible, mssql, options); return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { const axiosRequestArgs = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url}; @@ -5468,7 +6444,7 @@ export const DefaultApiFp = function(configuration?: Configuration) { * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async getDashboard(tags?: Array, sapSids?: Array, sapSystem?: boolean, ansible?: boolean, mssql?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + async getDashboard(tags?: Array, sapSids?: Array, sapSystem?: boolean, ansible?: boolean, mssql?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await DefaultApiAxiosParamCreator(configuration).getDashboard(tags, sapSids, sapSystem, ansible, mssql, options); return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { const axiosRequestArgs = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url}; @@ -5481,7 +6457,7 @@ export const DefaultApiFp = function(configuration?: Configuration) { * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async getExecutiveReport(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + async getExecutiveReport(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await DefaultApiAxiosParamCreator(configuration).getExecutiveReport(options); return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { const axiosRequestArgs = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url}; @@ -5495,7 +6471,7 @@ export const DefaultApiFp = function(configuration?: Configuration) { * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async getOSExposure(dataFormat?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + async getOSExposure(dataFormat?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await DefaultApiAxiosParamCreator(configuration).getOSExposure(dataFormat, options); return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { const axiosRequestArgs = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url}; @@ -5509,7 +6485,7 @@ export const DefaultApiFp = function(configuration?: Configuration) { * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async getPlaybookTemplate(ruleId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + async getPlaybookTemplate(ruleId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await DefaultApiAxiosParamCreator(configuration).getPlaybookTemplate(ruleId, options); return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { const axiosRequestArgs = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url}; @@ -5522,7 +6498,7 @@ export const DefaultApiFp = function(configuration?: Configuration) { * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async getStatusList(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + async getStatusList(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await DefaultApiAxiosParamCreator(configuration).getStatusList(options); return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { const axiosRequestArgs = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url}; @@ -5537,7 +6513,7 @@ export const DefaultApiFp = function(configuration?: Configuration) { * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async getSystemDetails(inventoryId: string, tags?: Array, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + async getSystemDetails(inventoryId: string, tags?: Array, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await DefaultApiAxiosParamCreator(configuration).getSystemDetails(inventoryId, tags, options); return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { const axiosRequestArgs = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url}; @@ -5569,7 +6545,7 @@ export const DefaultApiFp = function(configuration?: Configuration) { * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async getSystemsIds(filter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sort?: string, dataFormat?: string, stale?: boolean, uuid?: string, tags?: Array, sapSids?: Array, sapSystem?: boolean, excluded?: Array, rhelVersion?: string, ansible?: boolean, mssql?: boolean, groupNames?: Array, groupIds?: Array, hostType?: Array<'rpmdnf' | 'image' | 'edge'>, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + async getSystemsIds(filter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sort?: string, dataFormat?: string, stale?: boolean, uuid?: string, tags?: Array, sapSids?: Array, sapSystem?: boolean, excluded?: Array, rhelVersion?: string, ansible?: boolean, mssql?: boolean, groupNames?: Array, groupIds?: Array, hostType?: Array<'rpmdnf' | 'image' | 'edge'>, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await DefaultApiAxiosParamCreator(configuration).getSystemsIds(filter, limit, offset, page, pageSize, sort, dataFormat, stale, uuid, tags, sapSids, sapSystem, excluded, rhelVersion, ansible, mssql, groupNames, groupIds, hostType, options); return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { const axiosRequestArgs = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url}; @@ -5602,7 +6578,7 @@ export const DefaultApiFp = function(configuration?: Configuration) { * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async getSystemsList(filter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sort?: string, dataFormat?: string, stale?: boolean, uuid?: string, tags?: Array, sapSids?: Array, sapSystem?: boolean, excluded?: Array, rhelVersion?: string, report?: boolean, ansible?: boolean, mssql?: boolean, groupNames?: Array, groupIds?: Array, hostType?: Array<'rpmdnf' | 'image' | 'edge'>, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + async getSystemsList(filter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sort?: string, dataFormat?: string, stale?: boolean, uuid?: string, tags?: Array, sapSids?: Array, sapSystem?: boolean, excluded?: Array, rhelVersion?: string, report?: boolean, ansible?: boolean, mssql?: boolean, groupNames?: Array, groupIds?: Array, hostType?: Array<'rpmdnf' | 'image' | 'edge'>, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await DefaultApiAxiosParamCreator(configuration).getSystemsList(filter, limit, offset, page, pageSize, sort, dataFormat, stale, uuid, tags, sapSids, sapSystem, excluded, rhelVersion, report, ansible, mssql, groupNames, groupIds, hostType, options); return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { const axiosRequestArgs = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url}; @@ -5615,7 +6591,7 @@ export const DefaultApiFp = function(configuration?: Configuration) { * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async getVersion(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + async getVersion(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await DefaultApiAxiosParamCreator(configuration).getVersion(options); return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { const axiosRequestArgs = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url}; @@ -5625,12 +6601,12 @@ export const DefaultApiFp = function(configuration?: Configuration) { /** * This sets a business risk for a specific CVE. Set a value of low, medium, high or critical for a given CVE. These values are obtained by the business risk path *GET/business_risk*. To set a business risk, you must call the GET/business_risk endpoint first, followed by the *PATCH/cves/business_risk* path. * @summary Set business risk for a CVE - * @param {CveRiskIn} cveRiskIn Values to be set. At least one of the \"business_risk_id\" or \"business_risk_text\" parameters is required. + * @param {InlineObject} inlineObject * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async setCveBusinessRisk(cveRiskIn: CveRiskIn, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await DefaultApiAxiosParamCreator(configuration).setCveBusinessRisk(cveRiskIn, options); + async setCveBusinessRisk(inlineObject: InlineObject, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await DefaultApiAxiosParamCreator(configuration).setCveBusinessRisk(inlineObject, options); return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { const axiosRequestArgs = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url}; return axios.request(axiosRequestArgs); @@ -5639,12 +6615,12 @@ export const DefaultApiFp = function(configuration?: Configuration) { /** * This sets the status for a specific CVE. Set a status value for a given CVE (e.g. in-review, on-hold, scheduled for a patch, or resolved). These values are obtained by sending a *GET/status* request. To set a status, you must call the *GET/business_risk* first, followed by the *PATCH/cves/status* path. * @summary Set status for a CVE - * @param {CveStatusIn} cveStatusIn Values to be set. At least one of the \"status_id\" or \"status_text\" parameters is required. + * @param {InlineObject1} inlineObject1 * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async setCveStatus(cveStatusIn: CveStatusIn, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await DefaultApiAxiosParamCreator(configuration).setCveStatus(cveStatusIn, options); + async setCveStatus(inlineObject1: InlineObject1, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await DefaultApiAxiosParamCreator(configuration).setCveStatus(inlineObject1, options); return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { const axiosRequestArgs = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url}; return axios.request(axiosRequestArgs); @@ -5653,12 +6629,12 @@ export const DefaultApiFp = function(configuration?: Configuration) { /** * Use this endpoint to enable/disable reporting CVEs that do not have advisories (errata) for your customer account. If the feature is disabled, CVEs without advisories will be hidden in outputs of all endpoints. * @summary Set a feature flag for CVEs without errata - * @param {CvesWithoutErrataIn} cvesWithoutErrataIn Values to be set. + * @param {InlineObject5} inlineObject5 * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async setCvesWithoutErrata(cvesWithoutErrataIn: CvesWithoutErrataIn, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await DefaultApiAxiosParamCreator(configuration).setCvesWithoutErrata(cvesWithoutErrataIn, options); + async setCvesWithoutErrata(inlineObject5: InlineObject5, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await DefaultApiAxiosParamCreator(configuration).setCvesWithoutErrata(inlineObject5, options); return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { const axiosRequestArgs = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url}; return axios.request(axiosRequestArgs); @@ -5667,12 +6643,12 @@ export const DefaultApiFp = function(configuration?: Configuration) { /** * This endpoint sets status for given systems and CVEs. Use this endpoint when you need to set a status value for system-CVE pairs. * @summary Set status for system vulnerabilities - * @param {StatusIn} statusIn Values to be set. + * @param {InlineObject2} inlineObject2 * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async setStatus(statusIn: StatusIn, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await DefaultApiAxiosParamCreator(configuration).setStatus(statusIn, options); + async setStatus(inlineObject2: InlineObject2, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await DefaultApiAxiosParamCreator(configuration).setStatus(inlineObject2, options); return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { const axiosRequestArgs = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url}; return axios.request(axiosRequestArgs); @@ -5681,12 +6657,12 @@ export const DefaultApiFp = function(configuration?: Configuration) { /** * Opt a specific system in or out of vulnerability analysis. Use this when you want to use other Insights services but do not want to see specific systems in vulnerability reports. This allows you to hide select systems. * @summary Opt a system in or out of the vulnerability service - * @param {OptOutIn} optOutIn Values to be set. + * @param {InlineObject3} inlineObject3 * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async setSystemsOptOut(optOutIn: OptOutIn, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await DefaultApiAxiosParamCreator(configuration).setSystemsOptOut(optOutIn, options); + async setSystemsOptOut(inlineObject3: InlineObject3, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await DefaultApiAxiosParamCreator(configuration).setSystemsOptOut(inlineObject3, options); return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { const axiosRequestArgs = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url}; return axios.request(axiosRequestArgs); @@ -5707,7 +6683,7 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa * @param {*} [options] Override http request option. * @throws {RequiredError} */ - deleteNotifications(options?: any): AxiosPromise { + deleteNotifications(options?: any): AxiosPromise { return DefaultApiFp(configuration).deleteNotifications(options).then((request) => request(axios, basePath)); }, /** @@ -5745,7 +6721,7 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getAffectedSystemsByCve(cveId: string, filter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sort?: string, statusId?: string, dataFormat?: string, uuid?: string, ruleKey?: Array, rulePresence?: Array, rule?: Array, tags?: Array, sapSids?: Array, sapSystem?: boolean, showAdvisories?: boolean, advisory?: string, rhelVersion?: string, firstReportedFrom?: string, firstReportedTo?: string, advisoryAvailable?: Array, remediation?: string, report?: boolean, ansible?: boolean, mssql?: boolean, groupNames?: Array, groupIds?: Array, hostType?: Array<'rpmdnf' | 'image' | 'edge'>, options?: any): AxiosPromise { + getAffectedSystemsByCve(cveId: string, filter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sort?: string, statusId?: string, dataFormat?: string, uuid?: string, ruleKey?: Array, rulePresence?: Array, rule?: Array, tags?: Array, sapSids?: Array, sapSystem?: boolean, showAdvisories?: boolean, advisory?: string, rhelVersion?: string, firstReportedFrom?: string, firstReportedTo?: string, advisoryAvailable?: Array, remediation?: string, report?: boolean, ansible?: boolean, mssql?: boolean, groupNames?: Array, groupIds?: Array, hostType?: Array<'rpmdnf' | 'image' | 'edge'>, options?: any): AxiosPromise { return DefaultApiFp(configuration).getAffectedSystemsByCve(cveId, filter, limit, offset, page, pageSize, sort, statusId, dataFormat, uuid, ruleKey, rulePresence, rule, tags, sapSids, sapSystem, showAdvisories, advisory, rhelVersion, firstReportedFrom, firstReportedTo, advisoryAvailable, remediation, report, ansible, mssql, groupNames, groupIds, hostType, options).then((request) => request(axios, basePath)); }, /** @@ -5782,7 +6758,7 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getAffectedSystemsIdsByCve(cveId: string, filter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sort?: string, statusId?: string, dataFormat?: string, uuid?: string, ruleKey?: Array, rulePresence?: Array, rule?: Array, tags?: Array, sapSids?: Array, sapSystem?: boolean, showAdvisories?: boolean, advisory?: string, rhelVersion?: string, firstReportedFrom?: string, firstReportedTo?: string, advisoryAvailable?: Array, remediation?: string, ansible?: boolean, mssql?: boolean, groupNames?: Array, groupIds?: Array, hostType?: Array<'rpmdnf' | 'image' | 'edge'>, options?: any): AxiosPromise { + getAffectedSystemsIdsByCve(cveId: string, filter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sort?: string, statusId?: string, dataFormat?: string, uuid?: string, ruleKey?: Array, rulePresence?: Array, rule?: Array, tags?: Array, sapSids?: Array, sapSystem?: boolean, showAdvisories?: boolean, advisory?: string, rhelVersion?: string, firstReportedFrom?: string, firstReportedTo?: string, advisoryAvailable?: Array, remediation?: string, ansible?: boolean, mssql?: boolean, groupNames?: Array, groupIds?: Array, hostType?: Array<'rpmdnf' | 'image' | 'edge'>, options?: any): AxiosPromise { return DefaultApiFp(configuration).getAffectedSystemsIdsByCve(cveId, filter, limit, offset, page, pageSize, sort, statusId, dataFormat, uuid, ruleKey, rulePresence, rule, tags, sapSids, sapSystem, showAdvisories, advisory, rhelVersion, firstReportedFrom, firstReportedTo, advisoryAvailable, remediation, ansible, mssql, groupNames, groupIds, hostType, options).then((request) => request(axios, basePath)); }, /** @@ -5791,7 +6767,7 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getAnnouncement(options?: any): AxiosPromise { + getAnnouncement(options?: any): AxiosPromise { return DefaultApiFp(configuration).getAnnouncement(options).then((request) => request(axios, basePath)); }, /** @@ -5809,7 +6785,7 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getBusinessRiskList(options?: any): AxiosPromise { + getBusinessRiskList(options?: any): AxiosPromise { return DefaultApiFp(configuration).getBusinessRiskList(options).then((request) => request(axios, basePath)); }, /** @@ -5820,7 +6796,7 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getCveDetails(cveId: string, advisoryAvailable?: Array, options?: any): AxiosPromise { + getCveDetails(cveId: string, advisoryAvailable?: Array, options?: any): AxiosPromise { return DefaultApiFp(configuration).getCveDetails(cveId, advisoryAvailable, options).then((request) => request(axios, basePath)); }, /** @@ -5854,7 +6830,7 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getCveIdsBySystem(inventoryId: string, filter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sort?: string, cvssFrom?: number, cvssTo?: number, publicFrom?: string, publicTo?: string, impact?: string, statusId?: string, dataFormat?: string, businessRiskId?: string, rulePresence?: Array, showAdvisories?: boolean, advisory?: string, ruleKey?: Array, knownExploit?: Array, firstReportedFrom?: string, firstReportedTo?: string, advisoryAvailable?: Array, remediation?: string, tags?: Array, options?: any): AxiosPromise { + getCveIdsBySystem(inventoryId: string, filter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sort?: string, cvssFrom?: number, cvssTo?: number, publicFrom?: string, publicTo?: string, impact?: string, statusId?: string, dataFormat?: string, businessRiskId?: string, rulePresence?: Array, showAdvisories?: boolean, advisory?: string, ruleKey?: Array, knownExploit?: Array, firstReportedFrom?: string, firstReportedTo?: string, advisoryAvailable?: Array, remediation?: string, tags?: Array, options?: any): AxiosPromise { return DefaultApiFp(configuration).getCveIdsBySystem(inventoryId, filter, limit, offset, page, pageSize, sort, cvssFrom, cvssTo, publicFrom, publicTo, impact, statusId, dataFormat, businessRiskId, rulePresence, showAdvisories, advisory, ruleKey, knownExploit, firstReportedFrom, firstReportedTo, advisoryAvailable, remediation, tags, options).then((request) => request(axios, basePath)); }, /** @@ -5887,7 +6863,7 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getCveIdsList(filter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sort?: string, cvssFrom?: number, cvssTo?: number, publicFrom?: string, publicTo?: string, impact?: string, dataFormat?: string, businessRiskId?: string, statusId?: string, rulePresence?: Array, tags?: Array, sapSids?: Array, sapSystem?: boolean, knownExploit?: Array, affecting?: Array, rhelVersion?: string, ansible?: boolean, mssql?: boolean, advisoryAvailable?: Array, options?: any): AxiosPromise { + getCveIdsList(filter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sort?: string, cvssFrom?: number, cvssTo?: number, publicFrom?: string, publicTo?: string, impact?: string, dataFormat?: string, businessRiskId?: string, statusId?: string, rulePresence?: Array, tags?: Array, sapSids?: Array, sapSystem?: boolean, knownExploit?: Array, affecting?: Array, rhelVersion?: string, ansible?: boolean, mssql?: boolean, advisoryAvailable?: Array, options?: any): AxiosPromise { return DefaultApiFp(configuration).getCveIdsList(filter, limit, offset, page, pageSize, sort, cvssFrom, cvssTo, publicFrom, publicTo, impact, dataFormat, businessRiskId, statusId, rulePresence, tags, sapSids, sapSystem, knownExploit, affecting, rhelVersion, ansible, mssql, advisoryAvailable, options).then((request) => request(axios, basePath)); }, /** @@ -5925,7 +6901,7 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getCveList(filter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sort?: string, cvssFrom?: number, cvssTo?: number, publicFrom?: string, publicTo?: string, impact?: string, dataFormat?: string, businessRiskId?: string, statusId?: string, rulePresence?: Array, tags?: Array, sapSids?: Array, sapSystem?: boolean, knownExploit?: Array, affecting?: Array, rhelVersion?: string, report?: boolean, advancedReport?: boolean, ansible?: boolean, mssql?: boolean, advisoryAvailable?: Array, groupNames?: Array, groupIds?: Array, affectingHostType?: Array<'rpmdnf' | 'image' | 'edge' | 'none'>, options?: any): AxiosPromise { + getCveList(filter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sort?: string, cvssFrom?: number, cvssTo?: number, publicFrom?: string, publicTo?: string, impact?: string, dataFormat?: string, businessRiskId?: string, statusId?: string, rulePresence?: Array, tags?: Array, sapSids?: Array, sapSystem?: boolean, knownExploit?: Array, affecting?: Array, rhelVersion?: string, report?: boolean, advancedReport?: boolean, ansible?: boolean, mssql?: boolean, advisoryAvailable?: Array, groupNames?: Array, groupIds?: Array, affectingHostType?: Array<'rpmdnf' | 'image' | 'edge' | 'none'>, options?: any): AxiosPromise { return DefaultApiFp(configuration).getCveList(filter, limit, offset, page, pageSize, sort, cvssFrom, cvssTo, publicFrom, publicTo, impact, dataFormat, businessRiskId, statusId, rulePresence, tags, sapSids, sapSystem, knownExploit, affecting, rhelVersion, report, advancedReport, ansible, mssql, advisoryAvailable, groupNames, groupIds, affectingHostType, options).then((request) => request(axios, basePath)); }, /** @@ -5960,13 +6936,13 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getCveListBySystem(inventoryId: string, filter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sort?: string, cvssFrom?: number, cvssTo?: number, publicFrom?: string, publicTo?: string, impact?: string, statusId?: string, dataFormat?: string, businessRiskId?: string, rulePresence?: Array, showAdvisories?: boolean, advisory?: string, ruleKey?: Array, knownExploit?: Array, firstReportedFrom?: string, firstReportedTo?: string, advisoryAvailable?: Array, remediation?: string, report?: boolean, tags?: Array, options?: any): AxiosPromise { + getCveListBySystem(inventoryId: string, filter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sort?: string, cvssFrom?: number, cvssTo?: number, publicFrom?: string, publicTo?: string, impact?: string, statusId?: string, dataFormat?: string, businessRiskId?: string, rulePresence?: Array, showAdvisories?: boolean, advisory?: string, ruleKey?: Array, knownExploit?: Array, firstReportedFrom?: string, firstReportedTo?: string, advisoryAvailable?: Array, remediation?: string, report?: boolean, tags?: Array, options?: any): AxiosPromise { return DefaultApiFp(configuration).getCveListBySystem(inventoryId, filter, limit, offset, page, pageSize, sort, cvssFrom, cvssTo, publicFrom, publicTo, impact, statusId, dataFormat, businessRiskId, rulePresence, showAdvisories, advisory, ruleKey, knownExploit, firstReportedFrom, firstReportedTo, advisoryAvailable, remediation, report, tags, options).then((request) => request(axios, basePath)); }, /** * This is an overview of vulnerabilities for specific CVEs provided in the body. Use this endpoint to get a CVSS score, and learn the severity for a list of CVEs provided in the request. * @summary Send a vulnerabilities overview - * @param {VulnerabilitiesPostIn} vulnerabilitiesPostIn List of CVEs to provide info about. + * @param {InlineObject4} inlineObject4 * @param {string} [filter] Full text filter for CVE and it\'s description text. * @param {number} [limit] Maximum number of records per page. Limit/Offset pagination wins over page/page_size pagination. * @param {number} [offset] Offset of first record of paginated response. Limit/Offset pagination wins over page/page_size pagination. @@ -5976,8 +6952,17 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getCveList_1(vulnerabilitiesPostIn: VulnerabilitiesPostIn, filter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sort?: string, options?: any): AxiosPromise { - return DefaultApiFp(configuration).getCveList_1(vulnerabilitiesPostIn, filter, limit, offset, page, pageSize, sort, options).then((request) => request(axios, basePath)); + getCveList_1(inlineObject4: InlineObject4, filter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sort?: string, options?: any): AxiosPromise { + return DefaultApiFp(configuration).getCveList_1(inlineObject4, filter, limit, offset, page, pageSize, sort, options).then((request) => request(axios, basePath)); + }, + /** + * Use this endpoint to get an enablement status of reporting CVEs that do not have advisories (errata) for your customer account. If the feature is disabled, CVEs without advisories will be hidden in outputs of all endpoints. + * @summary Get a feature flag status for CVEs without errata + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getCvesWithoutErrata(options?: any): AxiosPromise { + return DefaultApiFp(configuration).getCvesWithoutErrata(options).then((request) => request(axios, basePath)); }, /** * These are aggregations summarizing your account such as number of unique CVEs, list of security rules, CVEs by severity and more. Use this endpoint to obtain a snapshot of all the CVES and details about their prevalence, severity and other details. @@ -5990,7 +6975,7 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getDashbar(tags?: Array, sapSids?: Array, sapSystem?: boolean, ansible?: boolean, mssql?: boolean, options?: any): AxiosPromise { + getDashbar(tags?: Array, sapSids?: Array, sapSystem?: boolean, ansible?: boolean, mssql?: boolean, options?: any): AxiosPromise { return DefaultApiFp(configuration).getDashbar(tags, sapSids, sapSystem, ansible, mssql, options).then((request) => request(axios, basePath)); }, /** @@ -6004,7 +6989,7 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getDashboard(tags?: Array, sapSids?: Array, sapSystem?: boolean, ansible?: boolean, mssql?: boolean, options?: any): AxiosPromise { + getDashboard(tags?: Array, sapSids?: Array, sapSystem?: boolean, ansible?: boolean, mssql?: boolean, options?: any): AxiosPromise { return DefaultApiFp(configuration).getDashboard(tags, sapSids, sapSystem, ansible, mssql, options).then((request) => request(axios, basePath)); }, /** @@ -6013,7 +6998,7 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getExecutiveReport(options?: any): AxiosPromise { + getExecutiveReport(options?: any): AxiosPromise { return DefaultApiFp(configuration).getExecutiveReport(options).then((request) => request(axios, basePath)); }, /** @@ -6023,7 +7008,7 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getOSExposure(dataFormat?: string, options?: any): AxiosPromise { + getOSExposure(dataFormat?: string, options?: any): AxiosPromise { return DefaultApiFp(configuration).getOSExposure(dataFormat, options).then((request) => request(axios, basePath)); }, /** @@ -6033,7 +7018,7 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getPlaybookTemplate(ruleId: string, options?: any): AxiosPromise { + getPlaybookTemplate(ruleId: string, options?: any): AxiosPromise { return DefaultApiFp(configuration).getPlaybookTemplate(ruleId, options).then((request) => request(axios, basePath)); }, /** @@ -6042,7 +7027,7 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getStatusList(options?: any): AxiosPromise { + getStatusList(options?: any): AxiosPromise { return DefaultApiFp(configuration).getStatusList(options).then((request) => request(axios, basePath)); }, /** @@ -6053,7 +7038,7 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getSystemDetails(inventoryId: string, tags?: Array, options?: any): AxiosPromise { + getSystemDetails(inventoryId: string, tags?: Array, options?: any): AxiosPromise { return DefaultApiFp(configuration).getSystemDetails(inventoryId, tags, options).then((request) => request(axios, basePath)); }, /** @@ -6081,7 +7066,7 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getSystemsIds(filter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sort?: string, dataFormat?: string, stale?: boolean, uuid?: string, tags?: Array, sapSids?: Array, sapSystem?: boolean, excluded?: Array, rhelVersion?: string, ansible?: boolean, mssql?: boolean, groupNames?: Array, groupIds?: Array, hostType?: Array<'rpmdnf' | 'image' | 'edge'>, options?: any): AxiosPromise { + getSystemsIds(filter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sort?: string, dataFormat?: string, stale?: boolean, uuid?: string, tags?: Array, sapSids?: Array, sapSystem?: boolean, excluded?: Array, rhelVersion?: string, ansible?: boolean, mssql?: boolean, groupNames?: Array, groupIds?: Array, hostType?: Array<'rpmdnf' | 'image' | 'edge'>, options?: any): AxiosPromise { return DefaultApiFp(configuration).getSystemsIds(filter, limit, offset, page, pageSize, sort, dataFormat, stale, uuid, tags, sapSids, sapSystem, excluded, rhelVersion, ansible, mssql, groupNames, groupIds, hostType, options).then((request) => request(axios, basePath)); }, /** @@ -6110,7 +7095,7 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getSystemsList(filter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sort?: string, dataFormat?: string, stale?: boolean, uuid?: string, tags?: Array, sapSids?: Array, sapSystem?: boolean, excluded?: Array, rhelVersion?: string, report?: boolean, ansible?: boolean, mssql?: boolean, groupNames?: Array, groupIds?: Array, hostType?: Array<'rpmdnf' | 'image' | 'edge'>, options?: any): AxiosPromise { + getSystemsList(filter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sort?: string, dataFormat?: string, stale?: boolean, uuid?: string, tags?: Array, sapSids?: Array, sapSystem?: boolean, excluded?: Array, rhelVersion?: string, report?: boolean, ansible?: boolean, mssql?: boolean, groupNames?: Array, groupIds?: Array, hostType?: Array<'rpmdnf' | 'image' | 'edge'>, options?: any): AxiosPromise { return DefaultApiFp(configuration).getSystemsList(filter, limit, offset, page, pageSize, sort, dataFormat, stale, uuid, tags, sapSids, sapSystem, excluded, rhelVersion, report, ansible, mssql, groupNames, groupIds, hostType, options).then((request) => request(axios, basePath)); }, /** @@ -6119,58 +7104,58 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getVersion(options?: any): AxiosPromise { + getVersion(options?: any): AxiosPromise { return DefaultApiFp(configuration).getVersion(options).then((request) => request(axios, basePath)); }, /** * This sets a business risk for a specific CVE. Set a value of low, medium, high or critical for a given CVE. These values are obtained by the business risk path *GET/business_risk*. To set a business risk, you must call the GET/business_risk endpoint first, followed by the *PATCH/cves/business_risk* path. * @summary Set business risk for a CVE - * @param {CveRiskIn} cveRiskIn Values to be set. At least one of the \"business_risk_id\" or \"business_risk_text\" parameters is required. + * @param {InlineObject} inlineObject * @param {*} [options] Override http request option. * @throws {RequiredError} */ - setCveBusinessRisk(cveRiskIn: CveRiskIn, options?: any): AxiosPromise { - return DefaultApiFp(configuration).setCveBusinessRisk(cveRiskIn, options).then((request) => request(axios, basePath)); + setCveBusinessRisk(inlineObject: InlineObject, options?: any): AxiosPromise { + return DefaultApiFp(configuration).setCveBusinessRisk(inlineObject, options).then((request) => request(axios, basePath)); }, /** * This sets the status for a specific CVE. Set a status value for a given CVE (e.g. in-review, on-hold, scheduled for a patch, or resolved). These values are obtained by sending a *GET/status* request. To set a status, you must call the *GET/business_risk* first, followed by the *PATCH/cves/status* path. * @summary Set status for a CVE - * @param {CveStatusIn} cveStatusIn Values to be set. At least one of the \"status_id\" or \"status_text\" parameters is required. + * @param {InlineObject1} inlineObject1 * @param {*} [options] Override http request option. * @throws {RequiredError} */ - setCveStatus(cveStatusIn: CveStatusIn, options?: any): AxiosPromise { - return DefaultApiFp(configuration).setCveStatus(cveStatusIn, options).then((request) => request(axios, basePath)); + setCveStatus(inlineObject1: InlineObject1, options?: any): AxiosPromise { + return DefaultApiFp(configuration).setCveStatus(inlineObject1, options).then((request) => request(axios, basePath)); }, /** * Use this endpoint to enable/disable reporting CVEs that do not have advisories (errata) for your customer account. If the feature is disabled, CVEs without advisories will be hidden in outputs of all endpoints. * @summary Set a feature flag for CVEs without errata - * @param {CvesWithoutErrataIn} cvesWithoutErrataIn Values to be set. + * @param {InlineObject5} inlineObject5 * @param {*} [options] Override http request option. * @throws {RequiredError} */ - setCvesWithoutErrata(cvesWithoutErrataIn: CvesWithoutErrataIn, options?: any): AxiosPromise { - return DefaultApiFp(configuration).setCvesWithoutErrata(cvesWithoutErrataIn, options).then((request) => request(axios, basePath)); + setCvesWithoutErrata(inlineObject5: InlineObject5, options?: any): AxiosPromise { + return DefaultApiFp(configuration).setCvesWithoutErrata(inlineObject5, options).then((request) => request(axios, basePath)); }, /** * This endpoint sets status for given systems and CVEs. Use this endpoint when you need to set a status value for system-CVE pairs. * @summary Set status for system vulnerabilities - * @param {StatusIn} statusIn Values to be set. + * @param {InlineObject2} inlineObject2 * @param {*} [options] Override http request option. * @throws {RequiredError} */ - setStatus(statusIn: StatusIn, options?: any): AxiosPromise { - return DefaultApiFp(configuration).setStatus(statusIn, options).then((request) => request(axios, basePath)); + setStatus(inlineObject2: InlineObject2, options?: any): AxiosPromise { + return DefaultApiFp(configuration).setStatus(inlineObject2, options).then((request) => request(axios, basePath)); }, /** * Opt a specific system in or out of vulnerability analysis. Use this when you want to use other Insights services but do not want to see specific systems in vulnerability reports. This allows you to hide select systems. * @summary Opt a system in or out of the vulnerability service - * @param {OptOutIn} optOutIn Values to be set. + * @param {InlineObject3} inlineObject3 * @param {*} [options] Override http request option. * @throws {RequiredError} */ - setSystemsOptOut(optOutIn: OptOutIn, options?: any): AxiosPromise { - return DefaultApiFp(configuration).setSystemsOptOut(optOutIn, options).then((request) => request(axios, basePath)); + setSystemsOptOut(inlineObject3: InlineObject3, options?: any): AxiosPromise { + return DefaultApiFp(configuration).setSystemsOptOut(inlineObject3, options).then((request) => request(axios, basePath)); }, }; }; @@ -6469,7 +7454,7 @@ export class DefaultApi extends BaseAPI { /** * This is an overview of vulnerabilities for specific CVEs provided in the body. Use this endpoint to get a CVSS score, and learn the severity for a list of CVEs provided in the request. * @summary Send a vulnerabilities overview - * @param {VulnerabilitiesPostIn} vulnerabilitiesPostIn List of CVEs to provide info about. + * @param {InlineObject4} inlineObject4 * @param {string} [filter] Full text filter for CVE and it\'s description text. * @param {number} [limit] Maximum number of records per page. Limit/Offset pagination wins over page/page_size pagination. * @param {number} [offset] Offset of first record of paginated response. Limit/Offset pagination wins over page/page_size pagination. @@ -6480,8 +7465,19 @@ export class DefaultApi extends BaseAPI { * @throws {RequiredError} * @memberof DefaultApi */ - public getCveList_1(vulnerabilitiesPostIn: VulnerabilitiesPostIn, filter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sort?: string, options?: any) { - return DefaultApiFp(this.configuration).getCveList_1(vulnerabilitiesPostIn, filter, limit, offset, page, pageSize, sort, options).then((request) => request(this.axios, this.basePath)); + public getCveList_1(inlineObject4: InlineObject4, filter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sort?: string, options?: any) { + return DefaultApiFp(this.configuration).getCveList_1(inlineObject4, filter, limit, offset, page, pageSize, sort, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Use this endpoint to get an enablement status of reporting CVEs that do not have advisories (errata) for your customer account. If the feature is disabled, CVEs without advisories will be hidden in outputs of all endpoints. + * @summary Get a feature flag status for CVEs without errata + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof DefaultApi + */ + public getCvesWithoutErrata(options?: any) { + return DefaultApiFp(this.configuration).getCvesWithoutErrata(options).then((request) => request(this.axios, this.basePath)); } /** @@ -6650,61 +7646,61 @@ export class DefaultApi extends BaseAPI { /** * This sets a business risk for a specific CVE. Set a value of low, medium, high or critical for a given CVE. These values are obtained by the business risk path *GET/business_risk*. To set a business risk, you must call the GET/business_risk endpoint first, followed by the *PATCH/cves/business_risk* path. * @summary Set business risk for a CVE - * @param {CveRiskIn} cveRiskIn Values to be set. At least one of the \"business_risk_id\" or \"business_risk_text\" parameters is required. + * @param {InlineObject} inlineObject * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ - public setCveBusinessRisk(cveRiskIn: CveRiskIn, options?: any) { - return DefaultApiFp(this.configuration).setCveBusinessRisk(cveRiskIn, options).then((request) => request(this.axios, this.basePath)); + public setCveBusinessRisk(inlineObject: InlineObject, options?: any) { + return DefaultApiFp(this.configuration).setCveBusinessRisk(inlineObject, options).then((request) => request(this.axios, this.basePath)); } /** * This sets the status for a specific CVE. Set a status value for a given CVE (e.g. in-review, on-hold, scheduled for a patch, or resolved). These values are obtained by sending a *GET/status* request. To set a status, you must call the *GET/business_risk* first, followed by the *PATCH/cves/status* path. * @summary Set status for a CVE - * @param {CveStatusIn} cveStatusIn Values to be set. At least one of the \"status_id\" or \"status_text\" parameters is required. + * @param {InlineObject1} inlineObject1 * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ - public setCveStatus(cveStatusIn: CveStatusIn, options?: any) { - return DefaultApiFp(this.configuration).setCveStatus(cveStatusIn, options).then((request) => request(this.axios, this.basePath)); + public setCveStatus(inlineObject1: InlineObject1, options?: any) { + return DefaultApiFp(this.configuration).setCveStatus(inlineObject1, options).then((request) => request(this.axios, this.basePath)); } /** * Use this endpoint to enable/disable reporting CVEs that do not have advisories (errata) for your customer account. If the feature is disabled, CVEs without advisories will be hidden in outputs of all endpoints. * @summary Set a feature flag for CVEs without errata - * @param {CvesWithoutErrataIn} cvesWithoutErrataIn Values to be set. + * @param {InlineObject5} inlineObject5 * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ - public setCvesWithoutErrata(cvesWithoutErrataIn: CvesWithoutErrataIn, options?: any) { - return DefaultApiFp(this.configuration).setCvesWithoutErrata(cvesWithoutErrataIn, options).then((request) => request(this.axios, this.basePath)); + public setCvesWithoutErrata(inlineObject5: InlineObject5, options?: any) { + return DefaultApiFp(this.configuration).setCvesWithoutErrata(inlineObject5, options).then((request) => request(this.axios, this.basePath)); } /** * This endpoint sets status for given systems and CVEs. Use this endpoint when you need to set a status value for system-CVE pairs. * @summary Set status for system vulnerabilities - * @param {StatusIn} statusIn Values to be set. + * @param {InlineObject2} inlineObject2 * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ - public setStatus(statusIn: StatusIn, options?: any) { - return DefaultApiFp(this.configuration).setStatus(statusIn, options).then((request) => request(this.axios, this.basePath)); + public setStatus(inlineObject2: InlineObject2, options?: any) { + return DefaultApiFp(this.configuration).setStatus(inlineObject2, options).then((request) => request(this.axios, this.basePath)); } /** * Opt a specific system in or out of vulnerability analysis. Use this when you want to use other Insights services but do not want to see specific systems in vulnerability reports. This allows you to hide select systems. * @summary Opt a system in or out of the vulnerability service - * @param {OptOutIn} optOutIn Values to be set. + * @param {InlineObject3} inlineObject3 * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ - public setSystemsOptOut(optOutIn: OptOutIn, options?: any) { - return DefaultApiFp(this.configuration).setSystemsOptOut(optOutIn, options).then((request) => request(this.axios, this.basePath)); + public setSystemsOptOut(inlineObject3: InlineObject3, options?: any) { + return DefaultApiFp(this.configuration).setSystemsOptOut(inlineObject3, options).then((request) => request(this.axios, this.basePath)); } } diff --git a/packages/vulnerabilities/git-api/base.ts b/packages/vulnerabilities/git-api/base.ts index 53d914ed3..e607631d9 100644 --- a/packages/vulnerabilities/git-api/base.ts +++ b/packages/vulnerabilities/git-api/base.ts @@ -3,7 +3,7 @@ * Vulnerability Engine Manager * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * - * The version of the OpenAPI document: 2.70.8 + * The version of the OpenAPI document: 2.74.1 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/packages/vulnerabilities/git-api/configuration.ts b/packages/vulnerabilities/git-api/configuration.ts index ea4436a6d..da7e7b06d 100644 --- a/packages/vulnerabilities/git-api/configuration.ts +++ b/packages/vulnerabilities/git-api/configuration.ts @@ -3,7 +3,7 @@ * Vulnerability Engine Manager * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * - * The version of the OpenAPI document: 2.70.8 + * The version of the OpenAPI document: 2.74.1 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/packages/vulnerabilities/git-api/index.ts b/packages/vulnerabilities/git-api/index.ts index 75cad59fd..a5c09208b 100644 --- a/packages/vulnerabilities/git-api/index.ts +++ b/packages/vulnerabilities/git-api/index.ts @@ -3,7 +3,7 @@ * Vulnerability Engine Manager * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * - * The version of the OpenAPI document: 2.70.8 + * The version of the OpenAPI document: 2.74.1 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/packages/vulnerabilities/index.ts b/packages/vulnerabilities/index.ts index 499773233..e974540c9 100644 --- a/packages/vulnerabilities/index.ts +++ b/packages/vulnerabilities/index.ts @@ -3,7 +3,7 @@ * Vulnerability Engine Manager * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * - * The version of the OpenAPI document: 2.70.8 + * The version of the OpenAPI document: 2.74.1 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -15,4 +15,3 @@ export * from "./api"; export * from "./configuration"; export { DefaultApi as GitApi } from "./git-api"; -// Trigger release - updated to regenerate clients