From 1993b225fd3ceb205453bb93e30ee68a664ea227 Mon Sep 17 00:00:00 2001 From: GitHub Date: Tue, 5 Nov 2024 21:49:01 +0000 Subject: [PATCH] chore(nightly-sync): API sync and client generation --- package-lock.json | 2 +- .../EndpointResourceV1CreateEndpoint/index.ts | 16 +- .../EndpointResourceV1GetEndpoint/index.ts | 2 +- .../index.ts | 2 +- .../index.ts | 2 +- .../EndpointResourceV1UpdateEndpoint/index.ts | 16 +- packages/integrations/api.ts | 2151 ++-------------- packages/integrations/types/index.ts | 2083 ++-------------- .../notifications/.openapi-generator/FILES | 1 + .../index.ts | 65 + packages/notifications/api.ts | 2171 ++++------------- packages/notifications/index.ts | 4 + packages/notifications/types/index.ts | 2048 +++------------- packages/patch/api.ts | 2 +- packages/patch/base.ts | 2 +- packages/patch/configuration.ts | 2 +- packages/patch/index.ts | 2 +- packages/rbac/configuration.ts | 12 + packages/rbac/v2/configuration.ts | 12 + packages/vulnerabilities/api.ts | 58 +- packages/vulnerabilities/apiSpec.json | 2 +- packages/vulnerabilities/base.ts | 2 +- packages/vulnerabilities/configuration.ts | 2 +- packages/vulnerabilities/git-api/api.ts | 58 +- packages/vulnerabilities/git-api/base.ts | 2 +- .../vulnerabilities/git-api/configuration.ts | 2 +- .../git-api/doc/classes/DefaultApi.md | 52 +- .../doc/interfaces/ConfigurationParameters.md | 2 +- .../doc/interfaces/MitigatedSystemsIdsOut.md | 57 - .../doc/interfaces/MitigatedSystemsOut.md | 57 - .../doc/interfaces/NotificationsOut.md | 2 +- .../git-api/doc/interfaces/OptOutIn.md | 4 +- .../doc/interfaces/PlaybookTemplate.md | 2 +- .../doc/interfaces/PlaybookTemplateData.md | 10 +- .../git-api/doc/interfaces/StatusIn.md | 8 +- .../git-api/doc/interfaces/StatusListOut.md | 4 +- .../doc/interfaces/StatusListOutData.md | 4 +- .../doc/interfaces/StatusListOutMeta.md | 2 +- .../git-api/doc/interfaces/StatusOut.md | 4 +- .../doc/interfaces/StatusOutUpdated.md | 4 +- .../doc/interfaces/SystemCvesIdsOut.md | 6 +- .../git-api/doc/interfaces/SystemCvesOut.md | 6 +- .../doc/interfaces/SystemDetailsOut.md | 4 +- .../doc/interfaces/SystemDetailsOutData.md | 33 +- .../interfaces/SystemDetailsOutDataTags.md | 6 +- .../git-api/doc/interfaces/SystemIdsOut.md | 6 +- .../git-api/doc/interfaces/SystemListOut.md | 6 +- .../git-api/doc/interfaces/VersionOut.md | 4 +- .../doc/interfaces/VulnerabilitiesIdsOut.md | 6 +- .../doc/interfaces/VulnerabilitiesOut.md | 6 +- .../doc/interfaces/VulnerabilitiesPostIn.md | 2 +- .../doc/interfaces/VulnerabilitiesPostOut.md | 6 +- .../VulnerabilitiesPostOutAttributes.md | 6 +- .../interfaces/VulnerabilitiesPostOutData.md | 6 +- .../vulnerabilities/git-api/doc/modules.md | 8 +- packages/vulnerabilities/git-api/index.ts | 2 +- packages/vulnerabilities/index.ts | 2 +- 57 files changed, 1573 insertions(+), 7475 deletions(-) create mode 100644 packages/notifications/NotificationResourceV1UpdateEventTypeEndpoints/index.ts delete mode 100644 packages/vulnerabilities/git-api/doc/interfaces/MitigatedSystemsIdsOut.md delete mode 100644 packages/vulnerabilities/git-api/doc/interfaces/MitigatedSystemsOut.md diff --git a/package-lock.json b/package-lock.json index 023b51beb..9ec8d9548 100644 --- a/package-lock.json +++ b/package-lock.json @@ -33762,7 +33762,7 @@ }, "packages/rbac": { "name": "@redhat-cloud-services/rbac-client", - "version": "2.2.6", + "version": "2.2.8", "license": "Apache-2.0", "dependencies": { "@redhat-cloud-services/javascript-clients-shared": "^1.2.4", diff --git a/packages/integrations/EndpointResourceV1CreateEndpoint/index.ts b/packages/integrations/EndpointResourceV1CreateEndpoint/index.ts index 9fe4ae0c8..b4e9fd547 100644 --- a/packages/integrations/EndpointResourceV1CreateEndpoint/index.ts +++ b/packages/integrations/EndpointResourceV1CreateEndpoint/index.ts @@ -8,21 +8,21 @@ 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 { Endpoint, EndpointDTO } from '../types'; +import type { Endpoint } from '../types'; export type EndpointResourceV1CreateEndpointParams = { /** * - * @type { EndpointDTO } + * @type { Endpoint } * @memberof EndpointResourceV1CreateEndpointApi */ - endpointDTO: EndpointDTO, + endpoint: Endpoint, options?: AxiosRequestConfig } const isEndpointResourceV1CreateEndpointObjectParams = (params: [EndpointResourceV1CreateEndpointParams] | unknown[]): params is [EndpointResourceV1CreateEndpointParams] => { - return params.length === 1 && Object.prototype.hasOwnProperty.call(params, 'endpointDTO') + return params.length === 1 && Object.prototype.hasOwnProperty.call(params, 'endpoint') } /** * Creates a new endpoint by providing data such as a description, a name, and the endpoint properties. Use this endpoint to create endpoints for integration with third-party services such as webhooks, Slack, or Google Chat. @@ -31,9 +31,9 @@ const isEndpointResourceV1CreateEndpointObjectParams = (params: [EndpointResourc * @param {*} [options] Override http request option. * @throws {RequiredError} */ -export const endpointResourceV1CreateEndpointParamCreator = async (...config: ([EndpointResourceV1CreateEndpointParams] | [EndpointDTO, AxiosRequestConfig])): Promise => { - const params = isEndpointResourceV1CreateEndpointObjectParams(config) ? config[0] : ['endpointDTO', 'options'].reduce((acc, curr, index) => ({ ...acc, [curr]: config[index] }), {}) as EndpointResourceV1CreateEndpointParams; - const { endpointDTO, options = {} } = params; +export const endpointResourceV1CreateEndpointParamCreator = async (...config: ([EndpointResourceV1CreateEndpointParams] | [Endpoint, AxiosRequestConfig])): Promise => { + const params = isEndpointResourceV1CreateEndpointObjectParams(config) ? config[0] : ['endpoint', 'options'].reduce((acc, curr, index) => ({ ...acc, [curr]: config[index] }), {}) as EndpointResourceV1CreateEndpointParams; + const { endpoint, options = {} } = params; const localVarPath = `/endpoints`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); @@ -51,7 +51,7 @@ export const endpointResourceV1CreateEndpointParamCreator = async (...config: ([ return { urlObj: localVarUrlObj, options: localVarRequestOptions, - serializeData: endpointDTO, + serializeData: endpoint, }; } diff --git a/packages/integrations/EndpointResourceV1GetEndpoint/index.ts b/packages/integrations/EndpointResourceV1GetEndpoint/index.ts index d734ef5aa..3732fa143 100644 --- a/packages/integrations/EndpointResourceV1GetEndpoint/index.ts +++ b/packages/integrations/EndpointResourceV1GetEndpoint/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 { EndpointDTO } from '../types'; +import type { Endpoint } from '../types'; export type EndpointResourceV1GetEndpointParams = { diff --git a/packages/integrations/EndpointResourceV1GetOrCreateDrawerSubscriptionEndpoint/index.ts b/packages/integrations/EndpointResourceV1GetOrCreateDrawerSubscriptionEndpoint/index.ts index fdf87fd00..cb927b80e 100644 --- a/packages/integrations/EndpointResourceV1GetOrCreateDrawerSubscriptionEndpoint/index.ts +++ b/packages/integrations/EndpointResourceV1GetOrCreateDrawerSubscriptionEndpoint/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 { EndpointDTO, RequestSystemSubscriptionProperties } from '../types'; +import type { Endpoint, RequestSystemSubscriptionProperties } from '../types'; export type EndpointResourceV1GetOrCreateDrawerSubscriptionEndpointParams = { diff --git a/packages/integrations/EndpointResourceV1GetOrCreateEmailSubscriptionEndpoint/index.ts b/packages/integrations/EndpointResourceV1GetOrCreateEmailSubscriptionEndpoint/index.ts index 6c1ca7a82..67be5f44f 100644 --- a/packages/integrations/EndpointResourceV1GetOrCreateEmailSubscriptionEndpoint/index.ts +++ b/packages/integrations/EndpointResourceV1GetOrCreateEmailSubscriptionEndpoint/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 { EndpointDTO, RequestSystemSubscriptionProperties } from '../types'; +import type { Endpoint, RequestSystemSubscriptionProperties } from '../types'; export type EndpointResourceV1GetOrCreateEmailSubscriptionEndpointParams = { diff --git a/packages/integrations/EndpointResourceV1UpdateEndpoint/index.ts b/packages/integrations/EndpointResourceV1UpdateEndpoint/index.ts index 28495ae06..72681cfc5 100644 --- a/packages/integrations/EndpointResourceV1UpdateEndpoint/index.ts +++ b/packages/integrations/EndpointResourceV1UpdateEndpoint/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 { EndpointDTO } from '../types'; +import type { Endpoint } from '../types'; export type EndpointResourceV1UpdateEndpointParams = { @@ -20,15 +20,15 @@ export type EndpointResourceV1UpdateEndpointParams = { id: string, /** * - * @type { EndpointDTO } + * @type { Endpoint } * @memberof EndpointResourceV1UpdateEndpointApi */ - endpointDTO: EndpointDTO, + endpoint: Endpoint, options?: AxiosRequestConfig } const isEndpointResourceV1UpdateEndpointObjectParams = (params: [EndpointResourceV1UpdateEndpointParams] | unknown[]): params is [EndpointResourceV1UpdateEndpointParams] => { - return params.length === 1 && Object.prototype.hasOwnProperty.call(params, 'id') && Object.prototype.hasOwnProperty.call(params, 'endpointDTO') + return params.length === 1 && Object.prototype.hasOwnProperty.call(params, 'id') && Object.prototype.hasOwnProperty.call(params, 'endpoint') } /** * Updates the endpoint configuration. Use this to update an existing endpoint. Any changes to the endpoint take place immediately. @@ -37,9 +37,9 @@ const isEndpointResourceV1UpdateEndpointObjectParams = (params: [EndpointResourc * @param {*} [options] Override http request option. * @throws {RequiredError} */ -export const endpointResourceV1UpdateEndpointParamCreator = async (...config: ([EndpointResourceV1UpdateEndpointParams] | [string, EndpointDTO, AxiosRequestConfig])): Promise => { - const params = isEndpointResourceV1UpdateEndpointObjectParams(config) ? config[0] : ['id', 'endpointDTO', 'options'].reduce((acc, curr, index) => ({ ...acc, [curr]: config[index] }), {}) as EndpointResourceV1UpdateEndpointParams; - const { id, endpointDTO, options = {} } = params; +export const endpointResourceV1UpdateEndpointParamCreator = async (...config: ([EndpointResourceV1UpdateEndpointParams] | [string, Endpoint, AxiosRequestConfig])): Promise => { + const params = isEndpointResourceV1UpdateEndpointObjectParams(config) ? config[0] : ['id', 'endpoint', 'options'].reduce((acc, curr, index) => ({ ...acc, [curr]: config[index] }), {}) as EndpointResourceV1UpdateEndpointParams; + const { id, endpoint, options = {} } = params; const localVarPath = `/endpoints/{id}` .replace(`{${"id"}}`, encodeURIComponent(String(id))); // use dummy base URL string because the URL constructor only accepts absolute URLs. @@ -58,7 +58,7 @@ export const endpointResourceV1UpdateEndpointParamCreator = async (...config: ([ return { urlObj: localVarUrlObj, options: localVarRequestOptions, - serializeData: endpointDTO, + serializeData: endpoint, }; } diff --git a/packages/integrations/api.ts b/packages/integrations/api.ts index 68695bbc0..9340dde79 100644 --- a/packages/integrations/api.ts +++ b/packages/integrations/api.ts @@ -26,1763 +26,443 @@ import { BASE_PATH, COLLECTION_FORMATS, BaseAPI, RequiredError } from './base'; /** * * @export - * @interface AddAccessRequest + * @interface Application */ -export interface AddAccessRequest { - /** - * - * @type {string} - * @memberof AddAccessRequest - */ - 'role'?: string; +export interface Application { /** * * @type {string} - * @memberof AddAccessRequest + * @memberof Application */ - 'application_id'?: string; -} -/** - * - * @export - * @interface AddApplicationRequest - */ -export interface AddApplicationRequest { + 'id'?: string; /** * * @type {string} - * @memberof AddApplicationRequest + * @memberof Application */ 'name': string; /** * * @type {string} - * @memberof AddApplicationRequest + * @memberof Application */ 'display_name': string; /** * * @type {string} - * @memberof AddApplicationRequest + * @memberof Application */ 'bundle_id': string; /** * - * @type {string} - * @memberof AddApplicationRequest + * @type {Set} + * @memberof Application */ - 'owner_role'?: string; + 'event_types'?: Set; } /** * * @export - * @interface AggregationEmailTemplate + * @interface BasicAuthentication */ -export interface AggregationEmailTemplate { +export interface BasicAuthentication { /** * * @type {string} - * @memberof AggregationEmailTemplate + * @memberof BasicAuthentication */ - 'created'?: string; + 'username'?: string; /** * * @type {string} - * @memberof AggregationEmailTemplate + * @memberof BasicAuthentication */ - 'updated'?: string; + 'password'?: string; +} +/** + * + * @export + * @interface Bundle + */ +export interface Bundle { /** * * @type {string} - * @memberof AggregationEmailTemplate + * @memberof Bundle */ 'id'?: string; /** * - * @type {Application} - * @memberof AggregationEmailTemplate + * @type {string} + * @memberof Bundle */ - 'application'?: Application; + 'name': string; /** * * @type {string} - * @memberof AggregationEmailTemplate + * @memberof Bundle + */ + 'display_name': string; + /** + * + * @type {Set} + * @memberof Bundle */ - 'application_id'?: string; + 'applications'?: Set; +} +/** + * + * @export + * @interface CamelProperties + */ +export interface CamelProperties { /** * - * @type {SubscriptionType} - * @memberof AggregationEmailTemplate + * @type {boolean} + * @memberof CamelProperties */ - 'subscription_type': SubscriptionType; + 'disableSslVerification': boolean; /** * - * @type {AggregationEmailTemplateSubjectTemplate} - * @memberof AggregationEmailTemplate + * @type {{ [key: string]: string; }} + * @memberof CamelProperties */ - 'subject_template'?: AggregationEmailTemplateSubjectTemplate; + 'extras'?: { [key: string]: string; }; /** * * @type {string} - * @memberof AggregationEmailTemplate + * @memberof CamelProperties */ - 'subject_template_id': string; + 'url': string; /** * - * @type {AggregationEmailTemplateSubjectTemplate} - * @memberof AggregationEmailTemplate + * @type {BasicAuthentication} + * @memberof CamelProperties */ - 'body_template'?: AggregationEmailTemplateSubjectTemplate; + 'basicAuthentication'?: BasicAuthentication; /** * * @type {string} - * @memberof AggregationEmailTemplate + * @memberof CamelProperties */ - 'body_template_id': string; + 'secretToken'?: string; } - - /** * * @export - * @interface AggregationEmailTemplateSubjectTemplate + * @interface Endpoint */ -export interface AggregationEmailTemplateSubjectTemplate { - /** - * - * @type {string} - * @memberof AggregationEmailTemplateSubjectTemplate - */ - 'created'?: string; - /** - * - * @type {string} - * @memberof AggregationEmailTemplateSubjectTemplate - */ - 'updated'?: string; +export interface Endpoint { /** * * @type {string} - * @memberof AggregationEmailTemplateSubjectTemplate + * @memberof Endpoint */ 'id'?: string; /** * * @type {string} - * @memberof AggregationEmailTemplateSubjectTemplate + * @memberof Endpoint */ 'name': string; /** * * @type {string} - * @memberof AggregationEmailTemplateSubjectTemplate + * @memberof Endpoint */ 'description': string; /** * - * @type {string} - * @memberof AggregationEmailTemplateSubjectTemplate + * @type {boolean} + * @memberof Endpoint */ - 'data': string; -} -/** - * - * @export - * @interface Application - */ -export interface Application { + 'enabled'?: boolean; /** * - * @type {string} - * @memberof Application + * @type {EndpointStatus} + * @memberof Endpoint */ - 'created'?: string; + 'status'?: EndpointStatus; /** * - * @type {string} - * @memberof Application + * @type {number} + * @memberof Endpoint */ - 'updated'?: string; + 'server_errors'?: number; /** * - * @type {string} - * @memberof Application + * @type {EndpointType} + * @memberof Endpoint */ - 'id'?: string; + 'type': EndpointType; /** * * @type {string} - * @memberof Application + * @memberof Endpoint */ - 'name': string; + 'sub_type'?: string; /** * * @type {string} - * @memberof Application + * @memberof Endpoint */ - 'display_name': string; + 'created'?: string; /** * * @type {string} - * @memberof Application + * @memberof Endpoint */ - 'bundle_id': string; -} -/** - * - * @export - * @interface Application1 - */ -export interface Application1 { + 'updated'?: string; /** * - * @type {string} - * @memberof Application1 + * @type {object} + * @memberof Endpoint */ - 'id': string; + 'properties'?: object; /** * - * @type {string} - * @memberof Application1 + * @type {Set} + * @memberof Endpoint */ - 'display_name': string; + 'event_types_group_by_bundles_and_applications'?: Set; + /** + * + * @type {Set} + * @memberof Endpoint + */ + 'event_types'?: Set; } + + /** * * @export - * @interface ApplicationDTO + * @interface EndpointPage */ -export interface ApplicationDTO { +export interface EndpointPage { /** * - * @type {string} - * @memberof ApplicationDTO + * @type {Array} + * @memberof EndpointPage */ - 'id'?: string; + 'data': Array; /** * - * @type {string} - * @memberof ApplicationDTO + * @type {{ [key: string]: string; }} + * @memberof EndpointPage */ - 'name': string; + 'links': { [key: string]: string; }; /** * - * @type {string} - * @memberof ApplicationDTO + * @type {Meta} + * @memberof EndpointPage */ - 'display_name': string; + 'meta': Meta; +} +/** + * + * @export + * @enum {string} + */ + +export const EndpointStatus = { + Deleting: 'DELETING', + Failed: 'FAILED', + New: 'NEW', + Provisioning: 'PROVISIONING', + Ready: 'READY', + Unknown: 'UNKNOWN' +} as const; + +export type EndpointStatus = typeof EndpointStatus[keyof typeof EndpointStatus]; + + +/** + * + * @export + * @interface EndpointTestRequest + */ +export interface EndpointTestRequest { /** * * @type {string} - * @memberof ApplicationDTO - */ - 'bundle_id': string; - /** - * - * @type {Set} - * @memberof ApplicationDTO + * @memberof EndpointTestRequest */ - 'event_types'?: Set; + 'message': string; } /** * * @export - * @interface ApplicationDTO1 + * @enum {string} + */ + +export const EndpointType = { + Ansible: 'ansible', + Camel: 'camel', + Drawer: 'drawer', + EmailSubscription: 'email_subscription', + Webhook: 'webhook', + Pagerduty: 'pagerduty' +} as const; + +export type EndpointType = typeof EndpointType[keyof typeof EndpointType]; + + +/** + * + * @export + * @interface EventType */ -export interface ApplicationDTO1 { +export interface EventType { /** * * @type {string} - * @memberof ApplicationDTO1 + * @memberof EventType */ 'id'?: string; /** * * @type {string} - * @memberof ApplicationDTO1 + * @memberof EventType */ 'name': string; /** * * @type {string} - * @memberof ApplicationDTO1 + * @memberof EventType */ 'display_name': string; /** * * @type {string} - * @memberof ApplicationDTO1 - */ - 'bundle_id': string; - /** - * - * @type {string} - * @memberof ApplicationDTO1 + * @memberof EventType */ - 'owner_role'?: string; + 'description'?: string; /** * - * @type {string} - * @memberof ApplicationDTO1 + * @type {Application} + * @memberof EventType */ - 'created'?: string; + 'application'?: Application; } /** * * @export - * @interface ApplicationSettingsValue + * @enum {string} */ -export interface ApplicationSettingsValue { - /** - * - * @type {{ [key: string]: EventTypeSettingsValue; }} - * @memberof ApplicationSettingsValue - */ - 'eventTypes'?: { [key: string]: EventTypeSettingsValue; }; -} + +export const HttpType = { + Get: 'GET', + Post: 'POST', + Put: 'PUT' +} as const; + +export type HttpType = typeof HttpType[keyof typeof HttpType]; + + /** * * @export - * @interface BasicAuthenticationDTO + * @interface Meta */ -export interface BasicAuthenticationDTO { - /** - * - * @type {string} - * @memberof BasicAuthenticationDTO - */ - 'username'?: string; +export interface Meta { /** * - * @type {string} - * @memberof BasicAuthenticationDTO + * @type {number} + * @memberof Meta */ - 'password'?: string; + 'count': number; } /** * * @export - * @interface BehaviorGroup + * @interface NotificationHistory */ -export interface BehaviorGroup { +export interface NotificationHistory { /** * * @type {string} - * @memberof BehaviorGroup + * @memberof NotificationHistory */ 'created'?: string; /** * * @type {string} - * @memberof BehaviorGroup - */ - 'updated'?: string; - /** - * - * @type {string} - * @memberof BehaviorGroup + * @memberof NotificationHistory */ 'id'?: string; /** * - * @type {string} - * @memberof BehaviorGroup + * @type {number} + * @memberof NotificationHistory */ - 'display_name': string; + 'invocationTime': number; /** * - * @type {string} - * @memberof BehaviorGroup + * @type {boolean} + * @memberof NotificationHistory */ - 'bundle_id': string; - /** - * - * @type {Bundle} - * @memberof BehaviorGroup - */ - 'bundle'?: Bundle; - /** - * - * @type {Array} - * @memberof BehaviorGroup - */ - 'actions'?: Array; - /** - * - * @type {Set} - * @memberof BehaviorGroup - */ - 'behaviors'?: Set; - /** - * - * @type {boolean} - * @memberof BehaviorGroup - */ - 'default_behavior'?: boolean; -} -/** - * - * @export - * @interface BehaviorGroupAction - */ -export interface BehaviorGroupAction { - /** - * - * @type {string} - * @memberof BehaviorGroupAction - */ - 'created'?: string; - /** - * - * @type {BehaviorGroupActionId} - * @memberof BehaviorGroupAction - */ - 'id'?: BehaviorGroupActionId; - /** - * - * @type {Endpoint} - * @memberof BehaviorGroupAction - */ - 'endpoint'?: Endpoint; -} -/** - * - * @export - * @interface BehaviorGroupActionId - */ -export interface BehaviorGroupActionId { - /** - * - * @type {string} - * @memberof BehaviorGroupActionId - */ - 'behaviorGroupId': string; - /** - * - * @type {string} - * @memberof BehaviorGroupActionId - */ - 'endpointId': string; -} -/** - * - * @export - * @interface Bundle - */ -export interface Bundle { - /** - * - * @type {string} - * @memberof Bundle - */ - 'created'?: string; - /** - * - * @type {string} - * @memberof Bundle - */ - 'updated'?: string; - /** - * - * @type {string} - * @memberof Bundle - */ - 'id'?: string; - /** - * - * @type {string} - * @memberof Bundle - */ - 'name': string; - /** - * - * @type {string} - * @memberof Bundle - */ - 'display_name': string; -} -/** - * - * @export - * @interface BundleDTO - */ -export interface BundleDTO { - /** - * - * @type {string} - * @memberof BundleDTO - */ - 'id'?: string; - /** - * - * @type {string} - * @memberof BundleDTO - */ - 'name': string; - /** - * - * @type {string} - * @memberof BundleDTO - */ - 'display_name': string; - /** - * - * @type {Set} - * @memberof BundleDTO - */ - 'applications'?: Set; -} -/** - * - * @export - * @interface BundleSettingsValue - */ -export interface BundleSettingsValue { - /** - * - * @type {{ [key: string]: ApplicationSettingsValue; }} - * @memberof BundleSettingsValue - */ - 'applications'?: { [key: string]: ApplicationSettingsValue; }; -} -/** - * - * @export - * @interface CamelPropertiesDTO - */ -export interface CamelPropertiesDTO { - /** - * - * @type {boolean} - * @memberof CamelPropertiesDTO - */ - 'disableSslVerification': boolean; - /** - * - * @type {{ [key: string]: string; }} - * @memberof CamelPropertiesDTO - */ - 'extras'?: { [key: string]: string; }; - /** - * - * @type {string} - * @memberof CamelPropertiesDTO - */ - 'url': string; - /** - * - * @type {BasicAuthenticationDTO} - * @memberof CamelPropertiesDTO - */ - 'basicAuthentication'?: BasicAuthenticationDTO; - /** - * - * @type {string} - * @memberof CamelPropertiesDTO - */ - 'secretToken'?: string; -} -/** - * - * @export - * @interface CreateBehaviorGroupRequest - */ -export interface CreateBehaviorGroupRequest { - /** - * - * @type {string} - * @memberof CreateBehaviorGroupRequest - */ - 'bundle_id'?: string; - /** - * - * @type {string} - * @memberof CreateBehaviorGroupRequest - */ - 'bundle_name'?: string; - /** - * - * @type {string} - * @memberof CreateBehaviorGroupRequest - */ - 'display_name': string; - /** - * - * @type {Array} - * @memberof CreateBehaviorGroupRequest - */ - 'endpoint_ids'?: Array; - /** - * - * @type {Set} - * @memberof CreateBehaviorGroupRequest - */ - 'event_type_ids'?: Set; - /** - * - * @type {boolean} - * @memberof CreateBehaviorGroupRequest - */ - 'bundle_uuid_or_bundle_name_valid'?: boolean; -} -/** - * - * @export - * @interface CreateBehaviorGroupResponse - */ -export interface CreateBehaviorGroupResponse { - /** - * - * @type {string} - * @memberof CreateBehaviorGroupResponse - */ - 'id': string; - /** - * - * @type {string} - * @memberof CreateBehaviorGroupResponse - */ - 'bundle_id': string; - /** - * - * @type {string} - * @memberof CreateBehaviorGroupResponse - */ - 'display_name': string; - /** - * - * @type {Array} - * @memberof CreateBehaviorGroupResponse - */ - 'endpoints': Array; - /** - * - * @type {Set} - * @memberof CreateBehaviorGroupResponse - */ - 'event_types': Set; - /** - * - * @type {string} - * @memberof CreateBehaviorGroupResponse - */ - 'created': string; -} -/** - * - * @export - * @interface CurrentStatus - */ -export interface CurrentStatus { - /** - * - * @type {Status} - * @memberof CurrentStatus - */ - 'status': Status; - /** - * - * @type {string} - * @memberof CurrentStatus - */ - 'start_time'?: string; - /** - * - * @type {string} - * @memberof CurrentStatus - */ - 'end_time'?: string; -} - - -/** - * - * @export - * @interface DrawerEntryPayload - */ -export interface DrawerEntryPayload { - /** - * - * @type {string} - * @memberof DrawerEntryPayload - */ - 'id'?: string; - /** - * - * @type {string} - * @memberof DrawerEntryPayload - */ - 'description'?: string; - /** - * - * @type {string} - * @memberof DrawerEntryPayload - */ - 'title'?: string; - /** - * - * @type {string} - * @memberof DrawerEntryPayload - */ - 'created'?: string; - /** - * - * @type {boolean} - * @memberof DrawerEntryPayload - */ - 'read': boolean; - /** - * - * @type {string} - * @memberof DrawerEntryPayload - */ - 'source'?: string; - /** - * - * @type {string} - * @memberof DrawerEntryPayload - */ - 'bundle'?: string; -} -/** - * - * @export - * @interface Endpoint - */ -export interface Endpoint { - /** - * - * @type {string} - * @memberof Endpoint - */ - 'created'?: string; - /** - * - * @type {string} - * @memberof Endpoint - */ - 'updated'?: string; - /** - * - * @type {string} - * @memberof Endpoint - */ - 'id'?: string; - /** - * - * @type {string} - * @memberof Endpoint - */ - 'name': string; - /** - * - * @type {string} - * @memberof Endpoint - */ - 'description': string; - /** - * - * @type {boolean} - * @memberof Endpoint - */ - 'enabled'?: boolean; - /** - * - * @type {EndpointStatus} - * @memberof Endpoint - */ - 'status'?: EndpointStatus; - /** - * - * @type {number} - * @memberof Endpoint - */ - 'server_errors'?: number; - /** - * - * @type {object} - * @memberof Endpoint - */ - 'properties'?: object; - /** - * - * @type {EndpointType} - * @memberof Endpoint - */ - 'type'?: EndpointType; - /** - * - * @type {string} - * @memberof Endpoint - */ - 'sub_type'?: string; -} - - -/** - * - * @export - * @interface EndpointDTO - */ -export interface EndpointDTO { - /** - * - * @type {string} - * @memberof EndpointDTO - */ - 'id'?: string; - /** - * - * @type {string} - * @memberof EndpointDTO - */ - 'name': string; - /** - * - * @type {string} - * @memberof EndpointDTO - */ - 'description': string; - /** - * - * @type {boolean} - * @memberof EndpointDTO - */ - 'enabled'?: boolean; - /** - * - * @type {EndpointStatusDTO} - * @memberof EndpointDTO - */ - 'status'?: EndpointStatusDTO; - /** - * - * @type {number} - * @memberof EndpointDTO - */ - 'server_errors'?: number; - /** - * - * @type {EndpointTypeDTO} - * @memberof EndpointDTO - */ - 'type': EndpointTypeDTO; - /** - * - * @type {string} - * @memberof EndpointDTO - */ - 'sub_type'?: string; - /** - * - * @type {string} - * @memberof EndpointDTO - */ - 'created'?: string; - /** - * - * @type {string} - * @memberof EndpointDTO - */ - 'updated'?: string; - /** - * - * @type {object} - * @memberof EndpointDTO - */ - 'properties'?: object; - /** - * - * @type {Set} - * @memberof EndpointDTO - */ - 'event_types_group_by_bundles_and_applications'?: Set; - /** - * - * @type {Set} - * @memberof EndpointDTO - */ - 'event_types'?: Set; -} - - -/** - * - * @export - * @interface EndpointPage - */ -export interface EndpointPage { - /** - * - * @type {Array} - * @memberof EndpointPage - */ - 'data': Array; - /** - * - * @type {{ [key: string]: string; }} - * @memberof EndpointPage - */ - 'links': { [key: string]: string; }; - /** - * - * @type {Meta} - * @memberof EndpointPage - */ - 'meta': Meta; -} -/** - * - * @export - * @enum {string} - */ - -export const EndpointStatus = { - Ready: 'READY', - Unknown: 'UNKNOWN', - New: 'NEW', - Provisioning: 'PROVISIONING', - Deleting: 'DELETING', - Failed: 'FAILED' -} as const; - -export type EndpointStatus = typeof EndpointStatus[keyof typeof EndpointStatus]; - - -/** - * - * @export - * @enum {string} - */ - -export const EndpointStatusDTO = { - Deleting: 'DELETING', - Failed: 'FAILED', - New: 'NEW', - Provisioning: 'PROVISIONING', - Ready: 'READY', - Unknown: 'UNKNOWN' -} as const; - -export type EndpointStatusDTO = typeof EndpointStatusDTO[keyof typeof EndpointStatusDTO]; - - -/** - * - * @export - * @interface EndpointTestRequest - */ -export interface EndpointTestRequest { - /** - * - * @type {string} - * @memberof EndpointTestRequest - */ - 'message': string; -} -/** - * - * @export - * @enum {string} - */ - -export const EndpointType = { - Ansible: 'ansible', - Camel: 'camel', - Drawer: 'drawer', - EmailSubscription: 'email_subscription', - Webhook: 'webhook', - Pagerduty: 'pagerduty' -} as const; - -export type EndpointType = typeof EndpointType[keyof typeof EndpointType]; - - -/** - * - * @export - * @enum {string} - */ - -export const EndpointTypeDTO = { - Ansible: 'ansible', - Camel: 'camel', - Drawer: 'drawer', - EmailSubscription: 'email_subscription', - Webhook: 'webhook' -} as const; - -export type EndpointTypeDTO = typeof EndpointTypeDTO[keyof typeof EndpointTypeDTO]; - - -/** - * - * @export - * @enum {string} - */ - -export const Environment = { - Prod: 'PROD', - Stage: 'STAGE', - Ephemeral: 'EPHEMERAL', - LocalServer: 'LOCAL_SERVER' -} as const; - -export type Environment = typeof Environment[keyof typeof Environment]; - - -/** - * - * @export - * @interface EventLogEntry - */ -export interface EventLogEntry { - /** - * - * @type {string} - * @memberof EventLogEntry - */ - 'id': string; - /** - * - * @type {string} - * @memberof EventLogEntry - */ - 'created': string; - /** - * - * @type {string} - * @memberof EventLogEntry - */ - 'bundle': string; - /** - * - * @type {string} - * @memberof EventLogEntry - */ - 'application': string; - /** - * - * @type {string} - * @memberof EventLogEntry - */ - 'event_type': string; - /** - * - * @type {string} - * @memberof EventLogEntry - */ - 'payload'?: string; - /** - * - * @type {Array} - * @memberof EventLogEntry - */ - 'actions': Array; -} -/** - * - * @export - * @interface EventLogEntryAction - */ -export interface EventLogEntryAction { - /** - * - * @type {string} - * @memberof EventLogEntryAction - */ - 'id': string; - /** - * - * @type {EndpointType} - * @memberof EventLogEntryAction - */ - 'endpoint_type': EndpointType; - /** - * - * @type {string} - * @memberof EventLogEntryAction - */ - 'endpoint_sub_type'?: string; - /** - * - * @type {boolean} - * @memberof EventLogEntryAction - * @deprecated - */ - 'invocation_result': boolean; - /** - * - * @type {EventLogEntryActionStatus} - * @memberof EventLogEntryAction - */ - 'status': EventLogEntryActionStatus; - /** - * - * @type {string} - * @memberof EventLogEntryAction - */ - 'endpoint_id'?: string; - /** - * - * @type {{ [key: string]: any; }} - * @memberof EventLogEntryAction - */ - 'details'?: { [key: string]: any; }; -} - - -/** - * - * @export - * @enum {string} - */ - -export const EventLogEntryActionStatus = { - Sent: 'SENT', - Success: 'SUCCESS', - Processing: 'PROCESSING', - Failed: 'FAILED', - Unknown: 'UNKNOWN' -} as const; - -export type EventLogEntryActionStatus = typeof EventLogEntryActionStatus[keyof typeof EventLogEntryActionStatus]; - - -/** - * - * @export - * @interface EventType - */ -export interface EventType { - /** - * - * @type {string} - * @memberof EventType - */ - 'id'?: string; - /** - * - * @type {string} - * @memberof EventType - */ - 'name': string; - /** - * - * @type {string} - * @memberof EventType - */ - 'display_name': string; - /** - * - * @type {string} - * @memberof EventType - */ - 'description'?: string; - /** - * - * @type {string} - * @memberof EventType - */ - 'fully_qualified_name'?: string; - /** - * - * @type {string} - * @memberof EventType - */ - 'application_id': string; - /** - * - * @type {Application} - * @memberof EventType - */ - 'application'?: Application; - /** - * - * @type {boolean} - * @memberof EventType - */ - 'visible'?: boolean; - /** - * - * @type {boolean} - * @memberof EventType - */ - 'subscribed_by_default'?: boolean; - /** - * - * @type {boolean} - * @memberof EventType - */ - 'subscription_locked'?: boolean; - /** - * - * @type {boolean} - * @memberof EventType - */ - 'not_subscription_locked_or_subscribed_by_default'?: boolean; -} -/** - * - * @export - * @interface EventTypeBehavior - */ -export interface EventTypeBehavior { - /** - * - * @type {string} - * @memberof EventTypeBehavior - */ - 'created'?: string; - /** - * - * @type {EventTypeBehaviorId} - * @memberof EventTypeBehavior - */ - 'id'?: EventTypeBehaviorId; - /** - * - * @type {EventType} - * @memberof EventTypeBehavior - */ - 'event_type'?: EventType; -} -/** - * - * @export - * @interface EventTypeBehaviorId - */ -export interface EventTypeBehaviorId { - /** - * - * @type {string} - * @memberof EventTypeBehaviorId - */ - 'eventTypeId': string; - /** - * - * @type {string} - * @memberof EventTypeBehaviorId - */ - 'behaviorGroupId': string; -} -/** - * - * @export - * @interface EventTypeDTO - */ -export interface EventTypeDTO { - /** - * - * @type {string} - * @memberof EventTypeDTO - */ - 'id'?: string; - /** - * - * @type {string} - * @memberof EventTypeDTO - */ - 'name': string; - /** - * - * @type {string} - * @memberof EventTypeDTO - */ - 'display_name': string; - /** - * - * @type {string} - * @memberof EventTypeDTO - */ - 'description'?: string; - /** - * - * @type {ApplicationDTO} - * @memberof EventTypeDTO - */ - 'application'?: ApplicationDTO; -} -/** - * - * @export - * @interface EventTypeSettingsValue - */ -export interface EventTypeSettingsValue { - /** - * - * @type {{ [key: string]: boolean; }} - * @memberof EventTypeSettingsValue - */ - 'emailSubscriptionTypes'?: { [key: string]: boolean; }; - /** - * - * @type {boolean} - * @memberof EventTypeSettingsValue - */ - 'hasForcedEmail'?: boolean; - /** - * - * @type {boolean} - * @memberof EventTypeSettingsValue - */ - 'subscriptionLocked'?: boolean; -} -/** - * - * @export - * @interface EventsReplayRequest - */ -export interface EventsReplayRequest { - /** - * - * @type {string} - * @memberof EventsReplayRequest - */ - 'start_date': string; - /** - * - * @type {string} - * @memberof EventsReplayRequest - */ - 'end_date': string; - /** - * - * @type {string} - * @memberof EventsReplayRequest - */ - 'org_id'?: string; -} -/** - * - * @export - * @interface Facet - */ -export interface Facet { - /** - * - * @type {string} - * @memberof Facet - */ - 'id': string; - /** - * - * @type {string} - * @memberof Facet - */ - 'name': string; - /** - * - * @type {string} - * @memberof Facet - */ - 'displayName': string; - /** - * - * @type {Array} - * @memberof Facet - */ - 'children'?: Array; -} -/** - * - * @export - * @enum {string} - */ - -export const HttpType = { - Get: 'GET', - Post: 'POST', - Put: 'PUT' -} as const; - -export type HttpType = typeof HttpType[keyof typeof HttpType]; - - -/** - * - * @export - * @interface InstantEmailTemplate - */ -export interface InstantEmailTemplate { - /** - * - * @type {string} - * @memberof InstantEmailTemplate - */ - 'created'?: string; - /** - * - * @type {string} - * @memberof InstantEmailTemplate - */ - 'updated'?: string; - /** - * - * @type {string} - * @memberof InstantEmailTemplate - */ - 'id'?: string; - /** - * - * @type {EventType} - * @memberof InstantEmailTemplate - */ - 'event_type'?: EventType; - /** - * - * @type {string} - * @memberof InstantEmailTemplate - */ - 'event_type_id'?: string; - /** - * - * @type {AggregationEmailTemplateSubjectTemplate} - * @memberof InstantEmailTemplate - */ - 'subject_template'?: AggregationEmailTemplateSubjectTemplate; - /** - * - * @type {string} - * @memberof InstantEmailTemplate - */ - 'subject_template_id': string; - /** - * - * @type {AggregationEmailTemplateSubjectTemplate} - * @memberof InstantEmailTemplate - */ - 'body_template'?: AggregationEmailTemplateSubjectTemplate; - /** - * - * @type {string} - * @memberof InstantEmailTemplate - */ - 'body_template_id': string; -} -/** - * - * @export - * @interface InternalApplicationUserPermission - */ -export interface InternalApplicationUserPermission { - /** - * - * @type {string} - * @memberof InternalApplicationUserPermission - */ - 'application_id': string; - /** - * - * @type {string} - * @memberof InternalApplicationUserPermission - */ - 'application_display_name': string; - /** - * - * @type {string} - * @memberof InternalApplicationUserPermission - */ - 'role': string; -} -/** - * - * @export - * @interface InternalRoleAccess - */ -export interface InternalRoleAccess { - /** - * - * @type {string} - * @memberof InternalRoleAccess - */ - 'id'?: string; - /** - * - * @type {string} - * @memberof InternalRoleAccess - */ - 'role': string; - /** - * - * @type {string} - * @memberof InternalRoleAccess - */ - 'application_id': string; -} -/** - * - * @export - * @interface InternalUserPermissions - */ -export interface InternalUserPermissions { - /** - * - * @type {boolean} - * @memberof InternalUserPermissions - */ - 'is_admin': boolean; - /** - * - * @type {Array} - * @memberof InternalUserPermissions - */ - 'applications': Array; - /** - * - * @type {Array} - * @memberof InternalUserPermissions - */ - 'roles': Array; -} -/** - * - * @export - * @interface MessageValidationResponse - */ -export interface MessageValidationResponse { - /** - * - * @type {{ [key: string]: Array; }} - * @memberof MessageValidationResponse - */ - 'errors': { [key: string]: Array; }; -} -/** - * - * @export - * @interface Meta - */ -export interface Meta { - /** - * - * @type {number} - * @memberof Meta - */ - 'count': number; -} -/** - * - * @export - * @interface NotificationHistory - */ -export interface NotificationHistory { - /** - * - * @type {string} - * @memberof NotificationHistory - */ - 'created'?: string; - /** - * - * @type {string} - * @memberof NotificationHistory - */ - 'id'?: string; - /** - * - * @type {number} - * @memberof NotificationHistory - */ - 'invocationTime': number; - /** - * - * @type {boolean} - * @memberof NotificationHistory - * @deprecated - */ - 'invocationResult': boolean; + 'invocationResult': boolean; /** * * @type {NotificationStatus} * @memberof NotificationHistory */ - 'status': NotificationStatus; - /** - * - * @type {string} - * @memberof NotificationHistory - */ - 'endpointId'?: string; - /** - * - * @type {{ [key: string]: any; }} - * @memberof NotificationHistory - */ - 'details'?: { [key: string]: any; }; - /** - * - * @type {EndpointType} - * @memberof NotificationHistory - */ - 'endpointType'?: EndpointType; - /** - * - * @type {string} - * @memberof NotificationHistory - */ - 'endpointSubType'?: string; -} - - -/** - * - * @export - * @enum {string} - */ - -export const NotificationStatus = { - FailedInternal: 'FAILED_INTERNAL', - FailedExternal: 'FAILED_EXTERNAL', - Processing: 'PROCESSING', - Sent: 'SENT', - Success: 'SUCCESS' -} as const; - -export type NotificationStatus = typeof NotificationStatus[keyof typeof NotificationStatus]; - - -/** - * - * @export - * @interface PageBehaviorGroup - */ -export interface PageBehaviorGroup { - /** - * - * @type {Array} - * @memberof PageBehaviorGroup - */ - 'data': Array; - /** - * - * @type {{ [key: string]: string; }} - * @memberof PageBehaviorGroup - */ - 'links': { [key: string]: string; }; - /** - * - * @type {Meta} - * @memberof PageBehaviorGroup - */ - 'meta': Meta; -} -/** - * - * @export - * @interface PageDrawerEntryPayload - */ -export interface PageDrawerEntryPayload { - /** - * - * @type {Array} - * @memberof PageDrawerEntryPayload - */ - 'data': Array; - /** - * - * @type {{ [key: string]: string; }} - * @memberof PageDrawerEntryPayload - */ - 'links': { [key: string]: string; }; - /** - * - * @type {Meta} - * @memberof PageDrawerEntryPayload - */ - 'meta': Meta; -} -/** - * - * @export - * @interface PageEventLogEntry - */ -export interface PageEventLogEntry { - /** - * - * @type {Array} - * @memberof PageEventLogEntry - */ - 'data': Array; - /** - * - * @type {{ [key: string]: string; }} - * @memberof PageEventLogEntry - */ - 'links': { [key: string]: string; }; - /** - * - * @type {Meta} - * @memberof PageEventLogEntry - */ - 'meta': Meta; -} -/** - * - * @export - * @interface PageEventType - */ -export interface PageEventType { + 'status': NotificationStatus; /** * - * @type {Array} - * @memberof PageEventType + * @type {string} + * @memberof NotificationHistory */ - 'data': Array; + 'endpointId'?: string; /** * - * @type {{ [key: string]: string; }} - * @memberof PageEventType + * @type {EndpointType} + * @memberof NotificationHistory */ - 'links': { [key: string]: string; }; + 'endpointType'?: EndpointType; /** * - * @type {Meta} - * @memberof PageEventType + * @type {{ [key: string]: any; }} + * @memberof NotificationHistory */ - 'meta': Meta; + 'details'?: { [key: string]: any; }; } + + /** * * @export - * @interface PageNotificationHistory + * @enum {string} */ -export interface PageNotificationHistory { - /** - * - * @type {Array} - * @memberof PageNotificationHistory - */ - 'data': Array; - /** - * - * @type {{ [key: string]: string; }} - * @memberof PageNotificationHistory - */ - 'links': { [key: string]: string; }; - /** - * - * @type {Meta} - * @memberof PageNotificationHistory - */ - 'meta': Meta; -} + +export const NotificationStatus = { + FailedInternal: 'FAILED_INTERNAL', + FailedExternal: 'FAILED_EXTERNAL', + Processing: 'PROCESSING', + Sent: 'SENT', + Success: 'SUCCESS' +} as const; + +export type NotificationStatus = typeof NotificationStatus[keyof typeof NotificationStatus]; + + /** * * @export - * @interface PagerDutyPropertiesDTO + * @interface PagerDutyProperties */ -export interface PagerDutyPropertiesDTO { +export interface PagerDutyProperties { /** * - * @type {PagerDutySeverityDTO} - * @memberof PagerDutyPropertiesDTO + * @type {PagerDutySeverity} + * @memberof PagerDutyProperties */ - 'severity': PagerDutySeverityDTO; + 'severity': PagerDutySeverity; /** * * @type {string} - * @memberof PagerDutyPropertiesDTO + * @memberof PagerDutyProperties */ 'secretToken': string; } @@ -1804,60 +484,6 @@ export const PagerDutySeverity = { export type PagerDutySeverity = typeof PagerDutySeverity[keyof typeof PagerDutySeverity]; -/** - * - * @export - * @enum {string} - */ - -export const PagerDutySeverityDTO = { - Critical: 'critical', - Error: 'error', - Warning: 'warning', - Info: 'info' -} as const; - -export type PagerDutySeverityDTO = typeof PagerDutySeverityDTO[keyof typeof PagerDutySeverityDTO]; - - -/** - * - * @export - * @interface RenderEmailTemplateRequest - */ -export interface RenderEmailTemplateRequest { - /** - * - * @type {Array} - * @memberof RenderEmailTemplateRequest - */ - 'template': Array; - /** - * - * @type {string} - * @memberof RenderEmailTemplateRequest - */ - 'payload': string; -} -/** - * - * @export - * @interface RequestDefaultBehaviorGroupPropertyList - */ -export interface RequestDefaultBehaviorGroupPropertyList { - /** - * - * @type {boolean} - * @memberof RequestDefaultBehaviorGroupPropertyList - */ - 'only_admins': boolean; - /** - * - * @type {boolean} - * @memberof RequestDefaultBehaviorGroupPropertyList - */ - 'ignore_preferences': boolean; -} /** * * @export @@ -1880,322 +506,73 @@ export interface RequestSystemSubscriptionProperties { /** * * @export - * @interface ServerInfo - */ -export interface ServerInfo { - /** - * - * @type {Environment} - * @memberof ServerInfo - */ - 'environment'?: Environment; -} - - -/** - * - * @export - * @interface SettingsValuesByEventType - */ -export interface SettingsValuesByEventType { - /** - * - * @type {{ [key: string]: BundleSettingsValue; }} - * @memberof SettingsValuesByEventType - */ - 'bundles'?: { [key: string]: BundleSettingsValue; }; -} -/** - * - * @export - * @enum {string} - */ - -export const Status = { - Up: 'UP', - Maintenance: 'MAINTENANCE' -} as const; - -export type Status = typeof Status[keyof typeof Status]; - - -/** - * - * @export - * @enum {string} - */ - -export const SubscriptionType = { - Instant: 'INSTANT', - Daily: 'DAILY', - Drawer: 'DRAWER' -} as const; - -export type SubscriptionType = typeof SubscriptionType[keyof typeof SubscriptionType]; - - -/** - * - * @export - * @interface SystemSubscriptionPropertiesDTO + * @interface SystemSubscriptionProperties */ -export interface SystemSubscriptionPropertiesDTO { +export interface SystemSubscriptionProperties { /** * * @type {string} - * @memberof SystemSubscriptionPropertiesDTO + * @memberof SystemSubscriptionProperties */ 'groupId'?: string; /** * * @type {boolean} - * @memberof SystemSubscriptionPropertiesDTO + * @memberof SystemSubscriptionProperties */ 'ignorePreferences'?: boolean; /** * * @type {boolean} - * @memberof SystemSubscriptionPropertiesDTO + * @memberof SystemSubscriptionProperties */ 'onlyAdmins'?: boolean; } /** * * @export - * @interface Template - */ -export interface Template { - /** - * - * @type {string} - * @memberof Template - */ - 'created'?: string; - /** - * - * @type {string} - * @memberof Template - */ - 'updated'?: string; - /** - * - * @type {string} - * @memberof Template - */ - 'id'?: string; - /** - * - * @type {string} - * @memberof Template - */ - 'name': string; - /** - * - * @type {string} - * @memberof Template - */ - 'description': string; - /** - * - * @type {string} - * @memberof Template - */ - 'data': string; -} -/** - * - * @export - * @interface TriggerDailyDigestRequest - */ -export interface TriggerDailyDigestRequest { - /** - * - * @type {string} - * @memberof TriggerDailyDigestRequest - */ - 'application_name': string; - /** - * - * @type {string} - * @memberof TriggerDailyDigestRequest - */ - 'bundle_name': string; - /** - * - * @type {string} - * @memberof TriggerDailyDigestRequest - */ - 'end'?: string; - /** - * - * @type {string} - * @memberof TriggerDailyDigestRequest - */ - 'org_id': string; - /** - * - * @type {string} - * @memberof TriggerDailyDigestRequest - */ - 'start'?: string; -} -/** - * - * @export - * @interface UpdateApplicationRequest - */ -export interface UpdateApplicationRequest { - /** - * - * @type {string} - * @memberof UpdateApplicationRequest - */ - 'name'?: string; - /** - * - * @type {string} - * @memberof UpdateApplicationRequest - */ - 'display_name'?: string; - /** - * - * @type {string} - * @memberof UpdateApplicationRequest - */ - 'owner_role'?: string; -} -/** - * - * @export - * @interface UpdateBehaviorGroupRequest - */ -export interface UpdateBehaviorGroupRequest { - /** - * - * @type {string} - * @memberof UpdateBehaviorGroupRequest - */ - 'display_name'?: string; - /** - * - * @type {Array} - * @memberof UpdateBehaviorGroupRequest - */ - 'endpoint_ids'?: Array; - /** - * - * @type {Set} - * @memberof UpdateBehaviorGroupRequest - */ - 'event_type_ids'?: Set; - /** - * - * @type {boolean} - * @memberof UpdateBehaviorGroupRequest - */ - 'display_name_not_null_and_blank'?: boolean; -} -/** - * - * @export - * @interface UpdateNotificationDrawerStatus - */ -export interface UpdateNotificationDrawerStatus { - /** - * - * @type {Set} - * @memberof UpdateNotificationDrawerStatus - */ - 'notification_ids': Set; - /** - * - * @type {boolean} - * @memberof UpdateNotificationDrawerStatus - */ - 'read_status': boolean; -} -/** - * - * @export - * @interface WebhookPropertiesDTO + * @interface WebhookProperties */ -export interface WebhookPropertiesDTO { +export interface WebhookProperties { /** * * @type {boolean} - * @memberof WebhookPropertiesDTO + * @memberof WebhookProperties */ 'disableSslVerification': boolean; /** * * @type {HttpType} - * @memberof WebhookPropertiesDTO + * @memberof WebhookProperties */ 'method': HttpType; /** * * @type {string} - * @memberof WebhookPropertiesDTO + * @memberof WebhookProperties */ 'url': string; /** * - * @type {BasicAuthenticationDTO} - * @memberof WebhookPropertiesDTO + * @type {BasicAuthentication} + * @memberof WebhookProperties */ - 'basicAuthentication'?: BasicAuthenticationDTO; + 'basicAuthentication'?: BasicAuthentication; /** * * @type {string} - * @memberof WebhookPropertiesDTO + * @memberof WebhookProperties */ 'bearerAuthentication'?: string; /** * * @type {string} - * @memberof WebhookPropertiesDTO + * @memberof WebhookProperties */ 'secretToken'?: string; } -/** - * - * @export - * @interface X509Certificate - */ -export interface X509Certificate { - /** - * - * @type {string} - * @memberof X509Certificate - */ - 'id'?: string; - /** - * - * @type {string} - * @memberof X509Certificate - */ - 'subject_dn': string; - /** - * - * @type {string} - * @memberof X509Certificate - */ - 'source_environment': string; - /** - * - * @type {string} - * @memberof X509Certificate - */ - 'bundle': string; - /** - * - * @type {string} - * @memberof X509Certificate - */ - 'application': string; -} /** * EndpointResourceV1AddEventTypeToEndpointApi - axios parameter creator @@ -2319,13 +696,13 @@ export const EndpointResourceV1CreateEndpointApiAxiosParamCreator = function (co /** * Creates a new endpoint by providing data such as a description, a name, and the endpoint properties. Use this endpoint to create endpoints for integration with third-party services such as webhooks, Slack, or Google Chat. * @summary Create a new endpoint - * @param {EndpointDTO} endpointDTO + * @param {Endpoint} endpoint * @param {*} [options] Override http request option. * @throws {RequiredError} */ - endpointResourceV1CreateEndpoint: async (endpointDTO: EndpointDTO, options: AxiosRequestConfig = {}): Promise => { - // verify required parameter 'endpointDTO' is not null or undefined - assertParamExists('endpointResourceV1CreateEndpoint', 'endpointDTO', endpointDTO) + endpointResourceV1CreateEndpoint: async (endpoint: Endpoint, options: AxiosRequestConfig = {}): Promise => { + // verify required parameter 'endpoint' is not null or undefined + assertParamExists('endpointResourceV1CreateEndpoint', 'endpoint', endpoint) const localVarPath = `/endpoints`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); @@ -2345,7 +722,7 @@ export const EndpointResourceV1CreateEndpointApiAxiosParamCreator = function (co setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(endpointDTO, localVarRequestOptions, configuration) + localVarRequestOptions.data = serializeDataIfNeeded(endpoint, localVarRequestOptions, configuration) return { url: toPathString(localVarUrlObj), @@ -2365,12 +742,12 @@ export const EndpointResourceV1CreateEndpointApiFp = function(configuration?: Co /** * Creates a new endpoint by providing data such as a description, a name, and the endpoint properties. Use this endpoint to create endpoints for integration with third-party services such as webhooks, Slack, or Google Chat. * @summary Create a new endpoint - * @param {EndpointDTO} endpointDTO + * @param {Endpoint} endpoint * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async endpointResourceV1CreateEndpoint(endpointDTO: EndpointDTO, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.endpointResourceV1CreateEndpoint(endpointDTO, options); + async endpointResourceV1CreateEndpoint(endpoint: Endpoint, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.endpointResourceV1CreateEndpoint(endpoint, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, } @@ -2386,12 +763,12 @@ export const EndpointResourceV1CreateEndpointApiFactory = function (configuratio /** * Creates a new endpoint by providing data such as a description, a name, and the endpoint properties. Use this endpoint to create endpoints for integration with third-party services such as webhooks, Slack, or Google Chat. * @summary Create a new endpoint - * @param {EndpointDTO} endpointDTO + * @param {Endpoint} endpoint * @param {*} [options] Override http request option. * @throws {RequiredError} */ - endpointResourceV1CreateEndpoint(endpointDTO: EndpointDTO, options?: any): AxiosPromise { - return localVarFp.endpointResourceV1CreateEndpoint(endpointDTO, options).then((request) => request(axios, basePath)); + endpointResourceV1CreateEndpoint(endpoint: Endpoint, options?: any): AxiosPromise { + return localVarFp.endpointResourceV1CreateEndpoint(endpoint, options).then((request) => request(axios, basePath)); }, }; }; @@ -2406,13 +783,13 @@ export class EndpointResourceV1CreateEndpointApi extends BaseAPI { /** * Creates a new endpoint by providing data such as a description, a name, and the endpoint properties. Use this endpoint to create endpoints for integration with third-party services such as webhooks, Slack, or Google Chat. * @summary Create a new endpoint - * @param {EndpointDTO} endpointDTO + * @param {Endpoint} endpoint * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof EndpointResourceV1CreateEndpointApi */ - public endpointResourceV1CreateEndpoint(endpointDTO: EndpointDTO, options?: AxiosRequestConfig) { - return EndpointResourceV1CreateEndpointApiFp(this.configuration).endpointResourceV1CreateEndpoint(endpointDTO, options).then((request) => request(this.axios, this.basePath)); + public endpointResourceV1CreateEndpoint(endpoint: Endpoint, options?: AxiosRequestConfig) { + return EndpointResourceV1CreateEndpointApiFp(this.configuration).endpointResourceV1CreateEndpoint(endpoint, options).then((request) => request(this.axios, this.basePath)); } } @@ -3019,7 +1396,7 @@ export const EndpointResourceV1GetEndpointApiFp = function(configuration?: Confi * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async endpointResourceV1GetEndpoint(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + async endpointResourceV1GetEndpoint(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.endpointResourceV1GetEndpoint(id, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, @@ -3040,7 +1417,7 @@ export const EndpointResourceV1GetEndpointApiFactory = function (configuration?: * @param {*} [options] Override http request option. * @throws {RequiredError} */ - endpointResourceV1GetEndpoint(id: string, options?: any): AxiosPromise { + endpointResourceV1GetEndpoint(id: string, options?: any): AxiosPromise { return localVarFp.endpointResourceV1GetEndpoint(id, options).then((request) => request(axios, basePath)); }, }; @@ -3440,7 +1817,7 @@ export const EndpointResourceV1GetOrCreateDrawerSubscriptionEndpointApiFp = func * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async endpointResourceV1GetOrCreateDrawerSubscriptionEndpoint(requestSystemSubscriptionProperties: RequestSystemSubscriptionProperties, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + async endpointResourceV1GetOrCreateDrawerSubscriptionEndpoint(requestSystemSubscriptionProperties: RequestSystemSubscriptionProperties, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.endpointResourceV1GetOrCreateDrawerSubscriptionEndpoint(requestSystemSubscriptionProperties, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, @@ -3461,7 +1838,7 @@ export const EndpointResourceV1GetOrCreateDrawerSubscriptionEndpointApiFactory = * @param {*} [options] Override http request option. * @throws {RequiredError} */ - endpointResourceV1GetOrCreateDrawerSubscriptionEndpoint(requestSystemSubscriptionProperties: RequestSystemSubscriptionProperties, options?: any): AxiosPromise { + endpointResourceV1GetOrCreateDrawerSubscriptionEndpoint(requestSystemSubscriptionProperties: RequestSystemSubscriptionProperties, options?: any): AxiosPromise { return localVarFp.endpointResourceV1GetOrCreateDrawerSubscriptionEndpoint(requestSystemSubscriptionProperties, options).then((request) => request(axios, basePath)); }, }; @@ -3548,7 +1925,7 @@ export const EndpointResourceV1GetOrCreateEmailSubscriptionEndpointApiFp = funct * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async endpointResourceV1GetOrCreateEmailSubscriptionEndpoint(requestSystemSubscriptionProperties: RequestSystemSubscriptionProperties, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + async endpointResourceV1GetOrCreateEmailSubscriptionEndpoint(requestSystemSubscriptionProperties: RequestSystemSubscriptionProperties, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.endpointResourceV1GetOrCreateEmailSubscriptionEndpoint(requestSystemSubscriptionProperties, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, @@ -3569,7 +1946,7 @@ export const EndpointResourceV1GetOrCreateEmailSubscriptionEndpointApiFactory = * @param {*} [options] Override http request option. * @throws {RequiredError} */ - endpointResourceV1GetOrCreateEmailSubscriptionEndpoint(requestSystemSubscriptionProperties: RequestSystemSubscriptionProperties, options?: any): AxiosPromise { + endpointResourceV1GetOrCreateEmailSubscriptionEndpoint(requestSystemSubscriptionProperties: RequestSystemSubscriptionProperties, options?: any): AxiosPromise { return localVarFp.endpointResourceV1GetOrCreateEmailSubscriptionEndpoint(requestSystemSubscriptionProperties, options).then((request) => request(axios, basePath)); }, }; @@ -3720,15 +2097,15 @@ export const EndpointResourceV1UpdateEndpointApiAxiosParamCreator = function (co * Updates the endpoint configuration. Use this to update an existing endpoint. Any changes to the endpoint take place immediately. * @summary Update an endpoint * @param {string} id - * @param {EndpointDTO} endpointDTO + * @param {Endpoint} endpoint * @param {*} [options] Override http request option. * @throws {RequiredError} */ - endpointResourceV1UpdateEndpoint: async (id: string, endpointDTO: EndpointDTO, options: AxiosRequestConfig = {}): Promise => { + endpointResourceV1UpdateEndpoint: async (id: string, endpoint: Endpoint, options: AxiosRequestConfig = {}): Promise => { // verify required parameter 'id' is not null or undefined assertParamExists('endpointResourceV1UpdateEndpoint', 'id', id) - // verify required parameter 'endpointDTO' is not null or undefined - assertParamExists('endpointResourceV1UpdateEndpoint', 'endpointDTO', endpointDTO) + // verify required parameter 'endpoint' is not null or undefined + assertParamExists('endpointResourceV1UpdateEndpoint', 'endpoint', endpoint) const localVarPath = `/endpoints/{id}` .replace(`{${"id"}}`, encodeURIComponent(String(id))); // use dummy base URL string because the URL constructor only accepts absolute URLs. @@ -3749,7 +2126,7 @@ export const EndpointResourceV1UpdateEndpointApiAxiosParamCreator = function (co setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(endpointDTO, localVarRequestOptions, configuration) + localVarRequestOptions.data = serializeDataIfNeeded(endpoint, localVarRequestOptions, configuration) return { url: toPathString(localVarUrlObj), @@ -3770,12 +2147,12 @@ export const EndpointResourceV1UpdateEndpointApiFp = function(configuration?: Co * Updates the endpoint configuration. Use this to update an existing endpoint. Any changes to the endpoint take place immediately. * @summary Update an endpoint * @param {string} id - * @param {EndpointDTO} endpointDTO + * @param {Endpoint} endpoint * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async endpointResourceV1UpdateEndpoint(id: string, endpointDTO: EndpointDTO, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.endpointResourceV1UpdateEndpoint(id, endpointDTO, options); + async endpointResourceV1UpdateEndpoint(id: string, endpoint: Endpoint, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.endpointResourceV1UpdateEndpoint(id, endpoint, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, } @@ -3792,12 +2169,12 @@ export const EndpointResourceV1UpdateEndpointApiFactory = function (configuratio * Updates the endpoint configuration. Use this to update an existing endpoint. Any changes to the endpoint take place immediately. * @summary Update an endpoint * @param {string} id - * @param {EndpointDTO} endpointDTO + * @param {Endpoint} endpoint * @param {*} [options] Override http request option. * @throws {RequiredError} */ - endpointResourceV1UpdateEndpoint(id: string, endpointDTO: EndpointDTO, options?: any): AxiosPromise { - return localVarFp.endpointResourceV1UpdateEndpoint(id, endpointDTO, options).then((request) => request(axios, basePath)); + endpointResourceV1UpdateEndpoint(id: string, endpoint: Endpoint, options?: any): AxiosPromise { + return localVarFp.endpointResourceV1UpdateEndpoint(id, endpoint, options).then((request) => request(axios, basePath)); }, }; }; @@ -3813,13 +2190,13 @@ export class EndpointResourceV1UpdateEndpointApi extends BaseAPI { * Updates the endpoint configuration. Use this to update an existing endpoint. Any changes to the endpoint take place immediately. * @summary Update an endpoint * @param {string} id - * @param {EndpointDTO} endpointDTO + * @param {Endpoint} endpoint * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof EndpointResourceV1UpdateEndpointApi */ - public endpointResourceV1UpdateEndpoint(id: string, endpointDTO: EndpointDTO, options?: AxiosRequestConfig) { - return EndpointResourceV1UpdateEndpointApiFp(this.configuration).endpointResourceV1UpdateEndpoint(id, endpointDTO, options).then((request) => request(this.axios, this.basePath)); + public endpointResourceV1UpdateEndpoint(id: string, endpoint: Endpoint, options?: AxiosRequestConfig) { + return EndpointResourceV1UpdateEndpointApiFp(this.configuration).endpointResourceV1UpdateEndpoint(id, endpoint, options).then((request) => request(this.axios, this.basePath)); } } diff --git a/packages/integrations/types/index.ts b/packages/integrations/types/index.ts index 83c4b6697..8fc5ff0b4 100644 --- a/packages/integrations/types/index.ts +++ b/packages/integrations/types/index.ts @@ -1,1763 +1,443 @@ /** * * @export - * @interface AddAccessRequest + * @interface Application */ -export interface AddAccessRequest { - /** - * - * @type {string} - * @memberof AddAccessRequest - */ - 'role'?: string; +export interface Application { /** * * @type {string} - * @memberof AddAccessRequest + * @memberof Application */ - 'application_id'?: string; -} -/** - * - * @export - * @interface AddApplicationRequest - */ -export interface AddApplicationRequest { + 'id'?: string; /** * * @type {string} - * @memberof AddApplicationRequest + * @memberof Application */ 'name': string; /** * * @type {string} - * @memberof AddApplicationRequest + * @memberof Application */ 'display_name': string; /** * * @type {string} - * @memberof AddApplicationRequest + * @memberof Application */ 'bundle_id': string; /** * - * @type {string} - * @memberof AddApplicationRequest + * @type {Set} + * @memberof Application */ - 'owner_role'?: string; + 'event_types'?: Set; } /** * * @export - * @interface AggregationEmailTemplate + * @interface BasicAuthentication */ -export interface AggregationEmailTemplate { +export interface BasicAuthentication { /** * * @type {string} - * @memberof AggregationEmailTemplate + * @memberof BasicAuthentication */ - 'created'?: string; + 'username'?: string; /** * * @type {string} - * @memberof AggregationEmailTemplate + * @memberof BasicAuthentication */ - 'updated'?: string; + 'password'?: string; +} +/** + * + * @export + * @interface Bundle + */ +export interface Bundle { /** * * @type {string} - * @memberof AggregationEmailTemplate + * @memberof Bundle */ 'id'?: string; /** * - * @type {Application} - * @memberof AggregationEmailTemplate + * @type {string} + * @memberof Bundle */ - 'application'?: Application; + 'name': string; /** * * @type {string} - * @memberof AggregationEmailTemplate + * @memberof Bundle + */ + 'display_name': string; + /** + * + * @type {Set} + * @memberof Bundle */ - 'application_id'?: string; + 'applications'?: Set; +} +/** + * + * @export + * @interface CamelProperties + */ +export interface CamelProperties { /** * - * @type {SubscriptionType} - * @memberof AggregationEmailTemplate + * @type {boolean} + * @memberof CamelProperties */ - 'subscription_type': SubscriptionType; + 'disableSslVerification': boolean; /** * - * @type {AggregationEmailTemplateSubjectTemplate} - * @memberof AggregationEmailTemplate + * @type {{ [key: string]: string; }} + * @memberof CamelProperties */ - 'subject_template'?: AggregationEmailTemplateSubjectTemplate; + 'extras'?: { [key: string]: string; }; /** * * @type {string} - * @memberof AggregationEmailTemplate + * @memberof CamelProperties */ - 'subject_template_id': string; + 'url': string; /** * - * @type {AggregationEmailTemplateSubjectTemplate} - * @memberof AggregationEmailTemplate + * @type {BasicAuthentication} + * @memberof CamelProperties */ - 'body_template'?: AggregationEmailTemplateSubjectTemplate; + 'basicAuthentication'?: BasicAuthentication; /** * * @type {string} - * @memberof AggregationEmailTemplate + * @memberof CamelProperties */ - 'body_template_id': string; + 'secretToken'?: string; } - - /** * * @export - * @interface AggregationEmailTemplateSubjectTemplate + * @interface Endpoint */ -export interface AggregationEmailTemplateSubjectTemplate { - /** - * - * @type {string} - * @memberof AggregationEmailTemplateSubjectTemplate - */ - 'created'?: string; - /** - * - * @type {string} - * @memberof AggregationEmailTemplateSubjectTemplate - */ - 'updated'?: string; +export interface Endpoint { /** * * @type {string} - * @memberof AggregationEmailTemplateSubjectTemplate + * @memberof Endpoint */ 'id'?: string; /** * * @type {string} - * @memberof AggregationEmailTemplateSubjectTemplate + * @memberof Endpoint */ 'name': string; /** * * @type {string} - * @memberof AggregationEmailTemplateSubjectTemplate + * @memberof Endpoint */ 'description': string; /** * - * @type {string} - * @memberof AggregationEmailTemplateSubjectTemplate + * @type {boolean} + * @memberof Endpoint */ - 'data': string; -} -/** - * - * @export - * @interface Application - */ -export interface Application { + 'enabled'?: boolean; /** * - * @type {string} - * @memberof Application + * @type {EndpointStatus} + * @memberof Endpoint */ - 'created'?: string; + 'status'?: EndpointStatus; /** * - * @type {string} - * @memberof Application + * @type {number} + * @memberof Endpoint */ - 'updated'?: string; + 'server_errors'?: number; /** * - * @type {string} - * @memberof Application + * @type {EndpointType} + * @memberof Endpoint */ - 'id'?: string; + 'type': EndpointType; /** * * @type {string} - * @memberof Application + * @memberof Endpoint */ - 'name': string; + 'sub_type'?: string; /** * * @type {string} - * @memberof Application + * @memberof Endpoint */ - 'display_name': string; + 'created'?: string; /** * * @type {string} - * @memberof Application + * @memberof Endpoint */ - 'bundle_id': string; -} -/** - * - * @export - * @interface Application1 - */ -export interface Application1 { + 'updated'?: string; /** * - * @type {string} - * @memberof Application1 + * @type {object} + * @memberof Endpoint */ - 'id': string; + 'properties'?: object; /** * - * @type {string} - * @memberof Application1 + * @type {Set} + * @memberof Endpoint */ - 'display_name': string; + 'event_types_group_by_bundles_and_applications'?: Set; + /** + * + * @type {Set} + * @memberof Endpoint + */ + 'event_types'?: Set; } + + /** * * @export - * @interface ApplicationDTO + * @interface EndpointPage */ -export interface ApplicationDTO { +export interface EndpointPage { /** * - * @type {string} - * @memberof ApplicationDTO + * @type {Array} + * @memberof EndpointPage */ - 'id'?: string; + 'data': Array; /** * - * @type {string} - * @memberof ApplicationDTO + * @type {{ [key: string]: string; }} + * @memberof EndpointPage */ - 'name': string; + 'links': { [key: string]: string; }; /** * - * @type {string} - * @memberof ApplicationDTO + * @type {Meta} + * @memberof EndpointPage */ - 'display_name': string; + 'meta': Meta; +} +/** + * + * @export + * @enum {string} + */ + +export const EndpointStatus = { + Deleting: 'DELETING', + Failed: 'FAILED', + New: 'NEW', + Provisioning: 'PROVISIONING', + Ready: 'READY', + Unknown: 'UNKNOWN' +} as const; + +export type EndpointStatus = typeof EndpointStatus[keyof typeof EndpointStatus]; + + +/** + * + * @export + * @interface EndpointTestRequest + */ +export interface EndpointTestRequest { /** * * @type {string} - * @memberof ApplicationDTO - */ - 'bundle_id': string; - /** - * - * @type {Set} - * @memberof ApplicationDTO + * @memberof EndpointTestRequest */ - 'event_types'?: Set; + 'message': string; } /** * * @export - * @interface ApplicationDTO1 + * @enum {string} + */ + +export const EndpointType = { + Ansible: 'ansible', + Camel: 'camel', + Drawer: 'drawer', + EmailSubscription: 'email_subscription', + Webhook: 'webhook', + Pagerduty: 'pagerduty' +} as const; + +export type EndpointType = typeof EndpointType[keyof typeof EndpointType]; + + +/** + * + * @export + * @interface EventType */ -export interface ApplicationDTO1 { +export interface EventType { /** * * @type {string} - * @memberof ApplicationDTO1 + * @memberof EventType */ 'id'?: string; /** * * @type {string} - * @memberof ApplicationDTO1 + * @memberof EventType */ 'name': string; /** * * @type {string} - * @memberof ApplicationDTO1 + * @memberof EventType */ 'display_name': string; /** * * @type {string} - * @memberof ApplicationDTO1 - */ - 'bundle_id': string; - /** - * - * @type {string} - * @memberof ApplicationDTO1 + * @memberof EventType */ - 'owner_role'?: string; + 'description'?: string; /** * - * @type {string} - * @memberof ApplicationDTO1 + * @type {Application} + * @memberof EventType */ - 'created'?: string; + 'application'?: Application; } /** * * @export - * @interface ApplicationSettingsValue + * @enum {string} */ -export interface ApplicationSettingsValue { - /** - * - * @type {{ [key: string]: EventTypeSettingsValue; }} - * @memberof ApplicationSettingsValue - */ - 'eventTypes'?: { [key: string]: EventTypeSettingsValue; }; -} + +export const HttpType = { + Get: 'GET', + Post: 'POST', + Put: 'PUT' +} as const; + +export type HttpType = typeof HttpType[keyof typeof HttpType]; + + /** * * @export - * @interface BasicAuthenticationDTO + * @interface Meta */ -export interface BasicAuthenticationDTO { - /** - * - * @type {string} - * @memberof BasicAuthenticationDTO - */ - 'username'?: string; +export interface Meta { /** * - * @type {string} - * @memberof BasicAuthenticationDTO + * @type {number} + * @memberof Meta */ - 'password'?: string; + 'count': number; } /** * * @export - * @interface BehaviorGroup + * @interface NotificationHistory */ -export interface BehaviorGroup { +export interface NotificationHistory { /** * * @type {string} - * @memberof BehaviorGroup + * @memberof NotificationHistory */ 'created'?: string; /** * * @type {string} - * @memberof BehaviorGroup - */ - 'updated'?: string; - /** - * - * @type {string} - * @memberof BehaviorGroup + * @memberof NotificationHistory */ 'id'?: string; /** * - * @type {string} - * @memberof BehaviorGroup + * @type {number} + * @memberof NotificationHistory */ - 'display_name': string; + 'invocationTime': number; /** * - * @type {string} - * @memberof BehaviorGroup + * @type {boolean} + * @memberof NotificationHistory */ - 'bundle_id': string; - /** - * - * @type {Bundle} - * @memberof BehaviorGroup - */ - 'bundle'?: Bundle; - /** - * - * @type {Array} - * @memberof BehaviorGroup - */ - 'actions'?: Array; - /** - * - * @type {Set} - * @memberof BehaviorGroup - */ - 'behaviors'?: Set; - /** - * - * @type {boolean} - * @memberof BehaviorGroup - */ - 'default_behavior'?: boolean; -} -/** - * - * @export - * @interface BehaviorGroupAction - */ -export interface BehaviorGroupAction { - /** - * - * @type {string} - * @memberof BehaviorGroupAction - */ - 'created'?: string; - /** - * - * @type {BehaviorGroupActionId} - * @memberof BehaviorGroupAction - */ - 'id'?: BehaviorGroupActionId; - /** - * - * @type {Endpoint} - * @memberof BehaviorGroupAction - */ - 'endpoint'?: Endpoint; -} -/** - * - * @export - * @interface BehaviorGroupActionId - */ -export interface BehaviorGroupActionId { - /** - * - * @type {string} - * @memberof BehaviorGroupActionId - */ - 'behaviorGroupId': string; - /** - * - * @type {string} - * @memberof BehaviorGroupActionId - */ - 'endpointId': string; -} -/** - * - * @export - * @interface Bundle - */ -export interface Bundle { - /** - * - * @type {string} - * @memberof Bundle - */ - 'created'?: string; - /** - * - * @type {string} - * @memberof Bundle - */ - 'updated'?: string; - /** - * - * @type {string} - * @memberof Bundle - */ - 'id'?: string; - /** - * - * @type {string} - * @memberof Bundle - */ - 'name': string; - /** - * - * @type {string} - * @memberof Bundle - */ - 'display_name': string; -} -/** - * - * @export - * @interface BundleDTO - */ -export interface BundleDTO { - /** - * - * @type {string} - * @memberof BundleDTO - */ - 'id'?: string; - /** - * - * @type {string} - * @memberof BundleDTO - */ - 'name': string; - /** - * - * @type {string} - * @memberof BundleDTO - */ - 'display_name': string; - /** - * - * @type {Set} - * @memberof BundleDTO - */ - 'applications'?: Set; -} -/** - * - * @export - * @interface BundleSettingsValue - */ -export interface BundleSettingsValue { - /** - * - * @type {{ [key: string]: ApplicationSettingsValue; }} - * @memberof BundleSettingsValue - */ - 'applications'?: { [key: string]: ApplicationSettingsValue; }; -} -/** - * - * @export - * @interface CamelPropertiesDTO - */ -export interface CamelPropertiesDTO { - /** - * - * @type {boolean} - * @memberof CamelPropertiesDTO - */ - 'disableSslVerification': boolean; - /** - * - * @type {{ [key: string]: string; }} - * @memberof CamelPropertiesDTO - */ - 'extras'?: { [key: string]: string; }; - /** - * - * @type {string} - * @memberof CamelPropertiesDTO - */ - 'url': string; - /** - * - * @type {BasicAuthenticationDTO} - * @memberof CamelPropertiesDTO - */ - 'basicAuthentication'?: BasicAuthenticationDTO; - /** - * - * @type {string} - * @memberof CamelPropertiesDTO - */ - 'secretToken'?: string; -} -/** - * - * @export - * @interface CreateBehaviorGroupRequest - */ -export interface CreateBehaviorGroupRequest { - /** - * - * @type {string} - * @memberof CreateBehaviorGroupRequest - */ - 'bundle_id'?: string; - /** - * - * @type {string} - * @memberof CreateBehaviorGroupRequest - */ - 'bundle_name'?: string; - /** - * - * @type {string} - * @memberof CreateBehaviorGroupRequest - */ - 'display_name': string; - /** - * - * @type {Array} - * @memberof CreateBehaviorGroupRequest - */ - 'endpoint_ids'?: Array; - /** - * - * @type {Set} - * @memberof CreateBehaviorGroupRequest - */ - 'event_type_ids'?: Set; - /** - * - * @type {boolean} - * @memberof CreateBehaviorGroupRequest - */ - 'bundle_uuid_or_bundle_name_valid'?: boolean; -} -/** - * - * @export - * @interface CreateBehaviorGroupResponse - */ -export interface CreateBehaviorGroupResponse { - /** - * - * @type {string} - * @memberof CreateBehaviorGroupResponse - */ - 'id': string; - /** - * - * @type {string} - * @memberof CreateBehaviorGroupResponse - */ - 'bundle_id': string; - /** - * - * @type {string} - * @memberof CreateBehaviorGroupResponse - */ - 'display_name': string; - /** - * - * @type {Array} - * @memberof CreateBehaviorGroupResponse - */ - 'endpoints': Array; - /** - * - * @type {Set} - * @memberof CreateBehaviorGroupResponse - */ - 'event_types': Set; - /** - * - * @type {string} - * @memberof CreateBehaviorGroupResponse - */ - 'created': string; -} -/** - * - * @export - * @interface CurrentStatus - */ -export interface CurrentStatus { - /** - * - * @type {Status} - * @memberof CurrentStatus - */ - 'status': Status; - /** - * - * @type {string} - * @memberof CurrentStatus - */ - 'start_time'?: string; - /** - * - * @type {string} - * @memberof CurrentStatus - */ - 'end_time'?: string; -} - - -/** - * - * @export - * @interface DrawerEntryPayload - */ -export interface DrawerEntryPayload { - /** - * - * @type {string} - * @memberof DrawerEntryPayload - */ - 'id'?: string; - /** - * - * @type {string} - * @memberof DrawerEntryPayload - */ - 'description'?: string; - /** - * - * @type {string} - * @memberof DrawerEntryPayload - */ - 'title'?: string; - /** - * - * @type {string} - * @memberof DrawerEntryPayload - */ - 'created'?: string; - /** - * - * @type {boolean} - * @memberof DrawerEntryPayload - */ - 'read': boolean; - /** - * - * @type {string} - * @memberof DrawerEntryPayload - */ - 'source'?: string; - /** - * - * @type {string} - * @memberof DrawerEntryPayload - */ - 'bundle'?: string; -} -/** - * - * @export - * @interface Endpoint - */ -export interface Endpoint { - /** - * - * @type {string} - * @memberof Endpoint - */ - 'created'?: string; - /** - * - * @type {string} - * @memberof Endpoint - */ - 'updated'?: string; - /** - * - * @type {string} - * @memberof Endpoint - */ - 'id'?: string; - /** - * - * @type {string} - * @memberof Endpoint - */ - 'name': string; - /** - * - * @type {string} - * @memberof Endpoint - */ - 'description': string; - /** - * - * @type {boolean} - * @memberof Endpoint - */ - 'enabled'?: boolean; - /** - * - * @type {EndpointStatus} - * @memberof Endpoint - */ - 'status'?: EndpointStatus; - /** - * - * @type {number} - * @memberof Endpoint - */ - 'server_errors'?: number; - /** - * - * @type {object} - * @memberof Endpoint - */ - 'properties'?: object; - /** - * - * @type {EndpointType} - * @memberof Endpoint - */ - 'type'?: EndpointType; - /** - * - * @type {string} - * @memberof Endpoint - */ - 'sub_type'?: string; -} - - -/** - * - * @export - * @interface EndpointDTO - */ -export interface EndpointDTO { - /** - * - * @type {string} - * @memberof EndpointDTO - */ - 'id'?: string; - /** - * - * @type {string} - * @memberof EndpointDTO - */ - 'name': string; - /** - * - * @type {string} - * @memberof EndpointDTO - */ - 'description': string; - /** - * - * @type {boolean} - * @memberof EndpointDTO - */ - 'enabled'?: boolean; - /** - * - * @type {EndpointStatusDTO} - * @memberof EndpointDTO - */ - 'status'?: EndpointStatusDTO; - /** - * - * @type {number} - * @memberof EndpointDTO - */ - 'server_errors'?: number; - /** - * - * @type {EndpointTypeDTO} - * @memberof EndpointDTO - */ - 'type': EndpointTypeDTO; - /** - * - * @type {string} - * @memberof EndpointDTO - */ - 'sub_type'?: string; - /** - * - * @type {string} - * @memberof EndpointDTO - */ - 'created'?: string; - /** - * - * @type {string} - * @memberof EndpointDTO - */ - 'updated'?: string; - /** - * - * @type {object} - * @memberof EndpointDTO - */ - 'properties'?: object; - /** - * - * @type {Set} - * @memberof EndpointDTO - */ - 'event_types_group_by_bundles_and_applications'?: Set; - /** - * - * @type {Set} - * @memberof EndpointDTO - */ - 'event_types'?: Set; -} - - -/** - * - * @export - * @interface EndpointPage - */ -export interface EndpointPage { - /** - * - * @type {Array} - * @memberof EndpointPage - */ - 'data': Array; - /** - * - * @type {{ [key: string]: string; }} - * @memberof EndpointPage - */ - 'links': { [key: string]: string; }; - /** - * - * @type {Meta} - * @memberof EndpointPage - */ - 'meta': Meta; -} -/** - * - * @export - * @enum {string} - */ - -export const EndpointStatus = { - Ready: 'READY', - Unknown: 'UNKNOWN', - New: 'NEW', - Provisioning: 'PROVISIONING', - Deleting: 'DELETING', - Failed: 'FAILED' -} as const; - -export type EndpointStatus = typeof EndpointStatus[keyof typeof EndpointStatus]; - - -/** - * - * @export - * @enum {string} - */ - -export const EndpointStatusDTO = { - Deleting: 'DELETING', - Failed: 'FAILED', - New: 'NEW', - Provisioning: 'PROVISIONING', - Ready: 'READY', - Unknown: 'UNKNOWN' -} as const; - -export type EndpointStatusDTO = typeof EndpointStatusDTO[keyof typeof EndpointStatusDTO]; - - -/** - * - * @export - * @interface EndpointTestRequest - */ -export interface EndpointTestRequest { - /** - * - * @type {string} - * @memberof EndpointTestRequest - */ - 'message': string; -} -/** - * - * @export - * @enum {string} - */ - -export const EndpointType = { - Ansible: 'ansible', - Camel: 'camel', - Drawer: 'drawer', - EmailSubscription: 'email_subscription', - Webhook: 'webhook', - Pagerduty: 'pagerduty' -} as const; - -export type EndpointType = typeof EndpointType[keyof typeof EndpointType]; - - -/** - * - * @export - * @enum {string} - */ - -export const EndpointTypeDTO = { - Ansible: 'ansible', - Camel: 'camel', - Drawer: 'drawer', - EmailSubscription: 'email_subscription', - Webhook: 'webhook' -} as const; - -export type EndpointTypeDTO = typeof EndpointTypeDTO[keyof typeof EndpointTypeDTO]; - - -/** - * - * @export - * @enum {string} - */ - -export const Environment = { - Prod: 'PROD', - Stage: 'STAGE', - Ephemeral: 'EPHEMERAL', - LocalServer: 'LOCAL_SERVER' -} as const; - -export type Environment = typeof Environment[keyof typeof Environment]; - - -/** - * - * @export - * @interface EventLogEntry - */ -export interface EventLogEntry { - /** - * - * @type {string} - * @memberof EventLogEntry - */ - 'id': string; - /** - * - * @type {string} - * @memberof EventLogEntry - */ - 'created': string; - /** - * - * @type {string} - * @memberof EventLogEntry - */ - 'bundle': string; - /** - * - * @type {string} - * @memberof EventLogEntry - */ - 'application': string; - /** - * - * @type {string} - * @memberof EventLogEntry - */ - 'event_type': string; - /** - * - * @type {string} - * @memberof EventLogEntry - */ - 'payload'?: string; - /** - * - * @type {Array} - * @memberof EventLogEntry - */ - 'actions': Array; -} -/** - * - * @export - * @interface EventLogEntryAction - */ -export interface EventLogEntryAction { - /** - * - * @type {string} - * @memberof EventLogEntryAction - */ - 'id': string; - /** - * - * @type {EndpointType} - * @memberof EventLogEntryAction - */ - 'endpoint_type': EndpointType; - /** - * - * @type {string} - * @memberof EventLogEntryAction - */ - 'endpoint_sub_type'?: string; - /** - * - * @type {boolean} - * @memberof EventLogEntryAction - * @deprecated - */ - 'invocation_result': boolean; - /** - * - * @type {EventLogEntryActionStatus} - * @memberof EventLogEntryAction - */ - 'status': EventLogEntryActionStatus; - /** - * - * @type {string} - * @memberof EventLogEntryAction - */ - 'endpoint_id'?: string; - /** - * - * @type {{ [key: string]: any; }} - * @memberof EventLogEntryAction - */ - 'details'?: { [key: string]: any; }; -} - - -/** - * - * @export - * @enum {string} - */ - -export const EventLogEntryActionStatus = { - Sent: 'SENT', - Success: 'SUCCESS', - Processing: 'PROCESSING', - Failed: 'FAILED', - Unknown: 'UNKNOWN' -} as const; - -export type EventLogEntryActionStatus = typeof EventLogEntryActionStatus[keyof typeof EventLogEntryActionStatus]; - - -/** - * - * @export - * @interface EventType - */ -export interface EventType { - /** - * - * @type {string} - * @memberof EventType - */ - 'id'?: string; - /** - * - * @type {string} - * @memberof EventType - */ - 'name': string; - /** - * - * @type {string} - * @memberof EventType - */ - 'display_name': string; - /** - * - * @type {string} - * @memberof EventType - */ - 'description'?: string; - /** - * - * @type {string} - * @memberof EventType - */ - 'fully_qualified_name'?: string; - /** - * - * @type {string} - * @memberof EventType - */ - 'application_id': string; - /** - * - * @type {Application} - * @memberof EventType - */ - 'application'?: Application; - /** - * - * @type {boolean} - * @memberof EventType - */ - 'visible'?: boolean; - /** - * - * @type {boolean} - * @memberof EventType - */ - 'subscribed_by_default'?: boolean; - /** - * - * @type {boolean} - * @memberof EventType - */ - 'subscription_locked'?: boolean; - /** - * - * @type {boolean} - * @memberof EventType - */ - 'not_subscription_locked_or_subscribed_by_default'?: boolean; -} -/** - * - * @export - * @interface EventTypeBehavior - */ -export interface EventTypeBehavior { - /** - * - * @type {string} - * @memberof EventTypeBehavior - */ - 'created'?: string; - /** - * - * @type {EventTypeBehaviorId} - * @memberof EventTypeBehavior - */ - 'id'?: EventTypeBehaviorId; - /** - * - * @type {EventType} - * @memberof EventTypeBehavior - */ - 'event_type'?: EventType; -} -/** - * - * @export - * @interface EventTypeBehaviorId - */ -export interface EventTypeBehaviorId { - /** - * - * @type {string} - * @memberof EventTypeBehaviorId - */ - 'eventTypeId': string; - /** - * - * @type {string} - * @memberof EventTypeBehaviorId - */ - 'behaviorGroupId': string; -} -/** - * - * @export - * @interface EventTypeDTO - */ -export interface EventTypeDTO { - /** - * - * @type {string} - * @memberof EventTypeDTO - */ - 'id'?: string; - /** - * - * @type {string} - * @memberof EventTypeDTO - */ - 'name': string; - /** - * - * @type {string} - * @memberof EventTypeDTO - */ - 'display_name': string; - /** - * - * @type {string} - * @memberof EventTypeDTO - */ - 'description'?: string; - /** - * - * @type {ApplicationDTO} - * @memberof EventTypeDTO - */ - 'application'?: ApplicationDTO; -} -/** - * - * @export - * @interface EventTypeSettingsValue - */ -export interface EventTypeSettingsValue { - /** - * - * @type {{ [key: string]: boolean; }} - * @memberof EventTypeSettingsValue - */ - 'emailSubscriptionTypes'?: { [key: string]: boolean; }; - /** - * - * @type {boolean} - * @memberof EventTypeSettingsValue - */ - 'hasForcedEmail'?: boolean; - /** - * - * @type {boolean} - * @memberof EventTypeSettingsValue - */ - 'subscriptionLocked'?: boolean; -} -/** - * - * @export - * @interface EventsReplayRequest - */ -export interface EventsReplayRequest { - /** - * - * @type {string} - * @memberof EventsReplayRequest - */ - 'start_date': string; - /** - * - * @type {string} - * @memberof EventsReplayRequest - */ - 'end_date': string; - /** - * - * @type {string} - * @memberof EventsReplayRequest - */ - 'org_id'?: string; -} -/** - * - * @export - * @interface Facet - */ -export interface Facet { - /** - * - * @type {string} - * @memberof Facet - */ - 'id': string; - /** - * - * @type {string} - * @memberof Facet - */ - 'name': string; - /** - * - * @type {string} - * @memberof Facet - */ - 'displayName': string; - /** - * - * @type {Array} - * @memberof Facet - */ - 'children'?: Array; -} -/** - * - * @export - * @enum {string} - */ - -export const HttpType = { - Get: 'GET', - Post: 'POST', - Put: 'PUT' -} as const; - -export type HttpType = typeof HttpType[keyof typeof HttpType]; - - -/** - * - * @export - * @interface InstantEmailTemplate - */ -export interface InstantEmailTemplate { - /** - * - * @type {string} - * @memberof InstantEmailTemplate - */ - 'created'?: string; - /** - * - * @type {string} - * @memberof InstantEmailTemplate - */ - 'updated'?: string; - /** - * - * @type {string} - * @memberof InstantEmailTemplate - */ - 'id'?: string; - /** - * - * @type {EventType} - * @memberof InstantEmailTemplate - */ - 'event_type'?: EventType; - /** - * - * @type {string} - * @memberof InstantEmailTemplate - */ - 'event_type_id'?: string; - /** - * - * @type {AggregationEmailTemplateSubjectTemplate} - * @memberof InstantEmailTemplate - */ - 'subject_template'?: AggregationEmailTemplateSubjectTemplate; - /** - * - * @type {string} - * @memberof InstantEmailTemplate - */ - 'subject_template_id': string; - /** - * - * @type {AggregationEmailTemplateSubjectTemplate} - * @memberof InstantEmailTemplate - */ - 'body_template'?: AggregationEmailTemplateSubjectTemplate; - /** - * - * @type {string} - * @memberof InstantEmailTemplate - */ - 'body_template_id': string; -} -/** - * - * @export - * @interface InternalApplicationUserPermission - */ -export interface InternalApplicationUserPermission { - /** - * - * @type {string} - * @memberof InternalApplicationUserPermission - */ - 'application_id': string; - /** - * - * @type {string} - * @memberof InternalApplicationUserPermission - */ - 'application_display_name': string; - /** - * - * @type {string} - * @memberof InternalApplicationUserPermission - */ - 'role': string; -} -/** - * - * @export - * @interface InternalRoleAccess - */ -export interface InternalRoleAccess { - /** - * - * @type {string} - * @memberof InternalRoleAccess - */ - 'id'?: string; - /** - * - * @type {string} - * @memberof InternalRoleAccess - */ - 'role': string; - /** - * - * @type {string} - * @memberof InternalRoleAccess - */ - 'application_id': string; -} -/** - * - * @export - * @interface InternalUserPermissions - */ -export interface InternalUserPermissions { - /** - * - * @type {boolean} - * @memberof InternalUserPermissions - */ - 'is_admin': boolean; - /** - * - * @type {Array} - * @memberof InternalUserPermissions - */ - 'applications': Array; - /** - * - * @type {Array} - * @memberof InternalUserPermissions - */ - 'roles': Array; -} -/** - * - * @export - * @interface MessageValidationResponse - */ -export interface MessageValidationResponse { - /** - * - * @type {{ [key: string]: Array; }} - * @memberof MessageValidationResponse - */ - 'errors': { [key: string]: Array; }; -} -/** - * - * @export - * @interface Meta - */ -export interface Meta { - /** - * - * @type {number} - * @memberof Meta - */ - 'count': number; -} -/** - * - * @export - * @interface NotificationHistory - */ -export interface NotificationHistory { - /** - * - * @type {string} - * @memberof NotificationHistory - */ - 'created'?: string; - /** - * - * @type {string} - * @memberof NotificationHistory - */ - 'id'?: string; - /** - * - * @type {number} - * @memberof NotificationHistory - */ - 'invocationTime': number; - /** - * - * @type {boolean} - * @memberof NotificationHistory - * @deprecated - */ - 'invocationResult': boolean; + 'invocationResult': boolean; /** * * @type {NotificationStatus} * @memberof NotificationHistory */ - 'status': NotificationStatus; - /** - * - * @type {string} - * @memberof NotificationHistory - */ - 'endpointId'?: string; - /** - * - * @type {{ [key: string]: any; }} - * @memberof NotificationHistory - */ - 'details'?: { [key: string]: any; }; - /** - * - * @type {EndpointType} - * @memberof NotificationHistory - */ - 'endpointType'?: EndpointType; - /** - * - * @type {string} - * @memberof NotificationHistory - */ - 'endpointSubType'?: string; -} - - -/** - * - * @export - * @enum {string} - */ - -export const NotificationStatus = { - FailedInternal: 'FAILED_INTERNAL', - FailedExternal: 'FAILED_EXTERNAL', - Processing: 'PROCESSING', - Sent: 'SENT', - Success: 'SUCCESS' -} as const; - -export type NotificationStatus = typeof NotificationStatus[keyof typeof NotificationStatus]; - - -/** - * - * @export - * @interface PageBehaviorGroup - */ -export interface PageBehaviorGroup { - /** - * - * @type {Array} - * @memberof PageBehaviorGroup - */ - 'data': Array; - /** - * - * @type {{ [key: string]: string; }} - * @memberof PageBehaviorGroup - */ - 'links': { [key: string]: string; }; - /** - * - * @type {Meta} - * @memberof PageBehaviorGroup - */ - 'meta': Meta; -} -/** - * - * @export - * @interface PageDrawerEntryPayload - */ -export interface PageDrawerEntryPayload { - /** - * - * @type {Array} - * @memberof PageDrawerEntryPayload - */ - 'data': Array; - /** - * - * @type {{ [key: string]: string; }} - * @memberof PageDrawerEntryPayload - */ - 'links': { [key: string]: string; }; - /** - * - * @type {Meta} - * @memberof PageDrawerEntryPayload - */ - 'meta': Meta; -} -/** - * - * @export - * @interface PageEventLogEntry - */ -export interface PageEventLogEntry { - /** - * - * @type {Array} - * @memberof PageEventLogEntry - */ - 'data': Array; - /** - * - * @type {{ [key: string]: string; }} - * @memberof PageEventLogEntry - */ - 'links': { [key: string]: string; }; - /** - * - * @type {Meta} - * @memberof PageEventLogEntry - */ - 'meta': Meta; -} -/** - * - * @export - * @interface PageEventType - */ -export interface PageEventType { + 'status': NotificationStatus; /** * - * @type {Array} - * @memberof PageEventType + * @type {string} + * @memberof NotificationHistory */ - 'data': Array; + 'endpointId'?: string; /** * - * @type {{ [key: string]: string; }} - * @memberof PageEventType + * @type {EndpointType} + * @memberof NotificationHistory */ - 'links': { [key: string]: string; }; + 'endpointType'?: EndpointType; /** * - * @type {Meta} - * @memberof PageEventType + * @type {{ [key: string]: any; }} + * @memberof NotificationHistory */ - 'meta': Meta; + 'details'?: { [key: string]: any; }; } + + /** * * @export - * @interface PageNotificationHistory + * @enum {string} */ -export interface PageNotificationHistory { - /** - * - * @type {Array} - * @memberof PageNotificationHistory - */ - 'data': Array; - /** - * - * @type {{ [key: string]: string; }} - * @memberof PageNotificationHistory - */ - 'links': { [key: string]: string; }; - /** - * - * @type {Meta} - * @memberof PageNotificationHistory - */ - 'meta': Meta; -} + +export const NotificationStatus = { + FailedInternal: 'FAILED_INTERNAL', + FailedExternal: 'FAILED_EXTERNAL', + Processing: 'PROCESSING', + Sent: 'SENT', + Success: 'SUCCESS' +} as const; + +export type NotificationStatus = typeof NotificationStatus[keyof typeof NotificationStatus]; + + /** * * @export - * @interface PagerDutyPropertiesDTO + * @interface PagerDutyProperties */ -export interface PagerDutyPropertiesDTO { +export interface PagerDutyProperties { /** * - * @type {PagerDutySeverityDTO} - * @memberof PagerDutyPropertiesDTO + * @type {PagerDutySeverity} + * @memberof PagerDutyProperties */ - 'severity': PagerDutySeverityDTO; + 'severity': PagerDutySeverity; /** * * @type {string} - * @memberof PagerDutyPropertiesDTO + * @memberof PagerDutyProperties */ 'secretToken': string; } @@ -1779,60 +459,6 @@ export const PagerDutySeverity = { export type PagerDutySeverity = typeof PagerDutySeverity[keyof typeof PagerDutySeverity]; -/** - * - * @export - * @enum {string} - */ - -export const PagerDutySeverityDTO = { - Critical: 'critical', - Error: 'error', - Warning: 'warning', - Info: 'info' -} as const; - -export type PagerDutySeverityDTO = typeof PagerDutySeverityDTO[keyof typeof PagerDutySeverityDTO]; - - -/** - * - * @export - * @interface RenderEmailTemplateRequest - */ -export interface RenderEmailTemplateRequest { - /** - * - * @type {Array} - * @memberof RenderEmailTemplateRequest - */ - 'template': Array; - /** - * - * @type {string} - * @memberof RenderEmailTemplateRequest - */ - 'payload': string; -} -/** - * - * @export - * @interface RequestDefaultBehaviorGroupPropertyList - */ -export interface RequestDefaultBehaviorGroupPropertyList { - /** - * - * @type {boolean} - * @memberof RequestDefaultBehaviorGroupPropertyList - */ - 'only_admins': boolean; - /** - * - * @type {boolean} - * @memberof RequestDefaultBehaviorGroupPropertyList - */ - 'ignore_preferences': boolean; -} /** * * @export @@ -1855,319 +481,70 @@ export interface RequestSystemSubscriptionProperties { /** * * @export - * @interface ServerInfo - */ -export interface ServerInfo { - /** - * - * @type {Environment} - * @memberof ServerInfo - */ - 'environment'?: Environment; -} - - -/** - * - * @export - * @interface SettingsValuesByEventType - */ -export interface SettingsValuesByEventType { - /** - * - * @type {{ [key: string]: BundleSettingsValue; }} - * @memberof SettingsValuesByEventType - */ - 'bundles'?: { [key: string]: BundleSettingsValue; }; -} -/** - * - * @export - * @enum {string} - */ - -export const Status = { - Up: 'UP', - Maintenance: 'MAINTENANCE' -} as const; - -export type Status = typeof Status[keyof typeof Status]; - - -/** - * - * @export - * @enum {string} - */ - -export const SubscriptionType = { - Instant: 'INSTANT', - Daily: 'DAILY', - Drawer: 'DRAWER' -} as const; - -export type SubscriptionType = typeof SubscriptionType[keyof typeof SubscriptionType]; - - -/** - * - * @export - * @interface SystemSubscriptionPropertiesDTO + * @interface SystemSubscriptionProperties */ -export interface SystemSubscriptionPropertiesDTO { +export interface SystemSubscriptionProperties { /** * * @type {string} - * @memberof SystemSubscriptionPropertiesDTO + * @memberof SystemSubscriptionProperties */ 'groupId'?: string; /** * * @type {boolean} - * @memberof SystemSubscriptionPropertiesDTO + * @memberof SystemSubscriptionProperties */ 'ignorePreferences'?: boolean; /** * * @type {boolean} - * @memberof SystemSubscriptionPropertiesDTO + * @memberof SystemSubscriptionProperties */ 'onlyAdmins'?: boolean; } /** * * @export - * @interface Template - */ -export interface Template { - /** - * - * @type {string} - * @memberof Template - */ - 'created'?: string; - /** - * - * @type {string} - * @memberof Template - */ - 'updated'?: string; - /** - * - * @type {string} - * @memberof Template - */ - 'id'?: string; - /** - * - * @type {string} - * @memberof Template - */ - 'name': string; - /** - * - * @type {string} - * @memberof Template - */ - 'description': string; - /** - * - * @type {string} - * @memberof Template - */ - 'data': string; -} -/** - * - * @export - * @interface TriggerDailyDigestRequest - */ -export interface TriggerDailyDigestRequest { - /** - * - * @type {string} - * @memberof TriggerDailyDigestRequest - */ - 'application_name': string; - /** - * - * @type {string} - * @memberof TriggerDailyDigestRequest - */ - 'bundle_name': string; - /** - * - * @type {string} - * @memberof TriggerDailyDigestRequest - */ - 'end'?: string; - /** - * - * @type {string} - * @memberof TriggerDailyDigestRequest - */ - 'org_id': string; - /** - * - * @type {string} - * @memberof TriggerDailyDigestRequest - */ - 'start'?: string; -} -/** - * - * @export - * @interface UpdateApplicationRequest - */ -export interface UpdateApplicationRequest { - /** - * - * @type {string} - * @memberof UpdateApplicationRequest - */ - 'name'?: string; - /** - * - * @type {string} - * @memberof UpdateApplicationRequest - */ - 'display_name'?: string; - /** - * - * @type {string} - * @memberof UpdateApplicationRequest - */ - 'owner_role'?: string; -} -/** - * - * @export - * @interface UpdateBehaviorGroupRequest - */ -export interface UpdateBehaviorGroupRequest { - /** - * - * @type {string} - * @memberof UpdateBehaviorGroupRequest - */ - 'display_name'?: string; - /** - * - * @type {Array} - * @memberof UpdateBehaviorGroupRequest - */ - 'endpoint_ids'?: Array; - /** - * - * @type {Set} - * @memberof UpdateBehaviorGroupRequest - */ - 'event_type_ids'?: Set; - /** - * - * @type {boolean} - * @memberof UpdateBehaviorGroupRequest - */ - 'display_name_not_null_and_blank'?: boolean; -} -/** - * - * @export - * @interface UpdateNotificationDrawerStatus - */ -export interface UpdateNotificationDrawerStatus { - /** - * - * @type {Set} - * @memberof UpdateNotificationDrawerStatus - */ - 'notification_ids': Set; - /** - * - * @type {boolean} - * @memberof UpdateNotificationDrawerStatus - */ - 'read_status': boolean; -} -/** - * - * @export - * @interface WebhookPropertiesDTO + * @interface WebhookProperties */ -export interface WebhookPropertiesDTO { +export interface WebhookProperties { /** * * @type {boolean} - * @memberof WebhookPropertiesDTO + * @memberof WebhookProperties */ 'disableSslVerification': boolean; /** * * @type {HttpType} - * @memberof WebhookPropertiesDTO + * @memberof WebhookProperties */ 'method': HttpType; /** * * @type {string} - * @memberof WebhookPropertiesDTO + * @memberof WebhookProperties */ 'url': string; /** * - * @type {BasicAuthenticationDTO} - * @memberof WebhookPropertiesDTO + * @type {BasicAuthentication} + * @memberof WebhookProperties */ - 'basicAuthentication'?: BasicAuthenticationDTO; + 'basicAuthentication'?: BasicAuthentication; /** * * @type {string} - * @memberof WebhookPropertiesDTO + * @memberof WebhookProperties */ 'bearerAuthentication'?: string; /** * * @type {string} - * @memberof WebhookPropertiesDTO + * @memberof WebhookProperties */ 'secretToken'?: string; } -/** - * - * @export - * @interface X509Certificate - */ -export interface X509Certificate { - /** - * - * @type {string} - * @memberof X509Certificate - */ - 'id'?: string; - /** - * - * @type {string} - * @memberof X509Certificate - */ - 'subject_dn': string; - /** - * - * @type {string} - * @memberof X509Certificate - */ - 'source_environment': string; - /** - * - * @type {string} - * @memberof X509Certificate - */ - 'bundle': string; - /** - * - * @type {string} - * @memberof X509Certificate - */ - 'application': string; -} diff --git a/packages/notifications/.openapi-generator/FILES b/packages/notifications/.openapi-generator/FILES index 28bd96e17..30da17e41 100644 --- a/packages/notifications/.openapi-generator/FILES +++ b/packages/notifications/.openapi-generator/FILES @@ -20,6 +20,7 @@ NotificationResourceV1GetLinkedBehaviorGroups/index.ts NotificationResourceV1UpdateBehaviorGroup/index.ts NotificationResourceV1UpdateBehaviorGroupActions/index.ts NotificationResourceV1UpdateEventTypeBehaviors/index.ts +NotificationResourceV1UpdateEventTypeEndpoints/index.ts OrgConfigResourceV1GetDailyDigestTimePreference/index.ts OrgConfigResourceV1SaveDailyDigestTimePreference/index.ts api.ts diff --git a/packages/notifications/NotificationResourceV1UpdateEventTypeEndpoints/index.ts b/packages/notifications/NotificationResourceV1UpdateEventTypeEndpoints/index.ts new file mode 100644 index 000000000..e5b68b299 --- /dev/null +++ b/packages/notifications/NotificationResourceV1UpdateEventTypeEndpoints/index.ts @@ -0,0 +1,65 @@ +// @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 NotificationResourceV1UpdateEventTypeEndpointsParams = { + /** + * UUID of the eventType to associate with the endpoint(s) + * @type { string } + * @memberof NotificationResourceV1UpdateEventTypeEndpointsApi + */ + eventTypeId: string, + /** + * + * @type { Set } + * @memberof NotificationResourceV1UpdateEventTypeEndpointsApi + */ + requestBody?: Set, + options?: AxiosRequestConfig +} + +const isNotificationResourceV1UpdateEventTypeEndpointsObjectParams = (params: [NotificationResourceV1UpdateEventTypeEndpointsParams] | unknown[]): params is [NotificationResourceV1UpdateEventTypeEndpointsParams] => { + return params.length === 1 && Object.prototype.hasOwnProperty.call(params, 'eventTypeId') && true +} +/** +* Updates the list of endpoints associated with an event type. +* @summary Update the list of endpoints for an event type +* @param {NotificationResourceV1UpdateEventTypeEndpointsParams} config with all available params. +* @param {*} [options] Override http request option. +* @throws {RequiredError} +*/ +export const notificationResourceV1UpdateEventTypeEndpointsParamCreator = async (...config: ([NotificationResourceV1UpdateEventTypeEndpointsParams] | [string, Set, AxiosRequestConfig])): Promise => { + const params = isNotificationResourceV1UpdateEventTypeEndpointsObjectParams(config) ? config[0] : ['eventTypeId', 'requestBody', 'options'].reduce((acc, curr, index) => ({ ...acc, [curr]: config[index] }), {}) as NotificationResourceV1UpdateEventTypeEndpointsParams; + const { eventTypeId, requestBody, options = {} } = params; + const localVarPath = `/notifications/eventTypes/{eventTypeId}/endpoints` + .replace(`{${"eventTypeId"}}`, encodeURIComponent(String(eventTypeId))); + // 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}; + + return { + urlObj: localVarUrlObj, + options: localVarRequestOptions, + serializeData: requestBody, + }; +} + +export default notificationResourceV1UpdateEventTypeEndpointsParamCreator; diff --git a/packages/notifications/api.ts b/packages/notifications/api.ts index 294e4eb51..f84af57c8 100644 --- a/packages/notifications/api.ts +++ b/packages/notifications/api.ts @@ -26,1602 +26,395 @@ import { BASE_PATH, COLLECTION_FORMATS, BaseAPI, RequiredError } from './base'; /** * * @export - * @interface AddAccessRequest + * @interface Application */ -export interface AddAccessRequest { +export interface Application { /** * * @type {string} - * @memberof AddAccessRequest + * @memberof Application */ - 'role'?: string; + 'created'?: string; /** * * @type {string} - * @memberof AddAccessRequest + * @memberof Application */ - 'application_id'?: string; -} -/** - * - * @export - * @interface AddApplicationRequest - */ -export interface AddApplicationRequest { + 'updated'?: string; /** * * @type {string} - * @memberof AddApplicationRequest + * @memberof Application */ - 'name': string; + 'id'?: string; /** * * @type {string} - * @memberof AddApplicationRequest + * @memberof Application */ - 'display_name': string; + 'name': string; /** * * @type {string} - * @memberof AddApplicationRequest + * @memberof Application */ - 'bundle_id': string; + 'display_name': string; /** * * @type {string} - * @memberof AddApplicationRequest + * @memberof Application */ - 'owner_role'?: string; + 'bundle_id': string; } /** * * @export - * @interface AggregationEmailTemplate + * @interface BehaviorGroup */ -export interface AggregationEmailTemplate { +export interface BehaviorGroup { /** * * @type {string} - * @memberof AggregationEmailTemplate + * @memberof BehaviorGroup */ 'created'?: string; /** * * @type {string} - * @memberof AggregationEmailTemplate + * @memberof BehaviorGroup */ 'updated'?: string; /** * * @type {string} - * @memberof AggregationEmailTemplate + * @memberof BehaviorGroup */ 'id'?: string; - /** - * - * @type {Application} - * @memberof AggregationEmailTemplate - */ - 'application'?: Application; /** * * @type {string} - * @memberof AggregationEmailTemplate + * @memberof BehaviorGroup */ - 'application_id'?: string; + 'display_name': string; /** * - * @type {SubscriptionType} - * @memberof AggregationEmailTemplate + * @type {string} + * @memberof BehaviorGroup */ - 'subscription_type': SubscriptionType; + 'bundle_id': string; /** * - * @type {AggregationEmailTemplateSubjectTemplate} - * @memberof AggregationEmailTemplate + * @type {Bundle} + * @memberof BehaviorGroup */ - 'subject_template'?: AggregationEmailTemplateSubjectTemplate; + 'bundle'?: Bundle; /** * - * @type {string} - * @memberof AggregationEmailTemplate + * @type {Array} + * @memberof BehaviorGroup */ - 'subject_template_id': string; + 'actions'?: Array; /** * - * @type {AggregationEmailTemplateSubjectTemplate} - * @memberof AggregationEmailTemplate + * @type {Set} + * @memberof BehaviorGroup */ - 'body_template'?: AggregationEmailTemplateSubjectTemplate; + 'behaviors'?: Set; /** * - * @type {string} - * @memberof AggregationEmailTemplate + * @type {boolean} + * @memberof BehaviorGroup */ - 'body_template_id': string; + 'default_behavior'?: boolean; } - - /** * * @export - * @interface AggregationEmailTemplateSubjectTemplate + * @interface BehaviorGroupAction */ -export interface AggregationEmailTemplateSubjectTemplate { +export interface BehaviorGroupAction { /** * * @type {string} - * @memberof AggregationEmailTemplateSubjectTemplate + * @memberof BehaviorGroupAction */ 'created'?: string; /** * - * @type {string} - * @memberof AggregationEmailTemplateSubjectTemplate - */ - 'updated'?: string; - /** - * - * @type {string} - * @memberof AggregationEmailTemplateSubjectTemplate + * @type {BehaviorGroupActionId} + * @memberof BehaviorGroupAction */ - 'id'?: string; + 'id'?: BehaviorGroupActionId; /** * - * @type {string} - * @memberof AggregationEmailTemplateSubjectTemplate + * @type {Endpoint} + * @memberof BehaviorGroupAction */ - 'name': string; + 'endpoint'?: Endpoint; +} +/** + * + * @export + * @interface BehaviorGroupActionId + */ +export interface BehaviorGroupActionId { /** * * @type {string} - * @memberof AggregationEmailTemplateSubjectTemplate + * @memberof BehaviorGroupActionId */ - 'description': string; + 'behaviorGroupId': string; /** * * @type {string} - * @memberof AggregationEmailTemplateSubjectTemplate + * @memberof BehaviorGroupActionId */ - 'data': string; + 'endpointId': string; } /** * * @export - * @interface Application + * @interface Bundle */ -export interface Application { +export interface Bundle { /** * * @type {string} - * @memberof Application + * @memberof Bundle */ 'created'?: string; /** * * @type {string} - * @memberof Application + * @memberof Bundle */ 'updated'?: string; /** * * @type {string} - * @memberof Application + * @memberof Bundle */ 'id'?: string; /** * * @type {string} - * @memberof Application + * @memberof Bundle */ 'name': string; /** * * @type {string} - * @memberof Application + * @memberof Bundle */ 'display_name': string; - /** - * - * @type {string} - * @memberof Application - */ - 'bundle_id': string; } /** * * @export - * @interface Application1 + * @interface CreateBehaviorGroupRequest */ -export interface Application1 { +export interface CreateBehaviorGroupRequest { /** * * @type {string} - * @memberof Application1 + * @memberof CreateBehaviorGroupRequest */ - 'id': string; + 'bundle_id'?: string; + /** + * + * @type {string} + * @memberof CreateBehaviorGroupRequest + */ + 'bundle_name'?: string; /** * * @type {string} - * @memberof Application1 + * @memberof CreateBehaviorGroupRequest */ 'display_name': string; + /** + * + * @type {Array} + * @memberof CreateBehaviorGroupRequest + */ + 'endpoint_ids'?: Array; + /** + * + * @type {Set} + * @memberof CreateBehaviorGroupRequest + */ + 'event_type_ids'?: Set; + /** + * + * @type {boolean} + * @memberof CreateBehaviorGroupRequest + */ + 'bundle_uuid_or_bundle_name_valid'?: boolean; } /** * * @export - * @interface ApplicationDTO + * @interface CreateBehaviorGroupResponse */ -export interface ApplicationDTO { +export interface CreateBehaviorGroupResponse { /** * * @type {string} - * @memberof ApplicationDTO + * @memberof CreateBehaviorGroupResponse */ - 'id'?: string; + 'id': string; /** * * @type {string} - * @memberof ApplicationDTO + * @memberof CreateBehaviorGroupResponse */ - 'name': string; + 'bundle_id': string; /** * * @type {string} - * @memberof ApplicationDTO + * @memberof CreateBehaviorGroupResponse */ 'display_name': string; /** * - * @type {string} - * @memberof ApplicationDTO + * @type {Array} + * @memberof CreateBehaviorGroupResponse */ - 'bundle_id': string; + 'endpoints': Array; + /** + * + * @type {Set} + * @memberof CreateBehaviorGroupResponse + */ + 'event_types': Set; /** * - * @type {Set} - * @memberof ApplicationDTO + * @type {string} + * @memberof CreateBehaviorGroupResponse */ - 'event_types'?: Set; + 'created': string; } /** * * @export - * @interface ApplicationDTO1 + * @interface DrawerEntryPayload */ -export interface ApplicationDTO1 { +export interface DrawerEntryPayload { /** * * @type {string} - * @memberof ApplicationDTO1 + * @memberof DrawerEntryPayload */ 'id'?: string; /** * * @type {string} - * @memberof ApplicationDTO1 - */ - 'name': string; - /** - * - * @type {string} - * @memberof ApplicationDTO1 - */ - 'display_name': string; - /** - * - * @type {string} - * @memberof ApplicationDTO1 + * @memberof DrawerEntryPayload */ - 'bundle_id': string; + 'description'?: string; /** * * @type {string} - * @memberof ApplicationDTO1 + * @memberof DrawerEntryPayload */ - 'owner_role'?: string; + 'title'?: string; /** * * @type {string} - * @memberof ApplicationDTO1 + * @memberof DrawerEntryPayload */ 'created'?: string; -} -/** - * - * @export - * @interface ApplicationSettingsValue - */ -export interface ApplicationSettingsValue { /** * - * @type {{ [key: string]: EventTypeSettingsValue; }} - * @memberof ApplicationSettingsValue + * @type {boolean} + * @memberof DrawerEntryPayload */ - 'eventTypes'?: { [key: string]: EventTypeSettingsValue; }; -} -/** - * - * @export - * @interface BasicAuthenticationDTO - */ -export interface BasicAuthenticationDTO { + 'read': boolean; /** * * @type {string} - * @memberof BasicAuthenticationDTO + * @memberof DrawerEntryPayload */ - 'username'?: string; + 'source'?: string; /** * * @type {string} - * @memberof BasicAuthenticationDTO + * @memberof DrawerEntryPayload */ - 'password'?: string; + 'bundle'?: string; } /** * * @export - * @interface BehaviorGroup + * @interface Endpoint */ -export interface BehaviorGroup { +export interface Endpoint { /** * * @type {string} - * @memberof BehaviorGroup + * @memberof Endpoint */ 'created'?: string; /** * * @type {string} - * @memberof BehaviorGroup + * @memberof Endpoint */ 'updated'?: string; /** * * @type {string} - * @memberof BehaviorGroup + * @memberof Endpoint */ 'id'?: string; /** * * @type {string} - * @memberof BehaviorGroup + * @memberof Endpoint */ - 'display_name': string; + 'name': string; /** * * @type {string} - * @memberof BehaviorGroup + * @memberof Endpoint */ - 'bundle_id': string; + 'description': string; /** * - * @type {Bundle} - * @memberof BehaviorGroup + * @type {boolean} + * @memberof Endpoint */ - 'bundle'?: Bundle; + 'enabled'?: boolean; /** * - * @type {Array} - * @memberof BehaviorGroup + * @type {EndpointStatus} + * @memberof Endpoint */ - 'actions'?: Array; + 'status'?: EndpointStatus; /** * - * @type {Set} - * @memberof BehaviorGroup + * @type {number} + * @memberof Endpoint */ - 'behaviors'?: Set; + 'server_errors'?: number; /** * - * @type {boolean} - * @memberof BehaviorGroup + * @type {object} + * @memberof Endpoint */ - 'default_behavior'?: boolean; -} -/** - * - * @export - * @interface BehaviorGroupAction - */ -export interface BehaviorGroupAction { + 'properties'?: object; /** * - * @type {string} - * @memberof BehaviorGroupAction + * @type {EndpointType} + * @memberof Endpoint */ - 'created'?: string; + 'type'?: EndpointType; /** * - * @type {BehaviorGroupActionId} - * @memberof BehaviorGroupAction + * @type {string} + * @memberof Endpoint */ - 'id'?: BehaviorGroupActionId; - /** - * - * @type {Endpoint} - * @memberof BehaviorGroupAction - */ - 'endpoint'?: Endpoint; -} -/** - * - * @export - * @interface BehaviorGroupActionId - */ -export interface BehaviorGroupActionId { - /** - * - * @type {string} - * @memberof BehaviorGroupActionId - */ - 'behaviorGroupId': string; - /** - * - * @type {string} - * @memberof BehaviorGroupActionId - */ - 'endpointId': string; -} -/** - * - * @export - * @interface Bundle - */ -export interface Bundle { - /** - * - * @type {string} - * @memberof Bundle - */ - 'created'?: string; - /** - * - * @type {string} - * @memberof Bundle - */ - 'updated'?: string; - /** - * - * @type {string} - * @memberof Bundle - */ - 'id'?: string; - /** - * - * @type {string} - * @memberof Bundle - */ - 'name': string; - /** - * - * @type {string} - * @memberof Bundle - */ - 'display_name': string; -} -/** - * - * @export - * @interface BundleDTO - */ -export interface BundleDTO { - /** - * - * @type {string} - * @memberof BundleDTO - */ - 'id'?: string; - /** - * - * @type {string} - * @memberof BundleDTO - */ - 'name': string; - /** - * - * @type {string} - * @memberof BundleDTO - */ - 'display_name': string; - /** - * - * @type {Set} - * @memberof BundleDTO - */ - 'applications'?: Set; -} -/** - * - * @export - * @interface BundleSettingsValue - */ -export interface BundleSettingsValue { - /** - * - * @type {{ [key: string]: ApplicationSettingsValue; }} - * @memberof BundleSettingsValue - */ - 'applications'?: { [key: string]: ApplicationSettingsValue; }; -} -/** - * - * @export - * @interface CamelPropertiesDTO - */ -export interface CamelPropertiesDTO { - /** - * - * @type {boolean} - * @memberof CamelPropertiesDTO - */ - 'disableSslVerification': boolean; - /** - * - * @type {{ [key: string]: string; }} - * @memberof CamelPropertiesDTO - */ - 'extras'?: { [key: string]: string; }; - /** - * - * @type {string} - * @memberof CamelPropertiesDTO - */ - 'url': string; - /** - * - * @type {BasicAuthenticationDTO} - * @memberof CamelPropertiesDTO - */ - 'basicAuthentication'?: BasicAuthenticationDTO; - /** - * - * @type {string} - * @memberof CamelPropertiesDTO - */ - 'secretToken'?: string; -} -/** - * - * @export - * @interface CreateBehaviorGroupRequest - */ -export interface CreateBehaviorGroupRequest { - /** - * - * @type {string} - * @memberof CreateBehaviorGroupRequest - */ - 'bundle_id'?: string; - /** - * - * @type {string} - * @memberof CreateBehaviorGroupRequest - */ - 'bundle_name'?: string; - /** - * - * @type {string} - * @memberof CreateBehaviorGroupRequest - */ - 'display_name': string; - /** - * - * @type {Array} - * @memberof CreateBehaviorGroupRequest - */ - 'endpoint_ids'?: Array; - /** - * - * @type {Set} - * @memberof CreateBehaviorGroupRequest - */ - 'event_type_ids'?: Set; - /** - * - * @type {boolean} - * @memberof CreateBehaviorGroupRequest - */ - 'bundle_uuid_or_bundle_name_valid'?: boolean; -} -/** - * - * @export - * @interface CreateBehaviorGroupResponse - */ -export interface CreateBehaviorGroupResponse { - /** - * - * @type {string} - * @memberof CreateBehaviorGroupResponse - */ - 'id': string; - /** - * - * @type {string} - * @memberof CreateBehaviorGroupResponse - */ - 'bundle_id': string; - /** - * - * @type {string} - * @memberof CreateBehaviorGroupResponse - */ - 'display_name': string; - /** - * - * @type {Array} - * @memberof CreateBehaviorGroupResponse - */ - 'endpoints': Array; - /** - * - * @type {Set} - * @memberof CreateBehaviorGroupResponse - */ - 'event_types': Set; - /** - * - * @type {string} - * @memberof CreateBehaviorGroupResponse - */ - 'created': string; -} -/** - * - * @export - * @interface CurrentStatus - */ -export interface CurrentStatus { - /** - * - * @type {Status} - * @memberof CurrentStatus - */ - 'status': Status; - /** - * - * @type {string} - * @memberof CurrentStatus - */ - 'start_time'?: string; - /** - * - * @type {string} - * @memberof CurrentStatus - */ - 'end_time'?: string; -} - - -/** - * - * @export - * @interface DrawerEntryPayload - */ -export interface DrawerEntryPayload { - /** - * - * @type {string} - * @memberof DrawerEntryPayload - */ - 'id'?: string; - /** - * - * @type {string} - * @memberof DrawerEntryPayload - */ - 'description'?: string; - /** - * - * @type {string} - * @memberof DrawerEntryPayload - */ - 'title'?: string; - /** - * - * @type {string} - * @memberof DrawerEntryPayload - */ - 'created'?: string; - /** - * - * @type {boolean} - * @memberof DrawerEntryPayload - */ - 'read': boolean; - /** - * - * @type {string} - * @memberof DrawerEntryPayload - */ - 'source'?: string; - /** - * - * @type {string} - * @memberof DrawerEntryPayload - */ - 'bundle'?: string; -} -/** - * - * @export - * @interface Endpoint - */ -export interface Endpoint { - /** - * - * @type {string} - * @memberof Endpoint - */ - 'created'?: string; - /** - * - * @type {string} - * @memberof Endpoint - */ - 'updated'?: string; - /** - * - * @type {string} - * @memberof Endpoint - */ - 'id'?: string; - /** - * - * @type {string} - * @memberof Endpoint - */ - 'name': string; - /** - * - * @type {string} - * @memberof Endpoint - */ - 'description': string; - /** - * - * @type {boolean} - * @memberof Endpoint - */ - 'enabled'?: boolean; - /** - * - * @type {EndpointStatus} - * @memberof Endpoint - */ - 'status'?: EndpointStatus; - /** - * - * @type {number} - * @memberof Endpoint - */ - 'server_errors'?: number; - /** - * - * @type {object} - * @memberof Endpoint - */ - 'properties'?: object; - /** - * - * @type {EndpointType} - * @memberof Endpoint - */ - 'type'?: EndpointType; - /** - * - * @type {string} - * @memberof Endpoint - */ - 'sub_type'?: string; -} - - -/** - * - * @export - * @interface EndpointDTO - */ -export interface EndpointDTO { - /** - * - * @type {string} - * @memberof EndpointDTO - */ - 'id'?: string; - /** - * - * @type {string} - * @memberof EndpointDTO - */ - 'name': string; - /** - * - * @type {string} - * @memberof EndpointDTO - */ - 'description': string; - /** - * - * @type {boolean} - * @memberof EndpointDTO - */ - 'enabled'?: boolean; - /** - * - * @type {EndpointStatusDTO} - * @memberof EndpointDTO - */ - 'status'?: EndpointStatusDTO; - /** - * - * @type {number} - * @memberof EndpointDTO - */ - 'server_errors'?: number; - /** - * - * @type {EndpointTypeDTO} - * @memberof EndpointDTO - */ - 'type': EndpointTypeDTO; - /** - * - * @type {string} - * @memberof EndpointDTO - */ - 'sub_type'?: string; - /** - * - * @type {string} - * @memberof EndpointDTO - */ - 'created'?: string; - /** - * - * @type {string} - * @memberof EndpointDTO - */ - 'updated'?: string; - /** - * - * @type {object} - * @memberof EndpointDTO - */ - 'properties'?: object; - /** - * - * @type {Set} - * @memberof EndpointDTO - */ - 'event_types_group_by_bundles_and_applications'?: Set; - /** - * - * @type {Set} - * @memberof EndpointDTO - */ - 'event_types'?: Set; -} - - -/** - * - * @export - * @interface EndpointPage - */ -export interface EndpointPage { - /** - * - * @type {Array} - * @memberof EndpointPage - */ - 'data': Array; - /** - * - * @type {{ [key: string]: string; }} - * @memberof EndpointPage - */ - 'links': { [key: string]: string; }; - /** - * - * @type {Meta} - * @memberof EndpointPage - */ - 'meta': Meta; -} -/** - * - * @export - * @enum {string} - */ - -export const EndpointStatus = { - Ready: 'READY', - Unknown: 'UNKNOWN', - New: 'NEW', - Provisioning: 'PROVISIONING', - Deleting: 'DELETING', - Failed: 'FAILED' -} as const; - -export type EndpointStatus = typeof EndpointStatus[keyof typeof EndpointStatus]; - - -/** - * - * @export - * @enum {string} - */ - -export const EndpointStatusDTO = { - Deleting: 'DELETING', - Failed: 'FAILED', - New: 'NEW', - Provisioning: 'PROVISIONING', - Ready: 'READY', - Unknown: 'UNKNOWN' -} as const; - -export type EndpointStatusDTO = typeof EndpointStatusDTO[keyof typeof EndpointStatusDTO]; - - -/** - * - * @export - * @interface EndpointTestRequest - */ -export interface EndpointTestRequest { - /** - * - * @type {string} - * @memberof EndpointTestRequest - */ - 'message': string; -} -/** - * - * @export - * @enum {string} - */ - -export const EndpointType = { - Ansible: 'ansible', - Camel: 'camel', - Drawer: 'drawer', - EmailSubscription: 'email_subscription', - Webhook: 'webhook', - Pagerduty: 'pagerduty' -} as const; - -export type EndpointType = typeof EndpointType[keyof typeof EndpointType]; - - -/** - * - * @export - * @enum {string} - */ - -export const EndpointTypeDTO = { - Ansible: 'ansible', - Camel: 'camel', - Drawer: 'drawer', - EmailSubscription: 'email_subscription', - Webhook: 'webhook' -} as const; - -export type EndpointTypeDTO = typeof EndpointTypeDTO[keyof typeof EndpointTypeDTO]; - - -/** - * - * @export - * @enum {string} - */ - -export const Environment = { - Prod: 'PROD', - Stage: 'STAGE', - Ephemeral: 'EPHEMERAL', - LocalServer: 'LOCAL_SERVER' -} as const; - -export type Environment = typeof Environment[keyof typeof Environment]; - - -/** - * - * @export - * @interface EventLogEntry - */ -export interface EventLogEntry { - /** - * - * @type {string} - * @memberof EventLogEntry - */ - 'id': string; - /** - * - * @type {string} - * @memberof EventLogEntry - */ - 'created': string; - /** - * - * @type {string} - * @memberof EventLogEntry - */ - 'bundle': string; - /** - * - * @type {string} - * @memberof EventLogEntry - */ - 'application': string; - /** - * - * @type {string} - * @memberof EventLogEntry - */ - 'event_type': string; - /** - * - * @type {string} - * @memberof EventLogEntry - */ - 'payload'?: string; - /** - * - * @type {Array} - * @memberof EventLogEntry - */ - 'actions': Array; -} -/** - * - * @export - * @interface EventLogEntryAction - */ -export interface EventLogEntryAction { - /** - * - * @type {string} - * @memberof EventLogEntryAction - */ - 'id': string; - /** - * - * @type {EndpointType} - * @memberof EventLogEntryAction - */ - 'endpoint_type': EndpointType; - /** - * - * @type {string} - * @memberof EventLogEntryAction - */ - 'endpoint_sub_type'?: string; - /** - * - * @type {boolean} - * @memberof EventLogEntryAction - * @deprecated - */ - 'invocation_result': boolean; - /** - * - * @type {EventLogEntryActionStatus} - * @memberof EventLogEntryAction - */ - 'status': EventLogEntryActionStatus; - /** - * - * @type {string} - * @memberof EventLogEntryAction - */ - 'endpoint_id'?: string; - /** - * - * @type {{ [key: string]: any; }} - * @memberof EventLogEntryAction - */ - 'details'?: { [key: string]: any; }; -} - - -/** - * - * @export - * @enum {string} - */ - -export const EventLogEntryActionStatus = { - Sent: 'SENT', - Success: 'SUCCESS', - Processing: 'PROCESSING', - Failed: 'FAILED', - Unknown: 'UNKNOWN' -} as const; - -export type EventLogEntryActionStatus = typeof EventLogEntryActionStatus[keyof typeof EventLogEntryActionStatus]; - - -/** - * - * @export - * @interface EventType - */ -export interface EventType { - /** - * - * @type {string} - * @memberof EventType - */ - 'id'?: string; - /** - * - * @type {string} - * @memberof EventType - */ - 'name': string; - /** - * - * @type {string} - * @memberof EventType - */ - 'display_name': string; - /** - * - * @type {string} - * @memberof EventType - */ - 'description'?: string; - /** - * - * @type {string} - * @memberof EventType - */ - 'fully_qualified_name'?: string; - /** - * - * @type {string} - * @memberof EventType - */ - 'application_id': string; - /** - * - * @type {Application} - * @memberof EventType - */ - 'application'?: Application; - /** - * - * @type {boolean} - * @memberof EventType - */ - 'visible'?: boolean; - /** - * - * @type {boolean} - * @memberof EventType - */ - 'subscribed_by_default'?: boolean; - /** - * - * @type {boolean} - * @memberof EventType - */ - 'subscription_locked'?: boolean; - /** - * - * @type {boolean} - * @memberof EventType - */ - 'not_subscription_locked_or_subscribed_by_default'?: boolean; -} -/** - * - * @export - * @interface EventTypeBehavior - */ -export interface EventTypeBehavior { - /** - * - * @type {string} - * @memberof EventTypeBehavior - */ - 'created'?: string; - /** - * - * @type {EventTypeBehaviorId} - * @memberof EventTypeBehavior - */ - 'id'?: EventTypeBehaviorId; - /** - * - * @type {EventType} - * @memberof EventTypeBehavior - */ - 'event_type'?: EventType; -} -/** - * - * @export - * @interface EventTypeBehaviorId - */ -export interface EventTypeBehaviorId { - /** - * - * @type {string} - * @memberof EventTypeBehaviorId - */ - 'eventTypeId': string; - /** - * - * @type {string} - * @memberof EventTypeBehaviorId - */ - 'behaviorGroupId': string; -} -/** - * - * @export - * @interface EventTypeDTO - */ -export interface EventTypeDTO { - /** - * - * @type {string} - * @memberof EventTypeDTO - */ - 'id'?: string; - /** - * - * @type {string} - * @memberof EventTypeDTO - */ - 'name': string; - /** - * - * @type {string} - * @memberof EventTypeDTO - */ - 'display_name': string; - /** - * - * @type {string} - * @memberof EventTypeDTO - */ - 'description'?: string; - /** - * - * @type {ApplicationDTO} - * @memberof EventTypeDTO - */ - 'application'?: ApplicationDTO; -} -/** - * - * @export - * @interface EventTypeSettingsValue - */ -export interface EventTypeSettingsValue { - /** - * - * @type {{ [key: string]: boolean; }} - * @memberof EventTypeSettingsValue - */ - 'emailSubscriptionTypes'?: { [key: string]: boolean; }; - /** - * - * @type {boolean} - * @memberof EventTypeSettingsValue - */ - 'hasForcedEmail'?: boolean; - /** - * - * @type {boolean} - * @memberof EventTypeSettingsValue - */ - 'subscriptionLocked'?: boolean; -} -/** - * - * @export - * @interface EventsReplayRequest - */ -export interface EventsReplayRequest { - /** - * - * @type {string} - * @memberof EventsReplayRequest - */ - 'start_date': string; - /** - * - * @type {string} - * @memberof EventsReplayRequest - */ - 'end_date': string; - /** - * - * @type {string} - * @memberof EventsReplayRequest - */ - 'org_id'?: string; -} -/** - * - * @export - * @interface Facet - */ -export interface Facet { - /** - * - * @type {string} - * @memberof Facet - */ - 'id': string; - /** - * - * @type {string} - * @memberof Facet - */ - 'name': string; - /** - * - * @type {string} - * @memberof Facet - */ - 'displayName': string; - /** - * - * @type {Array} - * @memberof Facet - */ - 'children'?: Array; -} -/** - * - * @export - * @enum {string} - */ - -export const HttpType = { - Get: 'GET', - Post: 'POST', - Put: 'PUT' -} as const; - -export type HttpType = typeof HttpType[keyof typeof HttpType]; - - -/** - * - * @export - * @interface InstantEmailTemplate - */ -export interface InstantEmailTemplate { - /** - * - * @type {string} - * @memberof InstantEmailTemplate - */ - 'created'?: string; - /** - * - * @type {string} - * @memberof InstantEmailTemplate - */ - 'updated'?: string; - /** - * - * @type {string} - * @memberof InstantEmailTemplate - */ - 'id'?: string; - /** - * - * @type {EventType} - * @memberof InstantEmailTemplate - */ - 'event_type'?: EventType; - /** - * - * @type {string} - * @memberof InstantEmailTemplate - */ - 'event_type_id'?: string; - /** - * - * @type {AggregationEmailTemplateSubjectTemplate} - * @memberof InstantEmailTemplate - */ - 'subject_template'?: AggregationEmailTemplateSubjectTemplate; - /** - * - * @type {string} - * @memberof InstantEmailTemplate - */ - 'subject_template_id': string; - /** - * - * @type {AggregationEmailTemplateSubjectTemplate} - * @memberof InstantEmailTemplate - */ - 'body_template'?: AggregationEmailTemplateSubjectTemplate; - /** - * - * @type {string} - * @memberof InstantEmailTemplate - */ - 'body_template_id': string; -} -/** - * - * @export - * @interface InternalApplicationUserPermission - */ -export interface InternalApplicationUserPermission { - /** - * - * @type {string} - * @memberof InternalApplicationUserPermission - */ - 'application_id': string; - /** - * - * @type {string} - * @memberof InternalApplicationUserPermission - */ - 'application_display_name': string; - /** - * - * @type {string} - * @memberof InternalApplicationUserPermission - */ - 'role': string; -} -/** - * - * @export - * @interface InternalRoleAccess - */ -export interface InternalRoleAccess { - /** - * - * @type {string} - * @memberof InternalRoleAccess - */ - 'id'?: string; - /** - * - * @type {string} - * @memberof InternalRoleAccess - */ - 'role': string; - /** - * - * @type {string} - * @memberof InternalRoleAccess - */ - 'application_id': string; -} -/** - * - * @export - * @interface InternalUserPermissions - */ -export interface InternalUserPermissions { - /** - * - * @type {boolean} - * @memberof InternalUserPermissions - */ - 'is_admin': boolean; - /** - * - * @type {Array} - * @memberof InternalUserPermissions - */ - 'applications': Array; - /** - * - * @type {Array} - * @memberof InternalUserPermissions - */ - 'roles': Array; -} -/** - * - * @export - * @interface MessageValidationResponse - */ -export interface MessageValidationResponse { - /** - * - * @type {{ [key: string]: Array; }} - * @memberof MessageValidationResponse - */ - 'errors': { [key: string]: Array; }; -} -/** - * - * @export - * @interface Meta - */ -export interface Meta { - /** - * - * @type {number} - * @memberof Meta - */ - 'count': number; -} -/** - * - * @export - * @interface NotificationHistory - */ -export interface NotificationHistory { - /** - * - * @type {string} - * @memberof NotificationHistory - */ - 'created'?: string; - /** - * - * @type {string} - * @memberof NotificationHistory - */ - 'id'?: string; - /** - * - * @type {number} - * @memberof NotificationHistory - */ - 'invocationTime': number; - /** - * - * @type {boolean} - * @memberof NotificationHistory - * @deprecated - */ - 'invocationResult': boolean; - /** - * - * @type {NotificationStatus} - * @memberof NotificationHistory - */ - 'status': NotificationStatus; - /** - * - * @type {string} - * @memberof NotificationHistory - */ - 'endpointId'?: string; - /** - * - * @type {{ [key: string]: any; }} - * @memberof NotificationHistory - */ - 'details'?: { [key: string]: any; }; - /** - * - * @type {EndpointType} - * @memberof NotificationHistory - */ - 'endpointType'?: EndpointType; - /** - * - * @type {string} - * @memberof NotificationHistory - */ - 'endpointSubType'?: string; + 'sub_type'?: string; } @@ -1631,160 +424,134 @@ export interface NotificationHistory { * @enum {string} */ -export const NotificationStatus = { - FailedInternal: 'FAILED_INTERNAL', - FailedExternal: 'FAILED_EXTERNAL', - Processing: 'PROCESSING', - Sent: 'SENT', - Success: 'SUCCESS' +export const EndpointStatus = { + Ready: 'READY', + Unknown: 'UNKNOWN', + New: 'NEW', + Provisioning: 'PROVISIONING', + Deleting: 'DELETING', + Failed: 'FAILED' } as const; -export type NotificationStatus = typeof NotificationStatus[keyof typeof NotificationStatus]; +export type EndpointStatus = typeof EndpointStatus[keyof typeof EndpointStatus]; /** * * @export - * @interface PageBehaviorGroup + * @enum {string} */ -export interface PageBehaviorGroup { - /** - * - * @type {Array} - * @memberof PageBehaviorGroup - */ - 'data': Array; - /** - * - * @type {{ [key: string]: string; }} - * @memberof PageBehaviorGroup - */ - 'links': { [key: string]: string; }; - /** - * - * @type {Meta} - * @memberof PageBehaviorGroup - */ - 'meta': Meta; -} + +export const EndpointType = { + Ansible: 'ansible', + Camel: 'camel', + Drawer: 'drawer', + EmailSubscription: 'email_subscription', + Webhook: 'webhook', + Pagerduty: 'pagerduty' +} as const; + +export type EndpointType = typeof EndpointType[keyof typeof EndpointType]; + + /** * * @export - * @interface PageDrawerEntryPayload + * @interface EventLogEntry */ -export interface PageDrawerEntryPayload { +export interface EventLogEntry { /** * - * @type {Array} - * @memberof PageDrawerEntryPayload + * @type {string} + * @memberof EventLogEntry */ - 'data': Array; + 'id': string; /** * - * @type {{ [key: string]: string; }} - * @memberof PageDrawerEntryPayload + * @type {string} + * @memberof EventLogEntry */ - 'links': { [key: string]: string; }; + 'created': string; /** * - * @type {Meta} - * @memberof PageDrawerEntryPayload + * @type {string} + * @memberof EventLogEntry */ - 'meta': Meta; -} -/** - * - * @export - * @interface PageEventLogEntry - */ -export interface PageEventLogEntry { + 'bundle': string; /** * - * @type {Array} - * @memberof PageEventLogEntry + * @type {string} + * @memberof EventLogEntry */ - 'data': Array; + 'application': string; /** * - * @type {{ [key: string]: string; }} - * @memberof PageEventLogEntry + * @type {string} + * @memberof EventLogEntry */ - 'links': { [key: string]: string; }; + 'event_type': string; /** * - * @type {Meta} - * @memberof PageEventLogEntry + * @type {string} + * @memberof EventLogEntry */ - 'meta': Meta; + 'payload'?: string; + /** + * + * @type {Array} + * @memberof EventLogEntry + */ + 'actions': Array; } /** * * @export - * @interface PageEventType + * @interface EventLogEntryAction */ -export interface PageEventType { - /** - * - * @type {Array} - * @memberof PageEventType - */ - 'data': Array; +export interface EventLogEntryAction { /** * - * @type {{ [key: string]: string; }} - * @memberof PageEventType + * @type {string} + * @memberof EventLogEntryAction */ - 'links': { [key: string]: string; }; + 'id': string; /** * - * @type {Meta} - * @memberof PageEventType + * @type {EndpointType} + * @memberof EventLogEntryAction */ - 'meta': Meta; -} -/** - * - * @export - * @interface PageNotificationHistory - */ -export interface PageNotificationHistory { + 'endpoint_type': EndpointType; /** * - * @type {Array} - * @memberof PageNotificationHistory + * @type {string} + * @memberof EventLogEntryAction */ - 'data': Array; + 'endpoint_sub_type'?: string; /** * - * @type {{ [key: string]: string; }} - * @memberof PageNotificationHistory + * @type {boolean} + * @memberof EventLogEntryAction + * @deprecated */ - 'links': { [key: string]: string; }; + 'invocation_result': boolean; /** * - * @type {Meta} - * @memberof PageNotificationHistory + * @type {EventLogEntryActionStatus} + * @memberof EventLogEntryAction */ - 'meta': Meta; -} -/** - * - * @export - * @interface PagerDutyPropertiesDTO - */ -export interface PagerDutyPropertiesDTO { + 'status': EventLogEntryActionStatus; /** * - * @type {PagerDutySeverityDTO} - * @memberof PagerDutyPropertiesDTO + * @type {string} + * @memberof EventLogEntryAction */ - 'severity': PagerDutySeverityDTO; + 'endpoint_id'?: string; /** * - * @type {string} - * @memberof PagerDutyPropertiesDTO + * @type {{ [key: string]: any; }} + * @memberof EventLogEntryAction */ - 'secretToken': string; + 'details'?: { [key: string]: any; }; } @@ -1794,275 +561,252 @@ export interface PagerDutyPropertiesDTO { * @enum {string} */ -export const PagerDutySeverity = { - Critical: 'critical', - Error: 'error', - Warning: 'warning', - Info: 'info' -} as const; - -export type PagerDutySeverity = typeof PagerDutySeverity[keyof typeof PagerDutySeverity]; - - -/** - * - * @export - * @enum {string} - */ - -export const PagerDutySeverityDTO = { - Critical: 'critical', - Error: 'error', - Warning: 'warning', - Info: 'info' +export const EventLogEntryActionStatus = { + Sent: 'SENT', + Success: 'SUCCESS', + Processing: 'PROCESSING', + Failed: 'FAILED', + Unknown: 'UNKNOWN' } as const; -export type PagerDutySeverityDTO = typeof PagerDutySeverityDTO[keyof typeof PagerDutySeverityDTO]; +export type EventLogEntryActionStatus = typeof EventLogEntryActionStatus[keyof typeof EventLogEntryActionStatus]; /** * * @export - * @interface RenderEmailTemplateRequest + * @interface EventType */ -export interface RenderEmailTemplateRequest { +export interface EventType { /** * - * @type {Array} - * @memberof RenderEmailTemplateRequest + * @type {string} + * @memberof EventType */ - 'template': Array; + 'id'?: string; /** * * @type {string} - * @memberof RenderEmailTemplateRequest + * @memberof EventType */ - 'payload': string; -} -/** - * - * @export - * @interface RequestDefaultBehaviorGroupPropertyList - */ -export interface RequestDefaultBehaviorGroupPropertyList { + 'name': string; /** * - * @type {boolean} - * @memberof RequestDefaultBehaviorGroupPropertyList + * @type {string} + * @memberof EventType */ - 'only_admins': boolean; + 'display_name': string; /** * - * @type {boolean} - * @memberof RequestDefaultBehaviorGroupPropertyList + * @type {string} + * @memberof EventType */ - 'ignore_preferences': boolean; -} -/** - * - * @export - * @interface RequestSystemSubscriptionProperties - */ -export interface RequestSystemSubscriptionProperties { + 'description'?: string; /** * - * @type {boolean} - * @memberof RequestSystemSubscriptionProperties + * @type {string} + * @memberof EventType */ - 'only_admins': boolean; + 'fully_qualified_name'?: string; /** * * @type {string} - * @memberof RequestSystemSubscriptionProperties + * @memberof EventType */ - 'group_id'?: string; -} -/** - * - * @export - * @interface ServerInfo - */ -export interface ServerInfo { + 'application_id': string; /** * - * @type {Environment} - * @memberof ServerInfo + * @type {Application} + * @memberof EventType */ - 'environment'?: Environment; -} - - -/** - * - * @export - * @interface SettingsValuesByEventType - */ -export interface SettingsValuesByEventType { + 'application'?: Application; /** * - * @type {{ [key: string]: BundleSettingsValue; }} - * @memberof SettingsValuesByEventType + * @type {boolean} + * @memberof EventType */ - 'bundles'?: { [key: string]: BundleSettingsValue; }; -} -/** - * - * @export - * @enum {string} - */ - -export const Status = { - Up: 'UP', - Maintenance: 'MAINTENANCE' -} as const; - -export type Status = typeof Status[keyof typeof Status]; - - -/** - * - * @export - * @enum {string} - */ - -export const SubscriptionType = { - Instant: 'INSTANT', - Daily: 'DAILY', - Drawer: 'DRAWER' -} as const; - -export type SubscriptionType = typeof SubscriptionType[keyof typeof SubscriptionType]; - - + 'visible'?: boolean; + /** + * + * @type {boolean} + * @memberof EventType + */ + 'subscribed_by_default'?: boolean; + /** + * + * @type {boolean} + * @memberof EventType + */ + 'subscription_locked'?: boolean; + /** + * + * @type {boolean} + * @memberof EventType + */ + 'not_subscription_locked_or_subscribed_by_default'?: boolean; +} /** * * @export - * @interface SystemSubscriptionPropertiesDTO + * @interface EventTypeBehavior */ -export interface SystemSubscriptionPropertiesDTO { +export interface EventTypeBehavior { /** * * @type {string} - * @memberof SystemSubscriptionPropertiesDTO + * @memberof EventTypeBehavior */ - 'groupId'?: string; + 'created'?: string; /** * - * @type {boolean} - * @memberof SystemSubscriptionPropertiesDTO + * @type {EventTypeBehaviorId} + * @memberof EventTypeBehavior */ - 'ignorePreferences'?: boolean; + 'id'?: EventTypeBehaviorId; /** * - * @type {boolean} - * @memberof SystemSubscriptionPropertiesDTO + * @type {EventType} + * @memberof EventTypeBehavior */ - 'onlyAdmins'?: boolean; + 'event_type'?: EventType; } /** * * @export - * @interface Template + * @interface EventTypeBehaviorId */ -export interface Template { +export interface EventTypeBehaviorId { /** * * @type {string} - * @memberof Template + * @memberof EventTypeBehaviorId */ - 'created'?: string; + 'eventTypeId': string; /** * * @type {string} - * @memberof Template + * @memberof EventTypeBehaviorId */ - 'updated'?: string; + 'behaviorGroupId': string; +} +/** + * + * @export + * @interface Facet + */ +export interface Facet { /** * * @type {string} - * @memberof Template + * @memberof Facet */ - 'id'?: string; + 'id': string; /** * * @type {string} - * @memberof Template + * @memberof Facet */ 'name': string; /** * * @type {string} - * @memberof Template + * @memberof Facet */ - 'description': string; + 'displayName': string; /** * - * @type {string} - * @memberof Template + * @type {Array} + * @memberof Facet */ - 'data': string; + 'children'?: Array; } /** * * @export - * @interface TriggerDailyDigestRequest + * @interface Meta */ -export interface TriggerDailyDigestRequest { +export interface Meta { /** * - * @type {string} - * @memberof TriggerDailyDigestRequest + * @type {number} + * @memberof Meta + */ + 'count': number; +} +/** + * + * @export + * @interface PageDrawerEntryPayload + */ +export interface PageDrawerEntryPayload { + /** + * + * @type {Array} + * @memberof PageDrawerEntryPayload */ - 'application_name': string; + 'data': Array; /** * - * @type {string} - * @memberof TriggerDailyDigestRequest + * @type {{ [key: string]: string; }} + * @memberof PageDrawerEntryPayload */ - 'bundle_name': string; + 'links': { [key: string]: string; }; /** * - * @type {string} - * @memberof TriggerDailyDigestRequest + * @type {Meta} + * @memberof PageDrawerEntryPayload */ - 'end'?: string; + 'meta': Meta; +} +/** + * + * @export + * @interface PageEventLogEntry + */ +export interface PageEventLogEntry { /** * - * @type {string} - * @memberof TriggerDailyDigestRequest + * @type {Array} + * @memberof PageEventLogEntry */ - 'org_id': string; + 'data': Array; /** * - * @type {string} - * @memberof TriggerDailyDigestRequest + * @type {{ [key: string]: string; }} + * @memberof PageEventLogEntry + */ + 'links': { [key: string]: string; }; + /** + * + * @type {Meta} + * @memberof PageEventLogEntry */ - 'start'?: string; + 'meta': Meta; } /** * * @export - * @interface UpdateApplicationRequest + * @interface PageEventType */ -export interface UpdateApplicationRequest { +export interface PageEventType { /** * - * @type {string} - * @memberof UpdateApplicationRequest + * @type {Array} + * @memberof PageEventType */ - 'name'?: string; + 'data': Array; /** * - * @type {string} - * @memberof UpdateApplicationRequest + * @type {{ [key: string]: string; }} + * @memberof PageEventType */ - 'display_name'?: string; + 'links': { [key: string]: string; }; /** * - * @type {string} - * @memberof UpdateApplicationRequest + * @type {Meta} + * @memberof PageEventType */ - 'owner_role'?: string; + 'meta': Meta; } /** * @@ -2114,88 +858,6 @@ export interface UpdateNotificationDrawerStatus { */ 'read_status': boolean; } -/** - * - * @export - * @interface WebhookPropertiesDTO - */ -export interface WebhookPropertiesDTO { - /** - * - * @type {boolean} - * @memberof WebhookPropertiesDTO - */ - 'disableSslVerification': boolean; - /** - * - * @type {HttpType} - * @memberof WebhookPropertiesDTO - */ - 'method': HttpType; - /** - * - * @type {string} - * @memberof WebhookPropertiesDTO - */ - 'url': string; - /** - * - * @type {BasicAuthenticationDTO} - * @memberof WebhookPropertiesDTO - */ - 'basicAuthentication'?: BasicAuthenticationDTO; - /** - * - * @type {string} - * @memberof WebhookPropertiesDTO - */ - 'bearerAuthentication'?: string; - /** - * - * @type {string} - * @memberof WebhookPropertiesDTO - */ - 'secretToken'?: string; -} - - -/** - * - * @export - * @interface X509Certificate - */ -export interface X509Certificate { - /** - * - * @type {string} - * @memberof X509Certificate - */ - 'id'?: string; - /** - * - * @type {string} - * @memberof X509Certificate - */ - 'subject_dn': string; - /** - * - * @type {string} - * @memberof X509Certificate - */ - 'source_environment': string; - /** - * - * @type {string} - * @memberof X509Certificate - */ - 'bundle': string; - /** - * - * @type {string} - * @memberof X509Certificate - */ - 'application': string; -} /** * DrawerResourceV1GetDrawerEntriesApi - axios parameter creator @@ -4694,6 +3356,119 @@ export class NotificationResourceV1UpdateEventTypeBehaviorsApi extends BaseAPI { +/** + * NotificationResourceV1UpdateEventTypeEndpointsApi - axios parameter creator + * @export + */ +export const NotificationResourceV1UpdateEventTypeEndpointsApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * Updates the list of endpoints associated with an event type. + * @summary Update the list of endpoints for an event type + * @param {string} eventTypeId UUID of the eventType to associate with the endpoint(s) + * @param {Set} [requestBody] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + notificationResourceV1UpdateEventTypeEndpoints: async (eventTypeId: string, requestBody?: Set, options: AxiosRequestConfig = {}): Promise => { + // verify required parameter 'eventTypeId' is not null or undefined + assertParamExists('notificationResourceV1UpdateEventTypeEndpoints', 'eventTypeId', eventTypeId) + const localVarPath = `/notifications/eventTypes/{eventTypeId}/endpoints` + .replace(`{${"eventTypeId"}}`, encodeURIComponent(String(eventTypeId))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(requestBody, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + } +}; + +/** + * NotificationResourceV1UpdateEventTypeEndpointsApi - functional programming interface + * @export + */ +export const NotificationResourceV1UpdateEventTypeEndpointsApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = NotificationResourceV1UpdateEventTypeEndpointsApiAxiosParamCreator(configuration) + return { + /** + * Updates the list of endpoints associated with an event type. + * @summary Update the list of endpoints for an event type + * @param {string} eventTypeId UUID of the eventType to associate with the endpoint(s) + * @param {Set} [requestBody] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async notificationResourceV1UpdateEventTypeEndpoints(eventTypeId: string, requestBody?: Set, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.notificationResourceV1UpdateEventTypeEndpoints(eventTypeId, requestBody, options); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); + }, + } +}; + +/** + * NotificationResourceV1UpdateEventTypeEndpointsApi - factory interface + * @export + */ +export const NotificationResourceV1UpdateEventTypeEndpointsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = NotificationResourceV1UpdateEventTypeEndpointsApiFp(configuration) + return { + /** + * Updates the list of endpoints associated with an event type. + * @summary Update the list of endpoints for an event type + * @param {string} eventTypeId UUID of the eventType to associate with the endpoint(s) + * @param {Set} [requestBody] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + notificationResourceV1UpdateEventTypeEndpoints(eventTypeId: string, requestBody?: Set, options?: any): AxiosPromise { + return localVarFp.notificationResourceV1UpdateEventTypeEndpoints(eventTypeId, requestBody, options).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * NotificationResourceV1UpdateEventTypeEndpointsApi - object-oriented interface + * @export + * @class NotificationResourceV1UpdateEventTypeEndpointsApi + * @extends {BaseAPI} + */ +export class NotificationResourceV1UpdateEventTypeEndpointsApi extends BaseAPI { + /** + * Updates the list of endpoints associated with an event type. + * @summary Update the list of endpoints for an event type + * @param {string} eventTypeId UUID of the eventType to associate with the endpoint(s) + * @param {Set} [requestBody] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof NotificationResourceV1UpdateEventTypeEndpointsApi + */ + public notificationResourceV1UpdateEventTypeEndpoints(eventTypeId: string, requestBody?: Set, options?: AxiosRequestConfig) { + return NotificationResourceV1UpdateEventTypeEndpointsApiFp(this.configuration).notificationResourceV1UpdateEventTypeEndpoints(eventTypeId, requestBody, options).then((request) => request(this.axios, this.basePath)); + } +} + + + /** * OrgConfigResourceV1GetDailyDigestTimePreferenceApi - axios parameter creator * @export diff --git a/packages/notifications/index.ts b/packages/notifications/index.ts index eb9a622d3..856f04992 100644 --- a/packages/notifications/index.ts +++ b/packages/notifications/index.ts @@ -81,6 +81,10 @@ export { default as notificationResourceV1UpdateBehaviorGroupActions } from './N export { default as notificationResourceV1UpdateEventTypeBehaviors } from './NotificationResourceV1UpdateEventTypeBehaviors' +// end of operations block +export { default as notificationResourceV1UpdateEventTypeEndpoints } from './NotificationResourceV1UpdateEventTypeEndpoints' + + // end of operations block export { default as orgConfigResourceV1GetDailyDigestTimePreference } from './OrgConfigResourceV1GetDailyDigestTimePreference' diff --git a/packages/notifications/types/index.ts b/packages/notifications/types/index.ts index 83c4b6697..38e3a381c 100644 --- a/packages/notifications/types/index.ts +++ b/packages/notifications/types/index.ts @@ -1,1782 +1,533 @@ /** * * @export - * @interface AddAccessRequest + * @interface Application */ -export interface AddAccessRequest { +export interface Application { /** * * @type {string} - * @memberof AddAccessRequest + * @memberof Application */ - 'role'?: string; + 'created'?: string; /** * * @type {string} - * @memberof AddAccessRequest + * @memberof Application */ - 'application_id'?: string; -} -/** - * - * @export - * @interface AddApplicationRequest - */ -export interface AddApplicationRequest { + 'updated'?: string; /** * * @type {string} - * @memberof AddApplicationRequest + * @memberof Application */ - 'name': string; + 'id'?: string; /** * * @type {string} - * @memberof AddApplicationRequest + * @memberof Application */ - 'display_name': string; + 'name': string; /** * * @type {string} - * @memberof AddApplicationRequest + * @memberof Application */ - 'bundle_id': string; + 'display_name': string; /** * * @type {string} - * @memberof AddApplicationRequest + * @memberof Application */ - 'owner_role'?: string; + 'bundle_id': string; } /** * * @export - * @interface AggregationEmailTemplate + * @interface BehaviorGroup */ -export interface AggregationEmailTemplate { +export interface BehaviorGroup { /** * * @type {string} - * @memberof AggregationEmailTemplate + * @memberof BehaviorGroup */ 'created'?: string; /** * * @type {string} - * @memberof AggregationEmailTemplate + * @memberof BehaviorGroup */ 'updated'?: string; /** * * @type {string} - * @memberof AggregationEmailTemplate + * @memberof BehaviorGroup */ 'id'?: string; - /** - * - * @type {Application} - * @memberof AggregationEmailTemplate - */ - 'application'?: Application; /** * * @type {string} - * @memberof AggregationEmailTemplate + * @memberof BehaviorGroup */ - 'application_id'?: string; + 'display_name': string; /** * - * @type {SubscriptionType} - * @memberof AggregationEmailTemplate + * @type {string} + * @memberof BehaviorGroup */ - 'subscription_type': SubscriptionType; + 'bundle_id': string; /** * - * @type {AggregationEmailTemplateSubjectTemplate} - * @memberof AggregationEmailTemplate + * @type {Bundle} + * @memberof BehaviorGroup */ - 'subject_template'?: AggregationEmailTemplateSubjectTemplate; + 'bundle'?: Bundle; /** * - * @type {string} - * @memberof AggregationEmailTemplate + * @type {Array} + * @memberof BehaviorGroup */ - 'subject_template_id': string; + 'actions'?: Array; /** * - * @type {AggregationEmailTemplateSubjectTemplate} - * @memberof AggregationEmailTemplate + * @type {Set} + * @memberof BehaviorGroup */ - 'body_template'?: AggregationEmailTemplateSubjectTemplate; + 'behaviors'?: Set; /** * - * @type {string} - * @memberof AggregationEmailTemplate + * @type {boolean} + * @memberof BehaviorGroup */ - 'body_template_id': string; + 'default_behavior'?: boolean; } - - /** * * @export - * @interface AggregationEmailTemplateSubjectTemplate + * @interface BehaviorGroupAction */ -export interface AggregationEmailTemplateSubjectTemplate { +export interface BehaviorGroupAction { /** * * @type {string} - * @memberof AggregationEmailTemplateSubjectTemplate + * @memberof BehaviorGroupAction */ 'created'?: string; /** * - * @type {string} - * @memberof AggregationEmailTemplateSubjectTemplate - */ - 'updated'?: string; - /** - * - * @type {string} - * @memberof AggregationEmailTemplateSubjectTemplate + * @type {BehaviorGroupActionId} + * @memberof BehaviorGroupAction */ - 'id'?: string; + 'id'?: BehaviorGroupActionId; /** * - * @type {string} - * @memberof AggregationEmailTemplateSubjectTemplate + * @type {Endpoint} + * @memberof BehaviorGroupAction */ - 'name': string; + 'endpoint'?: Endpoint; +} +/** + * + * @export + * @interface BehaviorGroupActionId + */ +export interface BehaviorGroupActionId { /** * * @type {string} - * @memberof AggregationEmailTemplateSubjectTemplate + * @memberof BehaviorGroupActionId */ - 'description': string; + 'behaviorGroupId': string; /** * * @type {string} - * @memberof AggregationEmailTemplateSubjectTemplate + * @memberof BehaviorGroupActionId */ - 'data': string; + 'endpointId': string; } /** * * @export - * @interface Application + * @interface Bundle */ -export interface Application { +export interface Bundle { /** * * @type {string} - * @memberof Application + * @memberof Bundle */ 'created'?: string; /** * * @type {string} - * @memberof Application + * @memberof Bundle */ 'updated'?: string; /** * * @type {string} - * @memberof Application + * @memberof Bundle */ 'id'?: string; /** * * @type {string} - * @memberof Application + * @memberof Bundle */ 'name': string; /** * * @type {string} - * @memberof Application + * @memberof Bundle */ 'display_name': string; - /** - * - * @type {string} - * @memberof Application - */ - 'bundle_id': string; } /** * * @export - * @interface Application1 + * @interface CreateBehaviorGroupRequest */ -export interface Application1 { +export interface CreateBehaviorGroupRequest { /** * * @type {string} - * @memberof Application1 + * @memberof CreateBehaviorGroupRequest */ - 'id': string; + 'bundle_id'?: string; + /** + * + * @type {string} + * @memberof CreateBehaviorGroupRequest + */ + 'bundle_name'?: string; /** * * @type {string} - * @memberof Application1 + * @memberof CreateBehaviorGroupRequest */ 'display_name': string; + /** + * + * @type {Array} + * @memberof CreateBehaviorGroupRequest + */ + 'endpoint_ids'?: Array; + /** + * + * @type {Set} + * @memberof CreateBehaviorGroupRequest + */ + 'event_type_ids'?: Set; + /** + * + * @type {boolean} + * @memberof CreateBehaviorGroupRequest + */ + 'bundle_uuid_or_bundle_name_valid'?: boolean; } /** * * @export - * @interface ApplicationDTO + * @interface CreateBehaviorGroupResponse */ -export interface ApplicationDTO { +export interface CreateBehaviorGroupResponse { /** * * @type {string} - * @memberof ApplicationDTO + * @memberof CreateBehaviorGroupResponse */ - 'id'?: string; + 'id': string; /** * * @type {string} - * @memberof ApplicationDTO + * @memberof CreateBehaviorGroupResponse */ - 'name': string; + 'bundle_id': string; /** * * @type {string} - * @memberof ApplicationDTO + * @memberof CreateBehaviorGroupResponse */ 'display_name': string; /** * - * @type {string} - * @memberof ApplicationDTO + * @type {Array} + * @memberof CreateBehaviorGroupResponse */ - 'bundle_id': string; + 'endpoints': Array; + /** + * + * @type {Set} + * @memberof CreateBehaviorGroupResponse + */ + 'event_types': Set; /** * - * @type {Set} - * @memberof ApplicationDTO + * @type {string} + * @memberof CreateBehaviorGroupResponse */ - 'event_types'?: Set; + 'created': string; } /** * * @export - * @interface ApplicationDTO1 + * @interface DrawerEntryPayload */ -export interface ApplicationDTO1 { +export interface DrawerEntryPayload { /** * * @type {string} - * @memberof ApplicationDTO1 + * @memberof DrawerEntryPayload */ 'id'?: string; /** * * @type {string} - * @memberof ApplicationDTO1 - */ - 'name': string; - /** - * - * @type {string} - * @memberof ApplicationDTO1 - */ - 'display_name': string; - /** - * - * @type {string} - * @memberof ApplicationDTO1 + * @memberof DrawerEntryPayload */ - 'bundle_id': string; + 'description'?: string; /** * * @type {string} - * @memberof ApplicationDTO1 + * @memberof DrawerEntryPayload */ - 'owner_role'?: string; + 'title'?: string; /** * * @type {string} - * @memberof ApplicationDTO1 + * @memberof DrawerEntryPayload */ 'created'?: string; -} -/** - * - * @export - * @interface ApplicationSettingsValue - */ -export interface ApplicationSettingsValue { /** * - * @type {{ [key: string]: EventTypeSettingsValue; }} - * @memberof ApplicationSettingsValue + * @type {boolean} + * @memberof DrawerEntryPayload */ - 'eventTypes'?: { [key: string]: EventTypeSettingsValue; }; -} -/** - * - * @export - * @interface BasicAuthenticationDTO - */ -export interface BasicAuthenticationDTO { + 'read': boolean; /** * * @type {string} - * @memberof BasicAuthenticationDTO + * @memberof DrawerEntryPayload */ - 'username'?: string; + 'source'?: string; /** * * @type {string} - * @memberof BasicAuthenticationDTO + * @memberof DrawerEntryPayload */ - 'password'?: string; + 'bundle'?: string; } /** * * @export - * @interface BehaviorGroup + * @interface Endpoint */ -export interface BehaviorGroup { +export interface Endpoint { /** * * @type {string} - * @memberof BehaviorGroup + * @memberof Endpoint */ 'created'?: string; /** * * @type {string} - * @memberof BehaviorGroup + * @memberof Endpoint */ 'updated'?: string; /** * * @type {string} - * @memberof BehaviorGroup + * @memberof Endpoint */ 'id'?: string; /** * * @type {string} - * @memberof BehaviorGroup + * @memberof Endpoint */ - 'display_name': string; + 'name': string; /** * * @type {string} - * @memberof BehaviorGroup + * @memberof Endpoint */ - 'bundle_id': string; + 'description': string; /** * - * @type {Bundle} - * @memberof BehaviorGroup + * @type {boolean} + * @memberof Endpoint */ - 'bundle'?: Bundle; + 'enabled'?: boolean; /** * - * @type {Array} - * @memberof BehaviorGroup + * @type {EndpointStatus} + * @memberof Endpoint */ - 'actions'?: Array; + 'status'?: EndpointStatus; /** * - * @type {Set} - * @memberof BehaviorGroup + * @type {number} + * @memberof Endpoint */ - 'behaviors'?: Set; + 'server_errors'?: number; /** * - * @type {boolean} - * @memberof BehaviorGroup + * @type {object} + * @memberof Endpoint */ - 'default_behavior'?: boolean; -} -/** - * - * @export - * @interface BehaviorGroupAction - */ -export interface BehaviorGroupAction { + 'properties'?: object; /** * - * @type {string} - * @memberof BehaviorGroupAction + * @type {EndpointType} + * @memberof Endpoint */ - 'created'?: string; + 'type'?: EndpointType; /** * - * @type {BehaviorGroupActionId} - * @memberof BehaviorGroupAction + * @type {string} + * @memberof Endpoint */ - 'id'?: BehaviorGroupActionId; - /** - * - * @type {Endpoint} - * @memberof BehaviorGroupAction - */ - 'endpoint'?: Endpoint; + 'sub_type'?: string; } + + /** * * @export - * @interface BehaviorGroupActionId + * @enum {string} */ -export interface BehaviorGroupActionId { - /** - * - * @type {string} - * @memberof BehaviorGroupActionId - */ - 'behaviorGroupId': string; - /** - * - * @type {string} - * @memberof BehaviorGroupActionId - */ - 'endpointId': string; -} + +export const EndpointStatus = { + Ready: 'READY', + Unknown: 'UNKNOWN', + New: 'NEW', + Provisioning: 'PROVISIONING', + Deleting: 'DELETING', + Failed: 'FAILED' +} as const; + +export type EndpointStatus = typeof EndpointStatus[keyof typeof EndpointStatus]; + + /** * * @export - * @interface Bundle + * @enum {string} */ -export interface Bundle { - /** - * - * @type {string} - * @memberof Bundle - */ - 'created'?: string; - /** - * - * @type {string} - * @memberof Bundle - */ - 'updated'?: string; - /** - * - * @type {string} - * @memberof Bundle - */ - 'id'?: string; - /** - * - * @type {string} - * @memberof Bundle - */ - 'name': string; - /** - * - * @type {string} - * @memberof Bundle - */ - 'display_name': string; -} + +export const EndpointType = { + Ansible: 'ansible', + Camel: 'camel', + Drawer: 'drawer', + EmailSubscription: 'email_subscription', + Webhook: 'webhook', + Pagerduty: 'pagerduty' +} as const; + +export type EndpointType = typeof EndpointType[keyof typeof EndpointType]; + + /** * * @export - * @interface BundleDTO + * @interface EventLogEntry */ -export interface BundleDTO { - /** - * - * @type {string} - * @memberof BundleDTO - */ - 'id'?: string; - /** - * - * @type {string} - * @memberof BundleDTO - */ - 'name': string; +export interface EventLogEntry { /** * * @type {string} - * @memberof BundleDTO - */ - 'display_name': string; - /** - * - * @type {Set} - * @memberof BundleDTO - */ - 'applications'?: Set; -} -/** - * - * @export - * @interface BundleSettingsValue - */ -export interface BundleSettingsValue { - /** - * - * @type {{ [key: string]: ApplicationSettingsValue; }} - * @memberof BundleSettingsValue - */ - 'applications'?: { [key: string]: ApplicationSettingsValue; }; -} -/** - * - * @export - * @interface CamelPropertiesDTO - */ -export interface CamelPropertiesDTO { - /** - * - * @type {boolean} - * @memberof CamelPropertiesDTO - */ - 'disableSslVerification': boolean; - /** - * - * @type {{ [key: string]: string; }} - * @memberof CamelPropertiesDTO + * @memberof EventLogEntry */ - 'extras'?: { [key: string]: string; }; + 'id': string; /** * * @type {string} - * @memberof CamelPropertiesDTO - */ - 'url': string; - /** - * - * @type {BasicAuthenticationDTO} - * @memberof CamelPropertiesDTO + * @memberof EventLogEntry */ - 'basicAuthentication'?: BasicAuthenticationDTO; + 'created': string; /** * * @type {string} - * @memberof CamelPropertiesDTO + * @memberof EventLogEntry */ - 'secretToken'?: string; -} -/** - * - * @export - * @interface CreateBehaviorGroupRequest - */ -export interface CreateBehaviorGroupRequest { + 'bundle': string; /** * * @type {string} - * @memberof CreateBehaviorGroupRequest + * @memberof EventLogEntry */ - 'bundle_id'?: string; + 'application': string; /** * * @type {string} - * @memberof CreateBehaviorGroupRequest + * @memberof EventLogEntry */ - 'bundle_name'?: string; + 'event_type': string; /** * * @type {string} - * @memberof CreateBehaviorGroupRequest - */ - 'display_name': string; - /** - * - * @type {Array} - * @memberof CreateBehaviorGroupRequest - */ - 'endpoint_ids'?: Array; - /** - * - * @type {Set} - * @memberof CreateBehaviorGroupRequest + * @memberof EventLogEntry */ - 'event_type_ids'?: Set; + 'payload'?: string; /** * - * @type {boolean} - * @memberof CreateBehaviorGroupRequest + * @type {Array} + * @memberof EventLogEntry */ - 'bundle_uuid_or_bundle_name_valid'?: boolean; + 'actions': Array; } /** * * @export - * @interface CreateBehaviorGroupResponse + * @interface EventLogEntryAction */ -export interface CreateBehaviorGroupResponse { +export interface EventLogEntryAction { /** * * @type {string} - * @memberof CreateBehaviorGroupResponse + * @memberof EventLogEntryAction */ 'id': string; /** * - * @type {string} - * @memberof CreateBehaviorGroupResponse - */ - 'bundle_id': string; - /** - * - * @type {string} - * @memberof CreateBehaviorGroupResponse - */ - 'display_name': string; - /** - * - * @type {Array} - * @memberof CreateBehaviorGroupResponse - */ - 'endpoints': Array; - /** - * - * @type {Set} - * @memberof CreateBehaviorGroupResponse - */ - 'event_types': Set; - /** - * - * @type {string} - * @memberof CreateBehaviorGroupResponse - */ - 'created': string; -} -/** - * - * @export - * @interface CurrentStatus - */ -export interface CurrentStatus { - /** - * - * @type {Status} - * @memberof CurrentStatus - */ - 'status': Status; - /** - * - * @type {string} - * @memberof CurrentStatus - */ - 'start_time'?: string; - /** - * - * @type {string} - * @memberof CurrentStatus + * @type {EndpointType} + * @memberof EventLogEntryAction */ - 'end_time'?: string; -} - - -/** - * - * @export - * @interface DrawerEntryPayload - */ -export interface DrawerEntryPayload { + 'endpoint_type': EndpointType; /** * * @type {string} - * @memberof DrawerEntryPayload + * @memberof EventLogEntryAction */ - 'id'?: string; + 'endpoint_sub_type'?: string; /** * - * @type {string} - * @memberof DrawerEntryPayload + * @type {boolean} + * @memberof EventLogEntryAction + * @deprecated */ - 'description'?: string; + 'invocation_result': boolean; /** * - * @type {string} - * @memberof DrawerEntryPayload + * @type {EventLogEntryActionStatus} + * @memberof EventLogEntryAction */ - 'title'?: string; + 'status': EventLogEntryActionStatus; /** * * @type {string} - * @memberof DrawerEntryPayload - */ - 'created'?: string; - /** - * - * @type {boolean} - * @memberof DrawerEntryPayload + * @memberof EventLogEntryAction */ - 'read': boolean; - /** - * - * @type {string} - * @memberof DrawerEntryPayload - */ - 'source'?: string; - /** - * - * @type {string} - * @memberof DrawerEntryPayload - */ - 'bundle'?: string; -} -/** - * - * @export - * @interface Endpoint - */ -export interface Endpoint { - /** - * - * @type {string} - * @memberof Endpoint - */ - 'created'?: string; - /** - * - * @type {string} - * @memberof Endpoint - */ - 'updated'?: string; - /** - * - * @type {string} - * @memberof Endpoint - */ - 'id'?: string; - /** - * - * @type {string} - * @memberof Endpoint - */ - 'name': string; - /** - * - * @type {string} - * @memberof Endpoint - */ - 'description': string; - /** - * - * @type {boolean} - * @memberof Endpoint - */ - 'enabled'?: boolean; - /** - * - * @type {EndpointStatus} - * @memberof Endpoint - */ - 'status'?: EndpointStatus; - /** - * - * @type {number} - * @memberof Endpoint - */ - 'server_errors'?: number; - /** - * - * @type {object} - * @memberof Endpoint - */ - 'properties'?: object; - /** - * - * @type {EndpointType} - * @memberof Endpoint - */ - 'type'?: EndpointType; - /** - * - * @type {string} - * @memberof Endpoint - */ - 'sub_type'?: string; -} - - -/** - * - * @export - * @interface EndpointDTO - */ -export interface EndpointDTO { - /** - * - * @type {string} - * @memberof EndpointDTO - */ - 'id'?: string; - /** - * - * @type {string} - * @memberof EndpointDTO - */ - 'name': string; - /** - * - * @type {string} - * @memberof EndpointDTO - */ - 'description': string; - /** - * - * @type {boolean} - * @memberof EndpointDTO - */ - 'enabled'?: boolean; - /** - * - * @type {EndpointStatusDTO} - * @memberof EndpointDTO - */ - 'status'?: EndpointStatusDTO; - /** - * - * @type {number} - * @memberof EndpointDTO - */ - 'server_errors'?: number; - /** - * - * @type {EndpointTypeDTO} - * @memberof EndpointDTO - */ - 'type': EndpointTypeDTO; - /** - * - * @type {string} - * @memberof EndpointDTO - */ - 'sub_type'?: string; - /** - * - * @type {string} - * @memberof EndpointDTO - */ - 'created'?: string; - /** - * - * @type {string} - * @memberof EndpointDTO - */ - 'updated'?: string; - /** - * - * @type {object} - * @memberof EndpointDTO - */ - 'properties'?: object; - /** - * - * @type {Set} - * @memberof EndpointDTO - */ - 'event_types_group_by_bundles_and_applications'?: Set; - /** - * - * @type {Set} - * @memberof EndpointDTO - */ - 'event_types'?: Set; -} - - -/** - * - * @export - * @interface EndpointPage - */ -export interface EndpointPage { - /** - * - * @type {Array} - * @memberof EndpointPage - */ - 'data': Array; - /** - * - * @type {{ [key: string]: string; }} - * @memberof EndpointPage - */ - 'links': { [key: string]: string; }; - /** - * - * @type {Meta} - * @memberof EndpointPage - */ - 'meta': Meta; -} -/** - * - * @export - * @enum {string} - */ - -export const EndpointStatus = { - Ready: 'READY', - Unknown: 'UNKNOWN', - New: 'NEW', - Provisioning: 'PROVISIONING', - Deleting: 'DELETING', - Failed: 'FAILED' -} as const; - -export type EndpointStatus = typeof EndpointStatus[keyof typeof EndpointStatus]; - - -/** - * - * @export - * @enum {string} - */ - -export const EndpointStatusDTO = { - Deleting: 'DELETING', - Failed: 'FAILED', - New: 'NEW', - Provisioning: 'PROVISIONING', - Ready: 'READY', - Unknown: 'UNKNOWN' -} as const; - -export type EndpointStatusDTO = typeof EndpointStatusDTO[keyof typeof EndpointStatusDTO]; - - -/** - * - * @export - * @interface EndpointTestRequest - */ -export interface EndpointTestRequest { - /** - * - * @type {string} - * @memberof EndpointTestRequest - */ - 'message': string; -} -/** - * - * @export - * @enum {string} - */ - -export const EndpointType = { - Ansible: 'ansible', - Camel: 'camel', - Drawer: 'drawer', - EmailSubscription: 'email_subscription', - Webhook: 'webhook', - Pagerduty: 'pagerduty' -} as const; - -export type EndpointType = typeof EndpointType[keyof typeof EndpointType]; - - -/** - * - * @export - * @enum {string} - */ - -export const EndpointTypeDTO = { - Ansible: 'ansible', - Camel: 'camel', - Drawer: 'drawer', - EmailSubscription: 'email_subscription', - Webhook: 'webhook' -} as const; - -export type EndpointTypeDTO = typeof EndpointTypeDTO[keyof typeof EndpointTypeDTO]; - - -/** - * - * @export - * @enum {string} - */ - -export const Environment = { - Prod: 'PROD', - Stage: 'STAGE', - Ephemeral: 'EPHEMERAL', - LocalServer: 'LOCAL_SERVER' -} as const; - -export type Environment = typeof Environment[keyof typeof Environment]; - - -/** - * - * @export - * @interface EventLogEntry - */ -export interface EventLogEntry { - /** - * - * @type {string} - * @memberof EventLogEntry - */ - 'id': string; - /** - * - * @type {string} - * @memberof EventLogEntry - */ - 'created': string; - /** - * - * @type {string} - * @memberof EventLogEntry - */ - 'bundle': string; - /** - * - * @type {string} - * @memberof EventLogEntry - */ - 'application': string; - /** - * - * @type {string} - * @memberof EventLogEntry - */ - 'event_type': string; - /** - * - * @type {string} - * @memberof EventLogEntry - */ - 'payload'?: string; - /** - * - * @type {Array} - * @memberof EventLogEntry - */ - 'actions': Array; -} -/** - * - * @export - * @interface EventLogEntryAction - */ -export interface EventLogEntryAction { - /** - * - * @type {string} - * @memberof EventLogEntryAction - */ - 'id': string; - /** - * - * @type {EndpointType} - * @memberof EventLogEntryAction - */ - 'endpoint_type': EndpointType; - /** - * - * @type {string} - * @memberof EventLogEntryAction - */ - 'endpoint_sub_type'?: string; - /** - * - * @type {boolean} - * @memberof EventLogEntryAction - * @deprecated - */ - 'invocation_result': boolean; - /** - * - * @type {EventLogEntryActionStatus} - * @memberof EventLogEntryAction - */ - 'status': EventLogEntryActionStatus; - /** - * - * @type {string} - * @memberof EventLogEntryAction - */ - 'endpoint_id'?: string; - /** - * - * @type {{ [key: string]: any; }} - * @memberof EventLogEntryAction - */ - 'details'?: { [key: string]: any; }; -} - - -/** - * - * @export - * @enum {string} - */ - -export const EventLogEntryActionStatus = { - Sent: 'SENT', - Success: 'SUCCESS', - Processing: 'PROCESSING', - Failed: 'FAILED', - Unknown: 'UNKNOWN' -} as const; - -export type EventLogEntryActionStatus = typeof EventLogEntryActionStatus[keyof typeof EventLogEntryActionStatus]; - - -/** - * - * @export - * @interface EventType - */ -export interface EventType { - /** - * - * @type {string} - * @memberof EventType - */ - 'id'?: string; - /** - * - * @type {string} - * @memberof EventType - */ - 'name': string; - /** - * - * @type {string} - * @memberof EventType - */ - 'display_name': string; - /** - * - * @type {string} - * @memberof EventType - */ - 'description'?: string; - /** - * - * @type {string} - * @memberof EventType - */ - 'fully_qualified_name'?: string; - /** - * - * @type {string} - * @memberof EventType - */ - 'application_id': string; - /** - * - * @type {Application} - * @memberof EventType - */ - 'application'?: Application; - /** - * - * @type {boolean} - * @memberof EventType - */ - 'visible'?: boolean; - /** - * - * @type {boolean} - * @memberof EventType - */ - 'subscribed_by_default'?: boolean; - /** - * - * @type {boolean} - * @memberof EventType - */ - 'subscription_locked'?: boolean; - /** - * - * @type {boolean} - * @memberof EventType - */ - 'not_subscription_locked_or_subscribed_by_default'?: boolean; -} -/** - * - * @export - * @interface EventTypeBehavior - */ -export interface EventTypeBehavior { - /** - * - * @type {string} - * @memberof EventTypeBehavior - */ - 'created'?: string; - /** - * - * @type {EventTypeBehaviorId} - * @memberof EventTypeBehavior - */ - 'id'?: EventTypeBehaviorId; - /** - * - * @type {EventType} - * @memberof EventTypeBehavior - */ - 'event_type'?: EventType; -} -/** - * - * @export - * @interface EventTypeBehaviorId - */ -export interface EventTypeBehaviorId { - /** - * - * @type {string} - * @memberof EventTypeBehaviorId - */ - 'eventTypeId': string; - /** - * - * @type {string} - * @memberof EventTypeBehaviorId - */ - 'behaviorGroupId': string; -} -/** - * - * @export - * @interface EventTypeDTO - */ -export interface EventTypeDTO { - /** - * - * @type {string} - * @memberof EventTypeDTO - */ - 'id'?: string; - /** - * - * @type {string} - * @memberof EventTypeDTO - */ - 'name': string; - /** - * - * @type {string} - * @memberof EventTypeDTO - */ - 'display_name': string; - /** - * - * @type {string} - * @memberof EventTypeDTO - */ - 'description'?: string; - /** - * - * @type {ApplicationDTO} - * @memberof EventTypeDTO - */ - 'application'?: ApplicationDTO; -} -/** - * - * @export - * @interface EventTypeSettingsValue - */ -export interface EventTypeSettingsValue { - /** - * - * @type {{ [key: string]: boolean; }} - * @memberof EventTypeSettingsValue - */ - 'emailSubscriptionTypes'?: { [key: string]: boolean; }; - /** - * - * @type {boolean} - * @memberof EventTypeSettingsValue - */ - 'hasForcedEmail'?: boolean; - /** - * - * @type {boolean} - * @memberof EventTypeSettingsValue - */ - 'subscriptionLocked'?: boolean; -} -/** - * - * @export - * @interface EventsReplayRequest - */ -export interface EventsReplayRequest { - /** - * - * @type {string} - * @memberof EventsReplayRequest - */ - 'start_date': string; - /** - * - * @type {string} - * @memberof EventsReplayRequest - */ - 'end_date': string; - /** - * - * @type {string} - * @memberof EventsReplayRequest - */ - 'org_id'?: string; -} -/** - * - * @export - * @interface Facet - */ -export interface Facet { - /** - * - * @type {string} - * @memberof Facet - */ - 'id': string; - /** - * - * @type {string} - * @memberof Facet - */ - 'name': string; - /** - * - * @type {string} - * @memberof Facet - */ - 'displayName': string; - /** - * - * @type {Array} - * @memberof Facet - */ - 'children'?: Array; -} -/** - * - * @export - * @enum {string} - */ - -export const HttpType = { - Get: 'GET', - Post: 'POST', - Put: 'PUT' -} as const; - -export type HttpType = typeof HttpType[keyof typeof HttpType]; - - -/** - * - * @export - * @interface InstantEmailTemplate - */ -export interface InstantEmailTemplate { - /** - * - * @type {string} - * @memberof InstantEmailTemplate - */ - 'created'?: string; - /** - * - * @type {string} - * @memberof InstantEmailTemplate - */ - 'updated'?: string; - /** - * - * @type {string} - * @memberof InstantEmailTemplate - */ - 'id'?: string; - /** - * - * @type {EventType} - * @memberof InstantEmailTemplate - */ - 'event_type'?: EventType; - /** - * - * @type {string} - * @memberof InstantEmailTemplate - */ - 'event_type_id'?: string; - /** - * - * @type {AggregationEmailTemplateSubjectTemplate} - * @memberof InstantEmailTemplate - */ - 'subject_template'?: AggregationEmailTemplateSubjectTemplate; - /** - * - * @type {string} - * @memberof InstantEmailTemplate - */ - 'subject_template_id': string; - /** - * - * @type {AggregationEmailTemplateSubjectTemplate} - * @memberof InstantEmailTemplate - */ - 'body_template'?: AggregationEmailTemplateSubjectTemplate; - /** - * - * @type {string} - * @memberof InstantEmailTemplate - */ - 'body_template_id': string; -} -/** - * - * @export - * @interface InternalApplicationUserPermission - */ -export interface InternalApplicationUserPermission { - /** - * - * @type {string} - * @memberof InternalApplicationUserPermission - */ - 'application_id': string; - /** - * - * @type {string} - * @memberof InternalApplicationUserPermission - */ - 'application_display_name': string; - /** - * - * @type {string} - * @memberof InternalApplicationUserPermission - */ - 'role': string; -} -/** - * - * @export - * @interface InternalRoleAccess - */ -export interface InternalRoleAccess { - /** - * - * @type {string} - * @memberof InternalRoleAccess - */ - 'id'?: string; - /** - * - * @type {string} - * @memberof InternalRoleAccess - */ - 'role': string; - /** - * - * @type {string} - * @memberof InternalRoleAccess - */ - 'application_id': string; -} -/** - * - * @export - * @interface InternalUserPermissions - */ -export interface InternalUserPermissions { - /** - * - * @type {boolean} - * @memberof InternalUserPermissions - */ - 'is_admin': boolean; - /** - * - * @type {Array} - * @memberof InternalUserPermissions - */ - 'applications': Array; - /** - * - * @type {Array} - * @memberof InternalUserPermissions - */ - 'roles': Array; -} -/** - * - * @export - * @interface MessageValidationResponse - */ -export interface MessageValidationResponse { - /** - * - * @type {{ [key: string]: Array; }} - * @memberof MessageValidationResponse - */ - 'errors': { [key: string]: Array; }; -} -/** - * - * @export - * @interface Meta - */ -export interface Meta { - /** - * - * @type {number} - * @memberof Meta - */ - 'count': number; -} -/** - * - * @export - * @interface NotificationHistory - */ -export interface NotificationHistory { - /** - * - * @type {string} - * @memberof NotificationHistory - */ - 'created'?: string; - /** - * - * @type {string} - * @memberof NotificationHistory - */ - 'id'?: string; - /** - * - * @type {number} - * @memberof NotificationHistory - */ - 'invocationTime': number; - /** - * - * @type {boolean} - * @memberof NotificationHistory - * @deprecated - */ - 'invocationResult': boolean; - /** - * - * @type {NotificationStatus} - * @memberof NotificationHistory - */ - 'status': NotificationStatus; - /** - * - * @type {string} - * @memberof NotificationHistory - */ - 'endpointId'?: string; + 'endpoint_id'?: string; /** * * @type {{ [key: string]: any; }} - * @memberof NotificationHistory - */ - 'details'?: { [key: string]: any; }; - /** - * - * @type {EndpointType} - * @memberof NotificationHistory - */ - 'endpointType'?: EndpointType; - /** - * - * @type {string} - * @memberof NotificationHistory - */ - 'endpointSubType'?: string; -} - - -/** - * - * @export - * @enum {string} - */ - -export const NotificationStatus = { - FailedInternal: 'FAILED_INTERNAL', - FailedExternal: 'FAILED_EXTERNAL', - Processing: 'PROCESSING', - Sent: 'SENT', - Success: 'SUCCESS' -} as const; - -export type NotificationStatus = typeof NotificationStatus[keyof typeof NotificationStatus]; - - -/** - * - * @export - * @interface PageBehaviorGroup - */ -export interface PageBehaviorGroup { - /** - * - * @type {Array} - * @memberof PageBehaviorGroup - */ - 'data': Array; - /** - * - * @type {{ [key: string]: string; }} - * @memberof PageBehaviorGroup - */ - 'links': { [key: string]: string; }; - /** - * - * @type {Meta} - * @memberof PageBehaviorGroup - */ - 'meta': Meta; -} -/** - * - * @export - * @interface PageDrawerEntryPayload - */ -export interface PageDrawerEntryPayload { - /** - * - * @type {Array} - * @memberof PageDrawerEntryPayload - */ - 'data': Array; - /** - * - * @type {{ [key: string]: string; }} - * @memberof PageDrawerEntryPayload - */ - 'links': { [key: string]: string; }; - /** - * - * @type {Meta} - * @memberof PageDrawerEntryPayload - */ - 'meta': Meta; -} -/** - * - * @export - * @interface PageEventLogEntry - */ -export interface PageEventLogEntry { - /** - * - * @type {Array} - * @memberof PageEventLogEntry - */ - 'data': Array; - /** - * - * @type {{ [key: string]: string; }} - * @memberof PageEventLogEntry - */ - 'links': { [key: string]: string; }; - /** - * - * @type {Meta} - * @memberof PageEventLogEntry - */ - 'meta': Meta; -} -/** - * - * @export - * @interface PageEventType - */ -export interface PageEventType { - /** - * - * @type {Array} - * @memberof PageEventType - */ - 'data': Array; - /** - * - * @type {{ [key: string]: string; }} - * @memberof PageEventType - */ - 'links': { [key: string]: string; }; - /** - * - * @type {Meta} - * @memberof PageEventType - */ - 'meta': Meta; -} -/** - * - * @export - * @interface PageNotificationHistory - */ -export interface PageNotificationHistory { - /** - * - * @type {Array} - * @memberof PageNotificationHistory - */ - 'data': Array; - /** - * - * @type {{ [key: string]: string; }} - * @memberof PageNotificationHistory - */ - 'links': { [key: string]: string; }; - /** - * - * @type {Meta} - * @memberof PageNotificationHistory - */ - 'meta': Meta; -} -/** - * - * @export - * @interface PagerDutyPropertiesDTO - */ -export interface PagerDutyPropertiesDTO { - /** - * - * @type {PagerDutySeverityDTO} - * @memberof PagerDutyPropertiesDTO - */ - 'severity': PagerDutySeverityDTO; - /** - * - * @type {string} - * @memberof PagerDutyPropertiesDTO - */ - 'secretToken': string; -} - - -/** - * - * @export - * @enum {string} - */ - -export const PagerDutySeverity = { - Critical: 'critical', - Error: 'error', - Warning: 'warning', - Info: 'info' -} as const; - -export type PagerDutySeverity = typeof PagerDutySeverity[keyof typeof PagerDutySeverity]; + * @memberof EventLogEntryAction + */ + 'details'?: { [key: string]: any; }; +} /** @@ -1785,259 +536,252 @@ export type PagerDutySeverity = typeof PagerDutySeverity[keyof typeof PagerDutyS * @enum {string} */ -export const PagerDutySeverityDTO = { - Critical: 'critical', - Error: 'error', - Warning: 'warning', - Info: 'info' +export const EventLogEntryActionStatus = { + Sent: 'SENT', + Success: 'SUCCESS', + Processing: 'PROCESSING', + Failed: 'FAILED', + Unknown: 'UNKNOWN' } as const; -export type PagerDutySeverityDTO = typeof PagerDutySeverityDTO[keyof typeof PagerDutySeverityDTO]; +export type EventLogEntryActionStatus = typeof EventLogEntryActionStatus[keyof typeof EventLogEntryActionStatus]; /** * * @export - * @interface RenderEmailTemplateRequest + * @interface EventType */ -export interface RenderEmailTemplateRequest { +export interface EventType { /** * - * @type {Array} - * @memberof RenderEmailTemplateRequest + * @type {string} + * @memberof EventType */ - 'template': Array; + 'id'?: string; /** * * @type {string} - * @memberof RenderEmailTemplateRequest + * @memberof EventType */ - 'payload': string; -} -/** - * - * @export - * @interface RequestDefaultBehaviorGroupPropertyList - */ -export interface RequestDefaultBehaviorGroupPropertyList { + 'name': string; /** * - * @type {boolean} - * @memberof RequestDefaultBehaviorGroupPropertyList + * @type {string} + * @memberof EventType */ - 'only_admins': boolean; + 'display_name': string; /** * - * @type {boolean} - * @memberof RequestDefaultBehaviorGroupPropertyList + * @type {string} + * @memberof EventType */ - 'ignore_preferences': boolean; -} -/** - * - * @export - * @interface RequestSystemSubscriptionProperties - */ -export interface RequestSystemSubscriptionProperties { + 'description'?: string; /** * - * @type {boolean} - * @memberof RequestSystemSubscriptionProperties + * @type {string} + * @memberof EventType */ - 'only_admins': boolean; + 'fully_qualified_name'?: string; /** * * @type {string} - * @memberof RequestSystemSubscriptionProperties + * @memberof EventType */ - 'group_id'?: string; -} -/** - * - * @export - * @interface ServerInfo - */ -export interface ServerInfo { + 'application_id': string; + /** + * + * @type {Application} + * @memberof EventType + */ + 'application'?: Application; /** * - * @type {Environment} - * @memberof ServerInfo + * @type {boolean} + * @memberof EventType */ - 'environment'?: Environment; -} - - -/** - * - * @export - * @interface SettingsValuesByEventType - */ -export interface SettingsValuesByEventType { + 'visible'?: boolean; + /** + * + * @type {boolean} + * @memberof EventType + */ + 'subscribed_by_default'?: boolean; + /** + * + * @type {boolean} + * @memberof EventType + */ + 'subscription_locked'?: boolean; /** * - * @type {{ [key: string]: BundleSettingsValue; }} - * @memberof SettingsValuesByEventType + * @type {boolean} + * @memberof EventType */ - 'bundles'?: { [key: string]: BundleSettingsValue; }; + 'not_subscription_locked_or_subscribed_by_default'?: boolean; } /** * * @export - * @enum {string} - */ - -export const Status = { - Up: 'UP', - Maintenance: 'MAINTENANCE' -} as const; - -export type Status = typeof Status[keyof typeof Status]; - - -/** - * - * @export - * @enum {string} - */ - -export const SubscriptionType = { - Instant: 'INSTANT', - Daily: 'DAILY', - Drawer: 'DRAWER' -} as const; - -export type SubscriptionType = typeof SubscriptionType[keyof typeof SubscriptionType]; - - -/** - * - * @export - * @interface SystemSubscriptionPropertiesDTO + * @interface EventTypeBehavior */ -export interface SystemSubscriptionPropertiesDTO { +export interface EventTypeBehavior { /** * * @type {string} - * @memberof SystemSubscriptionPropertiesDTO + * @memberof EventTypeBehavior */ - 'groupId'?: string; + 'created'?: string; /** * - * @type {boolean} - * @memberof SystemSubscriptionPropertiesDTO + * @type {EventTypeBehaviorId} + * @memberof EventTypeBehavior */ - 'ignorePreferences'?: boolean; + 'id'?: EventTypeBehaviorId; /** * - * @type {boolean} - * @memberof SystemSubscriptionPropertiesDTO + * @type {EventType} + * @memberof EventTypeBehavior */ - 'onlyAdmins'?: boolean; + 'event_type'?: EventType; } /** * * @export - * @interface Template + * @interface EventTypeBehaviorId */ -export interface Template { +export interface EventTypeBehaviorId { /** * * @type {string} - * @memberof Template + * @memberof EventTypeBehaviorId */ - 'created'?: string; + 'eventTypeId': string; /** * * @type {string} - * @memberof Template + * @memberof EventTypeBehaviorId */ - 'updated'?: string; + 'behaviorGroupId': string; +} +/** + * + * @export + * @interface Facet + */ +export interface Facet { /** * * @type {string} - * @memberof Template + * @memberof Facet */ - 'id'?: string; + 'id': string; /** * * @type {string} - * @memberof Template + * @memberof Facet */ 'name': string; /** * * @type {string} - * @memberof Template + * @memberof Facet */ - 'description': string; + 'displayName': string; /** * - * @type {string} - * @memberof Template + * @type {Array} + * @memberof Facet */ - 'data': string; + 'children'?: Array; } /** * * @export - * @interface TriggerDailyDigestRequest + * @interface Meta */ -export interface TriggerDailyDigestRequest { +export interface Meta { /** * - * @type {string} - * @memberof TriggerDailyDigestRequest + * @type {number} + * @memberof Meta */ - 'application_name': string; + 'count': number; +} +/** + * + * @export + * @interface PageDrawerEntryPayload + */ +export interface PageDrawerEntryPayload { /** * - * @type {string} - * @memberof TriggerDailyDigestRequest + * @type {Array} + * @memberof PageDrawerEntryPayload */ - 'bundle_name': string; + 'data': Array; /** * - * @type {string} - * @memberof TriggerDailyDigestRequest + * @type {{ [key: string]: string; }} + * @memberof PageDrawerEntryPayload */ - 'end'?: string; + 'links': { [key: string]: string; }; /** * - * @type {string} - * @memberof TriggerDailyDigestRequest + * @type {Meta} + * @memberof PageDrawerEntryPayload */ - 'org_id': string; + 'meta': Meta; +} +/** + * + * @export + * @interface PageEventLogEntry + */ +export interface PageEventLogEntry { /** * - * @type {string} - * @memberof TriggerDailyDigestRequest + * @type {Array} + * @memberof PageEventLogEntry + */ + 'data': Array; + /** + * + * @type {{ [key: string]: string; }} + * @memberof PageEventLogEntry + */ + 'links': { [key: string]: string; }; + /** + * + * @type {Meta} + * @memberof PageEventLogEntry */ - 'start'?: string; + 'meta': Meta; } /** * * @export - * @interface UpdateApplicationRequest + * @interface PageEventType */ -export interface UpdateApplicationRequest { +export interface PageEventType { /** * - * @type {string} - * @memberof UpdateApplicationRequest + * @type {Array} + * @memberof PageEventType */ - 'name'?: string; + 'data': Array; /** * - * @type {string} - * @memberof UpdateApplicationRequest + * @type {{ [key: string]: string; }} + * @memberof PageEventType */ - 'display_name'?: string; + 'links': { [key: string]: string; }; /** * - * @type {string} - * @memberof UpdateApplicationRequest + * @type {Meta} + * @memberof PageEventType */ - 'owner_role'?: string; + 'meta': Meta; } /** * @@ -2089,85 +833,3 @@ export interface UpdateNotificationDrawerStatus { */ 'read_status': boolean; } -/** - * - * @export - * @interface WebhookPropertiesDTO - */ -export interface WebhookPropertiesDTO { - /** - * - * @type {boolean} - * @memberof WebhookPropertiesDTO - */ - 'disableSslVerification': boolean; - /** - * - * @type {HttpType} - * @memberof WebhookPropertiesDTO - */ - 'method': HttpType; - /** - * - * @type {string} - * @memberof WebhookPropertiesDTO - */ - 'url': string; - /** - * - * @type {BasicAuthenticationDTO} - * @memberof WebhookPropertiesDTO - */ - 'basicAuthentication'?: BasicAuthenticationDTO; - /** - * - * @type {string} - * @memberof WebhookPropertiesDTO - */ - 'bearerAuthentication'?: string; - /** - * - * @type {string} - * @memberof WebhookPropertiesDTO - */ - 'secretToken'?: string; -} - - -/** - * - * @export - * @interface X509Certificate - */ -export interface X509Certificate { - /** - * - * @type {string} - * @memberof X509Certificate - */ - 'id'?: string; - /** - * - * @type {string} - * @memberof X509Certificate - */ - 'subject_dn': string; - /** - * - * @type {string} - * @memberof X509Certificate - */ - 'source_environment': string; - /** - * - * @type {string} - * @memberof X509Certificate - */ - 'bundle': string; - /** - * - * @type {string} - * @memberof X509Certificate - */ - 'application': string; -} diff --git a/packages/patch/api.ts b/packages/patch/api.ts index f3250d81c..93f3256c8 100644 --- a/packages/patch/api.ts +++ b/packages/patch/api.ts @@ -3,7 +3,7 @@ * Patchman-engine API * API of the Patch application on [console.redhat.com](https://console.redhat.com) Syntax of the `filter[name]` query parameters is described in [Filters documentation](https://github.com/RedHatInsights/patchman-engine/wiki/API-custom-filters) * - * The version of the OpenAPI document: v3.7.10 + * The version of the OpenAPI document: v3.7.39 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/packages/patch/base.ts b/packages/patch/base.ts index f92c202ea..b9674f2c2 100644 --- a/packages/patch/base.ts +++ b/packages/patch/base.ts @@ -3,7 +3,7 @@ * Patchman-engine API * API of the Patch application on [console.redhat.com](https://console.redhat.com) Syntax of the `filter[name]` query parameters is described in [Filters documentation](https://github.com/RedHatInsights/patchman-engine/wiki/API-custom-filters) * - * The version of the OpenAPI document: v3.7.10 + * The version of the OpenAPI document: v3.7.39 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/packages/patch/configuration.ts b/packages/patch/configuration.ts index 0133d084f..3c4ef2fea 100644 --- a/packages/patch/configuration.ts +++ b/packages/patch/configuration.ts @@ -3,7 +3,7 @@ * Patchman-engine API * API of the Patch application on [console.redhat.com](https://console.redhat.com) Syntax of the `filter[name]` query parameters is described in [Filters documentation](https://github.com/RedHatInsights/patchman-engine/wiki/API-custom-filters) * - * The version of the OpenAPI document: v3.7.10 + * The version of the OpenAPI document: v3.7.39 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/packages/patch/index.ts b/packages/patch/index.ts index 8e324b212..5af4cc390 100644 --- a/packages/patch/index.ts +++ b/packages/patch/index.ts @@ -3,7 +3,7 @@ * Patchman-engine API * API of the Patch application on [console.redhat.com](https://console.redhat.com) Syntax of the `filter[name]` query parameters is described in [Filters documentation](https://github.com/RedHatInsights/patchman-engine/wiki/API-custom-filters) * - * The version of the OpenAPI document: v3.7.10 + * The version of the OpenAPI document: v3.7.39 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/packages/rbac/configuration.ts b/packages/rbac/configuration.ts index 366d85db5..ef3873ad4 100644 --- a/packages/rbac/configuration.ts +++ b/packages/rbac/configuration.ts @@ -1,5 +1,17 @@ /* tslint:disable */ /* eslint-disable */ +/** + * Role Based Access Control + * The API for Role Based Access Control. + * + * The version of the OpenAPI document: 1.0.0 + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + export interface ConfigurationParameters { apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); diff --git a/packages/rbac/v2/configuration.ts b/packages/rbac/v2/configuration.ts index 366d85db5..6d1f7af77 100644 --- a/packages/rbac/v2/configuration.ts +++ b/packages/rbac/v2/configuration.ts @@ -1,5 +1,17 @@ /* tslint:disable */ /* eslint-disable */ +/** + * Role Based Access Control for Kessel Project + * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * + * The version of the OpenAPI document: v2 + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + export interface ConfigurationParameters { apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); diff --git a/packages/vulnerabilities/api.ts b/packages/vulnerabilities/api.ts index f62147ea2..cf3c43762 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.41.4 + * The version of the OpenAPI document: 2.42.4 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -2169,56 +2169,6 @@ export interface MetaVulnerabilitiesOutAllOfSystemCountPerType { */ edge?: number | null; } -/** - * - * @export - * @interface MitigatedSystemsIdsOut - */ -export interface MitigatedSystemsIdsOut { - /** - * - * @type {string | Array} - * @memberof MitigatedSystemsIdsOut - */ - data: string | Array; - /** - * - * @type {Links} - * @memberof MitigatedSystemsIdsOut - */ - links: Links; - /** - * - * @type {MetaAffectedSystems} - * @memberof MitigatedSystemsIdsOut - */ - meta: MetaAffectedSystems; -} -/** - * - * @export - * @interface MitigatedSystemsOut - */ -export interface MitigatedSystemsOut { - /** - * - * @type {string | Array} - * @memberof MitigatedSystemsOut - */ - data: string | Array; - /** - * - * @type {Links} - * @memberof MitigatedSystemsOut - */ - links: Links; - /** - * - * @type {MetaAffectedSystems} - * @memberof MitigatedSystemsOut - */ - meta: MetaAffectedSystems; -} /** * * @export @@ -2538,6 +2488,12 @@ export interface SystemDetailsOutData { * @memberof SystemDetailsOutData */ os: string; + /** + * System is locked to following RHSM version. + * @type {string} + * @memberof SystemDetailsOutData + */ + rhsm_lock: string | null; /** * * @type {Array} diff --git a/packages/vulnerabilities/apiSpec.json b/packages/vulnerabilities/apiSpec.json index a614c8289..875a3b224 100644 --- a/packages/vulnerabilities/apiSpec.json +++ b/packages/vulnerabilities/apiSpec.json @@ -1 +1 @@ -{"openapi":"3.0.0","info":{"title":"Vulnerability Engine Manager","version":"2.41.4"},"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"}}}}}}},"/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"}]}},"/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"}]}},"/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"}]}},"/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"}]}},"/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"}]}},"/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 \"edge\" returns CVEs with one or more vulnerable immutable 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","edge","none"]},"maxItems":3},"example":"edge,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, \"edge\" for OSTree systems.","schema":{"type":"array","items":{"type":"string","enum":["rpmdnf","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},"edge":{"type":"number","description":"Number of immutable systems.","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}},"required":["affecting","business_risk_id","cvss_from","cvss_to","public_from","public_to","impact","rhel_version","rule_presence","cves_without_errata","advisory_available"]}]},"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]},"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},"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"]}}},"required":["cve_status_id","culled_timestamp","display_name","first_reported","inventory_id","insights_id","last_evaluation","os","reporter","rule","rules_evaluation","stale_timestamp","stale_warning_timestamp","status_id","status_name","status_text","tags","updated","advisory_available","remediation","mitigation_reason","inventory_group"]}},"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"]},"MitigatedSystemsOut":{"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},"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},"mitigation_reason":{"type":"string","description":"Reason why the system is not vulnerable","example":"SELinux mitigates the issue"},"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]},"rule_id":{"type":"string","example":"CVE_2017_14491_dnsmasq|CVE_2017_14491_ERROR","description":"ID(s) of associated security rule(s).."},"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},"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":["cve_status_id","culled_timestamp","display_name","inventory_id","insights_id","last_evaluation","mitigation_reason","os","reporter","rules_evaluation","stale_timestamp","stale_warning_timestamp","status_id","status_name","status_text","tags","updated","advisory_available","remediation"]}},"required":["id","type","attributes"]}}]},"links":{"$ref":"#/components/schemas/Links"},"meta":{"$ref":"#/components/schemas/MetaAffectedSystems"}},"required":["data","links","meta"]},"MitigatedSystemsIdsOut":{"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}},"required":["inventory_id","rule_id","status_id","status_text"]}}]},"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},"edge":{"type":"number","description":"Number of immutable systems.","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"]},"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"},"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"]}}},"required":["last_evaluation","rules_evaluation","opt_out","last_upload","tags","os"]},"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"},"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"]}}},"required":["cve_count","display_name","inventory_id","insights_id","last_evaluation","rules_evaluation","opt_out","last_upload","os","stale_timestamp","stale_warning_timestamp","tags","culled_timestamp","inventory_group"]}},"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}},"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"]}},"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.42.4"},"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"}}}}}}},"/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"}]}},"/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"}]}},"/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"}]}},"/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"}]}},"/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"}]}},"/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 \"edge\" returns CVEs with one or more vulnerable immutable 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","edge","none"]},"maxItems":3},"example":"edge,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, \"edge\" for OSTree systems.","schema":{"type":"array","items":{"type":"string","enum":["rpmdnf","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},"edge":{"type":"number","description":"Number of immutable systems.","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}},"required":["affecting","business_risk_id","cvss_from","cvss_to","public_from","public_to","impact","rhel_version","rule_presence","cves_without_errata","advisory_available"]}]},"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},"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"]}}},"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"]}},"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},"edge":{"type":"number","description":"Number of immutable systems.","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"]},"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"]}}},"required":["last_evaluation","rules_evaluation","opt_out","last_upload","tags","os","rhsm_lock"]},"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"]}}},"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"]}},"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}},"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"]}},"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 diff --git a/packages/vulnerabilities/base.ts b/packages/vulnerabilities/base.ts index 64deaaa5b..0331923ba 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.41.4 + * The version of the OpenAPI document: 2.42.4 * * * 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 baa9ed6f8..ba214e25c 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.41.4 + * The version of the OpenAPI document: 2.42.4 * * * 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 f62147ea2..cf3c43762 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.41.4 + * The version of the OpenAPI document: 2.42.4 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -2169,56 +2169,6 @@ export interface MetaVulnerabilitiesOutAllOfSystemCountPerType { */ edge?: number | null; } -/** - * - * @export - * @interface MitigatedSystemsIdsOut - */ -export interface MitigatedSystemsIdsOut { - /** - * - * @type {string | Array} - * @memberof MitigatedSystemsIdsOut - */ - data: string | Array; - /** - * - * @type {Links} - * @memberof MitigatedSystemsIdsOut - */ - links: Links; - /** - * - * @type {MetaAffectedSystems} - * @memberof MitigatedSystemsIdsOut - */ - meta: MetaAffectedSystems; -} -/** - * - * @export - * @interface MitigatedSystemsOut - */ -export interface MitigatedSystemsOut { - /** - * - * @type {string | Array} - * @memberof MitigatedSystemsOut - */ - data: string | Array; - /** - * - * @type {Links} - * @memberof MitigatedSystemsOut - */ - links: Links; - /** - * - * @type {MetaAffectedSystems} - * @memberof MitigatedSystemsOut - */ - meta: MetaAffectedSystems; -} /** * * @export @@ -2538,6 +2488,12 @@ export interface SystemDetailsOutData { * @memberof SystemDetailsOutData */ os: string; + /** + * System is locked to following RHSM version. + * @type {string} + * @memberof SystemDetailsOutData + */ + rhsm_lock: string | null; /** * * @type {Array} diff --git a/packages/vulnerabilities/git-api/base.ts b/packages/vulnerabilities/git-api/base.ts index 64deaaa5b..0331923ba 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.41.4 + * The version of the OpenAPI document: 2.42.4 * * * 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 baa9ed6f8..ba214e25c 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.41.4 + * The version of the OpenAPI document: 2.42.4 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/packages/vulnerabilities/git-api/doc/classes/DefaultApi.md b/packages/vulnerabilities/git-api/doc/classes/DefaultApi.md index 55eae73a1..31b79de3d 100644 --- a/packages/vulnerabilities/git-api/doc/classes/DefaultApi.md +++ b/packages/vulnerabilities/git-api/doc/classes/DefaultApi.md @@ -153,7 +153,7 @@ DefaultApi #### Defined in -[api.ts:6081](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L6081) +[api.ts:6037](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L6037) ___ @@ -214,7 +214,7 @@ DefaultApi #### Defined in -[api.ts:6121](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L6121) +[api.ts:6077](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L6077) ___ @@ -274,7 +274,7 @@ DefaultApi #### Defined in -[api.ts:6160](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L6160) +[api.ts:6116](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L6116) ___ @@ -306,7 +306,7 @@ DefaultApi #### Defined in -[api.ts:6171](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L6171) +[api.ts:6127](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L6127) ___ @@ -338,7 +338,7 @@ DefaultApi #### Defined in -[api.ts:6182](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L6182) +[api.ts:6138](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L6138) ___ @@ -370,7 +370,7 @@ DefaultApi #### Defined in -[api.ts:6193](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L6193) +[api.ts:6149](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L6149) ___ @@ -404,7 +404,7 @@ DefaultApi #### Defined in -[api.ts:6206](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L6206) +[api.ts:6162](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L6162) ___ @@ -460,7 +460,7 @@ DefaultApi #### Defined in -[api.ts:6241](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L6241) +[api.ts:6197](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L6197) ___ @@ -516,7 +516,7 @@ DefaultApi #### Defined in -[api.ts:6276](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L6276) +[api.ts:6232](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L6232) ___ @@ -577,7 +577,7 @@ DefaultApi #### Defined in -[api.ts:6316](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L6316) +[api.ts:6272](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L6272) ___ @@ -634,7 +634,7 @@ DefaultApi #### Defined in -[api.ts:6352](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L6352) +[api.ts:6308](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L6308) ___ @@ -673,7 +673,7 @@ DefaultApi #### Defined in -[api.ts:6370](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L6370) +[api.ts:6326](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L6326) ___ @@ -710,7 +710,7 @@ DefaultApi #### Defined in -[api.ts:6386](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L6386) +[api.ts:6342](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L6342) ___ @@ -747,7 +747,7 @@ DefaultApi #### Defined in -[api.ts:6402](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L6402) +[api.ts:6358](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L6358) ___ @@ -779,7 +779,7 @@ DefaultApi #### Defined in -[api.ts:6413](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L6413) +[api.ts:6369](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L6369) ___ @@ -812,7 +812,7 @@ DefaultApi #### Defined in -[api.ts:6425](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L6425) +[api.ts:6381](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L6381) ___ @@ -844,7 +844,7 @@ DefaultApi #### Defined in -[api.ts:6436](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L6436) +[api.ts:6392](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L6392) ___ @@ -877,7 +877,7 @@ DefaultApi #### Defined in -[api.ts:6448](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L6448) +[api.ts:6404](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L6404) ___ @@ -927,7 +927,7 @@ DefaultApi #### Defined in -[api.ts:6477](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L6477) +[api.ts:6433](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L6433) ___ @@ -978,7 +978,7 @@ DefaultApi #### Defined in -[api.ts:6507](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L6507) +[api.ts:6463](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L6463) ___ @@ -1010,7 +1010,7 @@ DefaultApi #### Defined in -[api.ts:6518](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L6518) +[api.ts:6474](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L6474) ___ @@ -1043,7 +1043,7 @@ DefaultApi #### Defined in -[api.ts:6530](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L6530) +[api.ts:6486](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L6486) ___ @@ -1076,7 +1076,7 @@ DefaultApi #### Defined in -[api.ts:6542](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L6542) +[api.ts:6498](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L6498) ___ @@ -1109,7 +1109,7 @@ DefaultApi #### Defined in -[api.ts:6554](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L6554) +[api.ts:6510](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L6510) ___ @@ -1142,7 +1142,7 @@ DefaultApi #### Defined in -[api.ts:6566](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L6566) +[api.ts:6522](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L6522) ___ @@ -1175,4 +1175,4 @@ DefaultApi #### Defined in -[api.ts:6578](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L6578) +[api.ts:6534](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L6534) diff --git a/packages/vulnerabilities/git-api/doc/interfaces/ConfigurationParameters.md b/packages/vulnerabilities/git-api/doc/interfaces/ConfigurationParameters.md index e9b4ca671..13311c472 100644 --- a/packages/vulnerabilities/git-api/doc/interfaces/ConfigurationParameters.md +++ b/packages/vulnerabilities/git-api/doc/interfaces/ConfigurationParameters.md @@ -5,7 +5,7 @@ Vulnerability Engine Manager No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) -The version of the OpenAPI document: 2.41.4 +The version of the OpenAPI document: 2.42.4 NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech diff --git a/packages/vulnerabilities/git-api/doc/interfaces/MitigatedSystemsIdsOut.md b/packages/vulnerabilities/git-api/doc/interfaces/MitigatedSystemsIdsOut.md deleted file mode 100644 index 34e39a19d..000000000 --- a/packages/vulnerabilities/git-api/doc/interfaces/MitigatedSystemsIdsOut.md +++ /dev/null @@ -1,57 +0,0 @@ -[@redhat-cloud-services/vulnerabilities-client](../README.md) / [Exports](../modules.md) / MitigatedSystemsIdsOut - -# Interface: MitigatedSystemsIdsOut - -**`Export`** - -MitigatedSystemsIdsOut - -## Table of contents - -### Properties - -- [data](MitigatedSystemsIdsOut.md#data) -- [links](MitigatedSystemsIdsOut.md#links) -- [meta](MitigatedSystemsIdsOut.md#meta) - -## Properties - -### data - -• **data**: `string` \| `object`[] - -**`Memberof`** - -MitigatedSystemsIdsOut - -#### Defined in - -[api.ts:2183](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L2183) - -___ - -### links - -• **links**: [`Links`](Links.md) - -**`Memberof`** - -MitigatedSystemsIdsOut - -#### Defined in - -[api.ts:2189](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L2189) - -___ - -### meta - -• **meta**: [`MetaAffectedSystems`](MetaAffectedSystems.md) - -**`Memberof`** - -MitigatedSystemsIdsOut - -#### Defined in - -[api.ts:2195](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L2195) diff --git a/packages/vulnerabilities/git-api/doc/interfaces/MitigatedSystemsOut.md b/packages/vulnerabilities/git-api/doc/interfaces/MitigatedSystemsOut.md deleted file mode 100644 index c8b616be7..000000000 --- a/packages/vulnerabilities/git-api/doc/interfaces/MitigatedSystemsOut.md +++ /dev/null @@ -1,57 +0,0 @@ -[@redhat-cloud-services/vulnerabilities-client](../README.md) / [Exports](../modules.md) / MitigatedSystemsOut - -# Interface: MitigatedSystemsOut - -**`Export`** - -MitigatedSystemsOut - -## Table of contents - -### Properties - -- [data](MitigatedSystemsOut.md#data) -- [links](MitigatedSystemsOut.md#links) -- [meta](MitigatedSystemsOut.md#meta) - -## Properties - -### data - -• **data**: `string` \| `object`[] - -**`Memberof`** - -MitigatedSystemsOut - -#### Defined in - -[api.ts:2208](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L2208) - -___ - -### links - -• **links**: [`Links`](Links.md) - -**`Memberof`** - -MitigatedSystemsOut - -#### Defined in - -[api.ts:2214](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L2214) - -___ - -### meta - -• **meta**: [`MetaAffectedSystems`](MetaAffectedSystems.md) - -**`Memberof`** - -MitigatedSystemsOut - -#### Defined in - -[api.ts:2220](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L2220) diff --git a/packages/vulnerabilities/git-api/doc/interfaces/NotificationsOut.md b/packages/vulnerabilities/git-api/doc/interfaces/NotificationsOut.md index ead2eaa48..a82f7dbaf 100644 --- a/packages/vulnerabilities/git-api/doc/interfaces/NotificationsOut.md +++ b/packages/vulnerabilities/git-api/doc/interfaces/NotificationsOut.md @@ -26,4 +26,4 @@ NotificationsOut #### Defined in -[api.ts:2233](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L2233) +[api.ts:2183](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L2183) diff --git a/packages/vulnerabilities/git-api/doc/interfaces/OptOutIn.md b/packages/vulnerabilities/git-api/doc/interfaces/OptOutIn.md index cba4ef9e1..cd033c638 100644 --- a/packages/vulnerabilities/git-api/doc/interfaces/OptOutIn.md +++ b/packages/vulnerabilities/git-api/doc/interfaces/OptOutIn.md @@ -25,7 +25,7 @@ OptOutIn #### Defined in -[api.ts:2246](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L2246) +[api.ts:2196](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L2196) ___ @@ -41,4 +41,4 @@ OptOutIn #### Defined in -[api.ts:2252](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L2252) +[api.ts:2202](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L2202) diff --git a/packages/vulnerabilities/git-api/doc/interfaces/PlaybookTemplate.md b/packages/vulnerabilities/git-api/doc/interfaces/PlaybookTemplate.md index 8281d8eeb..9607ba6a5 100644 --- a/packages/vulnerabilities/git-api/doc/interfaces/PlaybookTemplate.md +++ b/packages/vulnerabilities/git-api/doc/interfaces/PlaybookTemplate.md @@ -24,4 +24,4 @@ PlaybookTemplate #### Defined in -[api.ts:2265](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L2265) +[api.ts:2215](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L2215) diff --git a/packages/vulnerabilities/git-api/doc/interfaces/PlaybookTemplateData.md b/packages/vulnerabilities/git-api/doc/interfaces/PlaybookTemplateData.md index 04e66637a..fa2d56ebc 100644 --- a/packages/vulnerabilities/git-api/doc/interfaces/PlaybookTemplateData.md +++ b/packages/vulnerabilities/git-api/doc/interfaces/PlaybookTemplateData.md @@ -30,7 +30,7 @@ PlaybookTemplateData #### Defined in -[api.ts:2278](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L2278) +[api.ts:2228](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L2228) ___ @@ -46,7 +46,7 @@ PlaybookTemplateData #### Defined in -[api.ts:2284](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L2284) +[api.ts:2234](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L2234) ___ @@ -62,7 +62,7 @@ PlaybookTemplateData #### Defined in -[api.ts:2296](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L2296) +[api.ts:2246](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L2246) ___ @@ -78,7 +78,7 @@ PlaybookTemplateData #### Defined in -[api.ts:2302](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L2302) +[api.ts:2252](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L2252) ___ @@ -94,4 +94,4 @@ PlaybookTemplateData #### Defined in -[api.ts:2290](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L2290) +[api.ts:2240](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L2240) diff --git a/packages/vulnerabilities/git-api/doc/interfaces/StatusIn.md b/packages/vulnerabilities/git-api/doc/interfaces/StatusIn.md index 646414c66..e8b5311f6 100644 --- a/packages/vulnerabilities/git-api/doc/interfaces/StatusIn.md +++ b/packages/vulnerabilities/git-api/doc/interfaces/StatusIn.md @@ -27,7 +27,7 @@ StatusIn #### Defined in -[api.ts:2321](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L2321) +[api.ts:2271](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L2271) ___ @@ -41,7 +41,7 @@ StatusIn #### Defined in -[api.ts:2315](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L2315) +[api.ts:2265](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L2265) ___ @@ -57,7 +57,7 @@ StatusIn #### Defined in -[api.ts:2327](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L2327) +[api.ts:2277](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L2277) ___ @@ -73,4 +73,4 @@ StatusIn #### Defined in -[api.ts:2333](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L2333) +[api.ts:2283](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L2283) diff --git a/packages/vulnerabilities/git-api/doc/interfaces/StatusListOut.md b/packages/vulnerabilities/git-api/doc/interfaces/StatusListOut.md index aa51f745d..77b81faf3 100644 --- a/packages/vulnerabilities/git-api/doc/interfaces/StatusListOut.md +++ b/packages/vulnerabilities/git-api/doc/interfaces/StatusListOut.md @@ -27,7 +27,7 @@ StatusListOut #### Defined in -[api.ts:2346](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L2346) +[api.ts:2296](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L2296) ___ @@ -41,4 +41,4 @@ StatusListOut #### Defined in -[api.ts:2352](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L2352) +[api.ts:2302](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L2302) diff --git a/packages/vulnerabilities/git-api/doc/interfaces/StatusListOutData.md b/packages/vulnerabilities/git-api/doc/interfaces/StatusListOutData.md index 69006f508..3e58b4cff 100644 --- a/packages/vulnerabilities/git-api/doc/interfaces/StatusListOutData.md +++ b/packages/vulnerabilities/git-api/doc/interfaces/StatusListOutData.md @@ -27,7 +27,7 @@ StatusListOutData #### Defined in -[api.ts:2365](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L2365) +[api.ts:2315](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L2315) ___ @@ -43,4 +43,4 @@ StatusListOutData #### Defined in -[api.ts:2371](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L2371) +[api.ts:2321](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L2321) diff --git a/packages/vulnerabilities/git-api/doc/interfaces/StatusListOutMeta.md b/packages/vulnerabilities/git-api/doc/interfaces/StatusListOutMeta.md index c14edffef..6c5db7f09 100644 --- a/packages/vulnerabilities/git-api/doc/interfaces/StatusListOutMeta.md +++ b/packages/vulnerabilities/git-api/doc/interfaces/StatusListOutMeta.md @@ -26,4 +26,4 @@ StatusListOutMeta #### Defined in -[api.ts:2384](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L2384) +[api.ts:2334](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L2334) diff --git a/packages/vulnerabilities/git-api/doc/interfaces/StatusOut.md b/packages/vulnerabilities/git-api/doc/interfaces/StatusOut.md index 2ee5a517e..6a6f0be16 100644 --- a/packages/vulnerabilities/git-api/doc/interfaces/StatusOut.md +++ b/packages/vulnerabilities/git-api/doc/interfaces/StatusOut.md @@ -25,7 +25,7 @@ StatusOut #### Defined in -[api.ts:2403](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L2403) +[api.ts:2353](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L2353) ___ @@ -41,4 +41,4 @@ StatusOut #### Defined in -[api.ts:2397](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L2397) +[api.ts:2347](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L2347) diff --git a/packages/vulnerabilities/git-api/doc/interfaces/StatusOutUpdated.md b/packages/vulnerabilities/git-api/doc/interfaces/StatusOutUpdated.md index acc4b0eee..d6aca8d03 100644 --- a/packages/vulnerabilities/git-api/doc/interfaces/StatusOutUpdated.md +++ b/packages/vulnerabilities/git-api/doc/interfaces/StatusOutUpdated.md @@ -25,7 +25,7 @@ StatusOutUpdated #### Defined in -[api.ts:2422](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L2422) +[api.ts:2372](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L2372) ___ @@ -39,4 +39,4 @@ StatusOutUpdated #### Defined in -[api.ts:2416](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L2416) +[api.ts:2366](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L2366) diff --git a/packages/vulnerabilities/git-api/doc/interfaces/SystemCvesIdsOut.md b/packages/vulnerabilities/git-api/doc/interfaces/SystemCvesIdsOut.md index 1d462f7cf..ff05e0723 100644 --- a/packages/vulnerabilities/git-api/doc/interfaces/SystemCvesIdsOut.md +++ b/packages/vulnerabilities/git-api/doc/interfaces/SystemCvesIdsOut.md @@ -26,7 +26,7 @@ SystemCvesIdsOut #### Defined in -[api.ts:2435](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L2435) +[api.ts:2385](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L2385) ___ @@ -40,7 +40,7 @@ SystemCvesIdsOut #### Defined in -[api.ts:2441](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L2441) +[api.ts:2391](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L2391) ___ @@ -54,4 +54,4 @@ SystemCvesIdsOut #### Defined in -[api.ts:2447](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L2447) +[api.ts:2397](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L2397) diff --git a/packages/vulnerabilities/git-api/doc/interfaces/SystemCvesOut.md b/packages/vulnerabilities/git-api/doc/interfaces/SystemCvesOut.md index 2c5d63c6f..27940a9ba 100644 --- a/packages/vulnerabilities/git-api/doc/interfaces/SystemCvesOut.md +++ b/packages/vulnerabilities/git-api/doc/interfaces/SystemCvesOut.md @@ -26,7 +26,7 @@ SystemCvesOut #### Defined in -[api.ts:2460](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L2460) +[api.ts:2410](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L2410) ___ @@ -40,7 +40,7 @@ SystemCvesOut #### Defined in -[api.ts:2466](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L2466) +[api.ts:2416](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L2416) ___ @@ -54,4 +54,4 @@ SystemCvesOut #### Defined in -[api.ts:2472](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L2472) +[api.ts:2422](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L2422) diff --git a/packages/vulnerabilities/git-api/doc/interfaces/SystemDetailsOut.md b/packages/vulnerabilities/git-api/doc/interfaces/SystemDetailsOut.md index 39dfc1981..857ed8ed7 100644 --- a/packages/vulnerabilities/git-api/doc/interfaces/SystemDetailsOut.md +++ b/packages/vulnerabilities/git-api/doc/interfaces/SystemDetailsOut.md @@ -25,7 +25,7 @@ SystemDetailsOut #### Defined in -[api.ts:2485](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L2485) +[api.ts:2435](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L2435) ___ @@ -39,4 +39,4 @@ SystemDetailsOut #### Defined in -[api.ts:2491](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L2491) +[api.ts:2441](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L2441) diff --git a/packages/vulnerabilities/git-api/doc/interfaces/SystemDetailsOutData.md b/packages/vulnerabilities/git-api/doc/interfaces/SystemDetailsOutData.md index a5c9e4b1c..76b1f6479 100644 --- a/packages/vulnerabilities/git-api/doc/interfaces/SystemDetailsOutData.md +++ b/packages/vulnerabilities/git-api/doc/interfaces/SystemDetailsOutData.md @@ -14,6 +14,7 @@ SystemDetailsOutData - [last\_upload](SystemDetailsOutData.md#last_upload) - [opt\_out](SystemDetailsOutData.md#opt_out) - [os](SystemDetailsOutData.md#os) +- [rhsm\_lock](SystemDetailsOutData.md#rhsm_lock) - [rules\_evaluation](SystemDetailsOutData.md#rules_evaluation) - [stale](SystemDetailsOutData.md#stale) - [tags](SystemDetailsOutData.md#tags) @@ -33,7 +34,7 @@ SystemDetailsOutData #### Defined in -[api.ts:2504](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L2504) +[api.ts:2454](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L2454) ___ @@ -49,7 +50,7 @@ SystemDetailsOutData #### Defined in -[api.ts:2522](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L2522) +[api.ts:2472](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L2472) ___ @@ -65,7 +66,7 @@ SystemDetailsOutData #### Defined in -[api.ts:2516](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L2516) +[api.ts:2466](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L2466) ___ @@ -81,7 +82,23 @@ SystemDetailsOutData #### Defined in -[api.ts:2540](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L2540) +[api.ts:2490](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L2490) + +___ + +### rhsm\_lock + +• **rhsm\_lock**: ``null`` \| `string` + +System is locked to following RHSM version. + +**`Memberof`** + +SystemDetailsOutData + +#### Defined in + +[api.ts:2496](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L2496) ___ @@ -97,7 +114,7 @@ SystemDetailsOutData #### Defined in -[api.ts:2510](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L2510) +[api.ts:2460](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L2460) ___ @@ -113,7 +130,7 @@ SystemDetailsOutData #### Defined in -[api.ts:2528](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L2528) +[api.ts:2478](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L2478) ___ @@ -127,7 +144,7 @@ SystemDetailsOutData #### Defined in -[api.ts:2546](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L2546) +[api.ts:2502](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L2502) ___ @@ -143,4 +160,4 @@ SystemDetailsOutData #### Defined in -[api.ts:2534](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L2534) +[api.ts:2484](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L2484) diff --git a/packages/vulnerabilities/git-api/doc/interfaces/SystemDetailsOutDataTags.md b/packages/vulnerabilities/git-api/doc/interfaces/SystemDetailsOutDataTags.md index 3e0286552..a9b7fd9b7 100644 --- a/packages/vulnerabilities/git-api/doc/interfaces/SystemDetailsOutDataTags.md +++ b/packages/vulnerabilities/git-api/doc/interfaces/SystemDetailsOutDataTags.md @@ -28,7 +28,7 @@ SystemDetailsOutDataTags #### Defined in -[api.ts:2565](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L2565) +[api.ts:2521](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L2521) ___ @@ -44,7 +44,7 @@ SystemDetailsOutDataTags #### Defined in -[api.ts:2559](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L2559) +[api.ts:2515](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L2515) ___ @@ -60,4 +60,4 @@ SystemDetailsOutDataTags #### Defined in -[api.ts:2571](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L2571) +[api.ts:2527](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L2527) diff --git a/packages/vulnerabilities/git-api/doc/interfaces/SystemIdsOut.md b/packages/vulnerabilities/git-api/doc/interfaces/SystemIdsOut.md index 29982eb8e..7e9155a6f 100644 --- a/packages/vulnerabilities/git-api/doc/interfaces/SystemIdsOut.md +++ b/packages/vulnerabilities/git-api/doc/interfaces/SystemIdsOut.md @@ -26,7 +26,7 @@ SystemIdsOut #### Defined in -[api.ts:2584](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L2584) +[api.ts:2540](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L2540) ___ @@ -40,7 +40,7 @@ SystemIdsOut #### Defined in -[api.ts:2590](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L2590) +[api.ts:2546](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L2546) ___ @@ -54,4 +54,4 @@ SystemIdsOut #### Defined in -[api.ts:2596](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L2596) +[api.ts:2552](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L2552) diff --git a/packages/vulnerabilities/git-api/doc/interfaces/SystemListOut.md b/packages/vulnerabilities/git-api/doc/interfaces/SystemListOut.md index de1b3e31b..1c0e9c021 100644 --- a/packages/vulnerabilities/git-api/doc/interfaces/SystemListOut.md +++ b/packages/vulnerabilities/git-api/doc/interfaces/SystemListOut.md @@ -26,7 +26,7 @@ SystemListOut #### Defined in -[api.ts:2609](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L2609) +[api.ts:2565](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L2565) ___ @@ -40,7 +40,7 @@ SystemListOut #### Defined in -[api.ts:2615](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L2615) +[api.ts:2571](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L2571) ___ @@ -54,4 +54,4 @@ SystemListOut #### Defined in -[api.ts:2621](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L2621) +[api.ts:2577](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L2577) diff --git a/packages/vulnerabilities/git-api/doc/interfaces/VersionOut.md b/packages/vulnerabilities/git-api/doc/interfaces/VersionOut.md index f3051102b..f1722c9c2 100644 --- a/packages/vulnerabilities/git-api/doc/interfaces/VersionOut.md +++ b/packages/vulnerabilities/git-api/doc/interfaces/VersionOut.md @@ -27,7 +27,7 @@ VersionOut #### Defined in -[api.ts:2634](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L2634) +[api.ts:2590](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L2590) ___ @@ -43,4 +43,4 @@ VersionOut #### Defined in -[api.ts:2640](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L2640) +[api.ts:2596](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L2596) diff --git a/packages/vulnerabilities/git-api/doc/interfaces/VulnerabilitiesIdsOut.md b/packages/vulnerabilities/git-api/doc/interfaces/VulnerabilitiesIdsOut.md index 644275dfd..355ae4383 100644 --- a/packages/vulnerabilities/git-api/doc/interfaces/VulnerabilitiesIdsOut.md +++ b/packages/vulnerabilities/git-api/doc/interfaces/VulnerabilitiesIdsOut.md @@ -26,7 +26,7 @@ VulnerabilitiesIdsOut #### Defined in -[api.ts:2653](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L2653) +[api.ts:2609](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L2609) ___ @@ -40,7 +40,7 @@ VulnerabilitiesIdsOut #### Defined in -[api.ts:2659](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L2659) +[api.ts:2615](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L2615) ___ @@ -54,4 +54,4 @@ VulnerabilitiesIdsOut #### Defined in -[api.ts:2665](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L2665) +[api.ts:2621](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L2621) diff --git a/packages/vulnerabilities/git-api/doc/interfaces/VulnerabilitiesOut.md b/packages/vulnerabilities/git-api/doc/interfaces/VulnerabilitiesOut.md index 18df2f712..f03be4d19 100644 --- a/packages/vulnerabilities/git-api/doc/interfaces/VulnerabilitiesOut.md +++ b/packages/vulnerabilities/git-api/doc/interfaces/VulnerabilitiesOut.md @@ -26,7 +26,7 @@ VulnerabilitiesOut #### Defined in -[api.ts:2678](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L2678) +[api.ts:2634](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L2634) ___ @@ -40,7 +40,7 @@ VulnerabilitiesOut #### Defined in -[api.ts:2684](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L2684) +[api.ts:2640](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L2640) ___ @@ -54,4 +54,4 @@ VulnerabilitiesOut #### Defined in -[api.ts:2690](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L2690) +[api.ts:2646](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L2646) diff --git a/packages/vulnerabilities/git-api/doc/interfaces/VulnerabilitiesPostIn.md b/packages/vulnerabilities/git-api/doc/interfaces/VulnerabilitiesPostIn.md index 946f04a30..fbbe012f1 100644 --- a/packages/vulnerabilities/git-api/doc/interfaces/VulnerabilitiesPostIn.md +++ b/packages/vulnerabilities/git-api/doc/interfaces/VulnerabilitiesPostIn.md @@ -26,4 +26,4 @@ VulnerabilitiesPostIn #### Defined in -[api.ts:2703](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L2703) +[api.ts:2659](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L2659) diff --git a/packages/vulnerabilities/git-api/doc/interfaces/VulnerabilitiesPostOut.md b/packages/vulnerabilities/git-api/doc/interfaces/VulnerabilitiesPostOut.md index 2086980a9..c356e3367 100644 --- a/packages/vulnerabilities/git-api/doc/interfaces/VulnerabilitiesPostOut.md +++ b/packages/vulnerabilities/git-api/doc/interfaces/VulnerabilitiesPostOut.md @@ -26,7 +26,7 @@ VulnerabilitiesPostOut #### Defined in -[api.ts:2716](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L2716) +[api.ts:2672](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L2672) ___ @@ -40,7 +40,7 @@ VulnerabilitiesPostOut #### Defined in -[api.ts:2722](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L2722) +[api.ts:2678](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L2678) ___ @@ -54,4 +54,4 @@ VulnerabilitiesPostOut #### Defined in -[api.ts:2728](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L2728) +[api.ts:2684](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L2684) diff --git a/packages/vulnerabilities/git-api/doc/interfaces/VulnerabilitiesPostOutAttributes.md b/packages/vulnerabilities/git-api/doc/interfaces/VulnerabilitiesPostOutAttributes.md index 8e26b121f..69a920cd7 100644 --- a/packages/vulnerabilities/git-api/doc/interfaces/VulnerabilitiesPostOutAttributes.md +++ b/packages/vulnerabilities/git-api/doc/interfaces/VulnerabilitiesPostOutAttributes.md @@ -28,7 +28,7 @@ VulnerabilitiesPostOutAttributes #### Defined in -[api.ts:2741](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L2741) +[api.ts:2697](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L2697) ___ @@ -44,7 +44,7 @@ VulnerabilitiesPostOutAttributes #### Defined in -[api.ts:2747](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L2747) +[api.ts:2703](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L2703) ___ @@ -60,4 +60,4 @@ VulnerabilitiesPostOutAttributes #### Defined in -[api.ts:2753](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L2753) +[api.ts:2709](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L2709) diff --git a/packages/vulnerabilities/git-api/doc/interfaces/VulnerabilitiesPostOutData.md b/packages/vulnerabilities/git-api/doc/interfaces/VulnerabilitiesPostOutData.md index 4fcef087b..ff2b9c377 100644 --- a/packages/vulnerabilities/git-api/doc/interfaces/VulnerabilitiesPostOutData.md +++ b/packages/vulnerabilities/git-api/doc/interfaces/VulnerabilitiesPostOutData.md @@ -26,7 +26,7 @@ VulnerabilitiesPostOutData #### Defined in -[api.ts:2778](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L2778) +[api.ts:2734](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L2734) ___ @@ -42,7 +42,7 @@ VulnerabilitiesPostOutData #### Defined in -[api.ts:2766](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L2766) +[api.ts:2722](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L2722) ___ @@ -58,4 +58,4 @@ VulnerabilitiesPostOutData #### Defined in -[api.ts:2772](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L2772) +[api.ts:2728](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L2728) diff --git a/packages/vulnerabilities/git-api/doc/modules.md b/packages/vulnerabilities/git-api/doc/modules.md index cd2a076d4..7edec0dae 100644 --- a/packages/vulnerabilities/git-api/doc/modules.md +++ b/packages/vulnerabilities/git-api/doc/modules.md @@ -62,8 +62,6 @@ - [MetaVulnerabilitiesOut](interfaces/MetaVulnerabilitiesOut.md) - [MetaVulnerabilitiesOutAllOf](interfaces/MetaVulnerabilitiesOutAllOf.md) - [MetaVulnerabilitiesOutAllOfSystemCountPerType](interfaces/MetaVulnerabilitiesOutAllOfSystemCountPerType.md) -- [MitigatedSystemsIdsOut](interfaces/MitigatedSystemsIdsOut.md) -- [MitigatedSystemsOut](interfaces/MitigatedSystemsOut.md) - [NotificationsOut](interfaces/NotificationsOut.md) - [OptOutIn](interfaces/OptOutIn.md) - [PlaybookTemplate](interfaces/PlaybookTemplate.md) @@ -175,7 +173,7 @@ DefaultApi - axios parameter creator #### Defined in -[api.ts:2785](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L2785) +[api.ts:2741](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L2741) ___ @@ -230,7 +228,7 @@ DefaultApi - factory interface #### Defined in -[api.ts:5606](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L5606) +[api.ts:5562](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L5562) ___ @@ -283,4 +281,4 @@ DefaultApi - functional programming interface #### Defined in -[api.ts:5037](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L5037) +[api.ts:4993](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/vulnerabilities/git-api/api.ts#L4993) diff --git a/packages/vulnerabilities/git-api/index.ts b/packages/vulnerabilities/git-api/index.ts index a9b437b42..74e9f831a 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.41.4 + * The version of the OpenAPI document: 2.42.4 * * * 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 f22bc6d15..936d02fd6 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.41.4 + * The version of the OpenAPI document: 2.42.4 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).