github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-06-27 18:51:07 -04:00
Code Issues Projects Releases Packages Wiki Activity
kibana/api_docs/security_solution.devdocs.json

3058 lines
No EOL
111 KiB
JSON
Raw Blame History

{
"id": "securitySolution",
"client": {
"classes": [
{
"parentPluginId": "securitySolution",
"id": "def-public.Plugin",
"type": "Class",
"tags": [],
"label": "Plugin",
"description": [],
"signature": [
{
"pluginId": "securitySolution",
"scope": "public",
"docId": "kibSecuritySolutionPluginApi",
"section": "def-public.Plugin",
"text": "Plugin"
},
" implements ",
{
"pluginId": "@kbn/core-plugins-browser",
"scope": "common",
"docId": "kibKbnCorePluginsBrowserPluginApi",
"section": "def-common.Plugin",
"text": "Plugin"
},
"<",
{
"pluginId": "securitySolution",
"scope": "public",
"docId": "kibSecuritySolutionPluginApi",
"section": "def-public.PluginSetup",
"text": "PluginSetup"
},
", ",
{
"pluginId": "securitySolution",
"scope": "public",
"docId": "kibSecuritySolutionPluginApi",
"section": "def-public.PluginStart",
"text": "PluginStart"
},
", ",
"SetupPlugins",
", ",
"StartPlugins",
">"
],
"path": "x-pack/plugins/security_solution/public/plugin.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "securitySolution",
"id": "def-public.Plugin.kibanaBranch",
"type": "string",
"tags": [],
"label": "kibanaBranch",
"description": [
"\nThe current Kibana branch. e.g. 'main'"
],
"path": "x-pack/plugins/security_solution/public/plugin.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "securitySolution",
"id": "def-public.Plugin.kibanaVersion",
"type": "string",
"tags": [],
"label": "kibanaVersion",
"description": [
"\nThe current Kibana version. e.g. '8.0.0' or '8.0.0-SNAPSHOT'"
],
"path": "x-pack/plugins/security_solution/public/plugin.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "securitySolution",
"id": "def-public.Plugin.prebuiltRulesPackageVersion",
"type": "string",
"tags": [],
"label": "prebuiltRulesPackageVersion",
"description": [
"\nFor internal use. Specify which version of the Detection Rules fleet package to install\nwhen upgrading rules. If not provided, the latest compatible package will be installed,\nor if running from a dev environment or -SNAPSHOT build, the latest pre-release package\nwill be used (if fleet is available or not within an airgapped environment).\n\nNote: This is for `upgrade only`, which occurs by means of the `useUpgradeSecurityPackages`\nhook when navigating to a Security Solution page. The package version specified in\n`fleet_packages.json` in project root will always be installed first on Kibana start if\nthe package is not already installed."
],
"signature": [
"string | undefined"
],
"path": "x-pack/plugins/security_solution/public/plugin.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "securitySolution",
"id": "def-public.Plugin.experimentalFeatures",
"type": "Object",
"tags": [],
"label": "experimentalFeatures",
"description": [],
"signature": [
"{ readonly tGridEnabled: boolean; readonly tGridEventRenderedViewEnabled: boolean; readonly excludePoliciesInFilterEnabled: boolean; readonly kubernetesEnabled: boolean; readonly chartEmbeddablesEnabled: boolean; readonly donutChartEmbeddablesEnabled: boolean; readonly alertsPreviewChartEmbeddablesEnabled: boolean; readonly previewTelemetryUrlEnabled: boolean; readonly insightsRelatedAlertsByProcessAncestry: boolean; readonly extendedRuleExecutionLoggingEnabled: boolean; readonly socTrendsEnabled: boolean; readonly responseActionsEnabled: boolean; readonly endpointResponseActionsEnabled: boolean; readonly alertDetailsPageEnabled: boolean; readonly responseActionUploadEnabled: boolean; readonly alertsPageChartsEnabled: boolean; readonly alertTypeEnabled: boolean; readonly alertsPageFiltersEnabled: boolean; readonly newUserDetailsFlyout: boolean; readonly riskScoringPersistence: boolean; readonly riskScoringRoutesEnabled: boolean; readonly discoverInTimeline: boolean; readonly protectionUpdatesEnabled: boolean; }"
],
"path": "x-pack/plugins/security_solution/public/plugin.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "securitySolution",
"id": "def-public.Plugin.Unnamed",
"type": "Function",
"tags": [],
"label": "Constructor",
"description": [],
"signature": [
"any"
],
"path": "x-pack/plugins/security_solution/public/plugin.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "securitySolution",
"id": "def-public.Plugin.Unnamed.$1",
"type": "Object",
"tags": [],
"label": "initializerContext",
"description": [],
"signature": [
{
"pluginId": "@kbn/core-plugins-browser",
"scope": "common",
"docId": "kibKbnCorePluginsBrowserPluginApi",
"section": "def-common.PluginInitializerContext",
"text": "PluginInitializerContext"
},
"<object>"
],
"path": "x-pack/plugins/security_solution/public/plugin.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "securitySolution",
"id": "def-public.Plugin.setup",
"type": "Function",
"tags": [],
"label": "setup",
"description": [],
"signature": [
"(core: ",
{
"pluginId": "@kbn/core-lifecycle-browser",
"scope": "common",
"docId": "kibKbnCoreLifecycleBrowserPluginApi",
"section": "def-common.CoreSetup",
"text": "CoreSetup"
},
"<",
"StartPluginsDependencies",
", ",
{
"pluginId": "securitySolution",
"scope": "public",
"docId": "kibSecuritySolutionPluginApi",
"section": "def-public.PluginStart",
"text": "PluginStart"
},
">, plugins: ",
"SetupPlugins",
") => ",
{
"pluginId": "securitySolution",
"scope": "public",
"docId": "kibSecuritySolutionPluginApi",
"section": "def-public.PluginSetup",
"text": "PluginSetup"
}
],
"path": "x-pack/plugins/security_solution/public/plugin.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "securitySolution",
"id": "def-public.Plugin.setup.$1",
"type": "Object",
"tags": [],
"label": "core",
"description": [],
"signature": [
{
"pluginId": "@kbn/core-lifecycle-browser",
"scope": "common",
"docId": "kibKbnCoreLifecycleBrowserPluginApi",
"section": "def-common.CoreSetup",
"text": "CoreSetup"
},
"<",
"StartPluginsDependencies",
", ",
{
"pluginId": "securitySolution",
"scope": "public",
"docId": "kibSecuritySolutionPluginApi",
"section": "def-public.PluginStart",
"text": "PluginStart"
},
">"
],
"path": "x-pack/plugins/security_solution/public/plugin.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "securitySolution",
"id": "def-public.Plugin.setup.$2",
"type": "Object",
"tags": [],
"label": "plugins",
"description": [],
"signature": [
"SetupPlugins"
],
"path": "x-pack/plugins/security_solution/public/plugin.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "securitySolution",
"id": "def-public.Plugin.start",
"type": "Function",
"tags": [],
"label": "start",
"description": [],
"signature": [
"(core: ",
{
"pluginId": "@kbn/core-lifecycle-browser",
"scope": "common",
"docId": "kibKbnCoreLifecycleBrowserPluginApi",
"section": "def-common.CoreStart",
"text": "CoreStart"
},
", plugins: ",
"StartPlugins",
") => ",
{
"pluginId": "securitySolution",
"scope": "public",
"docId": "kibSecuritySolutionPluginApi",
"section": "def-public.PluginStart",
"text": "PluginStart"
}
],
"path": "x-pack/plugins/security_solution/public/plugin.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "securitySolution",
"id": "def-public.Plugin.start.$1",
"type": "Object",
"tags": [],
"label": "core",
"description": [],
"signature": [
{
"pluginId": "@kbn/core-lifecycle-browser",
"scope": "common",
"docId": "kibKbnCoreLifecycleBrowserPluginApi",
"section": "def-common.CoreStart",
"text": "CoreStart"
}
],
"path": "x-pack/plugins/security_solution/public/plugin.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "securitySolution",
"id": "def-public.Plugin.start.$2",
"type": "Object",
"tags": [],
"label": "plugins",
"description": [],
"signature": [
"StartPlugins"
],
"path": "x-pack/plugins/security_solution/public/plugin.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "securitySolution",
"id": "def-public.Plugin.stop",
"type": "Function",
"tags": [],
"label": "stop",
"description": [],
"signature": [
"() => {}"
],
"path": "x-pack/plugins/security_solution/public/plugin.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "securitySolution",
"id": "def-public.Plugin.registerAppLinks",
"type": "Function",
"tags": [],
"label": "registerAppLinks",
"description": [
"\nRegister deepLinks and appUpdater for all app links, to change deepLinks as needed when licensing changes."
],
"signature": [
"(core: ",
{
"pluginId": "@kbn/core-lifecycle-browser",
"scope": "common",
"docId": "kibKbnCoreLifecycleBrowserPluginApi",
"section": "def-common.CoreStart",
"text": "CoreStart"
},
", plugins: ",
"StartPlugins",
") => Promise<void>"
],
"path": "x-pack/plugins/security_solution/public/plugin.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "securitySolution",
"id": "def-public.Plugin.registerAppLinks.$1",
"type": "Object",
"tags": [],
"label": "core",
"description": [],
"signature": [
{
"pluginId": "@kbn/core-lifecycle-browser",
"scope": "common",
"docId": "kibKbnCoreLifecycleBrowserPluginApi",
"section": "def-common.CoreStart",
"text": "CoreStart"
}
],
"path": "x-pack/plugins/security_solution/public/plugin.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "securitySolution",
"id": "def-public.Plugin.registerAppLinks.$2",
"type": "Object",
"tags": [],
"label": "plugins",
"description": [],
"signature": [
"StartPlugins"
],
"path": "x-pack/plugins/security_solution/public/plugin.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
}
],
"functions": [],
"interfaces": [
{
"parentPluginId": "securitySolution",
"id": "def-public.LinkItem",
"type": "Interface",
"tags": [],
"label": "LinkItem",
"description": [],
"path": "x-pack/plugins/security_solution/public/common/links/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "securitySolution",
"id": "def-public.LinkItem.capabilities",
"type": "CompoundType",
"tags": [],
"label": "capabilities",
"description": [
"\nCapabilities strings (using object dot notation) to enable the link.\n\nThe format of defining features supports OR and AND mechanism. To specify features in an OR fashion\nthey can be defined in a single level array like: [requiredFeature1, requiredFeature2]. If either of these features\nis satisfied the link would be included. To require that the features be AND'd together a second level array\ncan be specified: [feature1, [feature2, feature3]] this would result in feature1 || (feature2 && feature3). To specify\nfeatures that all must be and'd together an example would be: [[feature1, feature2]], this would result in the boolean\noperation feature1 && feature2.\n\nThe final format is to specify a single feature, this would be like: features: feature1, which is the same as\nfeatures: [feature1]"
],
"signature": [
"RequiredCapabilities",
" | undefined"
],
"path": "x-pack/plugins/security_solution/public/common/links/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "securitySolution",
"id": "def-public.LinkItem.categories",
"type": "Object",
"tags": [],
"label": "categories",
"description": [
"\nCategories to display in the navigation"
],
"signature": [
"readonly ",
{
"pluginId": "@kbn/security-solution-navigation",
"scope": "common",
"docId": "kibKbnSecuritySolutionNavigationPluginApi",
"section": "def-common.LinkCategory",
"text": "LinkCategory"
},
"<",
{
"pluginId": "@kbn/security-solution-navigation",
"scope": "common",
"docId": "kibKbnSecuritySolutionNavigationPluginApi",
"section": "def-common.SecurityPageName",
"text": "SecurityPageName"
},
">[] | undefined"
],
"path": "x-pack/plugins/security_solution/public/common/links/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "securitySolution",
"id": "def-public.LinkItem.description",
"type": "string",
"tags": [],
"label": "description",
"description": [
"\nThe description of the link content"
],
"signature": [
"string | undefined"
],
"path": "x-pack/plugins/security_solution/public/common/links/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "securitySolution",
"id": "def-public.LinkItem.experimentalKey",
"type": "CompoundType",
"tags": [],
"label": "experimentalKey",
"description": [
"\nExperimental flag needed to enable the link"
],
"signature": [
"\"tGridEnabled\" | \"tGridEventRenderedViewEnabled\" | \"excludePoliciesInFilterEnabled\" | \"kubernetesEnabled\" | \"chartEmbeddablesEnabled\" | \"donutChartEmbeddablesEnabled\" | \"alertsPreviewChartEmbeddablesEnabled\" | \"previewTelemetryUrlEnabled\" | \"insightsRelatedAlertsByProcessAncestry\" | \"extendedRuleExecutionLoggingEnabled\" | \"socTrendsEnabled\" | \"responseActionsEnabled\" | \"endpointResponseActionsEnabled\" | \"alertDetailsPageEnabled\" | \"responseActionUploadEnabled\" | \"alertsPageChartsEnabled\" | \"alertTypeEnabled\" | \"alertsPageFiltersEnabled\" | \"newUserDetailsFlyout\" | \"riskScoringPersistence\" | \"riskScoringRoutesEnabled\" | \"discoverInTimeline\" | \"protectionUpdatesEnabled\" | undefined"
],
"path": "x-pack/plugins/security_solution/public/common/links/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "securitySolution",
"id": "def-public.LinkItem.globalNavPosition",
"type": "number",
"tags": [],
"label": "globalNavPosition",
"description": [
"\nGlobal navigation position number.\nDefine this property only if the link needs to be visible within\nthe Security section of the Kibana collapsible global navigation"
],
"signature": [
"number | undefined"
],
"path": "x-pack/plugins/security_solution/public/common/links/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "securitySolution",
"id": "def-public.LinkItem.globalSearchDisabled",
"type": "CompoundType",
"tags": [],
"label": "globalSearchDisabled",
"description": [
"\nDisables link in the global search. Defaults to false."
],
"signature": [
"boolean | undefined"
],
"path": "x-pack/plugins/security_solution/public/common/links/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "securitySolution",
"id": "def-public.LinkItem.globalSearchKeywords",
"type": "Array",
"tags": [],
"label": "globalSearchKeywords",
"description": [
"\nKeywords for the global search to search."
],
"signature": [
"string[] | undefined"
],
"path": "x-pack/plugins/security_solution/public/common/links/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "securitySolution",
"id": "def-public.LinkItem.hideTimeline",
"type": "CompoundType",
"tags": [],
"label": "hideTimeline",
"description": [
"\nDisables the timeline call to action on the bottom of the page. Defaults to false."
],
"signature": [
"boolean | undefined"
],
"path": "x-pack/plugins/security_solution/public/common/links/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "securitySolution",
"id": "def-public.LinkItem.hideWhenExperimentalKey",
"type": "CompoundType",
"tags": [],
"label": "hideWhenExperimentalKey",
"description": [
"\nExperimental flag needed to disable the link. Opposite of experimentalKey"
],
"signature": [
"\"tGridEnabled\" | \"tGridEventRenderedViewEnabled\" | \"excludePoliciesInFilterEnabled\" | \"kubernetesEnabled\" | \"chartEmbeddablesEnabled\" | \"donutChartEmbeddablesEnabled\" | \"alertsPreviewChartEmbeddablesEnabled\" | \"previewTelemetryUrlEnabled\" | \"insightsRelatedAlertsByProcessAncestry\" | \"extendedRuleExecutionLoggingEnabled\" | \"socTrendsEnabled\" | \"responseActionsEnabled\" | \"endpointResponseActionsEnabled\" | \"alertDetailsPageEnabled\" | \"responseActionUploadEnabled\" | \"alertsPageChartsEnabled\" | \"alertTypeEnabled\" | \"alertsPageFiltersEnabled\" | \"newUserDetailsFlyout\" | \"riskScoringPersistence\" | \"riskScoringRoutesEnabled\" | \"discoverInTimeline\" | \"protectionUpdatesEnabled\" | undefined"
],
"path": "x-pack/plugins/security_solution/public/common/links/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "securitySolution",
"id": "def-public.LinkItem.id",
"type": "Enum",
"tags": [],
"label": "id",
"description": [
"\nLink id. Refers to a SecurityPageName"
],
"signature": [
{
"pluginId": "@kbn/security-solution-navigation",
"scope": "common",
"docId": "kibKbnSecuritySolutionNavigationPluginApi",
"section": "def-common.SecurityPageName",
"text": "SecurityPageName"
}
],
"path": "x-pack/plugins/security_solution/public/common/links/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "securitySolution",
"id": "def-public.LinkItem.isBeta",
"type": "CompoundType",
"tags": [],
"label": "isBeta",
"description": [
"\nDisplays the \"Beta\" badge. Defaults to false."
],
"signature": [
"boolean | undefined"
],
"path": "x-pack/plugins/security_solution/public/common/links/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "securitySolution",
"id": "def-public.LinkItem.betaOptions",
"type": "Object",
"tags": [],
"label": "betaOptions",
"description": [
"\nCustomize the \"Beta\" badge content."
],
"signature": [
"{ text: string; } | undefined"
],
"path": "x-pack/plugins/security_solution/public/common/links/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "securitySolution",
"id": "def-public.LinkItem.landingIcon",
"type": "CompoundType",
"tags": [],
"label": "landingIcon",
"description": [
"\nIcon that is displayed on menu navigation landing page.\nOnly required for pages that are displayed inside a landing page."
],
"signature": [
"IconType",
" | undefined"
],
"path": "x-pack/plugins/security_solution/public/common/links/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "securitySolution",
"id": "def-public.LinkItem.landingImage",
"type": "string",
"tags": [],
"label": "landingImage",
"description": [
"\nImage that is displayed on menu navigation landing page.\nOnly required for pages that are displayed inside a landing page."
],
"signature": [
"string | undefined"
],
"path": "x-pack/plugins/security_solution/public/common/links/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "securitySolution",
"id": "def-public.LinkItem.licenseType",
"type": "CompoundType",
"tags": [],
"label": "licenseType",
"description": [
"\nMinimum license required to enable the link"
],
"signature": [
"\"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined"
],
"path": "x-pack/plugins/security_solution/public/common/links/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "securitySolution",
"id": "def-public.LinkItem.links",
"type": "Array",
"tags": [],
"label": "links",
"description": [
"\nNested links"
],
"signature": [
{
"pluginId": "securitySolution",
"scope": "public",
"docId": "kibSecuritySolutionPluginApi",
"section": "def-public.LinkItem",
"text": "LinkItem"
},
"[] | undefined"
],
"path": "x-pack/plugins/security_solution/public/common/links/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "securitySolution",
"id": "def-public.LinkItem.path",
"type": "string",
"tags": [],
"label": "path",
"description": [
"\nLink path relative to security root"
],
"path": "x-pack/plugins/security_solution/public/common/links/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "securitySolution",
"id": "def-public.LinkItem.sideNavDisabled",
"type": "CompoundType",
"tags": [],
"label": "sideNavDisabled",
"description": [
"\nDisables link in the side navigation. Defaults to false."
],
"signature": [
"boolean | undefined"
],
"path": "x-pack/plugins/security_solution/public/common/links/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "securitySolution",
"id": "def-public.LinkItem.sideNavIcon",
"type": "CompoundType",
"tags": [],
"label": "sideNavIcon",
"description": [
"\nIcon that is displayed on the side navigation menu."
],
"signature": [
"IconType",
" | undefined"
],
"path": "x-pack/plugins/security_solution/public/common/links/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "securitySolution",
"id": "def-public.LinkItem.skipUrlState",
"type": "CompoundType",
"tags": [],
"label": "skipUrlState",
"description": [
"\nDisables the state query string in the URL. Defaults to false."
],
"signature": [
"boolean | undefined"
],
"path": "x-pack/plugins/security_solution/public/common/links/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "securitySolution",
"id": "def-public.LinkItem.title",
"type": "string",
"tags": [],
"label": "title",
"description": [
"\nTitle of the link"
],
"path": "x-pack/plugins/security_solution/public/common/links/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "securitySolution",
"id": "def-public.LinkItem.unauthorized",
"type": "CompoundType",
"tags": [],
"label": "unauthorized",
"description": [
"\nReserved for links management, this property is set automatically"
],
"signature": [
"boolean | undefined"
],
"path": "x-pack/plugins/security_solution/public/common/links/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "securitySolution",
"id": "def-public.TimelineModel",
"type": "Interface",
"tags": [],
"label": "TimelineModel",
"description": [],
"path": "x-pack/plugins/security_solution/public/timelines/store/timeline/model.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "securitySolution",
"id": "def-public.TimelineModel.activeTab",
"type": "Enum",
"tags": [],
"label": "activeTab",
"description": [
"The selected tab to displayed in the timeline"
],
"signature": [
"TimelineTabs"
],
"path": "x-pack/plugins/security_solution/public/timelines/store/timeline/model.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "securitySolution",
"id": "def-public.TimelineModel.prevActiveTab",
"type": "Enum",
"tags": [],
"label": "prevActiveTab",
"description": [],
"signature": [
"TimelineTabs"
],
"path": "x-pack/plugins/security_solution/public/timelines/store/timeline/model.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "securitySolution",
"id": "def-public.TimelineModel.scrollToTop",
"type": "Object",
"tags": [],
"label": "scrollToTop",
"description": [
"Used for scrolling to top when swiching tabs. It includes the timestamp of when the event happened"
],
"signature": [
"ScrollToTopEvent",
" | undefined"
],
"path": "x-pack/plugins/security_solution/public/timelines/store/timeline/model.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "securitySolution",
"id": "def-public.TimelineModel.createdBy",
"type": "string",
"tags": [],
"label": "createdBy",
"description": [
"Timeline saved object owner"
],
"signature": [
"string | undefined"
],
"path": "x-pack/plugins/security_solution/public/timelines/store/timeline/model.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "securitySolution",
"id": "def-public.TimelineModel.description",
"type": "string",
"tags": [],
"label": "description",
"description": [
"A summary of the events and notes in this timeline"
],
"path": "x-pack/plugins/security_solution/public/timelines/store/timeline/model.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "securitySolution",
"id": "def-public.TimelineModel.eqlOptions",
"type": "Object",
"tags": [],
"label": "eqlOptions",
"description": [],
"signature": [
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.EqlOptionsSelected",
"text": "EqlOptionsSelected"
}
],
"path": "x-pack/plugins/security_solution/public/timelines/store/timeline/model.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "securitySolution",
"id": "def-public.TimelineModel.eventType",
"type": "CompoundType",
"tags": [],
"label": "eventType",
"description": [
"Type of event you want to see in this timeline"
],
"signature": [
"TimelineEventsType",
" | undefined"
],
"path": "x-pack/plugins/security_solution/public/timelines/store/timeline/model.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "securitySolution",
"id": "def-public.TimelineModel.eventIdToNoteIds",
"type": "Object",
"tags": [],
"label": "eventIdToNoteIds",
"description": [
"A map of events in this timeline to the chronologically ordered notes (in this timeline) associated with the event"
],
"signature": [
"{ [x: string]: string[]; }"
],
"path": "x-pack/plugins/security_solution/public/timelines/store/timeline/model.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "securitySolution",
"id": "def-public.TimelineModel.historyIds",
"type": "Array",
"tags": [],
"label": "historyIds",
"description": [
"The chronological history of actions related to this timeline"
],
"signature": [
"string[]"
],
"path": "x-pack/plugins/security_solution/public/timelines/store/timeline/model.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "securitySolution",
"id": "def-public.TimelineModel.highlightedDropAndProviderId",
"type": "string",
"tags": [],
"label": "highlightedDropAndProviderId",
"description": [
"The chronological history of actions related to this timeline"
],
"path": "x-pack/plugins/security_solution/public/timelines/store/timeline/model.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "securitySolution",
"id": "def-public.TimelineModel.isFavorite",
"type": "boolean",
"tags": [],
"label": "isFavorite",
"description": [
"When true, this timeline was marked as \"favorite\" by the user"
],
"path": "x-pack/plugins/security_solution/public/timelines/store/timeline/model.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "securitySolution",
"id": "def-public.TimelineModel.isLive",
"type": "boolean",
"tags": [],
"label": "isLive",
"description": [
"When true, the timeline will update as new data arrives"
],
"path": "x-pack/plugins/security_solution/public/timelines/store/timeline/model.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "securitySolution",
"id": "def-public.TimelineModel.kqlMode",
"type": "CompoundType",
"tags": [],
"label": "kqlMode",
"description": [
"determines the behavior of the KQL bar"
],
"signature": [
"\"search\" | \"filter\""
],
"path": "x-pack/plugins/security_solution/public/timelines/store/timeline/model.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "securitySolution",
"id": "def-public.TimelineModel.title",
"type": "string",
"tags": [],
"label": "title",
"description": [
"Title"
],
"path": "x-pack/plugins/security_solution/public/timelines/store/timeline/model.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "securitySolution",
"id": "def-public.TimelineModel.timelineType",
"type": "Enum",
"tags": [],
"label": "timelineType",
"description": [
"timelineType: default | template"
],
"signature": [
"TimelineType"
],
"path": "x-pack/plugins/security_solution/public/timelines/store/timeline/model.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "securitySolution",
"id": "def-public.TimelineModel.templateTimelineId",
"type": "CompoundType",
"tags": [],
"label": "templateTimelineId",
"description": [
"an unique id for timeline template"
],
"signature": [
"string | null"
],
"path": "x-pack/plugins/security_solution/public/timelines/store/timeline/model.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "securitySolution",
"id": "def-public.TimelineModel.templateTimelineVersion",
"type": "CompoundType",
"tags": [],
"label": "templateTimelineVersion",
"description": [
"null for default timeline, number for timeline template"
],
"signature": [
"number | null"
],
"path": "x-pack/plugins/security_solution/public/timelines/store/timeline/model.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "securitySolution",
"id": "def-public.TimelineModel.noteIds",
"type": "Array",
"tags": [],
"label": "noteIds",
"description": [
"Notes added to the timeline itself. Notes added to events are stored (separately) in `eventIdToNote`"
],
"signature": [
"string[]"
],
"path": "x-pack/plugins/security_solution/public/timelines/store/timeline/model.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "securitySolution",
"id": "def-public.TimelineModel.pinnedEventIds",
"type": "Object",
"tags": [],
"label": "pinnedEventIds",
"description": [
"Events pinned to this timeline"
],
"signature": [
"{ [x: string]: boolean; }"
],
"path": "x-pack/plugins/security_solution/public/timelines/store/timeline/model.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "securitySolution",
"id": "def-public.TimelineModel.pinnedEventsSaveObject",
"type": "Object",
"tags": [],
"label": "pinnedEventsSaveObject",
"description": [],
"signature": [
"{ [x: string]: ",
"PinnedEvent",
"; }"
],
"path": "x-pack/plugins/security_solution/public/timelines/store/timeline/model.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "securitySolution",
"id": "def-public.TimelineModel.resolveTimelineConfig",
"type": "Object",
"tags": [],
"label": "resolveTimelineConfig",
"description": [],
"signature": [
"ResolveTimelineConfig",
" | undefined"
],
"path": "x-pack/plugins/security_solution/public/timelines/store/timeline/model.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "securitySolution",
"id": "def-public.TimelineModel.showSaveModal",
"type": "CompoundType",
"tags": [],
"label": "showSaveModal",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "x-pack/plugins/security_solution/public/timelines/store/timeline/model.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "securitySolution",
"id": "def-public.TimelineModel.savedQueryId",
"type": "CompoundType",
"tags": [],
"label": "savedQueryId",
"description": [],
"signature": [
"string | null | undefined"
],
"path": "x-pack/plugins/security_solution/public/timelines/store/timeline/model.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "securitySolution",
"id": "def-public.TimelineModel.sessionViewConfig",
"type": "CompoundType",
"tags": [],
"label": "sessionViewConfig",
"description": [],
"signature": [
"SessionViewConfig",
" | null"
],
"path": "x-pack/plugins/security_solution/public/timelines/store/timeline/model.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "securitySolution",
"id": "def-public.TimelineModel.show",
"type": "boolean",
"tags": [],
"label": "show",
"description": [
"When true, show the timeline flyover"
],
"path": "x-pack/plugins/security_solution/public/timelines/store/timeline/model.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "securitySolution",
"id": "def-public.TimelineModel.status",
"type": "Enum",
"tags": [],
"label": "status",
"description": [
"status: active | draft"
],
"signature": [
"TimelineStatus"
],
"path": "x-pack/plugins/security_solution/public/timelines/store/timeline/model.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "securitySolution",
"id": "def-public.TimelineModel.updated",
"type": "number",
"tags": [],
"label": "updated",
"description": [
"updated saved object timestamp"
],
"signature": [
"number | undefined"
],
"path": "x-pack/plugins/security_solution/public/timelines/store/timeline/model.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "securitySolution",
"id": "def-public.TimelineModel.updatedBy",
"type": "CompoundType",
"tags": [],
"label": "updatedBy",
"description": [
"updated saved object user"
],
"signature": [
"string | null | undefined"
],
"path": "x-pack/plugins/security_solution/public/timelines/store/timeline/model.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "securitySolution",
"id": "def-public.TimelineModel.isSaving",
"type": "boolean",
"tags": [],
"label": "isSaving",
"description": [
"timeline is saving"
],
"path": "x-pack/plugins/security_solution/public/timelines/store/timeline/model.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "securitySolution",
"id": "def-public.TimelineModel.version",
"type": "CompoundType",
"tags": [],
"label": "version",
"description": [],
"signature": [
"string | null"
],
"path": "x-pack/plugins/security_solution/public/timelines/store/timeline/model.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "securitySolution",
"id": "def-public.TimelineModel.initialized",
"type": "CompoundType",
"tags": [],
"label": "initialized",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "x-pack/plugins/security_solution/public/timelines/store/timeline/model.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "securitySolution",
"id": "def-public.TimelineModel.savedObjectId",
"type": "CompoundType",
"tags": [],
"label": "savedObjectId",
"description": [],
"signature": [
"string | null"
],
"path": "x-pack/plugins/security_solution/public/timelines/store/timeline/model.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "securitySolution",
"id": "def-public.TimelineModel.sort",
"type": "Array",
"tags": [],
"label": "sort",
"description": [
" Specifies which column the timeline is sorted on, and the direction (ascending / descending)"
],
"signature": [
"SortColumnTimeline",
"[]"
],
"path": "x-pack/plugins/security_solution/public/timelines/store/timeline/model.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "securitySolution",
"id": "def-public.TimelineModel.columns",
"type": "Array",
"tags": [],
"label": "columns",
"description": [
"The columns displayed in the data table"
],
"signature": [
"ColumnHeaderOptions",
"[]"
],
"path": "x-pack/plugins/security_solution/public/timelines/store/timeline/model.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "securitySolution",
"id": "def-public.TimelineModel.defaultColumns",
"type": "Array",
"tags": [],
"label": "defaultColumns",
"description": [],
"signature": [
"ColumnHeaderOptions",
"[]"
],
"path": "x-pack/plugins/security_solution/public/timelines/store/timeline/model.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "securitySolution",
"id": "def-public.TimelineModel.dataProviders",
"type": "Array",
"tags": [],
"label": "dataProviders",
"description": [
"The sources of the event data shown in the data table"
],
"signature": [
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.DataProvider",
"text": "DataProvider"
},
"[]"
],
"path": "x-pack/plugins/security_solution/public/timelines/store/timeline/model.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "securitySolution",
"id": "def-public.TimelineModel.dataViewId",
"type": "CompoundType",
"tags": [],
"label": "dataViewId",
"description": [
"Kibana data view id"
],
"signature": [
"string | null"
],
"path": "x-pack/plugins/security_solution/public/timelines/store/timeline/model.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "securitySolution",
"id": "def-public.TimelineModel.deletedEventIds",
"type": "Array",
"tags": [],
"label": "deletedEventIds",
"description": [
"Events to not be rendered"
],
"signature": [
"string[]"
],
"path": "x-pack/plugins/security_solution/public/timelines/store/timeline/model.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "securitySolution",
"id": "def-public.TimelineModel.documentType",
"type": "string",
"tags": [],
"label": "documentType",
"description": [],
"path": "x-pack/plugins/security_solution/public/timelines/store/timeline/model.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "securitySolution",
"id": "def-public.TimelineModel.excludedRowRendererIds",
"type": "Array",
"tags": [],
"label": "excludedRowRendererIds",
"description": [],
"signature": [
"RowRendererId",
"[]"
],
"path": "x-pack/plugins/security_solution/public/timelines/store/timeline/model.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "securitySolution",
"id": "def-public.TimelineModel.filterManager",
"type": "Object",
"tags": [],
"label": "filterManager",
"description": [],
"signature": [
{
"pluginId": "data",
"scope": "public",
"docId": "kibDataQueryPluginApi",
"section": "def-public.FilterManager",
"text": "FilterManager"
},
" | undefined"
],
"path": "x-pack/plugins/security_solution/public/timelines/store/timeline/model.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "securitySolution",
"id": "def-public.TimelineModel.footerText",
"type": "CompoundType",
"tags": [],
"label": "footerText",
"description": [],
"signature": [
"boolean | React.ReactChild | React.ReactFragment | React.ReactPortal | null | undefined"
],
"path": "x-pack/plugins/security_solution/public/timelines/store/timeline/model.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "securitySolution",
"id": "def-public.TimelineModel.loadingText",
"type": "CompoundType",
"tags": [],
"label": "loadingText",
"description": [],
"signature": [
"boolean | React.ReactChild | React.ReactFragment | React.ReactPortal | null | undefined"
],
"path": "x-pack/plugins/security_solution/public/timelines/store/timeline/model.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "securitySolution",
"id": "def-public.TimelineModel.queryFields",
"type": "Array",
"tags": [],
"label": "queryFields",
"description": [],
"signature": [
"string[]"
],
"path": "x-pack/plugins/security_solution/public/timelines/store/timeline/model.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "securitySolution",
"id": "def-public.TimelineModel.expandedDetail",
"type": "Object",
"tags": [],
"label": "expandedDetail",
"description": [
"This holds the view information for the flyout when viewing timeline in a consuming view (i.e. hosts page) or the side panel in the primary timeline view"
],
"signature": [
"{ query?: ",
"ExpandedDetailType",
" | undefined; graph?: ",
"ExpandedDetailType",
" | undefined; notes?: ",
"ExpandedDetailType",
" | undefined; pinned?: ",
"ExpandedDetailType",
" | undefined; eql?: ",
"ExpandedDetailType",
" | undefined; session?: ",
"ExpandedDetailType",
" | undefined; securityAssistant?: ",
"ExpandedDetailType",
" | undefined; discover?: ",
"ExpandedDetailType",
" | undefined; }"
],
"path": "x-pack/plugins/security_solution/public/timelines/store/timeline/model.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "securitySolution",
"id": "def-public.TimelineModel.graphEventId",
"type": "string",
"tags": [],
"label": "graphEventId",
"description": [
"When non-empty, display a graph view for this event"
],
"signature": [
"string | undefined"
],
"path": "x-pack/plugins/security_solution/public/timelines/store/timeline/model.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "securitySolution",
"id": "def-public.TimelineModel.indexNames",
"type": "Array",
"tags": [],
"label": "indexNames",
"description": [],
"signature": [
"string[]"
],
"path": "x-pack/plugins/security_solution/public/timelines/store/timeline/model.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "securitySolution",
"id": "def-public.TimelineModel.itemsPerPage",
"type": "number",
"tags": [],
"label": "itemsPerPage",
"description": [
"The number of items to show in a single page of results"
],
"path": "x-pack/plugins/security_solution/public/timelines/store/timeline/model.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "securitySolution",
"id": "def-public.TimelineModel.itemsPerPageOptions",
"type": "Array",
"tags": [],
"label": "itemsPerPageOptions",
"description": [
"Displays a series of choices that when selected, become the value of `itemsPerPage`"
],
"signature": [
"number[]"
],
"path": "x-pack/plugins/security_solution/public/timelines/store/timeline/model.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "securitySolution",
"id": "def-public.TimelineModel.kqlQuery",
"type": "Object",
"tags": [],
"label": "kqlQuery",
"description": [
"the KQL query in the KQL bar"
],
"signature": [
"{ filterQuery: ",
"SerializedFilterQuery",
" | null; }"
],
"path": "x-pack/plugins/security_solution/public/timelines/store/timeline/model.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "securitySolution",
"id": "def-public.TimelineModel.loadingEventIds",
"type": "Array",
"tags": [],
"label": "loadingEventIds",
"description": [
"Events to be rendered as loading"
],
"signature": [
"string[]"
],
"path": "x-pack/plugins/security_solution/public/timelines/store/timeline/model.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "securitySolution",
"id": "def-public.TimelineModel.dateRange",
"type": "Object",
"tags": [],
"label": "dateRange",
"description": [
"Specifies the granularity of the date range (e.g. 1 Day / Week / Month) applicable to the mini-map"
],
"signature": [
"{ start: string; end: string; }"
],
"path": "x-pack/plugins/security_solution/public/timelines/store/timeline/model.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "securitySolution",
"id": "def-public.TimelineModel.id",
"type": "string",
"tags": [],
"label": "id",
"description": [
"Uniquely identifies the timeline"
],
"path": "x-pack/plugins/security_solution/public/timelines/store/timeline/model.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "securitySolution",
"id": "def-public.TimelineModel.filters",
"type": "Array",
"tags": [],
"label": "filters",
"description": [],
"signature": [
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[] | undefined"
],
"path": "x-pack/plugins/security_solution/public/timelines/store/timeline/model.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "securitySolution",
"id": "def-public.TimelineModel.selectedEventIds",
"type": "Object",
"tags": [],
"label": "selectedEventIds",
"description": [],
"signature": [
"{ [x: string]: ",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineNonEcsData",
"text": "TimelineNonEcsData"
},
"[]; }"
],
"path": "x-pack/plugins/security_solution/public/timelines/store/timeline/model.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "securitySolution",
"id": "def-public.TimelineModel.isSelectAllChecked",
"type": "boolean",
"tags": [],
"label": "isSelectAllChecked",
"description": [
"If selectAll checkbox in header is checked"
],
"path": "x-pack/plugins/security_solution/public/timelines/store/timeline/model.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "securitySolution",
"id": "def-public.TimelineModel.isLoading",
"type": "boolean",
"tags": [],
"label": "isLoading",
"description": [],
"path": "x-pack/plugins/security_solution/public/timelines/store/timeline/model.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "securitySolution",
"id": "def-public.TimelineModel.selectAll",
"type": "boolean",
"tags": [],
"label": "selectAll",
"description": [],
"path": "x-pack/plugins/security_solution/public/timelines/store/timeline/model.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
}
],
"enums": [],
"misc": [],
"objects": [],
"setup": {
"parentPluginId": "securitySolution",
"id": "def-public.PluginSetup",
"type": "Interface",
"tags": [],
"label": "PluginSetup",
"description": [],
"path": "x-pack/plugins/security_solution/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "securitySolution",
"id": "def-public.PluginSetup.resolver",
"type": "Function",
"tags": [],
"label": "resolver",
"description": [],
"signature": [
"() => Promise<",
"ResolverPluginSetup",
">"
],
"path": "x-pack/plugins/security_solution/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "securitySolution",
"id": "def-public.PluginSetup.setAppLinksSwitcher",
"type": "Function",
"tags": [],
"label": "setAppLinksSwitcher",
"description": [],
"signature": [
"(appLinksSwitcher: ",
"AppLinksSwitcher",
") => void"
],
"path": "x-pack/plugins/security_solution/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "securitySolution",
"id": "def-public.PluginSetup.setAppLinksSwitcher.$1",
"type": "Function",
"tags": [],
"label": "appLinksSwitcher",
"description": [],
"signature": [
"AppLinksSwitcher"
],
"path": "x-pack/plugins/security_solution/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
}
],
"lifecycle": "setup",
"initialIsOpen": true
},
"start": {
"parentPluginId": "securitySolution",
"id": "def-public.PluginStart",
"type": "Interface",
"tags": [],
"label": "PluginStart",
"description": [],
"path": "x-pack/plugins/security_solution/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "securitySolution",
"id": "def-public.PluginStart.getNavLinks$",
"type": "Function",
"tags": [],
"label": "getNavLinks$",
"description": [],
"signature": [
"() => ",
"Observable",
"<",
"NavigationLink",
"[]>"
],
"path": "x-pack/plugins/security_solution/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "securitySolution",
"id": "def-public.PluginStart.setExtraRoutes",
"type": "Function",
"tags": [],
"label": "setExtraRoutes",
"description": [],
"signature": [
"(extraRoutes: ",
"RouteProps",
"<string, { [x: string]: string | undefined; }>[]) => void"
],
"path": "x-pack/plugins/security_solution/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "securitySolution",
"id": "def-public.PluginStart.setExtraRoutes.$1",
"type": "Array",
"tags": [],
"label": "extraRoutes",
"description": [],
"signature": [
"RouteProps",
"<string, { [x: string]: string | undefined; }>[]"
],
"path": "x-pack/plugins/security_solution/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "securitySolution",
"id": "def-public.PluginStart.setIsILMAvailable",
"type": "Function",
"tags": [],
"label": "setIsILMAvailable",
"description": [],
"signature": [
"(isILMAvailable: boolean) => void"
],
"path": "x-pack/plugins/security_solution/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "securitySolution",
"id": "def-public.PluginStart.setIsILMAvailable.$1",
"type": "boolean",
"tags": [],
"label": "isILMAvailable",
"description": [],
"signature": [
"boolean"
],
"path": "x-pack/plugins/security_solution/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "securitySolution",
"id": "def-public.PluginStart.setIsSidebarEnabled",
"type": "Function",
"tags": [],
"label": "setIsSidebarEnabled",
"description": [],
"signature": [
"(isSidebarEnabled: boolean) => void"
],
"path": "x-pack/plugins/security_solution/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "securitySolution",
"id": "def-public.PluginStart.setIsSidebarEnabled.$1",
"type": "boolean",
"tags": [],
"label": "isSidebarEnabled",
"description": [],
"signature": [
"boolean"
],
"path": "x-pack/plugins/security_solution/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "securitySolution",
"id": "def-public.PluginStart.setGetStartedPage",
"type": "Function",
"tags": [],
"label": "setGetStartedPage",
"description": [],
"signature": [
"(getStartedComponent: React.ComponentType<{}>) => void"
],
"path": "x-pack/plugins/security_solution/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "securitySolution",
"id": "def-public.PluginStart.setGetStartedPage.$1",
"type": "CompoundType",
"tags": [],
"label": "getStartedComponent",
"description": [],
"signature": [
"React.ComponentType<{}>"
],
"path": "x-pack/plugins/security_solution/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "securitySolution",
"id": "def-public.PluginStart.setDashboardsLandingCallout",
"type": "Function",
"tags": [],
"label": "setDashboardsLandingCallout",
"description": [],
"signature": [
"(dashboardsLandingCallout: React.ComponentType<{}>) => void"
],
"path": "x-pack/plugins/security_solution/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "securitySolution",
"id": "def-public.PluginStart.setDashboardsLandingCallout.$1",
"type": "CompoundType",
"tags": [],
"label": "dashboardsLandingCallout",
"description": [],
"signature": [
"React.ComponentType<{}>"
],
"path": "x-pack/plugins/security_solution/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "securitySolution",
"id": "def-public.PluginStart.getBreadcrumbsNav$",
"type": "Function",
"tags": [],
"label": "getBreadcrumbsNav$",
"description": [],
"signature": [
"() => ",
"Observable",
"<",
"BreadcrumbsNav",
">"
],
"path": "x-pack/plugins/security_solution/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "securitySolution",
"id": "def-public.PluginStart.getUpselling",
"type": "Function",
"tags": [],
"label": "getUpselling",
"description": [],
"signature": [
"() => ",
"UpsellingService"
],
"path": "x-pack/plugins/security_solution/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
}
],
"lifecycle": "start",
"initialIsOpen": true
}
},
"server": {
"classes": [
{
"parentPluginId": "securitySolution",
"id": "def-server.AppClient",
"type": "Class",
"tags": [],
"label": "AppClient",
"description": [],
"path": "x-pack/plugins/security_solution/server/client/client.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "securitySolution",
"id": "def-server.AppClient.Unnamed",
"type": "Function",
"tags": [],
"label": "Constructor",
"description": [],
"signature": [
"any"
],
"path": "x-pack/plugins/security_solution/server/client/client.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "securitySolution",
"id": "def-server.AppClient.Unnamed.$1",
"type": "string",
"tags": [],
"label": "spaceId",
"description": [],
"signature": [
"string"
],
"path": "x-pack/plugins/security_solution/server/client/client.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "securitySolution",
"id": "def-server.AppClient.Unnamed.$2",
"type": "CompoundType",
"tags": [],
"label": "config",
"description": [],
"signature": [
{
"pluginId": "securitySolution",
"scope": "server",
"docId": "kibSecuritySolutionPluginApi",
"section": "def-server.ConfigType",
"text": "ConfigType"
}
],
"path": "x-pack/plugins/security_solution/server/client/client.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "securitySolution",
"id": "def-server.AppClient.Unnamed.$3",
"type": "string",
"tags": [],
"label": "kibanaVersion",
"description": [],
"signature": [
"string"
],
"path": "x-pack/plugins/security_solution/server/client/client.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "securitySolution",
"id": "def-server.AppClient.Unnamed.$4",
"type": "string",
"tags": [],
"label": "kibanaBranch",
"description": [],
"signature": [
"string"
],
"path": "x-pack/plugins/security_solution/server/client/client.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "securitySolution",
"id": "def-server.AppClient.getAlertsIndex",
"type": "Function",
"tags": [],
"label": "getAlertsIndex",
"description": [],
"signature": [
"() => string"
],
"path": "x-pack/plugins/security_solution/server/client/client.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "securitySolution",
"id": "def-server.AppClient.getSignalsIndex",
"type": "Function",
"tags": [],
"label": "getSignalsIndex",
"description": [],
"signature": [
"() => string"
],
"path": "x-pack/plugins/security_solution/server/client/client.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "securitySolution",
"id": "def-server.AppClient.getPreviewIndex",
"type": "Function",
"tags": [],
"label": "getPreviewIndex",
"description": [],
"signature": [
"() => string"
],
"path": "x-pack/plugins/security_solution/server/client/client.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "securitySolution",
"id": "def-server.AppClient.getSourcererDataViewId",
"type": "Function",
"tags": [],
"label": "getSourcererDataViewId",
"description": [],
"signature": [
"() => string"
],
"path": "x-pack/plugins/security_solution/server/client/client.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "securitySolution",
"id": "def-server.AppClient.getSpaceId",
"type": "Function",
"tags": [],
"label": "getSpaceId",
"description": [],
"signature": [
"() => string"
],
"path": "x-pack/plugins/security_solution/server/client/client.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "securitySolution",
"id": "def-server.AppClient.getKibanaVersion",
"type": "Function",
"tags": [],
"label": "getKibanaVersion",
"description": [],
"signature": [
"() => string"
],
"path": "x-pack/plugins/security_solution/server/client/client.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "securitySolution",
"id": "def-server.AppClient.getKibanaBranch",
"type": "Function",
"tags": [],
"label": "getKibanaBranch",
"description": [],
"signature": [
"() => string"
],
"path": "x-pack/plugins/security_solution/server/client/client.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "securitySolution",
"id": "def-server.Plugin",
"type": "Class",
"tags": [],
"label": "Plugin",
"description": [],
"signature": [
{
"pluginId": "securitySolution",
"scope": "server",
"docId": "kibSecuritySolutionPluginApi",
"section": "def-server.Plugin",
"text": "Plugin"
},
" implements ",
{
"pluginId": "@kbn/core-plugins-server",
"scope": "common",
"docId": "kibKbnCorePluginsServerPluginApi",
"section": "def-common.Plugin",
"text": "Plugin"
},
"<",
{
"pluginId": "securitySolution",
"scope": "server",
"docId": "kibSecuritySolutionPluginApi",
"section": "def-server.SecuritySolutionPluginSetup",
"text": "SecuritySolutionPluginSetup"
},
", ",
{
"pluginId": "securitySolution",
"scope": "server",
"docId": "kibSecuritySolutionPluginApi",
"section": "def-server.SecuritySolutionPluginStart",
"text": "SecuritySolutionPluginStart"
},
", ",
"SecuritySolutionPluginSetupDependencies",
", ",
"SecuritySolutionPluginStartDependencies",
">"
],
"path": "x-pack/plugins/security_solution/server/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "securitySolution",
"id": "def-server.Plugin.Unnamed",
"type": "Function",
"tags": [],
"label": "Constructor",
"description": [],
"signature": [
"any"
],
"path": "x-pack/plugins/security_solution/server/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "securitySolution",
"id": "def-server.Plugin.Unnamed.$1",
"type": "Object",
"tags": [],
"label": "context",
"description": [],
"signature": [
{
"pluginId": "@kbn/core-plugins-server",
"scope": "common",
"docId": "kibKbnCorePluginsServerPluginApi",
"section": "def-common.PluginInitializerContext",
"text": "PluginInitializerContext"
},
"<unknown>"
],
"path": "x-pack/plugins/security_solution/server/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "securitySolution",
"id": "def-server.Plugin.setup",
"type": "Function",
"tags": [],
"label": "setup",
"description": [],
"signature": [
"(core: ",
"SecuritySolutionPluginCoreSetupDependencies",
", plugins: ",
"SecuritySolutionPluginSetupDependencies",
") => ",
{
"pluginId": "securitySolution",
"scope": "server",
"docId": "kibSecuritySolutionPluginApi",
"section": "def-server.SecuritySolutionPluginSetup",
"text": "SecuritySolutionPluginSetup"
}
],
"path": "x-pack/plugins/security_solution/server/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "securitySolution",
"id": "def-server.Plugin.setup.$1",
"type": "Object",
"tags": [],
"label": "core",
"description": [],
"signature": [
"SecuritySolutionPluginCoreSetupDependencies"
],
"path": "x-pack/plugins/security_solution/server/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "securitySolution",
"id": "def-server.Plugin.setup.$2",
"type": "Object",
"tags": [],
"label": "plugins",
"description": [],
"signature": [
"SecuritySolutionPluginSetupDependencies"
],
"path": "x-pack/plugins/security_solution/server/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "securitySolution",
"id": "def-server.Plugin.start",
"type": "Function",
"tags": [],
"label": "start",
"description": [],
"signature": [
"(core: ",
{
"pluginId": "@kbn/core-lifecycle-server",
"scope": "common",
"docId": "kibKbnCoreLifecycleServerPluginApi",
"section": "def-common.CoreStart",
"text": "CoreStart"
},
", plugins: ",
"SecuritySolutionPluginStartDependencies",
") => ",
{
"pluginId": "securitySolution",
"scope": "server",
"docId": "kibSecuritySolutionPluginApi",
"section": "def-server.SecuritySolutionPluginStart",
"text": "SecuritySolutionPluginStart"
}
],
"path": "x-pack/plugins/security_solution/server/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "securitySolution",
"id": "def-server.Plugin.start.$1",
"type": "Object",
"tags": [],
"label": "core",
"description": [],
"signature": [
{
"pluginId": "@kbn/core-lifecycle-server",
"scope": "common",
"docId": "kibKbnCoreLifecycleServerPluginApi",
"section": "def-common.CoreStart",
"text": "CoreStart"
}
],
"path": "x-pack/plugins/security_solution/server/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "securitySolution",
"id": "def-server.Plugin.start.$2",
"type": "Object",
"tags": [],
"label": "plugins",
"description": [],
"signature": [
"SecuritySolutionPluginStartDependencies"
],
"path": "x-pack/plugins/security_solution/server/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "securitySolution",
"id": "def-server.Plugin.stop",
"type": "Function",
"tags": [],
"label": "stop",
"description": [],
"signature": [
"() => void"
],
"path": "x-pack/plugins/security_solution/server/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
}
],
"initialIsOpen": false
}
],
"functions": [],
"interfaces": [
{
"parentPluginId": "securitySolution",
"id": "def-server.SecuritySolutionApiRequestHandlerContext",
"type": "Interface",
"tags": [],
"label": "SecuritySolutionApiRequestHandlerContext",
"description": [],
"path": "x-pack/plugins/security_solution/server/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "securitySolution",
"id": "def-server.SecuritySolutionApiRequestHandlerContext.core",
"type": "Object",
"tags": [],
"label": "core",
"description": [],
"signature": [
{
"pluginId": "@kbn/core-http-request-handler-context-server",
"scope": "common",
"docId": "kibKbnCoreHttpRequestHandlerContextServerPluginApi",
"section": "def-common.CoreRequestHandlerContext",
"text": "CoreRequestHandlerContext"
}
],
"path": "x-pack/plugins/security_solution/server/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "securitySolution",
"id": "def-server.SecuritySolutionApiRequestHandlerContext.getServerBasePath",
"type": "Function",
"tags": [],
"label": "getServerBasePath",
"description": [],
"signature": [
"() => string"
],
"path": "x-pack/plugins/security_solution/server/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "securitySolution",
"id": "def-server.SecuritySolutionApiRequestHandlerContext.getEndpointAuthz",
"type": "Function",
"tags": [],
"label": "getEndpointAuthz",
"description": [],
"signature": [
"() => Promise<",
"ImmutableObject",
"<",
"EndpointAuthz",
">>"
],
"path": "x-pack/plugins/security_solution/server/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "securitySolution",
"id": "def-server.SecuritySolutionApiRequestHandlerContext.getConfig",
"type": "Function",
"tags": [],
"label": "getConfig",
"description": [],
"signature": [
"() => ",
{
"pluginId": "securitySolution",
"scope": "server",
"docId": "kibSecuritySolutionPluginApi",
"section": "def-server.ConfigType",
"text": "ConfigType"
}
],
"path": "x-pack/plugins/security_solution/server/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "securitySolution",
"id": "def-server.SecuritySolutionApiRequestHandlerContext.getFrameworkRequest",
"type": "Function",
"tags": [],
"label": "getFrameworkRequest",
"description": [],
"signature": [
"() => ",
"FrameworkRequest"
],
"path": "x-pack/plugins/security_solution/server/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "securitySolution",
"id": "def-server.SecuritySolutionApiRequestHandlerContext.getAppClient",
"type": "Function",
"tags": [],
"label": "getAppClient",
"description": [],
"signature": [
"() => ",
{
"pluginId": "securitySolution",
"scope": "server",
"docId": "kibSecuritySolutionPluginApi",
"section": "def-server.AppClient",
"text": "AppClient"
}
],
"path": "x-pack/plugins/security_solution/server/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "securitySolution",
"id": "def-server.SecuritySolutionApiRequestHandlerContext.getSpaceId",
"type": "Function",
"tags": [],
"label": "getSpaceId",
"description": [],
"signature": [
"() => string"
],
"path": "x-pack/plugins/security_solution/server/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "securitySolution",
"id": "def-server.SecuritySolutionApiRequestHandlerContext.getRuleDataService",
"type": "Function",
"tags": [],
"label": "getRuleDataService",
"description": [],
"signature": [
"() => ",
{
"pluginId": "ruleRegistry",
"scope": "server",
"docId": "kibRuleRegistryPluginApi",
"section": "def-server.IRuleDataService",
"text": "IRuleDataService"
}
],
"path": "x-pack/plugins/security_solution/server/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "securitySolution",
"id": "def-server.SecuritySolutionApiRequestHandlerContext.getDetectionEngineHealthClient",
"type": "Function",
"tags": [],
"label": "getDetectionEngineHealthClient",
"description": [],
"signature": [
"() => ",
"IDetectionEngineHealthClient"
],
"path": "x-pack/plugins/security_solution/server/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "securitySolution",
"id": "def-server.SecuritySolutionApiRequestHandlerContext.getRuleExecutionLog",
"type": "Function",
"tags": [],
"label": "getRuleExecutionLog",
"description": [],
"signature": [
"() => ",
"IRuleExecutionLogForRoutes"
],
"path": "x-pack/plugins/security_solution/server/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "securitySolution",
"id": "def-server.SecuritySolutionApiRequestHandlerContext.getRacClient",
"type": "Function",
"tags": [],
"label": "getRacClient",
"description": [],
"signature": [
"(req: ",
{
"pluginId": "@kbn/core-http-server",
"scope": "common",
"docId": "kibKbnCoreHttpServerPluginApi",
"section": "def-common.KibanaRequest",
"text": "KibanaRequest"
},
"<unknown, unknown, unknown, any>) => Promise<",
{
"pluginId": "ruleRegistry",
"scope": "server",
"docId": "kibRuleRegistryPluginApi",
"section": "def-server.AlertsClient",
"text": "AlertsClient"
},
">"
],
"path": "x-pack/plugins/security_solution/server/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "securitySolution",
"id": "def-server.SecuritySolutionApiRequestHandlerContext.getRacClient.$1",
"type": "Object",
"tags": [],
"label": "req",
"description": [],
"signature": [
{
"pluginId": "@kbn/core-http-server",
"scope": "common",
"docId": "kibKbnCoreHttpServerPluginApi",
"section": "def-common.KibanaRequest",
"text": "KibanaRequest"
},
"<unknown, unknown, unknown, any>"
],
"path": "x-pack/plugins/security_solution/server/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "securitySolution",
"id": "def-server.SecuritySolutionApiRequestHandlerContext.getExceptionListClient",
"type": "Function",
"tags": [],
"label": "getExceptionListClient",
"description": [],
"signature": [
"() => ",
{
"pluginId": "lists",
"scope": "server",
"docId": "kibListsPluginApi",
"section": "def-server.ExceptionListClient",
"text": "ExceptionListClient"
},
" | null"
],
"path": "x-pack/plugins/security_solution/server/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "securitySolution",
"id": "def-server.SecuritySolutionApiRequestHandlerContext.getInternalFleetServices",
"type": "Function",
"tags": [],
"label": "getInternalFleetServices",
"description": [],
"signature": [
"() => ",
"EndpointInternalFleetServicesInterface"
],
"path": "x-pack/plugins/security_solution/server/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "securitySolution",
"id": "def-server.SecuritySolutionApiRequestHandlerContext.getRiskEngineDataClient",
"type": "Function",
"tags": [],
"label": "getRiskEngineDataClient",
"description": [],
"signature": [
"() => ",
"RiskEngineDataClient"
],
"path": "x-pack/plugins/security_solution/server/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
}
],
"initialIsOpen": false
}
],
"enums": [],
"misc": [
{
"parentPluginId": "securitySolution",
"id": "def-server.ConfigType",
"type": "Type",
"tags": [],
"label": "ConfigType",
"description": [],
"signature": [
"Readonly<{ prebuiltRulesPackageVersion?: string | undefined; } & { enabled: boolean; signalsIndex: string; maxRuleImportExportSize: number; maxRuleImportPayloadBytes: number; maxTimelineImportExportSize: number; maxTimelineImportPayloadBytes: number; alertMergeStrategy: \"allFields\" | \"missingFields\" | \"noFields\"; alertIgnoreFields: string[]; enableExperimental: string[]; packagerTaskInterval: string; packagerTaskPackagePolicyUpdateBatchSize: number; maxUploadResponseActionFileBytes: number; }> & { experimentalFeatures: ",
{
"pluginId": "securitySolution",
"scope": "common",
"docId": "kibSecuritySolutionPluginApi",
"section": "def-common.ExperimentalFeatures",
"text": "ExperimentalFeatures"
},
"; }"
],
"path": "x-pack/plugins/security_solution/server/config.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
],
"objects": [],
"setup": {
"parentPluginId": "securitySolution",
"id": "def-server.SecuritySolutionPluginSetup",
"type": "Interface",
"tags": [],
"label": "SecuritySolutionPluginSetup",
"description": [],
"path": "x-pack/plugins/security_solution/server/plugin_contract.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "securitySolution",
"id": "def-server.SecuritySolutionPluginSetup.setAppFeaturesConfigurator",
"type": "Function",
"tags": [],
"label": "setAppFeaturesConfigurator",
"description": [
"\nSets the configurations for app features that are available to the Security Solution"
],
"signature": [
"(configurator: ",
"AppFeaturesConfigurator",
") => void"
],
"path": "x-pack/plugins/security_solution/server/plugin_contract.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "securitySolution",
"id": "def-server.SecuritySolutionPluginSetup.setAppFeaturesConfigurator.$1",
"type": "Object",
"tags": [],
"label": "configurator",
"description": [],
"signature": [
"AppFeaturesConfigurator"
],
"path": "x-pack/plugins/security_solution/server/lib/app_features_service/app_features_service.ts",
"deprecated": false,
"trackAdoption": false
}
]
}
],
"lifecycle": "setup",
"initialIsOpen": true
},
"start": {
"parentPluginId": "securitySolution",
"id": "def-server.SecuritySolutionPluginStart",
"type": "Interface",
"tags": [],
"label": "SecuritySolutionPluginStart",
"description": [],
"path": "x-pack/plugins/security_solution/server/plugin_contract.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"lifecycle": "start",
"initialIsOpen": true
}
},
"common": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [
{
"parentPluginId": "securitySolution",
"id": "def-common.SecurityPageName",
"type": "Enum",
"tags": [],
"label": "SecurityPageName",
"description": [],
"path": "x-pack/packages/security-solution/navigation/src/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
],
"misc": [
{
"parentPluginId": "securitySolution",
"id": "def-common.ADD_DATA_PATH",
"type": "string",
"tags": [],
"label": "ADD_DATA_PATH",
"description": [],
"signature": [
"\"/app/integrations/browse/security\""
],
"path": "x-pack/plugins/security_solution/common/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "securitySolution",
"id": "def-common.APP_ID",
"type": "string",
"tags": [],
"label": "APP_ID",
"description": [
"\nas const\n\nThe const assertion ensures that type widening does not occur\nhttps://mariusschulz.com/blog/literal-type-widening-in-typescript\nPlease follow this convention when adding to this file"
],
"signature": [
"\"securitySolution\""
],
"path": "x-pack/plugins/security_solution/common/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "securitySolution",
"id": "def-common.APP_PATH",
"type": "string",
"tags": [],
"label": "APP_PATH",
"description": [],
"signature": [
"\"/app/security\""
],
"path": "x-pack/plugins/security_solution/common/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "securitySolution",
"id": "def-common.APP_UI_ID",
"type": "string",
"tags": [],
"label": "APP_UI_ID",
"description": [],
"signature": [
"\"securitySolutionUI\""
],
"path": "x-pack/plugins/security_solution/common/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "securitySolution",
"id": "def-common.CASES_FEATURE_ID",
"type": "string",
"tags": [],
"label": "CASES_FEATURE_ID",
"description": [],
"signature": [
"\"securitySolutionCases\""
],
"path": "x-pack/plugins/security_solution/common/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "securitySolution",
"id": "def-common.ELASTIC_SECURITY_RULE_ID",
"type": "string",
"tags": [],
"label": "ELASTIC_SECURITY_RULE_ID",
"description": [
"\nRule signature id (`rule.rule_id`) of the prebuilt \"Endpoint Security\" rule."
],
"signature": [
"\"9a1a2dae-0b5f-4c3d-8305-a268d404c306\""
],
"path": "x-pack/plugins/security_solution/common/detection_engine/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "securitySolution",
"id": "def-common.ExperimentalFeatures",
"type": "Type",
"tags": [],
"label": "ExperimentalFeatures",
"description": [],
"signature": [
"{ readonly tGridEnabled: boolean; readonly tGridEventRenderedViewEnabled: boolean; readonly excludePoliciesInFilterEnabled: boolean; readonly kubernetesEnabled: boolean; readonly chartEmbeddablesEnabled: boolean; readonly donutChartEmbeddablesEnabled: boolean; readonly alertsPreviewChartEmbeddablesEnabled: boolean; readonly previewTelemetryUrlEnabled: boolean; readonly insightsRelatedAlertsByProcessAncestry: boolean; readonly extendedRuleExecutionLoggingEnabled: boolean; readonly socTrendsEnabled: boolean; readonly responseActionsEnabled: boolean; readonly endpointResponseActionsEnabled: boolean; readonly alertDetailsPageEnabled: boolean; readonly responseActionUploadEnabled: boolean; readonly alertsPageChartsEnabled: boolean; readonly alertTypeEnabled: boolean; readonly alertsPageFiltersEnabled: boolean; readonly newUserDetailsFlyout: boolean; readonly riskScoringPersistence: boolean; readonly riskScoringRoutesEnabled: boolean; readonly discoverInTimeline: boolean; readonly protectionUpdatesEnabled: boolean; }"
],
"path": "x-pack/plugins/security_solution/common/experimental_features.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "securitySolution",
"id": "def-common.MANAGE_PATH",
"type": "string",
"tags": [],
"label": "MANAGE_PATH",
"description": [],
"signature": [
"\"/manage\""
],
"path": "x-pack/plugins/security_solution/common/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "securitySolution",
"id": "def-common.SERVER_APP_ID",
"type": "string",
"tags": [],
"label": "SERVER_APP_ID",
"description": [],
"signature": [
"\"siem\""
],
"path": "x-pack/plugins/security_solution/common/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
],
"objects": [
{
"parentPluginId": "securitySolution",
"id": "def-common.allowedExperimentalValues",
"type": "Object",
"tags": [],
"label": "allowedExperimentalValues",
"description": [
"\nA list of allowed values that can be used in `xpack.securitySolution.enableExperimental`.\nThis object is then used to validate and parse the value entered."
],
"signature": [
"{ readonly tGridEnabled: boolean; readonly tGridEventRenderedViewEnabled: boolean; readonly excludePoliciesInFilterEnabled: boolean; readonly kubernetesEnabled: boolean; readonly chartEmbeddablesEnabled: boolean; readonly donutChartEmbeddablesEnabled: boolean; readonly alertsPreviewChartEmbeddablesEnabled: boolean; readonly previewTelemetryUrlEnabled: boolean; readonly insightsRelatedAlertsByProcessAncestry: boolean; readonly extendedRuleExecutionLoggingEnabled: boolean; readonly socTrendsEnabled: boolean; readonly responseActionsEnabled: boolean; readonly endpointResponseActionsEnabled: boolean; readonly alertDetailsPageEnabled: boolean; readonly responseActionUploadEnabled: boolean; readonly alertsPageChartsEnabled: boolean; readonly alertTypeEnabled: boolean; readonly alertsPageFiltersEnabled: boolean; readonly newUserDetailsFlyout: boolean; readonly riskScoringPersistence: boolean; readonly riskScoringRoutesEnabled: boolean; readonly discoverInTimeline: boolean; readonly protectionUpdatesEnabled: boolean; }"
],
"path": "x-pack/plugins/security_solution/common/experimental_features.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
]
}
}
Reference in a new issue View git blame Copy permalink