maxmustermann/kibana
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity
kibana/api_docs/fleet.json
Mike Côté 3abb79a179
Create new alerting HTTP APIs that use the new terminology (#93977) 
* Move current alert HTTP APIs to legacy folder (#93943)

* Move current HTTP APIs to legacy folder

* Rename BASE_ALERT_API_PATH to LEGACY_BASE_ALERT_API_PATH

* Fix failing tests and extra files

* Create new rule HTTP APIs (#93980)

* Move current HTTP APIs to legacy folder

* Rename BASE_ALERT_API_PATH to LEGACY_BASE_ALERT_API_PATH

* Fix failing tests and extra files

* Move current alert HTTP APIs to legacy folder (#93943)

* Move current HTTP APIs to legacy folder

* Rename BASE_ALERT_API_PATH to LEGACY_BASE_ALERT_API_PATH

* Fix failing tests and extra files

* Add necessary files

* Create rule route

* Get rule API

* Update rule API

* Delete rule route

* Aggregate rules API

* Disable rule API

* Enable rule API

* Find rules API

* Fix Update API

* Get rule alert summary API

* Get rule state API

* Health API

* Rule types API

* Mute all API

* Mute alert API

* Unmute all API

* Unmute alert route

* Update API key API

* corrected tpye by making it much more complicated

* removed unneeded cocde

* Fixes

* Add back health route

* mutedInstanceIds -> mutedAlertIds

* lastRun -> last_run

* alert_type_state -> rule_type_state & alert_instances -> alerts

Co-authored-by: Gidi Meir Morris <github@gidi.io>

* Create docs for new rule HTTP APIs, deprecate old docs (#94745)

* Create docs for new APIs, deprecate old docs

* Remove connector_type_id

* Update docs

* Add link to legacy APIs from rules API docs

* Remove connector_type_id references

* [DOCS] Add legacy APIs to index.asciidoc

* Fix camel case

Co-authored-by: lcawl <lcawley@elastic.co>

* Make alerting tests use new rules APIs (#95159)

* Make API integration tests use new HTTP APIs

* Fix end to end tests

* Fix test failures

* Fix more test failures

* Rename some files

* Add tests for legacy APIs (#95333)

* Initial commit (#95457)

* Move some new alerting APIs to /internal (#95461)

* Initial commit

* Update README.md

* Use internal API

* Merge deprecated warning w/ alternative solution

* Update API docs

Co-authored-by: Gidi Meir Morris <github@gidi.io>
Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
Co-authored-by: lcawl <lcawley@elastic.co>
2021-03-30 08:27:28 -04:00

16548 lines
504 KiB
JSON
Raw Blame History

{
"id": "fleet",
"client": {
"classes": [],
"functions": [
{
"id": "def-public.pkgKeyFromPackageInfo",
"type": "Function",
"children": [
{
"type": "Uncategorized",
"label": "packageInfo",
"isRequired": true,
"signature": [
"T"
],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/public/applications/fleet/services/pkg_key_from_package_info.ts",
"lineNumber": 9
}
}
],
"signature": [
"<T extends { name: string; version: string; }>(packageInfo: T) => string"
],
"description": [],
"label": "pkgKeyFromPackageInfo",
"source": {
"path": "x-pack/plugins/fleet/public/applications/fleet/services/pkg_key_from_package_info.ts",
"lineNumber": 8
},
"tags": [],
"returnComment": [],
"initialIsOpen": false
}
],
"interfaces": [
{
"id": "def-public.AgentDetailsReassignPolicyAction",
"type": "Interface",
"label": "AgentDetailsReassignPolicyAction",
"description": [
"\nSupported routing state for the agent policy details page routes with deploy agents action"
],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.AgentDetailsReassignPolicyAction.onDoneNavigateTo",
"type": "Object",
"label": "onDoneNavigateTo",
"description": [
"On done, navigate to the given app"
],
"source": {
"path": "x-pack/plugins/fleet/public/applications/fleet/types/intra_app_route_state.ts",
"lineNumber": 39
},
"signature": [
"[appId: string, options?: ",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreApplicationPluginApi",
"section": "def-public.NavigateToAppOptions",
"text": "NavigateToAppOptions"
},
" | undefined] | undefined"
]
}
],
"source": {
"path": "x-pack/plugins/fleet/public/applications/fleet/types/intra_app_route_state.ts",
"lineNumber": 37
},
"initialIsOpen": false
},
{
"id": "def-public.AgentPolicyDetailsDeployAgentAction",
"type": "Interface",
"label": "AgentPolicyDetailsDeployAgentAction",
"description": [
"\nSupported routing state for the agent policy details page routes with deploy agents action"
],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.AgentPolicyDetailsDeployAgentAction.onDoneNavigateTo",
"type": "Object",
"label": "onDoneNavigateTo",
"description": [
"On done, navigate to the given app"
],
"source": {
"path": "x-pack/plugins/fleet/public/applications/fleet/types/intra_app_route_state.ts",
"lineNumber": 31
},
"signature": [
"[appId: string, options?: ",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreApplicationPluginApi",
"section": "def-public.NavigateToAppOptions",
"text": "NavigateToAppOptions"
},
" | undefined] | undefined"
]
}
],
"source": {
"path": "x-pack/plugins/fleet/public/applications/fleet/types/intra_app_route_state.ts",
"lineNumber": 29
},
"initialIsOpen": false
},
{
"id": "def-public.CreatePackagePolicyRouteState",
"type": "Interface",
"label": "CreatePackagePolicyRouteState",
"description": [
"\nSupported routing state for the create package policy page routes"
],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.CreatePackagePolicyRouteState.onSaveNavigateTo",
"type": "CompoundType",
"label": "onSaveNavigateTo",
"description": [
"On a successful save of the package policy, use navigate to the given app"
],
"source": {
"path": "x-pack/plugins/fleet/public/applications/fleet/types/intra_app_route_state.ts",
"lineNumber": 17
},
"signature": [
"[appId: string, options?: ",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreApplicationPluginApi",
"section": "def-public.NavigateToAppOptions",
"text": "NavigateToAppOptions"
},
" | undefined] | ((newPackagePolicy: ",
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.PackagePolicy",
"text": "PackagePolicy"
},
") => [appId: string, options?: ",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreApplicationPluginApi",
"section": "def-public.NavigateToAppOptions",
"text": "NavigateToAppOptions"
},
" | undefined]) | undefined"
]
},
{
"tags": [],
"id": "def-public.CreatePackagePolicyRouteState.onCancelNavigateTo",
"type": "Object",
"label": "onCancelNavigateTo",
"description": [
"On cancel, navigate to the given app"
],
"source": {
"path": "x-pack/plugins/fleet/public/applications/fleet/types/intra_app_route_state.ts",
"lineNumber": 21
},
"signature": [
"[appId: string, options?: ",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreApplicationPluginApi",
"section": "def-public.NavigateToAppOptions",
"text": "NavigateToAppOptions"
},
" | undefined] | undefined"
]
},
{
"tags": [],
"id": "def-public.CreatePackagePolicyRouteState.onCancelUrl",
"type": "string",
"label": "onCancelUrl",
"description": [
"Url to be used on cancel links"
],
"source": {
"path": "x-pack/plugins/fleet/public/applications/fleet/types/intra_app_route_state.ts",
"lineNumber": 23
},
"signature": [
"string | undefined"
]
}
],
"source": {
"path": "x-pack/plugins/fleet/public/applications/fleet/types/intra_app_route_state.ts",
"lineNumber": 15
},
"initialIsOpen": false
},
{
"id": "def-public.NewPackagePolicy",
"type": "Interface",
"label": "NewPackagePolicy",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.NewPackagePolicy.name",
"type": "string",
"label": "name",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/package_policy.ts",
"lineNumber": 50
}
},
{
"tags": [],
"id": "def-public.NewPackagePolicy.description",
"type": "string",
"label": "description",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/package_policy.ts",
"lineNumber": 51
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-public.NewPackagePolicy.namespace",
"type": "string",
"label": "namespace",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/package_policy.ts",
"lineNumber": 52
}
},
{
"tags": [],
"id": "def-public.NewPackagePolicy.enabled",
"type": "boolean",
"label": "enabled",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/package_policy.ts",
"lineNumber": 53
}
},
{
"tags": [],
"id": "def-public.NewPackagePolicy.policy_id",
"type": "string",
"label": "policy_id",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/package_policy.ts",
"lineNumber": 54
}
},
{
"tags": [],
"id": "def-public.NewPackagePolicy.output_id",
"type": "string",
"label": "output_id",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/package_policy.ts",
"lineNumber": 55
}
},
{
"tags": [],
"id": "def-public.NewPackagePolicy.package",
"type": "Object",
"label": "package",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/package_policy.ts",
"lineNumber": 56
},
"signature": [
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.PackagePolicyPackage",
"text": "PackagePolicyPackage"
},
" | undefined"
]
},
{
"tags": [],
"id": "def-public.NewPackagePolicy.inputs",
"type": "Array",
"label": "inputs",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/package_policy.ts",
"lineNumber": 57
},
"signature": [
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.NewPackagePolicyInput",
"text": "NewPackagePolicyInput"
},
"[]"
]
}
],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/package_policy.ts",
"lineNumber": 49
},
"initialIsOpen": false
},
{
"id": "def-public.PackageCustomExtension",
"type": "Interface",
"label": "PackageCustomExtension",
"description": [
"Extension point registration contract for Integration details Custom view"
],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.PackageCustomExtension.package",
"type": "string",
"label": "package",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts",
"lineNumber": 95
}
},
{
"tags": [],
"id": "def-public.PackageCustomExtension.view",
"type": "string",
"label": "view",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts",
"lineNumber": 96
},
"signature": [
"\"package-detail-custom\""
]
},
{
"tags": [],
"id": "def-public.PackageCustomExtension.component",
"type": "Function",
"label": "component",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts",
"lineNumber": 97
},
"signature": [
"React.LazyExoticComponent<React.ComponentType<",
{
"pluginId": "fleet",
"scope": "public",
"docId": "kibFleetPluginApi",
"section": "def-public.PackageCustomExtensionComponentProps",
"text": "PackageCustomExtensionComponentProps"
},
">>"
]
}
],
"source": {
"path": "x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts",
"lineNumber": 94
},
"initialIsOpen": false
},
{
"id": "def-public.PackageCustomExtensionComponentProps",
"type": "Interface",
"label": "PackageCustomExtensionComponentProps",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.PackageCustomExtensionComponentProps.pkgkey",
"type": "string",
"label": "pkgkey",
"description": [
"The package key value that should be used used for URLs"
],
"source": {
"path": "x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts",
"lineNumber": 89
}
},
{
"tags": [],
"id": "def-public.PackageCustomExtensionComponentProps.packageInfo",
"type": "CompoundType",
"label": "packageInfo",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts",
"lineNumber": 90
},
"signature": [
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.PackageInfo",
"text": "PackageInfo"
}
]
}
],
"source": {
"path": "x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts",
"lineNumber": 87
},
"initialIsOpen": false
},
{
"id": "def-public.PackagePolicyCreateExtension",
"type": "Interface",
"label": "PackagePolicyCreateExtension",
"description": [
"Extension point registration contract for Integration Policy Create views"
],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.PackagePolicyCreateExtension.package",
"type": "string",
"label": "package",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts",
"lineNumber": 77
}
},
{
"tags": [],
"id": "def-public.PackagePolicyCreateExtension.view",
"type": "string",
"label": "view",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts",
"lineNumber": 78
},
"signature": [
"\"package-policy-create\""
]
},
{
"tags": [],
"id": "def-public.PackagePolicyCreateExtension.component",
"type": "Function",
"label": "component",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts",
"lineNumber": 79
},
"signature": [
"React.LazyExoticComponent<React.ComponentType<",
{
"pluginId": "fleet",
"scope": "public",
"docId": "kibFleetPluginApi",
"section": "def-public.PackagePolicyCreateExtensionComponentProps",
"text": "PackagePolicyCreateExtensionComponentProps"
},
">>"
]
}
],
"source": {
"path": "x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts",
"lineNumber": 76
},
"initialIsOpen": false
},
{
"id": "def-public.PackagePolicyCreateExtensionComponentProps",
"type": "Interface",
"label": "PackagePolicyCreateExtensionComponentProps",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.PackagePolicyCreateExtensionComponentProps.newPolicy",
"type": "Object",
"label": "newPolicy",
"description": [
"The integration policy being created"
],
"source": {
"path": "x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts",
"lineNumber": 62
},
"signature": [
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.NewPackagePolicy",
"text": "NewPackagePolicy"
}
]
},
{
"tags": [],
"id": "def-public.PackagePolicyCreateExtensionComponentProps.onChange",
"type": "Function",
"label": "onChange",
"description": [
"\nA callback that should be executed anytime a change to the Integration Policy needs to\nbe reported back to the Fleet Policy Edit page"
],
"source": {
"path": "x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts",
"lineNumber": 67
},
"signature": [
"(opts: { isValid: boolean; updatedPolicy: ",
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.NewPackagePolicy",
"text": "NewPackagePolicy"
},
"; }) => void"
]
}
],
"source": {
"path": "x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts",
"lineNumber": 60
},
"initialIsOpen": false
},
{
"id": "def-public.PackagePolicyEditExtension",
"type": "Interface",
"label": "PackagePolicyEditExtension",
"description": [
"Extension point registration contract for Integration Policy Edit views"
],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.PackagePolicyEditExtension.package",
"type": "string",
"label": "package",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts",
"lineNumber": 49
}
},
{
"tags": [],
"id": "def-public.PackagePolicyEditExtension.view",
"type": "string",
"label": "view",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts",
"lineNumber": 50
},
"signature": [
"\"package-policy-edit\""
]
},
{
"tags": [],
"id": "def-public.PackagePolicyEditExtension.component",
"type": "Function",
"label": "component",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts",
"lineNumber": 51
},
"signature": [
"React.LazyExoticComponent<React.ComponentType<",
{
"pluginId": "fleet",
"scope": "public",
"docId": "kibFleetPluginApi",
"section": "def-public.PackagePolicyEditExtensionComponentProps",
"text": "PackagePolicyEditExtensionComponentProps"
},
">>"
]
}
],
"source": {
"path": "x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts",
"lineNumber": 48
},
"initialIsOpen": false
},
{
"id": "def-public.PackagePolicyEditExtensionComponentProps",
"type": "Interface",
"label": "PackagePolicyEditExtensionComponentProps",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.PackagePolicyEditExtensionComponentProps.policy",
"type": "Object",
"label": "policy",
"description": [
"The current integration policy being edited"
],
"source": {
"path": "x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts",
"lineNumber": 28
},
"signature": [
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.PackagePolicy",
"text": "PackagePolicy"
}
]
},
{
"tags": [],
"id": "def-public.PackagePolicyEditExtensionComponentProps.newPolicy",
"type": "Object",
"label": "newPolicy",
"description": [
"The new (updated) integration policy that will be saved"
],
"source": {
"path": "x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts",
"lineNumber": 30
},
"signature": [
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.NewPackagePolicy",
"text": "NewPackagePolicy"
}
]
},
{
"tags": [],
"id": "def-public.PackagePolicyEditExtensionComponentProps.onChange",
"type": "Function",
"label": "onChange",
"description": [
"\nA callback that should be executed anytime a change to the Integration Policy needs to\nbe reported back to the Fleet Policy Edit page.\n\n**NOTE:**\nthis callback will be recreated everytime the policy data changes, thus logic around its\ninvocation should take that into consideration in order to avoid an endless loop."
],
"source": {
"path": "x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts",
"lineNumber": 39
},
"signature": [
"(opts: { isValid: boolean; updatedPolicy: Partial<",
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.NewPackagePolicy",
"text": "NewPackagePolicy"
},
">; }) => void"
]
}
],
"source": {
"path": "x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts",
"lineNumber": 26
},
"initialIsOpen": false
},
{
"id": "def-public.UIExtensionsStorage",
"type": "Interface",
"label": "UIExtensionsStorage",
"description": [
"Internal storage for registered UI Extension Points"
],
"tags": [],
"children": [
{
"id": "def-public.UIExtensionsStorage.Unnamed",
"type": "Any",
"label": "Unnamed",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts",
"lineNumber": 17
},
"signature": [
"any"
]
}
],
"source": {
"path": "x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts",
"lineNumber": 16
},
"initialIsOpen": false
}
],
"enums": [],
"misc": [
{
"id": "def-public.AnyIntraAppRouteState",
"type": "Type",
"label": "AnyIntraAppRouteState",
"tags": [],
"description": [
"\nAll possible Route states."
],
"source": {
"path": "x-pack/plugins/fleet/public/applications/fleet/types/intra_app_route_state.ts",
"lineNumber": 45
},
"signature": [
{
"pluginId": "fleet",
"scope": "public",
"docId": "kibFleetPluginApi",
"section": "def-public.CreatePackagePolicyRouteState",
"text": "CreatePackagePolicyRouteState"
},
" | ",
{
"pluginId": "fleet",
"scope": "public",
"docId": "kibFleetPluginApi",
"section": "def-public.AgentPolicyDetailsDeployAgentAction",
"text": "AgentPolicyDetailsDeployAgentAction"
},
" | ",
{
"pluginId": "fleet",
"scope": "public",
"docId": "kibFleetPluginApi",
"section": "def-public.AgentDetailsReassignPolicyAction",
"text": "AgentDetailsReassignPolicyAction"
}
],
"initialIsOpen": false
},
{
"id": "def-public.PackageCustomExtensionComponent",
"type": "Type",
"label": "PackageCustomExtensionComponent",
"tags": [],
"description": [
"\nUI Component Extension is used to display a Custom tab (and view) under a given Integration"
],
"source": {
"path": "x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts",
"lineNumber": 85
},
"signature": [
"React.ComponentClass<",
{
"pluginId": "fleet",
"scope": "public",
"docId": "kibFleetPluginApi",
"section": "def-public.PackageCustomExtensionComponentProps",
"text": "PackageCustomExtensionComponentProps"
},
", any> | React.FunctionComponent<",
{
"pluginId": "fleet",
"scope": "public",
"docId": "kibFleetPluginApi",
"section": "def-public.PackageCustomExtensionComponentProps",
"text": "PackageCustomExtensionComponentProps"
},
">"
],
"initialIsOpen": false
},
{
"id": "def-public.PackagePolicyCreateExtensionComponent",
"type": "Type",
"label": "PackagePolicyCreateExtensionComponent",
"tags": [],
"description": [
"\nUI Component Extension is used on the pages displaying the ability to Create an\nIntegration Policy"
],
"source": {
"path": "x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts",
"lineNumber": 58
},
"signature": [
"React.ComponentClass<",
{
"pluginId": "fleet",
"scope": "public",
"docId": "kibFleetPluginApi",
"section": "def-public.PackagePolicyCreateExtensionComponentProps",
"text": "PackagePolicyCreateExtensionComponentProps"
},
", any> | React.FunctionComponent<",
{
"pluginId": "fleet",
"scope": "public",
"docId": "kibFleetPluginApi",
"section": "def-public.PackagePolicyCreateExtensionComponentProps",
"text": "PackagePolicyCreateExtensionComponentProps"
},
">"
],
"initialIsOpen": false
},
{
"id": "def-public.PackagePolicyEditExtensionComponent",
"type": "Type",
"label": "PackagePolicyEditExtensionComponent",
"tags": [],
"description": [
"\nUI Component Extension is used on the pages displaying the ability to edit an\nIntegration Policy"
],
"source": {
"path": "x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts",
"lineNumber": 24
},
"signature": [
"React.ComponentClass<",
{
"pluginId": "fleet",
"scope": "public",
"docId": "kibFleetPluginApi",
"section": "def-public.PackagePolicyEditExtensionComponentProps",
"text": "PackagePolicyEditExtensionComponentProps"
},
", any> | React.FunctionComponent<",
{
"pluginId": "fleet",
"scope": "public",
"docId": "kibFleetPluginApi",
"section": "def-public.PackagePolicyEditExtensionComponentProps",
"text": "PackagePolicyEditExtensionComponentProps"
},
">"
],
"initialIsOpen": false
},
{
"id": "def-public.UIExtensionPoint",
"type": "Type",
"label": "UIExtensionPoint",
"tags": [],
"description": [
"Fleet UI Extension Point"
],
"source": {
"path": "x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts",
"lineNumber": 101
},
"signature": [
{
"pluginId": "fleet",
"scope": "public",
"docId": "kibFleetPluginApi",
"section": "def-public.PackagePolicyEditExtension",
"text": "PackagePolicyEditExtension"
},
" | ",
{
"pluginId": "fleet",
"scope": "public",
"docId": "kibFleetPluginApi",
"section": "def-public.PackageCustomExtension",
"text": "PackageCustomExtension"
},
" | ",
{
"pluginId": "fleet",
"scope": "public",
"docId": "kibFleetPluginApi",
"section": "def-public.PackagePolicyCreateExtension",
"text": "PackagePolicyCreateExtension"
}
],
"initialIsOpen": false
},
{
"id": "def-public.UIExtensionRegistrationCallback",
"type": "Type",
"label": "UIExtensionRegistrationCallback",
"tags": [],
"description": [
"Register a Fleet UI extension"
],
"source": {
"path": "x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts",
"lineNumber": 13
},
"signature": [
"(extensionPoint: ",
{
"pluginId": "fleet",
"scope": "public",
"docId": "kibFleetPluginApi",
"section": "def-public.UIExtensionPoint",
"text": "UIExtensionPoint"
},
") => void"
],
"initialIsOpen": false
}
],
"objects": [
{
"id": "def-public.pagePathGetters",
"type": "Object",
"tags": [],
"children": [
{
"id": "def-public.pagePathGetters.base",
"type": "Function",
"children": [],
"signature": [
"() => string"
],
"description": [],
"label": "base",
"source": {
"path": "x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts",
"lineNumber": 75
},
"tags": [],
"returnComment": []
},
{
"id": "def-public.pagePathGetters.overview",
"type": "Function",
"children": [],
"signature": [
"() => string"
],
"description": [],
"label": "overview",
"source": {
"path": "x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts",
"lineNumber": 76
},
"tags": [],
"returnComment": []
},
{
"id": "def-public.pagePathGetters.integrations",
"type": "Function",
"children": [],
"signature": [
"() => string"
],
"description": [],
"label": "integrations",
"source": {
"path": "x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts",
"lineNumber": 77
},
"tags": [],
"returnComment": []
},
{
"id": "def-public.pagePathGetters.integrations_all",
"type": "Function",
"children": [],
"signature": [
"() => string"
],
"description": [],
"label": "integrations_all",
"source": {
"path": "x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts",
"lineNumber": 78
},
"tags": [],
"returnComment": []
},
{
"id": "def-public.pagePathGetters.integrations_installed",
"type": "Function",
"children": [],
"signature": [
"() => string"
],
"description": [],
"label": "integrations_installed",
"source": {
"path": "x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts",
"lineNumber": 79
},
"tags": [],
"returnComment": []
},
{
"id": "def-public.pagePathGetters.integration_details_overview",
"type": "Function",
"children": [
{
"type": "Object",
"label": "{ pkgkey }",
"isRequired": true,
"signature": [
{
"pluginId": "fleet",
"scope": "public",
"docId": "kibFleetPluginApi",
"section": "def-public.DynamicPagePathValues",
"text": "DynamicPagePathValues"
}
],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts",
"lineNumber": 80
}
}
],
"signature": [
"({ pkgkey }: ",
{
"pluginId": "fleet",
"scope": "public",
"docId": "kibFleetPluginApi",
"section": "def-public.DynamicPagePathValues",
"text": "DynamicPagePathValues"
},
") => string"
],
"description": [],
"label": "integration_details_overview",
"source": {
"path": "x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts",
"lineNumber": 80
},
"tags": [],
"returnComment": []
},
{
"id": "def-public.pagePathGetters.integration_details_policies",
"type": "Function",
"children": [
{
"type": "Object",
"label": "{ pkgkey }",
"isRequired": true,
"signature": [
{
"pluginId": "fleet",
"scope": "public",
"docId": "kibFleetPluginApi",
"section": "def-public.DynamicPagePathValues",
"text": "DynamicPagePathValues"
}
],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts",
"lineNumber": 81
}
}
],
"signature": [
"({ pkgkey }: ",
{
"pluginId": "fleet",
"scope": "public",
"docId": "kibFleetPluginApi",
"section": "def-public.DynamicPagePathValues",
"text": "DynamicPagePathValues"
},
") => string"
],
"description": [],
"label": "integration_details_policies",
"source": {
"path": "x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts",
"lineNumber": 81
},
"tags": [],
"returnComment": []
},
{
"id": "def-public.pagePathGetters.integration_details_settings",
"type": "Function",
"children": [
{
"type": "Object",
"label": "{ pkgkey }",
"isRequired": true,
"signature": [
{
"pluginId": "fleet",
"scope": "public",
"docId": "kibFleetPluginApi",
"section": "def-public.DynamicPagePathValues",
"text": "DynamicPagePathValues"
}
],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts",
"lineNumber": 82
}
}
],
"signature": [
"({ pkgkey }: ",
{
"pluginId": "fleet",
"scope": "public",
"docId": "kibFleetPluginApi",
"section": "def-public.DynamicPagePathValues",
"text": "DynamicPagePathValues"
},
") => string"
],
"description": [],
"label": "integration_details_settings",
"source": {
"path": "x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts",
"lineNumber": 82
},
"tags": [],
"returnComment": []
},
{
"id": "def-public.pagePathGetters.integration_details_custom",
"type": "Function",
"children": [
{
"type": "Object",
"label": "{ pkgkey }",
"isRequired": true,
"signature": [
{
"pluginId": "fleet",
"scope": "public",
"docId": "kibFleetPluginApi",
"section": "def-public.DynamicPagePathValues",
"text": "DynamicPagePathValues"
}
],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts",
"lineNumber": 83
}
}
],
"signature": [
"({ pkgkey }: ",
{
"pluginId": "fleet",
"scope": "public",
"docId": "kibFleetPluginApi",
"section": "def-public.DynamicPagePathValues",
"text": "DynamicPagePathValues"
},
") => string"
],
"description": [],
"label": "integration_details_custom",
"source": {
"path": "x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts",
"lineNumber": 83
},
"tags": [],
"returnComment": []
},
{
"id": "def-public.pagePathGetters.integration_policy_edit",
"type": "Function",
"children": [
{
"type": "Object",
"label": "{ packagePolicyId }",
"isRequired": true,
"signature": [
{
"pluginId": "fleet",
"scope": "public",
"docId": "kibFleetPluginApi",
"section": "def-public.DynamicPagePathValues",
"text": "DynamicPagePathValues"
}
],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts",
"lineNumber": 84
}
}
],
"signature": [
"({ packagePolicyId }: ",
{
"pluginId": "fleet",
"scope": "public",
"docId": "kibFleetPluginApi",
"section": "def-public.DynamicPagePathValues",
"text": "DynamicPagePathValues"
},
") => string"
],
"description": [],
"label": "integration_policy_edit",
"source": {
"path": "x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts",
"lineNumber": 84
},
"tags": [],
"returnComment": []
},
{
"id": "def-public.pagePathGetters.policies",
"type": "Function",
"children": [],
"signature": [
"() => string"
],
"description": [],
"label": "policies",
"source": {
"path": "x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts",
"lineNumber": 86
},
"tags": [],
"returnComment": []
},
{
"id": "def-public.pagePathGetters.policies_list",
"type": "Function",
"children": [],
"signature": [
"() => string"
],
"description": [],
"label": "policies_list",
"source": {
"path": "x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts",
"lineNumber": 87
},
"tags": [],
"returnComment": []
},
{
"id": "def-public.pagePathGetters.policy_details",
"type": "Function",
"children": [
{
"type": "Object",
"label": "{ policyId, tabId }",
"isRequired": true,
"signature": [
{
"pluginId": "fleet",
"scope": "public",
"docId": "kibFleetPluginApi",
"section": "def-public.DynamicPagePathValues",
"text": "DynamicPagePathValues"
}
],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts",
"lineNumber": 88
}
}
],
"signature": [
"({ policyId, tabId }: ",
{
"pluginId": "fleet",
"scope": "public",
"docId": "kibFleetPluginApi",
"section": "def-public.DynamicPagePathValues",
"text": "DynamicPagePathValues"
},
") => string"
],
"description": [],
"label": "policy_details",
"source": {
"path": "x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts",
"lineNumber": 88
},
"tags": [],
"returnComment": []
},
{
"id": "def-public.pagePathGetters.add_integration_from_policy",
"type": "Function",
"children": [
{
"type": "Object",
"label": "{ policyId }",
"isRequired": true,
"signature": [
{
"pluginId": "fleet",
"scope": "public",
"docId": "kibFleetPluginApi",
"section": "def-public.DynamicPagePathValues",
"text": "DynamicPagePathValues"
}
],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts",
"lineNumber": 89
}
}
],
"signature": [
"({ policyId }: ",
{
"pluginId": "fleet",
"scope": "public",
"docId": "kibFleetPluginApi",
"section": "def-public.DynamicPagePathValues",
"text": "DynamicPagePathValues"
},
") => string"
],
"description": [],
"label": "add_integration_from_policy",
"source": {
"path": "x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts",
"lineNumber": 89
},
"tags": [],
"returnComment": []
},
{
"id": "def-public.pagePathGetters.add_integration_to_policy",
"type": "Function",
"children": [
{
"type": "Object",
"label": "{ pkgkey }",
"isRequired": true,
"signature": [
{
"pluginId": "fleet",
"scope": "public",
"docId": "kibFleetPluginApi",
"section": "def-public.DynamicPagePathValues",
"text": "DynamicPagePathValues"
}
],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts",
"lineNumber": 90
}
}
],
"signature": [
"({ pkgkey }: ",
{
"pluginId": "fleet",
"scope": "public",
"docId": "kibFleetPluginApi",
"section": "def-public.DynamicPagePathValues",
"text": "DynamicPagePathValues"
},
") => string"
],
"description": [],
"label": "add_integration_to_policy",
"source": {
"path": "x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts",
"lineNumber": 90
},
"tags": [],
"returnComment": []
},
{
"id": "def-public.pagePathGetters.edit_integration",
"type": "Function",
"children": [
{
"type": "Object",
"label": "{ policyId, packagePolicyId }",
"isRequired": true,
"signature": [
{
"pluginId": "fleet",
"scope": "public",
"docId": "kibFleetPluginApi",
"section": "def-public.DynamicPagePathValues",
"text": "DynamicPagePathValues"
}
],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts",
"lineNumber": 91
}
}
],
"signature": [
"({ policyId, packagePolicyId }: ",
{
"pluginId": "fleet",
"scope": "public",
"docId": "kibFleetPluginApi",
"section": "def-public.DynamicPagePathValues",
"text": "DynamicPagePathValues"
},
") => string"
],
"description": [],
"label": "edit_integration",
"source": {
"path": "x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts",
"lineNumber": 91
},
"tags": [],
"returnComment": []
},
{
"id": "def-public.pagePathGetters.fleet",
"type": "Function",
"children": [],
"signature": [
"() => string"
],
"description": [],
"label": "fleet",
"source": {
"path": "x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts",
"lineNumber": 93
},
"tags": [],
"returnComment": []
},
{
"id": "def-public.pagePathGetters.fleet_agent_list",
"type": "Function",
"children": [
{
"type": "Object",
"label": "{ kuery }",
"isRequired": true,
"signature": [
{
"pluginId": "fleet",
"scope": "public",
"docId": "kibFleetPluginApi",
"section": "def-public.DynamicPagePathValues",
"text": "DynamicPagePathValues"
}
],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts",
"lineNumber": 94
}
}
],
"signature": [
"({ kuery }: ",
{
"pluginId": "fleet",
"scope": "public",
"docId": "kibFleetPluginApi",
"section": "def-public.DynamicPagePathValues",
"text": "DynamicPagePathValues"
},
") => string"
],
"description": [],
"label": "fleet_agent_list",
"source": {
"path": "x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts",
"lineNumber": 94
},
"tags": [],
"returnComment": []
},
{
"id": "def-public.pagePathGetters.fleet_agent_details",
"type": "Function",
"children": [
{
"type": "Object",
"label": "{ agentId, tabId, logQuery }",
"isRequired": true,
"signature": [
{
"pluginId": "fleet",
"scope": "public",
"docId": "kibFleetPluginApi",
"section": "def-public.DynamicPagePathValues",
"text": "DynamicPagePathValues"
}
],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts",
"lineNumber": 95
}
}
],
"signature": [
"({ agentId, tabId, logQuery }: ",
{
"pluginId": "fleet",
"scope": "public",
"docId": "kibFleetPluginApi",
"section": "def-public.DynamicPagePathValues",
"text": "DynamicPagePathValues"
},
") => string"
],
"description": [],
"label": "fleet_agent_details",
"source": {
"path": "x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts",
"lineNumber": 95
},
"tags": [],
"returnComment": []
},
{
"id": "def-public.pagePathGetters.fleet_enrollment_tokens",
"type": "Function",
"children": [],
"signature": [
"() => string"
],
"description": [],
"label": "fleet_enrollment_tokens",
"source": {
"path": "x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts",
"lineNumber": 97
},
"tags": [],
"returnComment": []
},
{
"id": "def-public.pagePathGetters.data_streams",
"type": "Function",
"children": [],
"signature": [
"() => string"
],
"description": [],
"label": "data_streams",
"source": {
"path": "x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts",
"lineNumber": 98
},
"tags": [],
"returnComment": []
}
],
"description": [],
"label": "pagePathGetters",
"source": {
"path": "x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts",
"lineNumber": 69
},
"initialIsOpen": false
}
],
"setup": {
"id": "def-public.FleetSetup",
"type": "Interface",
"label": "FleetSetup",
"description": [],
"tags": [],
"children": [],
"source": {
"path": "x-pack/plugins/fleet/public/plugin.ts",
"lineNumber": 50
},
"lifecycle": "setup",
"initialIsOpen": true
},
"start": {
"id": "def-public.FleetStart",
"type": "Interface",
"label": "FleetStart",
"description": [
"\nDescribes public Fleet plugin contract returned at the `start` stage."
],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.FleetStart.registerExtension",
"type": "Function",
"label": "registerExtension",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/public/plugin.ts",
"lineNumber": 56
},
"signature": [
{
"pluginId": "fleet",
"scope": "public",
"docId": "kibFleetPluginApi",
"section": "def-public.UIExtensionRegistrationCallback",
"text": "UIExtensionRegistrationCallback"
}
]
},
{
"tags": [],
"id": "def-public.FleetStart.isInitialized",
"type": "Function",
"label": "isInitialized",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/public/plugin.ts",
"lineNumber": 57
},
"signature": [
"() => Promise<true>"
]
}
],
"source": {
"path": "x-pack/plugins/fleet/public/plugin.ts",
"lineNumber": 55
},
"lifecycle": "start",
"initialIsOpen": true
}
},
"server": {
"classes": [
{
"id": "def-server.AgentNotFoundError",
"type": "Class",
"tags": [],
"label": "AgentNotFoundError",
"description": [],
"signature": [
{
"pluginId": "fleet",
"scope": "server",
"docId": "kibFleetPluginApi",
"section": "def-server.AgentNotFoundError",
"text": "AgentNotFoundError"
},
" extends ",
"IngestManagerError"
],
"children": [],
"source": {
"path": "x-pack/plugins/fleet/server/errors/index.ts",
"lineNumber": 37
},
"initialIsOpen": false
}
],
"functions": [
{
"id": "def-server.getRegistryUrl",
"type": "Function",
"children": [],
"signature": [
"() => string"
],
"description": [],
"label": "getRegistryUrl",
"source": {
"path": "x-pack/plugins/fleet/server/services/epm/registry/registry_url.ts",
"lineNumber": 33
},
"tags": [],
"returnComment": [],
"initialIsOpen": false
},
{
"id": "def-server.relativeDownloadUrlFromArtifact",
"type": "Function",
"children": [
{
"type": "Uncategorized",
"label": "{\n identifier,\n decodedSha256,\n}",
"isRequired": true,
"signature": [
"T"
],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/server/services/artifacts/mappings.ts",
"lineNumber": 66
}
}
],
"signature": [
"<T extends Pick<",
{
"pluginId": "fleet",
"scope": "server",
"docId": "kibFleetPluginApi",
"section": "def-server.Artifact",
"text": "Artifact"
},
", \"identifier\" | \"decodedSha256\">>({ identifier, decodedSha256, }: T) => string"
],
"description": [],
"label": "relativeDownloadUrlFromArtifact",
"source": {
"path": "x-pack/plugins/fleet/server/services/artifacts/mappings.ts",
"lineNumber": 64
},
"tags": [],
"returnComment": [],
"initialIsOpen": false
}
],
"interfaces": [
{
"id": "def-server.AgentPolicyServiceInterface",
"type": "Interface",
"label": "AgentPolicyServiceInterface",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-server.AgentPolicyServiceInterface.get",
"type": "Function",
"label": "get",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/server/services/index.ts",
"lineNumber": 68
},
"signature": [
"(soClient: Pick<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsClient",
"text": "SavedObjectsClient"
},
", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\" | \"errors\" | \"checkConflicts\" | \"resolve\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\">, id: string, withPackagePolicies?: boolean) => Promise<",
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.AgentPolicy",
"text": "AgentPolicy"
},
" | null>"
]
},
{
"tags": [],
"id": "def-server.AgentPolicyServiceInterface.list",
"type": "Function",
"label": "list",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/server/services/index.ts",
"lineNumber": 69
},
"signature": [
"(soClient: Pick<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsClient",
"text": "SavedObjectsClient"
},
", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\" | \"errors\" | \"checkConflicts\" | \"resolve\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\">, options: Readonly<{ page?: number | undefined; perPage?: number | undefined; sortField?: string | undefined; sortOrder?: \"asc\" | \"desc\" | undefined; kuery?: any; showUpgradeable?: boolean | undefined; } & {}> & { withPackagePolicies?: boolean | undefined; }) => Promise<{ items: ",
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.AgentPolicy",
"text": "AgentPolicy"
},
"[]; total: number; page: number; perPage: number; }>"
]
},
{
"tags": [],
"id": "def-server.AgentPolicyServiceInterface.getDefaultAgentPolicyId",
"type": "Function",
"label": "getDefaultAgentPolicyId",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/server/services/index.ts",
"lineNumber": 70
},
"signature": [
"(soClient: Pick<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsClient",
"text": "SavedObjectsClient"
},
", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\" | \"errors\" | \"checkConflicts\" | \"resolve\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\">) => Promise<string>"
]
},
{
"tags": [],
"id": "def-server.AgentPolicyServiceInterface.getFullAgentPolicy",
"type": "Function",
"label": "getFullAgentPolicy",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/server/services/index.ts",
"lineNumber": 71
},
"signature": [
"(soClient: Pick<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsClient",
"text": "SavedObjectsClient"
},
", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\" | \"errors\" | \"checkConflicts\" | \"resolve\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\">, id: string, options?: { standalone: boolean; } | undefined) => Promise<",
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.FullAgentPolicy",
"text": "FullAgentPolicy"
},
" | null>"
]
}
],
"source": {
"path": "x-pack/plugins/fleet/server/services/index.ts",
"lineNumber": 67
},
"initialIsOpen": false
},
{
"id": "def-server.AgentService",
"type": "Interface",
"label": "AgentService",
"description": [
"\nA service that provides exported functions that return information about an Agent"
],
"tags": [],
"children": [
{
"tags": [],
"id": "def-server.AgentService.getAgent",
"type": "Function",
"label": "getAgent",
"description": [
"\nGet an Agent by id"
],
"source": {
"path": "x-pack/plugins/fleet/server/services/index.ts",
"lineNumber": 49
},
"signature": [
"typeof ",
{
"pluginId": "fleet",
"scope": "server",
"docId": "kibFleetPluginApi",
"section": "def-server.getAgentById",
"text": "getAgentById"
}
]
},
{
"id": "def-server.AgentService.authenticateAgentWithAccessToken",
"type": "Function",
"label": "authenticateAgentWithAccessToken",
"signature": [
"(esClient: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCorePluginApi",
"section": "def-server.ElasticsearchClient",
"text": "ElasticsearchClient"
},
", request: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreHttpPluginApi",
"section": "def-server.KibanaRequest",
"text": "KibanaRequest"
},
"<unknown, unknown, unknown, any>) => Promise<",
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.Agent",
"text": "Agent"
},
">"
],
"description": [
"\nAuthenticate an agent with access toekn"
],
"children": [
{
"type": "CompoundType",
"label": "esClient",
"isRequired": true,
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCorePluginApi",
"section": "def-server.ElasticsearchClient",
"text": "ElasticsearchClient"
}
],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/server/services/index.ts",
"lineNumber": 54
}
},
{
"type": "Object",
"label": "request",
"isRequired": true,
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreHttpPluginApi",
"section": "def-server.KibanaRequest",
"text": "KibanaRequest"
},
"<unknown, unknown, unknown, any>"
],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/server/services/index.ts",
"lineNumber": 55
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "x-pack/plugins/fleet/server/services/index.ts",
"lineNumber": 53
}
},
{
"id": "def-server.AgentService.getAgentStatusById",
"type": "Function",
"label": "getAgentStatusById",
"signature": [
"(esClient: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCorePluginApi",
"section": "def-server.ElasticsearchClient",
"text": "ElasticsearchClient"
},
", agentId: string) => Promise<",
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.AgentStatus",
"text": "AgentStatus"
},
">"
],
"description": [
"\nReturn the status by the Agent's id"
],
"children": [
{
"type": "CompoundType",
"label": "esClient",
"isRequired": true,
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCorePluginApi",
"section": "def-server.ElasticsearchClient",
"text": "ElasticsearchClient"
}
],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/server/services/index.ts",
"lineNumber": 60
}
},
{
"type": "string",
"label": "agentId",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/server/services/index.ts",
"lineNumber": 60
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "x-pack/plugins/fleet/server/services/index.ts",
"lineNumber": 60
}
},
{
"tags": [],
"id": "def-server.AgentService.listAgents",
"type": "Function",
"label": "listAgents",
"description": [
"\nList agents"
],
"source": {
"path": "x-pack/plugins/fleet/server/services/index.ts",
"lineNumber": 64
},
"signature": [
"typeof ",
{
"pluginId": "fleet",
"scope": "server",
"docId": "kibFleetPluginApi",
"section": "def-server.getAgentsByKuery",
"text": "getAgentsByKuery"
}
]
}
],
"source": {
"path": "x-pack/plugins/fleet/server/services/index.ts",
"lineNumber": 45
},
"initialIsOpen": false
},
{
"id": "def-server.Artifact",
"type": "Interface",
"label": "Artifact",
"signature": [
{
"pluginId": "fleet",
"scope": "server",
"docId": "kibFleetPluginApi",
"section": "def-server.Artifact",
"text": "Artifact"
},
" extends ",
"NewArtifact"
],
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-server.Artifact.id",
"type": "string",
"label": "id",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/server/services/artifacts/types.ts",
"lineNumber": 34
}
},
{
"tags": [],
"id": "def-server.Artifact.created",
"type": "string",
"label": "created",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/server/services/artifacts/types.ts",
"lineNumber": 35
}
}
],
"source": {
"path": "x-pack/plugins/fleet/server/services/artifacts/types.ts",
"lineNumber": 33
},
"initialIsOpen": false
},
{
"id": "def-server.ArtifactsClientInterface",
"type": "Interface",
"label": "ArtifactsClientInterface",
"description": [
"\nThe interface exposed out of Fleet's Artifact service via the client class"
],
"tags": [],
"children": [
{
"id": "def-server.ArtifactsClientInterface.getArtifact",
"type": "Function",
"label": "getArtifact",
"signature": [
"(id: string) => Promise<",
{
"pluginId": "fleet",
"scope": "server",
"docId": "kibFleetPluginApi",
"section": "def-server.Artifact",
"text": "Artifact"
},
" | undefined>"
],
"description": [],
"children": [
{
"type": "string",
"label": "id",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/server/services/artifacts/types.ts",
"lineNumber": 79
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "x-pack/plugins/fleet/server/services/artifacts/types.ts",
"lineNumber": 79
}
},
{
"id": "def-server.ArtifactsClientInterface.createArtifact",
"type": "Function",
"label": "createArtifact",
"signature": [
"(options: ",
{
"pluginId": "fleet",
"scope": "server",
"docId": "kibFleetPluginApi",
"section": "def-server.ArtifactsClientCreateOptions",
"text": "ArtifactsClientCreateOptions"
},
") => Promise<",
{
"pluginId": "fleet",
"scope": "server",
"docId": "kibFleetPluginApi",
"section": "def-server.Artifact",
"text": "Artifact"
},
">"
],
"description": [],
"children": [
{
"type": "CompoundType",
"label": "options",
"isRequired": true,
"signature": [
{
"pluginId": "fleet",
"scope": "server",
"docId": "kibFleetPluginApi",
"section": "def-server.ArtifactsClientCreateOptions",
"text": "ArtifactsClientCreateOptions"
}
],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/server/services/artifacts/types.ts",
"lineNumber": 81
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "x-pack/plugins/fleet/server/services/artifacts/types.ts",
"lineNumber": 81
}
},
{
"id": "def-server.ArtifactsClientInterface.deleteArtifact",
"type": "Function",
"label": "deleteArtifact",
"signature": [
"(id: string) => Promise<void>"
],
"description": [],
"children": [
{
"type": "string",
"label": "id",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/server/services/artifacts/types.ts",
"lineNumber": 83
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "x-pack/plugins/fleet/server/services/artifacts/types.ts",
"lineNumber": 83
}
},
{
"id": "def-server.ArtifactsClientInterface.listArtifacts",
"type": "Function",
"label": "listArtifacts",
"signature": [
"(options?: ",
{
"pluginId": "fleet",
"scope": "server",
"docId": "kibFleetPluginApi",
"section": "def-server.ListArtifactsProps",
"text": "ListArtifactsProps"
},
" | undefined) => Promise<",
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.ListResult",
"text": "ListResult"
},
"<",
{
"pluginId": "fleet",
"scope": "server",
"docId": "kibFleetPluginApi",
"section": "def-server.Artifact",
"text": "Artifact"
},
">>"
],
"description": [],
"children": [
{
"type": "CompoundType",
"label": "options",
"isRequired": false,
"signature": [
{
"pluginId": "fleet",
"scope": "server",
"docId": "kibFleetPluginApi",
"section": "def-server.ListArtifactsProps",
"text": "ListArtifactsProps"
},
" | undefined"
],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/server/services/artifacts/types.ts",
"lineNumber": 85
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "x-pack/plugins/fleet/server/services/artifacts/types.ts",
"lineNumber": 85
}
},
{
"id": "def-server.ArtifactsClientInterface.encodeContent",
"type": "Function",
"label": "encodeContent",
"signature": [
"(content: string) => Promise<Pick<",
{
"pluginId": "fleet",
"scope": "server",
"docId": "kibFleetPluginApi",
"section": "def-server.Artifact",
"text": "Artifact"
},
", \"body\" | \"decodedSha256\" | \"decodedSize\" | \"encodedSha256\" | \"encodedSize\" | \"compressionAlgorithm\">>"
],
"description": [],
"children": [
{
"type": "string",
"label": "content",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/server/services/artifacts/types.ts",
"lineNumber": 87
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "x-pack/plugins/fleet/server/services/artifacts/types.ts",
"lineNumber": 87
}
},
{
"id": "def-server.ArtifactsClientInterface.generateHash",
"type": "Function",
"label": "generateHash",
"signature": [
"(content: string) => string"
],
"description": [],
"children": [
{
"type": "string",
"label": "content",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/server/services/artifacts/types.ts",
"lineNumber": 89
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "x-pack/plugins/fleet/server/services/artifacts/types.ts",
"lineNumber": 89
}
}
],
"source": {
"path": "x-pack/plugins/fleet/server/services/artifacts/types.ts",
"lineNumber": 78
},
"initialIsOpen": false
},
{
"id": "def-server.ESIndexPatternService",
"type": "Interface",
"label": "ESIndexPatternService",
"description": [
"\nService to return the index pattern of EPM packages"
],
"tags": [],
"children": [
{
"id": "def-server.ESIndexPatternService.getESIndexPattern",
"type": "Function",
"label": "getESIndexPattern",
"signature": [
"(savedObjectsClient: Pick<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsClient",
"text": "SavedObjectsClient"
},
", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\" | \"errors\" | \"checkConflicts\" | \"resolve\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\">, pkgName: string, datasetPath: string) => Promise<string | undefined>"
],
"description": [],
"children": [
{
"type": "Object",
"label": "savedObjectsClient",
"isRequired": true,
"signature": [
"Pick<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsClient",
"text": "SavedObjectsClient"
},
", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\" | \"errors\" | \"checkConflicts\" | \"resolve\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\">"
],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/server/services/index.ts",
"lineNumber": 25
}
},
{
"type": "string",
"label": "pkgName",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/server/services/index.ts",
"lineNumber": 26
}
},
{
"type": "string",
"label": "datasetPath",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/server/services/index.ts",
"lineNumber": 27
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "x-pack/plugins/fleet/server/services/index.ts",
"lineNumber": 24
}
}
],
"source": {
"path": "x-pack/plugins/fleet/server/services/index.ts",
"lineNumber": 23
},
"initialIsOpen": false
},
{
"id": "def-server.FleetSetupDeps",
"type": "Interface",
"label": "FleetSetupDeps",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-server.FleetSetupDeps.licensing",
"type": "Object",
"label": "licensing",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/server/plugin.ts",
"lineNumber": 95
},
"signature": [
{
"pluginId": "licensing",
"scope": "server",
"docId": "kibLicensingPluginApi",
"section": "def-server.LicensingPluginSetup",
"text": "LicensingPluginSetup"
}
]
},
{
"tags": [],
"id": "def-server.FleetSetupDeps.security",
"type": "Object",
"label": "security",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/server/plugin.ts",
"lineNumber": 96
},
"signature": [
{
"pluginId": "security",
"scope": "server",
"docId": "kibSecurityPluginApi",
"section": "def-server.SecurityPluginSetup",
"text": "SecurityPluginSetup"
},
" | undefined"
]
},
{
"tags": [],
"id": "def-server.FleetSetupDeps.features",
"type": "Object",
"label": "features",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/server/plugin.ts",
"lineNumber": 97
},
"signature": [
{
"pluginId": "features",
"scope": "server",
"docId": "kibFeaturesPluginApi",
"section": "def-server.PluginSetupContract",
"text": "PluginSetupContract"
},
" | undefined"
]
},
{
"tags": [],
"id": "def-server.FleetSetupDeps.encryptedSavedObjects",
"type": "Object",
"label": "encryptedSavedObjects",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/server/plugin.ts",
"lineNumber": 98
},
"signature": [
{
"pluginId": "encryptedSavedObjects",
"scope": "server",
"docId": "kibEncryptedSavedObjectsPluginApi",
"section": "def-server.EncryptedSavedObjectsPluginSetup",
"text": "EncryptedSavedObjectsPluginSetup"
}
]
},
{
"tags": [],
"id": "def-server.FleetSetupDeps.cloud",
"type": "Object",
"label": "cloud",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/server/plugin.ts",
"lineNumber": 99
},
"signature": [
{
"pluginId": "cloud",
"scope": "server",
"docId": "kibCloudPluginApi",
"section": "def-server.CloudSetup",
"text": "CloudSetup"
},
" | undefined"
]
},
{
"tags": [],
"id": "def-server.FleetSetupDeps.usageCollection",
"type": "Object",
"label": "usageCollection",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/server/plugin.ts",
"lineNumber": 100
},
"signature": [
"Pick<",
{
"pluginId": "usageCollection",
"scope": "server",
"docId": "kibUsageCollectionPluginApi",
"section": "def-server.CollectorSet",
"text": "CollectorSet"
},
", \"makeStatsCollector\" | \"makeUsageCollector\" | \"registerCollector\" | \"getCollectorByType\" | \"areAllCollectorsReady\" | \"bulkFetch\" | \"bulkFetchUsage\" | \"toObject\" | \"toApiFieldNames\"> | undefined"
]
}
],
"source": {
"path": "x-pack/plugins/fleet/server/plugin.ts",
"lineNumber": 94
},
"initialIsOpen": false
},
{
"id": "def-server.PackageService",
"type": "Interface",
"label": "PackageService",
"description": [
"\nService that provides exported function that return information about EPM packages"
],
"tags": [],
"children": [
{
"id": "def-server.PackageService.getInstalledEsAssetReferences",
"type": "Function",
"label": "getInstalledEsAssetReferences",
"signature": [
"(savedObjectsClient: Pick<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsClient",
"text": "SavedObjectsClient"
},
", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\" | \"errors\" | \"checkConflicts\" | \"resolve\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\">, pkgName: string) => Promise<",
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.EsAssetReference",
"text": "EsAssetReference"
},
"[]>"
],
"description": [],
"children": [
{
"type": "Object",
"label": "savedObjectsClient",
"isRequired": true,
"signature": [
"Pick<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsClient",
"text": "SavedObjectsClient"
},
", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\" | \"errors\" | \"checkConflicts\" | \"resolve\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\">"
],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/server/services/index.ts",
"lineNumber": 37
}
},
{
"type": "string",
"label": "pkgName",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/server/services/index.ts",
"lineNumber": 38
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "x-pack/plugins/fleet/server/services/index.ts",
"lineNumber": 36
}
}
],
"source": {
"path": "x-pack/plugins/fleet/server/services/index.ts",
"lineNumber": 35
},
"initialIsOpen": false
}
],
"enums": [],
"misc": [
{
"id": "def-server.ExternalCallback",
"type": "Type",
"label": "ExternalCallback",
"tags": [],
"description": [
"\nCallbacks supported by the Fleet plugin"
],
"source": {
"path": "x-pack/plugins/fleet/server/plugin.ts",
"lineNumber": 140
},
"signature": [
"[\"packagePolicyCreate\", (newPackagePolicy: ",
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.NewPackagePolicy",
"text": "NewPackagePolicy"
},
", context: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCorePluginApi",
"section": "def-server.RequestHandlerContext",
"text": "RequestHandlerContext"
},
", request: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreHttpPluginApi",
"section": "def-server.KibanaRequest",
"text": "KibanaRequest"
},
"<unknown, unknown, unknown, any>) => Promise<",
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.NewPackagePolicy",
"text": "NewPackagePolicy"
},
">] | [\"packagePolicyUpdate\", (newPackagePolicy: ",
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.UpdatePackagePolicy",
"text": "UpdatePackagePolicy"
}
],
"initialIsOpen": false
},
{
"id": "def-server.FleetConfigType",
"type": "Type",
"label": "FleetConfigType",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/server/index.ts",
"lineNumber": 78
},
"signature": [
"any"
],
"initialIsOpen": false
},
{
"id": "def-server.PackagePolicyServiceInterface",
"type": "Type",
"label": "PackagePolicyServiceInterface",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/server/services/package_policy.ts",
"lineNumber": 592
},
"signature": [
"PackagePolicyService"
],
"initialIsOpen": false
}
],
"objects": [
{
"tags": [],
"id": "def-server.agent",
"type": "Object",
"label": "agent",
"description": [],
"source": {
"path": "node_modules/elastic-apm-node/index.d.ts",
"lineNumber": 7
},
"signature": [
"Agent"
],
"initialIsOpen": false
}
],
"setup": {
"id": "def-server.FleetSetupContract",
"type": "Type",
"label": "FleetSetupContract",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/server/plugin.ts",
"lineNumber": 125
},
"signature": [
"void"
],
"lifecycle": "setup",
"initialIsOpen": true
},
"start": {
"id": "def-server.FleetStartContract",
"type": "Interface",
"label": "FleetStartContract",
"description": [
"\nDescribes public Fleet plugin contract returned at the `startup` stage."
],
"tags": [],
"children": [
{
"tags": [],
"id": "def-server.FleetStartContract.esIndexPatternService",
"type": "Object",
"label": "esIndexPatternService",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/server/plugin.ts",
"lineNumber": 164
},
"signature": [
{
"pluginId": "fleet",
"scope": "server",
"docId": "kibFleetPluginApi",
"section": "def-server.ESIndexPatternService",
"text": "ESIndexPatternService"
}
]
},
{
"tags": [],
"id": "def-server.FleetStartContract.packageService",
"type": "Object",
"label": "packageService",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/server/plugin.ts",
"lineNumber": 165
},
"signature": [
{
"pluginId": "fleet",
"scope": "server",
"docId": "kibFleetPluginApi",
"section": "def-server.PackageService",
"text": "PackageService"
}
]
},
{
"tags": [],
"id": "def-server.FleetStartContract.agentService",
"type": "Object",
"label": "agentService",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/server/plugin.ts",
"lineNumber": 166
},
"signature": [
{
"pluginId": "fleet",
"scope": "server",
"docId": "kibFleetPluginApi",
"section": "def-server.AgentService",
"text": "AgentService"
}
]
},
{
"tags": [],
"id": "def-server.FleetStartContract.packagePolicyService",
"type": "Object",
"label": "packagePolicyService",
"description": [
"\nServices for Fleet's package policies"
],
"source": {
"path": "x-pack/plugins/fleet/server/plugin.ts",
"lineNumber": 170
},
"signature": [
{
"pluginId": "fleet",
"scope": "server",
"docId": "kibFleetPluginApi",
"section": "def-server.PackagePolicyService",
"text": "PackagePolicyService"
}
]
},
{
"tags": [],
"id": "def-server.FleetStartContract.agentPolicyService",
"type": "Object",
"label": "agentPolicyService",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/server/plugin.ts",
"lineNumber": 171
},
"signature": [
{
"pluginId": "fleet",
"scope": "server",
"docId": "kibFleetPluginApi",
"section": "def-server.AgentPolicyServiceInterface",
"text": "AgentPolicyServiceInterface"
}
]
},
{
"tags": [],
"id": "def-server.FleetStartContract.registerExternalCallback",
"type": "Function",
"label": "registerExternalCallback",
"description": [
"\nRegister callbacks for inclusion in fleet API processing"
],
"source": {
"path": "x-pack/plugins/fleet/server/plugin.ts",
"lineNumber": 176
},
"signature": [
"(...args: ",
{
"pluginId": "fleet",
"scope": "server",
"docId": "kibFleetPluginApi",
"section": "def-server.ExternalCallback",
"text": "ExternalCallback"
},
") => void"
]
},
{
"tags": [],
"id": "def-server.FleetStartContract.createArtifactsClient",
"type": "Function",
"label": "createArtifactsClient",
"description": [
"\nCreate a Fleet Artifact Client instance"
],
"source": {
"path": "x-pack/plugins/fleet/server/plugin.ts",
"lineNumber": 182
},
"signature": [
"(packageName: string) => ",
{
"pluginId": "fleet",
"scope": "server",
"docId": "kibFleetPluginApi",
"section": "def-server.FleetArtifactsClient",
"text": "FleetArtifactsClient"
}
]
}
],
"source": {
"path": "x-pack/plugins/fleet/server/plugin.ts",
"lineNumber": 163
},
"lifecycle": "start",
"initialIsOpen": true
}
},
"common": {
"classes": [
{
"id": "def-common.LicenseService",
"type": "Class",
"tags": [],
"label": "LicenseService",
"description": [],
"children": [
{
"id": "def-common.LicenseService.start",
"type": "Function",
"label": "start",
"signature": [
"(license$: ",
"Observable",
"<",
{
"pluginId": "licensing",
"scope": "common",
"docId": "kibLicensingPluginApi",
"section": "def-common.ILicense",
"text": "ILicense"
},
">) => void"
],
"description": [],
"children": [
{
"type": "Object",
"label": "license$",
"isRequired": true,
"signature": [
"Observable",
"<",
{
"pluginId": "licensing",
"scope": "common",
"docId": "kibLicensingPluginApi",
"section": "def-common.ILicense",
"text": "ILicense"
},
">"
],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/services/license.ts",
"lineNumber": 23
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "x-pack/plugins/fleet/common/services/license.ts",
"lineNumber": 23
}
},
{
"id": "def-common.LicenseService.stop",
"type": "Function",
"label": "stop",
"signature": [
"() => void"
],
"description": [],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "x-pack/plugins/fleet/common/services/license.ts",
"lineNumber": 28
}
},
{
"id": "def-common.LicenseService.getLicenseInformation",
"type": "Function",
"label": "getLicenseInformation",
"signature": [
"() => ",
{
"pluginId": "licensing",
"scope": "common",
"docId": "kibLicensingPluginApi",
"section": "def-common.ILicense",
"text": "ILicense"
},
" | null"
],
"description": [],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "x-pack/plugins/fleet/common/services/license.ts",
"lineNumber": 34
}
},
{
"id": "def-common.LicenseService.getLicenseInformation$",
"type": "Function",
"label": "getLicenseInformation$",
"signature": [
"() => ",
"Observable",
"<",
{
"pluginId": "licensing",
"scope": "common",
"docId": "kibLicensingPluginApi",
"section": "def-common.ILicense",
"text": "ILicense"
},
"> | null"
],
"description": [],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "x-pack/plugins/fleet/common/services/license.ts",
"lineNumber": 38
}
},
{
"id": "def-common.LicenseService.isGoldPlus",
"type": "Function",
"label": "isGoldPlus",
"signature": [
"() => boolean | undefined"
],
"description": [],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "x-pack/plugins/fleet/common/services/license.ts",
"lineNumber": 42
}
},
{
"id": "def-common.LicenseService.isEnterprise",
"type": "Function",
"label": "isEnterprise",
"signature": [
"() => boolean | undefined"
],
"description": [],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "x-pack/plugins/fleet/common/services/license.ts",
"lineNumber": 49
}
}
],
"source": {
"path": "x-pack/plugins/fleet/common/services/license.ts",
"lineNumber": 14
},
"initialIsOpen": false
}
],
"functions": [
{
"id": "def-common.decodeCloudId",
"type": "Function",
"label": "decodeCloudId",
"signature": [
"(cid: string) => { host: string; defaultPort: string; elasticsearchUrl: string; kibanaUrl: string; } | undefined"
],
"description": [],
"children": [
{
"type": "string",
"label": "cid",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/services/decode_cloud_id.ts",
"lineNumber": 10
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "x-pack/plugins/fleet/common/services/decode_cloud_id.ts",
"lineNumber": 9
},
"initialIsOpen": false
},
{
"id": "def-common.doesAgentPolicyAlreadyIncludePackage",
"type": "Function",
"children": [
{
"type": "Object",
"label": "agentPolicy",
"isRequired": true,
"signature": [
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.AgentPolicy",
"text": "AgentPolicy"
}
],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/services/limited_package.ts",
"lineNumber": 16
}
},
{
"type": "string",
"label": "packageName",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/services/limited_package.ts",
"lineNumber": 17
}
}
],
"signature": [
"(agentPolicy: ",
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.AgentPolicy",
"text": "AgentPolicy"
},
", packageName: string) => boolean"
],
"description": [],
"label": "doesAgentPolicyAlreadyIncludePackage",
"source": {
"path": "x-pack/plugins/fleet/common/services/limited_package.ts",
"lineNumber": 15
},
"tags": [],
"returnComment": [],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-common.entries",
"type": "Function",
"label": "entries",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/index.ts",
"lineNumber": 39
},
"signature": [
"<T>(o: T) => [keyof T, T[keyof T]][]"
],
"initialIsOpen": false
},
{
"id": "def-common.fullAgentPolicyToYaml",
"type": "Function",
"children": [
{
"type": "Object",
"label": "policy",
"isRequired": true,
"signature": [
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.FullAgentPolicy",
"text": "FullAgentPolicy"
}
],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/services/full_agent_policy_to_yaml.ts",
"lineNumber": 27
}
}
],
"signature": [
"(policy: ",
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.FullAgentPolicy",
"text": "FullAgentPolicy"
},
") => string"
],
"description": [],
"label": "fullAgentPolicyToYaml",
"source": {
"path": "x-pack/plugins/fleet/common/services/full_agent_policy_to_yaml.ts",
"lineNumber": 27
},
"tags": [],
"returnComment": [],
"initialIsOpen": false
},
{
"id": "def-common.isAgentUpgradeable",
"type": "Function",
"label": "isAgentUpgradeable",
"signature": [
"(agent: ",
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.Agent",
"text": "Agent"
},
", kibanaVersion: string) => boolean"
],
"description": [],
"children": [
{
"type": "Object",
"label": "agent",
"isRequired": true,
"signature": [
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.Agent",
"text": "Agent"
}
],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/services/is_agent_upgradeable.ts",
"lineNumber": 13
}
},
{
"type": "string",
"label": "kibanaVersion",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/services/is_agent_upgradeable.ts",
"lineNumber": 13
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "x-pack/plugins/fleet/common/services/is_agent_upgradeable.ts",
"lineNumber": 13
},
"initialIsOpen": false
},
{
"id": "def-common.isDiffPathProtocol",
"type": "Function",
"label": "isDiffPathProtocol",
"signature": [
"(kibanaUrls: string[]) => boolean"
],
"description": [],
"children": [
{
"type": "Array",
"label": "kibanaUrls",
"isRequired": true,
"signature": [
"string[]"
],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/services/is_diff_path_protocol.ts",
"lineNumber": 9
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "x-pack/plugins/fleet/common/services/is_diff_path_protocol.ts",
"lineNumber": 9
},
"initialIsOpen": false
},
{
"id": "def-common.isPackageLimited",
"type": "Function",
"children": [
{
"type": "CompoundType",
"label": "packageInfo",
"isRequired": true,
"signature": [
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.PackageInfo",
"text": "PackageInfo"
}
],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/services/limited_package.ts",
"lineNumber": 11
}
}
],
"signature": [
"(packageInfo: ",
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.PackageInfo",
"text": "PackageInfo"
},
") => boolean"
],
"description": [],
"label": "isPackageLimited",
"source": {
"path": "x-pack/plugins/fleet/common/services/limited_package.ts",
"lineNumber": 11
},
"tags": [],
"returnComment": [],
"initialIsOpen": false
},
{
"id": "def-common.isValidNamespace",
"type": "Function",
"label": "isValidNamespace",
"signature": [
"(namespace: string) => { valid: boolean; error?: string | undefined; }"
],
"description": [],
"children": [
{
"type": "string",
"label": "namespace",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/services/is_valid_namespace.ts",
"lineNumber": 13
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "x-pack/plugins/fleet/common/services/is_valid_namespace.ts",
"lineNumber": 13
},
"initialIsOpen": false
},
{
"id": "def-common.packageToPackagePolicy",
"type": "Function",
"children": [
{
"type": "CompoundType",
"label": "packageInfo",
"isRequired": true,
"signature": [
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.PackageInfo",
"text": "PackageInfo"
}
],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/services/package_to_package_policy.ts",
"lineNumber": 117
}
},
{
"type": "string",
"label": "agentPolicyId",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/services/package_to_package_policy.ts",
"lineNumber": 118
}
},
{
"type": "string",
"label": "outputId",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/services/package_to_package_policy.ts",
"lineNumber": 119
}
},
{
"type": "string",
"label": "namespace",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/services/package_to_package_policy.ts",
"lineNumber": 120
}
},
{
"type": "string",
"label": "packagePolicyName",
"isRequired": false,
"signature": [
"string | undefined"
],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/services/package_to_package_policy.ts",
"lineNumber": 121
}
},
{
"type": "string",
"label": "description",
"isRequired": false,
"signature": [
"string | undefined"
],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/services/package_to_package_policy.ts",
"lineNumber": 122
}
}
],
"signature": [
"(packageInfo: ",
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.PackageInfo",
"text": "PackageInfo"
},
", agentPolicyId: string, outputId: string, namespace?: string, packagePolicyName?: string | undefined, description?: string | undefined) => ",
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.NewPackagePolicy",
"text": "NewPackagePolicy"
}
],
"description": [
"\nBuilds a `NewPackagePolicy` structure based on a package\n"
],
"label": "packageToPackagePolicy",
"source": {
"path": "x-pack/plugins/fleet/common/services/package_to_package_policy.ts",
"lineNumber": 116
},
"tags": [],
"returnComment": [],
"initialIsOpen": false
},
{
"id": "def-common.packageToPackagePolicyInputs",
"type": "Function",
"children": [
{
"type": "CompoundType",
"label": "packageInfo",
"isRequired": true,
"signature": [
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.PackageInfo",
"text": "PackageInfo"
}
],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/services/package_to_package_policy.ts",
"lineNumber": 47
}
}
],
"signature": [
"(packageInfo: ",
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.PackageInfo",
"text": "PackageInfo"
},
") => ",
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.NewPackagePolicyInput",
"text": "NewPackagePolicyInput"
},
"[]"
],
"description": [],
"label": "packageToPackagePolicyInputs",
"source": {
"path": "x-pack/plugins/fleet/common/services/package_to_package_policy.ts",
"lineNumber": 46
},
"tags": [],
"returnComment": [],
"initialIsOpen": false
},
{
"id": "def-common.storedPackagePoliciesToAgentInputs",
"type": "Function",
"children": [
{
"type": "Array",
"label": "packagePolicies",
"isRequired": true,
"signature": [
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.PackagePolicy",
"text": "PackagePolicy"
},
"[]"
],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/services/package_policies_to_agent_inputs.ts",
"lineNumber": 12
}
}
],
"signature": [
"(packagePolicies: ",
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.PackagePolicy",
"text": "PackagePolicy"
},
"[]) => ",
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.FullAgentPolicyInput",
"text": "FullAgentPolicyInput"
},
"[]"
],
"description": [],
"label": "storedPackagePoliciesToAgentInputs",
"source": {
"path": "x-pack/plugins/fleet/common/services/package_policies_to_agent_inputs.ts",
"lineNumber": 11
},
"tags": [],
"returnComment": [],
"initialIsOpen": false
}
],
"interfaces": [
{
"id": "def-common.Agent",
"type": "Interface",
"label": "Agent",
"signature": [
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.Agent",
"text": "Agent"
},
" extends AgentBase"
],
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.Agent.id",
"type": "string",
"label": "id",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
"lineNumber": 151
}
},
{
"tags": [],
"id": "def-common.Agent.current_error_events",
"type": "Array",
"label": "current_error_events",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
"lineNumber": 152
},
"signature": [
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.AgentEvent",
"text": "AgentEvent"
},
"[]"
]
},
{
"tags": [],
"id": "def-common.Agent.access_api_key",
"type": "string",
"label": "access_api_key",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
"lineNumber": 153
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-common.Agent.status",
"type": "string",
"label": "status",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
"lineNumber": 154
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-common.Agent.packages",
"type": "Array",
"label": "packages",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
"lineNumber": 155
},
"signature": [
"string[]"
]
}
],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
"lineNumber": 150
},
"initialIsOpen": false
},
{
"id": "def-common.AgentAction",
"type": "Interface",
"label": "AgentAction",
"signature": [
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.AgentAction",
"text": "AgentAction"
},
" extends ",
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.NewAgentAction",
"text": "NewAgentAction"
}
],
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.AgentAction.type",
"type": "CompoundType",
"label": "type",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
"lineNumber": 48
},
"signature": [
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.AgentActionType",
"text": "AgentActionType"
}
]
},
{
"tags": [],
"id": "def-common.AgentAction.data",
"type": "Any",
"label": "data",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
"lineNumber": 49
},
"signature": [
"any"
]
},
{
"tags": [],
"id": "def-common.AgentAction.sent_at",
"type": "string",
"label": "sent_at",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
"lineNumber": 50
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-common.AgentAction.id",
"type": "string",
"label": "id",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
"lineNumber": 51
}
},
{
"tags": [],
"id": "def-common.AgentAction.agent_id",
"type": "string",
"label": "agent_id",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
"lineNumber": 52
}
},
{
"tags": [],
"id": "def-common.AgentAction.created_at",
"type": "string",
"label": "created_at",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
"lineNumber": 53
}
},
{
"tags": [],
"id": "def-common.AgentAction.ack_data",
"type": "Any",
"label": "ack_data",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
"lineNumber": 54
},
"signature": [
"any"
]
}
],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
"lineNumber": 47
},
"initialIsOpen": false
},
{
"id": "def-common.AgentEvent",
"type": "Interface",
"label": "AgentEvent",
"signature": [
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.AgentEvent",
"text": "AgentEvent"
},
" extends ",
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.NewAgentEvent",
"text": "NewAgentEvent"
}
],
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.AgentEvent.id",
"type": "string",
"label": "id",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
"lineNumber": 123
}
}
],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
"lineNumber": 122
},
"initialIsOpen": false
},
{
"id": "def-common.AgentMetadata",
"type": "Interface",
"label": "AgentMetadata",
"description": [],
"tags": [],
"children": [
{
"id": "def-common.AgentMetadata.Unnamed",
"type": "Any",
"label": "Unnamed",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
"lineNumber": 129
},
"signature": [
"any"
]
}
],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
"lineNumber": 128
},
"initialIsOpen": false
},
{
"id": "def-common.AgentPolicy",
"type": "Interface",
"label": "AgentPolicy",
"signature": [
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.AgentPolicy",
"text": "AgentPolicy"
},
" extends ",
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.NewAgentPolicy",
"text": "NewAgentPolicy"
}
],
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.AgentPolicy.id",
"type": "string",
"label": "id",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts",
"lineNumber": 27
}
},
{
"tags": [],
"id": "def-common.AgentPolicy.status",
"type": "CompoundType",
"label": "status",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts",
"lineNumber": 28
},
"signature": [
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.ValueOf",
"text": "ValueOf"
},
"<{ readonly Active: \"active\"; readonly Inactive: \"inactive\"; }>"
]
},
{
"tags": [],
"id": "def-common.AgentPolicy.package_policies",
"type": "CompoundType",
"label": "package_policies",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts",
"lineNumber": 29
},
"signature": [
"string[] | ",
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.PackagePolicy",
"text": "PackagePolicy"
},
"[]"
]
},
{
"tags": [],
"id": "def-common.AgentPolicy.is_managed",
"type": "boolean",
"label": "is_managed",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts",
"lineNumber": 30
}
},
{
"tags": [],
"id": "def-common.AgentPolicy.updated_at",
"type": "string",
"label": "updated_at",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts",
"lineNumber": 31
}
},
{
"tags": [],
"id": "def-common.AgentPolicy.updated_by",
"type": "string",
"label": "updated_by",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts",
"lineNumber": 32
}
},
{
"tags": [],
"id": "def-common.AgentPolicy.revision",
"type": "number",
"label": "revision",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts",
"lineNumber": 33
}
}
],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts",
"lineNumber": 26
},
"initialIsOpen": false
},
{
"id": "def-common.AgentPolicyAction",
"type": "Interface",
"label": "AgentPolicyAction",
"signature": [
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.AgentPolicyAction",
"text": "AgentPolicyAction"
},
" extends ",
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.NewAgentAction",
"text": "NewAgentAction"
}
],
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.AgentPolicyAction.id",
"type": "string",
"label": "id",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
"lineNumber": 58
}
},
{
"tags": [],
"id": "def-common.AgentPolicyAction.type",
"type": "CompoundType",
"label": "type",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
"lineNumber": 59
},
"signature": [
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.AgentActionType",
"text": "AgentActionType"
}
]
},
{
"tags": [],
"id": "def-common.AgentPolicyAction.data",
"type": "Object",
"label": "data",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
"lineNumber": 60
},
"signature": [
"{ policy: ",
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.FullAgentPolicy",
"text": "FullAgentPolicy"
},
"; }"
]
},
{
"tags": [],
"id": "def-common.AgentPolicyAction.policy_id",
"type": "string",
"label": "policy_id",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
"lineNumber": 63
}
},
{
"tags": [],
"id": "def-common.AgentPolicyAction.policy_revision",
"type": "number",
"label": "policy_revision",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
"lineNumber": 64
}
},
{
"tags": [],
"id": "def-common.AgentPolicyAction.created_at",
"type": "string",
"label": "created_at",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
"lineNumber": 65
}
},
{
"tags": [],
"id": "def-common.AgentPolicyAction.ack_data",
"type": "Any",
"label": "ack_data",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
"lineNumber": 66
},
"signature": [
"any"
]
}
],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
"lineNumber": 57
},
"initialIsOpen": false
},
{
"id": "def-common.AgentSOAttributes",
"type": "Interface",
"label": "AgentSOAttributes",
"signature": [
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.AgentSOAttributes",
"text": "AgentSOAttributes"
},
" extends AgentBase"
],
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.AgentSOAttributes.current_error_events",
"type": "string",
"label": "current_error_events",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
"lineNumber": 159
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-common.AgentSOAttributes.packages",
"type": "Array",
"label": "packages",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
"lineNumber": 160
},
"signature": [
"string[] | undefined"
]
}
],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
"lineNumber": 158
},
"initialIsOpen": false
},
{
"id": "def-common.AssetParts",
"type": "Interface",
"label": "AssetParts",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.AssetParts.pkgkey",
"type": "string",
"label": "pkgkey",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"lineNumber": 213
}
},
{
"tags": [],
"id": "def-common.AssetParts.dataset",
"type": "string",
"label": "dataset",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"lineNumber": 214
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-common.AssetParts.service",
"type": "CompoundType",
"label": "service",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"lineNumber": 215
},
"signature": [
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.ServiceName",
"text": "ServiceName"
}
]
},
{
"tags": [],
"id": "def-common.AssetParts.type",
"type": "CompoundType",
"label": "type",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"lineNumber": 216
},
"signature": [
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.AssetType",
"text": "AssetType"
}
]
},
{
"tags": [],
"id": "def-common.AssetParts.file",
"type": "string",
"label": "file",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"lineNumber": 217
}
}
],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"lineNumber": 212
},
"initialIsOpen": false
},
{
"id": "def-common.BaseSettings",
"type": "Interface",
"label": "BaseSettings",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.BaseSettings.kibana_urls",
"type": "Array",
"label": "kibana_urls",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/settings.ts",
"lineNumber": 11
},
"signature": [
"string[]"
]
},
{
"tags": [],
"id": "def-common.BaseSettings.kibana_ca_sha256",
"type": "string",
"label": "kibana_ca_sha256",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/settings.ts",
"lineNumber": 12
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-common.BaseSettings.has_seen_add_data_notice",
"type": "CompoundType",
"label": "has_seen_add_data_notice",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/settings.ts",
"lineNumber": 13
},
"signature": [
"boolean | undefined"
]
}
],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/settings.ts",
"lineNumber": 10
},
"initialIsOpen": false
},
{
"id": "def-common.BulkInstallPackageInfo",
"type": "Interface",
"label": "BulkInstallPackageInfo",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.BulkInstallPackageInfo.name",
"type": "string",
"label": "name",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts",
"lineNumber": 91
}
},
{
"tags": [],
"id": "def-common.BulkInstallPackageInfo.version",
"type": "string",
"label": "version",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts",
"lineNumber": 92
}
},
{
"tags": [],
"id": "def-common.BulkInstallPackageInfo.result",
"type": "Object",
"label": "result",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts",
"lineNumber": 93
},
"signature": [
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.InstallResult",
"text": "InstallResult"
}
]
}
],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts",
"lineNumber": 90
},
"initialIsOpen": false
},
{
"id": "def-common.BulkInstallPackagesRequest",
"type": "Interface",
"label": "BulkInstallPackagesRequest",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.BulkInstallPackagesRequest.body",
"type": "Object",
"label": "body",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts",
"lineNumber": 101
},
"signature": [
"{ packages: string[]; }"
]
}
],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts",
"lineNumber": 100
},
"initialIsOpen": false
},
{
"id": "def-common.BulkInstallPackagesResponse",
"type": "Interface",
"label": "BulkInstallPackagesResponse",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.BulkInstallPackagesResponse.response",
"type": "Array",
"label": "response",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts",
"lineNumber": 97
},
"signature": [
"(",
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.IBulkInstallPackageHTTPError",
"text": "IBulkInstallPackageHTTPError"
},
" | ",
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.BulkInstallPackageInfo",
"text": "BulkInstallPackageInfo"
},
")[]"
]
}
],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts",
"lineNumber": 96
},
"initialIsOpen": false
},
{
"id": "def-common.CategorySummaryItem",
"type": "Interface",
"label": "CategorySummaryItem",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.CategorySummaryItem.id",
"type": "string",
"label": "id",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"lineNumber": 206
}
},
{
"tags": [],
"id": "def-common.CategorySummaryItem.title",
"type": "string",
"label": "title",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"lineNumber": 207
}
},
{
"tags": [],
"id": "def-common.CategorySummaryItem.count",
"type": "number",
"label": "count",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"lineNumber": 208
}
}
],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"lineNumber": 205
},
"initialIsOpen": false
},
{
"id": "def-common.CheckPermissionsResponse",
"type": "Interface",
"label": "CheckPermissionsResponse",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.CheckPermissionsResponse.error",
"type": "CompoundType",
"label": "error",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/app.ts",
"lineNumber": 9
},
"signature": [
"\"MISSING_SECURITY\" | \"MISSING_SUPERUSER_ROLE\" | undefined"
]
},
{
"tags": [],
"id": "def-common.CheckPermissionsResponse.success",
"type": "boolean",
"label": "success",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/app.ts",
"lineNumber": 10
}
}
],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/app.ts",
"lineNumber": 8
},
"initialIsOpen": false
},
{
"id": "def-common.CopyAgentPolicyRequest",
"type": "Interface",
"label": "CopyAgentPolicyRequest",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.CopyAgentPolicyRequest.body",
"type": "Object",
"label": "body",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts",
"lineNumber": 54
},
"signature": [
"Pick<",
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.AgentPolicy",
"text": "AgentPolicy"
},
", \"description\" | \"name\">"
]
}
],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts",
"lineNumber": 53
},
"initialIsOpen": false
},
{
"id": "def-common.CopyAgentPolicyResponse",
"type": "Interface",
"label": "CopyAgentPolicyResponse",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.CopyAgentPolicyResponse.item",
"type": "Object",
"label": "item",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts",
"lineNumber": 58
},
"signature": [
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.AgentPolicy",
"text": "AgentPolicy"
}
]
}
],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts",
"lineNumber": 57
},
"initialIsOpen": false
},
{
"id": "def-common.CreateAgentPolicyRequest",
"type": "Interface",
"label": "CreateAgentPolicyRequest",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.CreateAgentPolicyRequest.body",
"type": "Object",
"label": "body",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts",
"lineNumber": 38
},
"signature": [
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.NewAgentPolicy",
"text": "NewAgentPolicy"
}
]
}
],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts",
"lineNumber": 37
},
"initialIsOpen": false
},
{
"id": "def-common.CreateAgentPolicyResponse",
"type": "Interface",
"label": "CreateAgentPolicyResponse",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.CreateAgentPolicyResponse.item",
"type": "Object",
"label": "item",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts",
"lineNumber": 42
},
"signature": [
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.AgentPolicy",
"text": "AgentPolicy"
}
]
}
],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts",
"lineNumber": 41
},
"initialIsOpen": false
},
{
"id": "def-common.CreateFleetSetupResponse",
"type": "Interface",
"label": "CreateFleetSetupResponse",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.CreateFleetSetupResponse.isInitialized",
"type": "boolean",
"label": "isInitialized",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/fleet_setup.ts",
"lineNumber": 9
}
}
],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/fleet_setup.ts",
"lineNumber": 8
},
"initialIsOpen": false
},
{
"id": "def-common.CreatePackagePolicyRequest",
"type": "Interface",
"label": "CreatePackagePolicyRequest",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.CreatePackagePolicyRequest.body",
"type": "Object",
"label": "body",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts",
"lineNumber": 36
},
"signature": [
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.NewPackagePolicy",
"text": "NewPackagePolicy"
}
]
}
],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts",
"lineNumber": 35
},
"initialIsOpen": false
},
{
"id": "def-common.CreatePackagePolicyResponse",
"type": "Interface",
"label": "CreatePackagePolicyResponse",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.CreatePackagePolicyResponse.item",
"type": "Object",
"label": "item",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts",
"lineNumber": 40
},
"signature": [
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.PackagePolicy",
"text": "PackagePolicy"
}
]
}
],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts",
"lineNumber": 39
},
"initialIsOpen": false
},
{
"id": "def-common.DataStream",
"type": "Interface",
"label": "DataStream",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.DataStream.index",
"type": "string",
"label": "index",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/data_stream.ts",
"lineNumber": 9
}
},
{
"tags": [],
"id": "def-common.DataStream.dataset",
"type": "string",
"label": "dataset",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/data_stream.ts",
"lineNumber": 10
}
},
{
"tags": [],
"id": "def-common.DataStream.namespace",
"type": "string",
"label": "namespace",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/data_stream.ts",
"lineNumber": 11
}
},
{
"tags": [],
"id": "def-common.DataStream.type",
"type": "string",
"label": "type",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/data_stream.ts",
"lineNumber": 12
}
},
{
"tags": [],
"id": "def-common.DataStream.package",
"type": "string",
"label": "package",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/data_stream.ts",
"lineNumber": 13
}
},
{
"tags": [],
"id": "def-common.DataStream.package_version",
"type": "string",
"label": "package_version",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/data_stream.ts",
"lineNumber": 14
}
},
{
"tags": [],
"id": "def-common.DataStream.last_activity_ms",
"type": "number",
"label": "last_activity_ms",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/data_stream.ts",
"lineNumber": 15
}
},
{
"tags": [],
"id": "def-common.DataStream.size_in_bytes",
"type": "number",
"label": "size_in_bytes",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/data_stream.ts",
"lineNumber": 16
}
},
{
"tags": [],
"id": "def-common.DataStream.dashboards",
"type": "Array",
"label": "dashboards",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/data_stream.ts",
"lineNumber": 17
},
"signature": [
"{ id: string; title: string; }[]"
]
}
],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/data_stream.ts",
"lineNumber": 8
},
"initialIsOpen": false
},
{
"id": "def-common.DeleteAgentPolicyRequest",
"type": "Interface",
"label": "DeleteAgentPolicyRequest",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.DeleteAgentPolicyRequest.body",
"type": "Object",
"label": "body",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts",
"lineNumber": 62
},
"signature": [
"{ agentPolicyId: string; }"
]
}
],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts",
"lineNumber": 61
},
"initialIsOpen": false
},
{
"id": "def-common.DeleteAgentPolicyResponse",
"type": "Interface",
"label": "DeleteAgentPolicyResponse",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.DeleteAgentPolicyResponse.id",
"type": "string",
"label": "id",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts",
"lineNumber": 68
}
},
{
"tags": [],
"id": "def-common.DeleteAgentPolicyResponse.name",
"type": "string",
"label": "name",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts",
"lineNumber": 69
}
}
],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts",
"lineNumber": 67
},
"initialIsOpen": false
},
{
"id": "def-common.DeleteAgentRequest",
"type": "Interface",
"label": "DeleteAgentRequest",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.DeleteAgentRequest.params",
"type": "Object",
"label": "params",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts",
"lineNumber": 200
},
"signature": [
"{ agentId: string; }"
]
}
],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts",
"lineNumber": 199
},
"initialIsOpen": false
},
{
"id": "def-common.DeleteEnrollmentAPIKeyRequest",
"type": "Interface",
"label": "DeleteEnrollmentAPIKeyRequest",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.DeleteEnrollmentAPIKeyRequest.params",
"type": "Object",
"label": "params",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts",
"lineNumber": 36
},
"signature": [
"{ keyId: string; }"
]
}
],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts",
"lineNumber": 35
},
"initialIsOpen": false
},
{
"id": "def-common.DeleteEnrollmentAPIKeyResponse",
"type": "Interface",
"label": "DeleteEnrollmentAPIKeyResponse",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.DeleteEnrollmentAPIKeyResponse.action",
"type": "string",
"label": "action",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts",
"lineNumber": 42
}
}
],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts",
"lineNumber": 41
},
"initialIsOpen": false
},
{
"id": "def-common.DeletePackagePoliciesRequest",
"type": "Interface",
"label": "DeletePackagePoliciesRequest",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.DeletePackagePoliciesRequest.body",
"type": "Object",
"label": "body",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts",
"lineNumber": 50
},
"signature": [
"{ packagePolicyIds: string[]; }"
]
}
],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts",
"lineNumber": 49
},
"initialIsOpen": false
},
{
"id": "def-common.DeletePackageRequest",
"type": "Interface",
"label": "DeletePackageRequest",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.DeletePackageRequest.params",
"type": "Object",
"label": "params",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts",
"lineNumber": 111
},
"signature": [
"{ pkgkey: string; }"
]
}
],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts",
"lineNumber": 110
},
"initialIsOpen": false
},
{
"id": "def-common.DeletePackageResponse",
"type": "Interface",
"label": "DeletePackageResponse",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.DeletePackageResponse.response",
"type": "Array",
"label": "response",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts",
"lineNumber": 117
},
"signature": [
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.AssetReference",
"text": "AssetReference"
},
"[]"
]
}
],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts",
"lineNumber": 116
},
"initialIsOpen": false
},
{
"id": "def-common.EnrollmentAPIKey",
"type": "Interface",
"label": "EnrollmentAPIKey",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.EnrollmentAPIKey.id",
"type": "string",
"label": "id",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/enrollment_api_key.ts",
"lineNumber": 9
}
},
{
"tags": [],
"id": "def-common.EnrollmentAPIKey.api_key_id",
"type": "string",
"label": "api_key_id",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/enrollment_api_key.ts",
"lineNumber": 10
}
},
{
"tags": [],
"id": "def-common.EnrollmentAPIKey.api_key",
"type": "string",
"label": "api_key",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/enrollment_api_key.ts",
"lineNumber": 11
}
},
{
"tags": [],
"id": "def-common.EnrollmentAPIKey.name",
"type": "string",
"label": "name",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/enrollment_api_key.ts",
"lineNumber": 12
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-common.EnrollmentAPIKey.active",
"type": "boolean",
"label": "active",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/enrollment_api_key.ts",
"lineNumber": 13
}
},
{
"tags": [],
"id": "def-common.EnrollmentAPIKey.policy_id",
"type": "string",
"label": "policy_id",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/enrollment_api_key.ts",
"lineNumber": 14
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-common.EnrollmentAPIKey.created_at",
"type": "string",
"label": "created_at",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/enrollment_api_key.ts",
"lineNumber": 15
}
}
],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/enrollment_api_key.ts",
"lineNumber": 8
},
"initialIsOpen": false
},
{
"id": "def-common.EpmPackageAdditions",
"type": "Interface",
"label": "EpmPackageAdditions",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.EpmPackageAdditions.title",
"type": "string",
"label": "title",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"lineNumber": 312
}
},
{
"tags": [],
"id": "def-common.EpmPackageAdditions.latestVersion",
"type": "string",
"label": "latestVersion",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"lineNumber": 313
}
},
{
"tags": [],
"id": "def-common.EpmPackageAdditions.assets",
"type": "CompoundType",
"label": "assets",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"lineNumber": 314
},
"signature": [
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.AssetsGroupedByServiceByType",
"text": "AssetsGroupedByServiceByType"
}
]
},
{
"tags": [],
"id": "def-common.EpmPackageAdditions.removable",
"type": "CompoundType",
"label": "removable",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"lineNumber": 315
},
"signature": [
"boolean | undefined"
]
}
],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"lineNumber": 311
},
"initialIsOpen": false
},
{
"id": "def-common.FleetConfigType",
"type": "Interface",
"label": "FleetConfigType",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.FleetConfigType.enabled",
"type": "boolean",
"label": "enabled",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/index.ts",
"lineNumber": 12
}
},
{
"tags": [],
"id": "def-common.FleetConfigType.registryUrl",
"type": "string",
"label": "registryUrl",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/index.ts",
"lineNumber": 13
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-common.FleetConfigType.registryProxyUrl",
"type": "string",
"label": "registryProxyUrl",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/index.ts",
"lineNumber": 14
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-common.FleetConfigType.agents",
"type": "Object",
"label": "agents",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/index.ts",
"lineNumber": 15
},
"signature": [
"{ enabled: boolean; fleetServerEnabled: boolean; tlsCheckDisabled: boolean; pollingRequestTimeout: number; maxConcurrentConnections: number; kibana: { host?: string | string[] | undefined; ca_sha256?: string | undefined; }; elasticsearch: { host?: string | undefined; ca_sha256?: string | undefined; }; agentPolicyRolloutRateLimitIntervalMs: number; agentPolicyRolloutRateLimitRequestPerInterval: number; }"
]
}
],
"source": {
"path": "x-pack/plugins/fleet/common/types/index.ts",
"lineNumber": 11
},
"initialIsOpen": false
},
{
"id": "def-common.FleetServerAgent",
"type": "Interface",
"label": "FleetServerAgent",
"description": [
"\nAn Elastic Agent that has enrolled into Fleet"
],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.FleetServerAgent._version",
"type": "number",
"label": "_version",
"description": [
"\nThe version of the document in the index"
],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
"lineNumber": 172
},
"signature": [
"number | undefined"
]
},
{
"tags": [],
"id": "def-common.FleetServerAgent.shared_id",
"type": "string",
"label": "shared_id",
"description": [
"\nShared ID"
],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
"lineNumber": 176
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-common.FleetServerAgent.type",
"type": "CompoundType",
"label": "type",
"description": [
"\nType"
],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
"lineNumber": 180
},
"signature": [
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.AgentType",
"text": "AgentType"
}
]
},
{
"tags": [],
"id": "def-common.FleetServerAgent.active",
"type": "boolean",
"label": "active",
"description": [
"\nActive flag"
],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
"lineNumber": 184
}
},
{
"tags": [],
"id": "def-common.FleetServerAgent.enrolled_at",
"type": "string",
"label": "enrolled_at",
"description": [
"\nDate/time the Elastic Agent enrolled"
],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
"lineNumber": 188
}
},
{
"tags": [],
"id": "def-common.FleetServerAgent.unenrolled_at",
"type": "string",
"label": "unenrolled_at",
"description": [
"\nDate/time the Elastic Agent unenrolled"
],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
"lineNumber": 192
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-common.FleetServerAgent.unenrollment_started_at",
"type": "string",
"label": "unenrollment_started_at",
"description": [
"\nDate/time the Elastic Agent unenrolled started"
],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
"lineNumber": 196
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-common.FleetServerAgent.upgraded_at",
"type": "CompoundType",
"label": "upgraded_at",
"description": [
"\nDate/time the Elastic Agent was last upgraded"
],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
"lineNumber": 200
},
"signature": [
"string | null | undefined"
]
},
{
"tags": [],
"id": "def-common.FleetServerAgent.upgrade_started_at",
"type": "CompoundType",
"label": "upgrade_started_at",
"description": [
"\nDate/time the Elastic Agent started the current upgrade"
],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
"lineNumber": 204
},
"signature": [
"string | null | undefined"
]
},
{
"tags": [],
"id": "def-common.FleetServerAgent.access_api_key_id",
"type": "string",
"label": "access_api_key_id",
"description": [
"\nID of the API key the Elastic Agent must used to contact Fleet Server"
],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
"lineNumber": 208
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-common.FleetServerAgent.agent",
"type": "Object",
"label": "agent",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
"lineNumber": 209
},
"signature": [
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.FleetServerAgentMetadata",
"text": "FleetServerAgentMetadata"
},
" | undefined"
]
},
{
"tags": [],
"id": "def-common.FleetServerAgent.user_provided_metadata",
"type": "Object",
"label": "user_provided_metadata",
"description": [
"\nUser provided metadata information for the Elastic Agent"
],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
"lineNumber": 213
},
"signature": [
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.AgentMetadata",
"text": "AgentMetadata"
}
]
},
{
"tags": [],
"id": "def-common.FleetServerAgent.local_metadata",
"type": "Object",
"label": "local_metadata",
"description": [
"\nLocal metadata information for the Elastic Agent"
],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
"lineNumber": 217
},
"signature": [
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.AgentMetadata",
"text": "AgentMetadata"
}
]
},
{
"tags": [],
"id": "def-common.FleetServerAgent.policy_id",
"type": "string",
"label": "policy_id",
"description": [
"\nThe policy ID for the Elastic Agent"
],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
"lineNumber": 221
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-common.FleetServerAgent.policy_revision_idx",
"type": "CompoundType",
"label": "policy_revision_idx",
"description": [
"\nThe current policy revision_idx for the Elastic Agent"
],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
"lineNumber": 225
},
"signature": [
"number | null | undefined"
]
},
{
"tags": [],
"id": "def-common.FleetServerAgent.policy_coordinator_idx",
"type": "number",
"label": "policy_coordinator_idx",
"description": [
"\nThe current policy coordinator for the Elastic Agent"
],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
"lineNumber": 229
},
"signature": [
"number | undefined"
]
},
{
"tags": [],
"id": "def-common.FleetServerAgent.last_updated",
"type": "string",
"label": "last_updated",
"description": [
"\nDate/time the Elastic Agent was last updated"
],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
"lineNumber": 233
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-common.FleetServerAgent.last_checkin",
"type": "string",
"label": "last_checkin",
"description": [
"\nDate/time the Elastic Agent checked in last time"
],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
"lineNumber": 237
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-common.FleetServerAgent.last_checkin_status",
"type": "CompoundType",
"label": "last_checkin_status",
"description": [
"\nLst checkin status"
],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
"lineNumber": 241
},
"signature": [
"\"online\" | \"error\" | \"updating\" | \"degraded\" | undefined"
]
},
{
"tags": [],
"id": "def-common.FleetServerAgent.default_api_key_id",
"type": "string",
"label": "default_api_key_id",
"description": [
"\nID of the API key the Elastic Agent uses to authenticate with elasticsearch"
],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
"lineNumber": 245
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-common.FleetServerAgent.default_api_key",
"type": "string",
"label": "default_api_key",
"description": [
"\nAPI key the Elastic Agent uses to authenticate with elasticsearch"
],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
"lineNumber": 249
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-common.FleetServerAgent.updated_at",
"type": "string",
"label": "updated_at",
"description": [
"\nDate/time the Elastic Agent was last updated"
],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
"lineNumber": 253
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-common.FleetServerAgent.packages",
"type": "Array",
"label": "packages",
"description": [
"\nPackages array"
],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
"lineNumber": 257
},
"signature": [
"string[] | undefined"
]
},
{
"tags": [],
"id": "def-common.FleetServerAgent.action_seq_no",
"type": "number",
"label": "action_seq_no",
"description": [
"\nThe last acknowledged action sequence number for the Elastic Agent"
],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
"lineNumber": 261
},
"signature": [
"number | undefined"
]
}
],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
"lineNumber": 168
},
"initialIsOpen": false
},
{
"id": "def-common.FleetServerAgentAction",
"type": "Interface",
"label": "FleetServerAgentAction",
"description": [
"\nAn Elastic Agent action"
],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.FleetServerAgentAction._id",
"type": "string",
"label": "_id",
"description": [
"\nThe unique identifier for action document"
],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
"lineNumber": 285
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-common.FleetServerAgentAction._seq_no",
"type": "number",
"label": "_seq_no",
"description": [
"\nThe action sequence number"
],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
"lineNumber": 289
},
"signature": [
"number | undefined"
]
},
{
"tags": [],
"id": "def-common.FleetServerAgentAction.action_id",
"type": "string",
"label": "action_id",
"description": [
"\nThe unique identifier for the Elastic Agent action. There could be multiple documents with the same action_id if the action is split into two separate documents."
],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
"lineNumber": 293
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-common.FleetServerAgentAction.'@timestamp'",
"type": "string",
"label": "'@timestamp'",
"description": [
"\nDate/time the action was created"
],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
"lineNumber": 297
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-common.FleetServerAgentAction.expiration",
"type": "string",
"label": "expiration",
"description": [
"\nThe action expiration date/time"
],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
"lineNumber": 301
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-common.FleetServerAgentAction.type",
"type": "string",
"label": "type",
"description": [
"\nThe action type. APP_ACTION is the value for the actions that suppose to be routed to the endpoints/beats."
],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
"lineNumber": 305
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-common.FleetServerAgentAction.input_id",
"type": "string",
"label": "input_id",
"description": [
"\nThe input identifier the actions should be routed to."
],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
"lineNumber": 309
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-common.FleetServerAgentAction.agents",
"type": "Array",
"label": "agents",
"description": [
"\nThe Agent IDs the action is intended for. No support for json.RawMessage with the current generator. Could be useful to lazy parse the agent ids"
],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
"lineNumber": 313
},
"signature": [
"string[] | undefined"
]
},
{
"tags": [],
"id": "def-common.FleetServerAgentAction.data",
"type": "Object",
"label": "data",
"description": [
"\nThe opaque payload."
],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
"lineNumber": 317
},
"signature": [
"{ [k: string]: unknown; } | undefined"
]
},
{
"id": "def-common.FleetServerAgentAction.Unnamed",
"type": "Any",
"label": "Unnamed",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
"lineNumber": 320
},
"signature": [
"any"
]
}
],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
"lineNumber": 281
},
"initialIsOpen": false
},
{
"id": "def-common.FleetServerAgentMetadata",
"type": "Interface",
"label": "FleetServerAgentMetadata",
"description": [
"\nAn Elastic Agent metadata"
],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.FleetServerAgentMetadata.id",
"type": "string",
"label": "id",
"description": [
"\nThe unique identifier for the Elastic Agent"
],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
"lineNumber": 270
}
},
{
"tags": [],
"id": "def-common.FleetServerAgentMetadata.version",
"type": "string",
"label": "version",
"description": [
"\nThe version of the Elastic Agent"
],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
"lineNumber": 274
}
},
{
"id": "def-common.FleetServerAgentMetadata.Unnamed",
"type": "Any",
"label": "Unnamed",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
"lineNumber": 275
},
"signature": [
"any"
]
}
],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
"lineNumber": 266
},
"initialIsOpen": false
},
{
"id": "def-common.FleetServerEnrollmentAPIKey",
"type": "Interface",
"label": "FleetServerEnrollmentAPIKey",
"description": [
"\nAn Elastic Agent enrollment API key"
],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.FleetServerEnrollmentAPIKey.active",
"type": "CompoundType",
"label": "active",
"description": [
"\nTrue when the key is active"
],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/enrollment_api_key.ts",
"lineNumber": 29
},
"signature": [
"boolean | undefined"
]
},
{
"tags": [],
"id": "def-common.FleetServerEnrollmentAPIKey.api_key_id",
"type": "string",
"label": "api_key_id",
"description": [
"\nThe unique identifier for the enrollment key, currently xid"
],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/enrollment_api_key.ts",
"lineNumber": 33
}
},
{
"tags": [],
"id": "def-common.FleetServerEnrollmentAPIKey.api_key",
"type": "string",
"label": "api_key",
"description": [
"\nApi key"
],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/enrollment_api_key.ts",
"lineNumber": 37
}
},
{
"tags": [],
"id": "def-common.FleetServerEnrollmentAPIKey.name",
"type": "string",
"label": "name",
"description": [
"\nEnrollment key name"
],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/enrollment_api_key.ts",
"lineNumber": 41
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-common.FleetServerEnrollmentAPIKey.policy_id",
"type": "string",
"label": "policy_id",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/enrollment_api_key.ts",
"lineNumber": 42
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-common.FleetServerEnrollmentAPIKey.expire_at",
"type": "string",
"label": "expire_at",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/enrollment_api_key.ts",
"lineNumber": 43
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-common.FleetServerEnrollmentAPIKey.created_at",
"type": "string",
"label": "created_at",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/enrollment_api_key.ts",
"lineNumber": 44
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-common.FleetServerEnrollmentAPIKey.updated_at",
"type": "string",
"label": "updated_at",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/enrollment_api_key.ts",
"lineNumber": 45
},
"signature": [
"string | undefined"
]
}
],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/enrollment_api_key.ts",
"lineNumber": 25
},
"initialIsOpen": false
},
{
"id": "def-common.FleetServerPolicy",
"type": "Interface",
"label": "FleetServerPolicy",
"description": [
"\nA policy that an Elastic Agent is attached to"
],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.FleetServerPolicy.'@timestamp'",
"type": "string",
"label": "'@timestamp'",
"description": [
"\nDate/time the policy revision was created"
],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts",
"lineNumber": 99
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-common.FleetServerPolicy.policy_id",
"type": "string",
"label": "policy_id",
"description": [
"\nThe ID of the policy"
],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts",
"lineNumber": 103
}
},
{
"tags": [],
"id": "def-common.FleetServerPolicy.revision_idx",
"type": "number",
"label": "revision_idx",
"description": [
"\nThe revision index of the policy"
],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts",
"lineNumber": 107
}
},
{
"tags": [],
"id": "def-common.FleetServerPolicy.coordinator_idx",
"type": "number",
"label": "coordinator_idx",
"description": [
"\nThe coordinator index of the policy"
],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts",
"lineNumber": 111
}
},
{
"tags": [],
"id": "def-common.FleetServerPolicy.data",
"type": "Object",
"label": "data",
"description": [
"\nThe opaque payload."
],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts",
"lineNumber": 115
},
"signature": [
"{ [k: string]: unknown; }"
]
},
{
"tags": [],
"id": "def-common.FleetServerPolicy.default_fleet_server",
"type": "boolean",
"label": "default_fleet_server",
"description": [
"\nTrue when this policy is the default policy to start Fleet Server"
],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts",
"lineNumber": 121
}
}
],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts",
"lineNumber": 95
},
"initialIsOpen": false
},
{
"id": "def-common.FullAgentPolicy",
"type": "Interface",
"label": "FullAgentPolicy",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.FullAgentPolicy.id",
"type": "string",
"label": "id",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts",
"lineNumber": 63
}
},
{
"tags": [],
"id": "def-common.FullAgentPolicy.outputs",
"type": "Object",
"label": "outputs",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts",
"lineNumber": 64
},
"signature": [
"{ [key: string]: Pick<",
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.Output",
"text": "Output"
},
", \"type\" | \"hosts\" | \"ca_sha256\" | \"api_key\"> & { [key: string]: any; }; }"
]
},
{
"tags": [],
"id": "def-common.FullAgentPolicy.fleet",
"type": "Object",
"label": "fleet",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts",
"lineNumber": 69
},
"signature": [
"{ kibana: ",
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.FullAgentPolicyKibanaConfig",
"text": "FullAgentPolicyKibanaConfig"
},
"; } | undefined"
]
},
{
"tags": [],
"id": "def-common.FullAgentPolicy.inputs",
"type": "Array",
"label": "inputs",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts",
"lineNumber": 72
},
"signature": [
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.FullAgentPolicyInput",
"text": "FullAgentPolicyInput"
},
"[]"
]
},
{
"tags": [],
"id": "def-common.FullAgentPolicy.revision",
"type": "number",
"label": "revision",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts",
"lineNumber": 73
},
"signature": [
"number | undefined"
]
},
{
"tags": [],
"id": "def-common.FullAgentPolicy.agent",
"type": "Object",
"label": "agent",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts",
"lineNumber": 74
},
"signature": [
"{ monitoring: { use_output?: string | undefined; enabled: boolean; metrics: boolean; logs: boolean; }; } | undefined"
]
}
],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts",
"lineNumber": 62
},
"initialIsOpen": false
},
{
"id": "def-common.FullAgentPolicyInput",
"type": "Interface",
"label": "FullAgentPolicyInput",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.FullAgentPolicyInput.id",
"type": "string",
"label": "id",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts",
"lineNumber": 48
}
},
{
"tags": [],
"id": "def-common.FullAgentPolicyInput.name",
"type": "string",
"label": "name",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts",
"lineNumber": 49
}
},
{
"tags": [],
"id": "def-common.FullAgentPolicyInput.revision",
"type": "number",
"label": "revision",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts",
"lineNumber": 50
}
},
{
"tags": [],
"id": "def-common.FullAgentPolicyInput.type",
"type": "string",
"label": "type",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts",
"lineNumber": 51
}
},
{
"tags": [],
"id": "def-common.FullAgentPolicyInput.data_stream",
"type": "Object",
"label": "data_stream",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts",
"lineNumber": 52
},
"signature": [
"{ namespace: string; }"
]
},
{
"tags": [],
"id": "def-common.FullAgentPolicyInput.use_output",
"type": "string",
"label": "use_output",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts",
"lineNumber": 53
}
},
{
"tags": [],
"id": "def-common.FullAgentPolicyInput.meta",
"type": "Object",
"label": "meta",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts",
"lineNumber": 54
},
"signature": [
"{ [key: string]: unknown; package?: Pick<",
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.PackagePolicyPackage",
"text": "PackagePolicyPackage"
},
", \"name\" | \"version\"> | undefined; } | undefined"
]
},
{
"tags": [],
"id": "def-common.FullAgentPolicyInput.streams",
"type": "Array",
"label": "streams",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts",
"lineNumber": 58
},
"signature": [
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.FullAgentPolicyInputStream",
"text": "FullAgentPolicyInputStream"
},
"[] | undefined"
]
},
{
"id": "def-common.FullAgentPolicyInput.Unnamed",
"type": "Any",
"label": "Unnamed",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts",
"lineNumber": 59
},
"signature": [
"any"
]
}
],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts",
"lineNumber": 47
},
"initialIsOpen": false
},
{
"id": "def-common.FullAgentPolicyInputStream",
"type": "Interface",
"label": "FullAgentPolicyInputStream",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.FullAgentPolicyInputStream.id",
"type": "string",
"label": "id",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts",
"lineNumber": 39
}
},
{
"tags": [],
"id": "def-common.FullAgentPolicyInputStream.data_stream",
"type": "Object",
"label": "data_stream",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts",
"lineNumber": 40
},
"signature": [
"{ dataset: string; type: string; }"
]
},
{
"id": "def-common.FullAgentPolicyInputStream.Unnamed",
"type": "Any",
"label": "Unnamed",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts",
"lineNumber": 44
},
"signature": [
"any"
]
}
],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts",
"lineNumber": 38
},
"initialIsOpen": false
},
{
"id": "def-common.FullAgentPolicyKibanaConfig",
"type": "Interface",
"label": "FullAgentPolicyKibanaConfig",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.FullAgentPolicyKibanaConfig.hosts",
"type": "Array",
"label": "hosts",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts",
"lineNumber": 85
},
"signature": [
"string[]"
]
},
{
"tags": [],
"id": "def-common.FullAgentPolicyKibanaConfig.protocol",
"type": "string",
"label": "protocol",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts",
"lineNumber": 86
}
},
{
"tags": [],
"id": "def-common.FullAgentPolicyKibanaConfig.path",
"type": "string",
"label": "path",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts",
"lineNumber": 87
},
"signature": [
"string | undefined"
]
}
],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts",
"lineNumber": 84
},
"initialIsOpen": false
},
{
"id": "def-common.GetAgentPoliciesRequest",
"type": "Interface",
"label": "GetAgentPoliciesRequest",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.GetAgentPoliciesRequest.query",
"type": "CompoundType",
"label": "query",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts",
"lineNumber": 13
},
"signature": [
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.ListWithKuery",
"text": "ListWithKuery"
},
" & { full?: boolean | undefined; }"
]
}
],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts",
"lineNumber": 12
},
"initialIsOpen": false
},
{
"id": "def-common.GetAgentPoliciesResponse",
"type": "Interface",
"label": "GetAgentPoliciesResponse",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.GetAgentPoliciesResponse.items",
"type": "Array",
"label": "items",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts",
"lineNumber": 21
},
"signature": [
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.GetAgentPoliciesResponseItem",
"text": "GetAgentPoliciesResponseItem"
},
"[]"
]
},
{
"tags": [],
"id": "def-common.GetAgentPoliciesResponse.total",
"type": "number",
"label": "total",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts",
"lineNumber": 22
}
},
{
"tags": [],
"id": "def-common.GetAgentPoliciesResponse.page",
"type": "number",
"label": "page",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts",
"lineNumber": 23
}
},
{
"tags": [],
"id": "def-common.GetAgentPoliciesResponse.perPage",
"type": "number",
"label": "perPage",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts",
"lineNumber": 24
}
}
],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts",
"lineNumber": 20
},
"initialIsOpen": false
},
{
"id": "def-common.GetAgentsRequest",
"type": "Interface",
"label": "GetAgentsRequest",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.GetAgentsRequest.query",
"type": "Object",
"label": "query",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts",
"lineNumber": 19
},
"signature": [
"{ page: number; perPage: number; kuery?: string | undefined; showInactive: boolean; showUpgradeable?: boolean | undefined; }"
]
}
],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts",
"lineNumber": 18
},
"initialIsOpen": false
},
{
"id": "def-common.GetAgentsResponse",
"type": "Interface",
"label": "GetAgentsResponse",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.GetAgentsResponse.list",
"type": "Array",
"label": "list",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts",
"lineNumber": 29
},
"signature": [
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.Agent",
"text": "Agent"
},
"[]"
]
},
{
"tags": [],
"id": "def-common.GetAgentsResponse.total",
"type": "number",
"label": "total",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts",
"lineNumber": 30
}
},
{
"tags": [],
"id": "def-common.GetAgentsResponse.totalInactive",
"type": "number",
"label": "totalInactive",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts",
"lineNumber": 31
}
},
{
"tags": [],
"id": "def-common.GetAgentsResponse.page",
"type": "number",
"label": "page",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts",
"lineNumber": 32
}
},
{
"tags": [],
"id": "def-common.GetAgentsResponse.perPage",
"type": "number",
"label": "perPage",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts",
"lineNumber": 33
}
}
],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts",
"lineNumber": 28
},
"initialIsOpen": false
},
{
"id": "def-common.GetAgentStatusRequest",
"type": "Interface",
"label": "GetAgentStatusRequest",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.GetAgentStatusRequest.query",
"type": "Object",
"label": "query",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts",
"lineNumber": 215
},
"signature": [
"{ kuery?: string | undefined; policyId?: string | undefined; }"
]
}
],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts",
"lineNumber": 214
},
"initialIsOpen": false
},
{
"id": "def-common.GetAgentStatusResponse",
"type": "Interface",
"label": "GetAgentStatusResponse",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.GetAgentStatusResponse.results",
"type": "Object",
"label": "results",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts",
"lineNumber": 222
},
"signature": [
"{ events: number; total: number; online: number; error: number; offline: number; other: number; updating: number; }"
]
}
],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts",
"lineNumber": 221
},
"initialIsOpen": false
},
{
"id": "def-common.GetCategoriesRequest",
"type": "Interface",
"label": "GetCategoriesRequest",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.GetCategoriesRequest.query",
"type": "Object",
"label": "query",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts",
"lineNumber": 18
},
"signature": [
"{ experimental?: boolean | undefined; }"
]
}
],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts",
"lineNumber": 17
},
"initialIsOpen": false
},
{
"id": "def-common.GetCategoriesResponse",
"type": "Interface",
"label": "GetCategoriesResponse",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.GetCategoriesResponse.response",
"type": "Array",
"label": "response",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts",
"lineNumber": 24
},
"signature": [
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.CategorySummaryList",
"text": "CategorySummaryList"
}
]
}
],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts",
"lineNumber": 23
},
"initialIsOpen": false
},
{
"id": "def-common.GetDataStreamsResponse",
"type": "Interface",
"label": "GetDataStreamsResponse",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.GetDataStreamsResponse.data_streams",
"type": "Array",
"label": "data_streams",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/data_stream.ts",
"lineNumber": 11
},
"signature": [
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.DataStream",
"text": "DataStream"
},
"[]"
]
}
],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/data_stream.ts",
"lineNumber": 10
},
"initialIsOpen": false
},
{
"id": "def-common.GetEnrollmentAPIKeysRequest",
"type": "Interface",
"label": "GetEnrollmentAPIKeysRequest",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.GetEnrollmentAPIKeysRequest.query",
"type": "Object",
"label": "query",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts",
"lineNumber": 11
},
"signature": [
"{ page: number; perPage: number; kuery?: string | undefined; }"
]
}
],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts",
"lineNumber": 10
},
"initialIsOpen": false
},
{
"id": "def-common.GetEnrollmentAPIKeysResponse",
"type": "Interface",
"label": "GetEnrollmentAPIKeysResponse",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.GetEnrollmentAPIKeysResponse.list",
"type": "Array",
"label": "list",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts",
"lineNumber": 19
},
"signature": [
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.EnrollmentAPIKey",
"text": "EnrollmentAPIKey"
},
"[]"
]
},
{
"tags": [],
"id": "def-common.GetEnrollmentAPIKeysResponse.total",
"type": "number",
"label": "total",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts",
"lineNumber": 20
}
},
{
"tags": [],
"id": "def-common.GetEnrollmentAPIKeysResponse.page",
"type": "number",
"label": "page",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts",
"lineNumber": 21
}
},
{
"tags": [],
"id": "def-common.GetEnrollmentAPIKeysResponse.perPage",
"type": "number",
"label": "perPage",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts",
"lineNumber": 22
}
}
],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts",
"lineNumber": 18
},
"initialIsOpen": false
},
{
"id": "def-common.GetFileRequest",
"type": "Interface",
"label": "GetFileRequest",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.GetFileRequest.params",
"type": "Object",
"label": "params",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts",
"lineNumber": 43
},
"signature": [
"{ pkgkey: string; filePath: string; }"
]
}
],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts",
"lineNumber": 42
},
"initialIsOpen": false
},
{
"id": "def-common.GetFleetStatusResponse",
"type": "Interface",
"label": "GetFleetStatusResponse",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.GetFleetStatusResponse.isReady",
"type": "boolean",
"label": "isReady",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/fleet_setup.ts",
"lineNumber": 13
}
},
{
"tags": [],
"id": "def-common.GetFleetStatusResponse.missing_requirements",
"type": "Array",
"label": "missing_requirements",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/fleet_setup.ts",
"lineNumber": 14
},
"signature": [
"(\"tls_required\" | \"api_keys\" | \"fleet_admin_user\" | \"encrypted_saved_object_encryption_key_required\")[]"
]
}
],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/fleet_setup.ts",
"lineNumber": 12
},
"initialIsOpen": false
},
{
"id": "def-common.GetFullAgentPolicyRequest",
"type": "Interface",
"label": "GetFullAgentPolicyRequest",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.GetFullAgentPolicyRequest.params",
"type": "Object",
"label": "params",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts",
"lineNumber": 73
},
"signature": [
"{ agentPolicyId: string; }"
]
}
],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts",
"lineNumber": 72
},
"initialIsOpen": false
},
{
"id": "def-common.GetFullAgentPolicyResponse",
"type": "Interface",
"label": "GetFullAgentPolicyResponse",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.GetFullAgentPolicyResponse.item",
"type": "Object",
"label": "item",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts",
"lineNumber": 79
},
"signature": [
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.FullAgentPolicy",
"text": "FullAgentPolicy"
}
]
}
],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts",
"lineNumber": 78
},
"initialIsOpen": false
},
{
"id": "def-common.GetInfoRequest",
"type": "Interface",
"label": "GetInfoRequest",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.GetInfoRequest.params",
"type": "Object",
"label": "params",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts",
"lineNumber": 50
},
"signature": [
"{ pkgkey: string; }"
]
}
],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts",
"lineNumber": 49
},
"initialIsOpen": false
},
{
"id": "def-common.GetInfoResponse",
"type": "Interface",
"label": "GetInfoResponse",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.GetInfoResponse.response",
"type": "CompoundType",
"label": "response",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts",
"lineNumber": 56
},
"signature": [
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.PackageInfo",
"text": "PackageInfo"
}
]
}
],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts",
"lineNumber": 55
},
"initialIsOpen": false
},
{
"id": "def-common.GetLimitedPackagesResponse",
"type": "Interface",
"label": "GetLimitedPackagesResponse",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.GetLimitedPackagesResponse.response",
"type": "Array",
"label": "response",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts",
"lineNumber": 39
},
"signature": [
"string[]"
]
}
],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts",
"lineNumber": 38
},
"initialIsOpen": false
},
{
"id": "def-common.GetOneAgentEventsRequest",
"type": "Interface",
"label": "GetOneAgentEventsRequest",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.GetOneAgentEventsRequest.params",
"type": "Object",
"label": "params",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts",
"lineNumber": 182
},
"signature": [
"{ agentId: string; }"
]
},
{
"tags": [],
"id": "def-common.GetOneAgentEventsRequest.query",
"type": "Object",
"label": "query",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts",
"lineNumber": 185
},
"signature": [
"{ page: number; perPage: number; kuery?: string | undefined; }"
]
}
],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts",
"lineNumber": 181
},
"initialIsOpen": false
},
{
"id": "def-common.GetOneAgentEventsResponse",
"type": "Interface",
"label": "GetOneAgentEventsResponse",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.GetOneAgentEventsResponse.list",
"type": "Array",
"label": "list",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts",
"lineNumber": 193
},
"signature": [
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.AgentEvent",
"text": "AgentEvent"
},
"[]"
]
},
{
"tags": [],
"id": "def-common.GetOneAgentEventsResponse.total",
"type": "number",
"label": "total",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts",
"lineNumber": 194
}
},
{
"tags": [],
"id": "def-common.GetOneAgentEventsResponse.page",
"type": "number",
"label": "page",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts",
"lineNumber": 195
}
},
{
"tags": [],
"id": "def-common.GetOneAgentEventsResponse.perPage",
"type": "number",
"label": "perPage",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts",
"lineNumber": 196
}
}
],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts",
"lineNumber": 192
},
"initialIsOpen": false
},
{
"id": "def-common.GetOneAgentPolicyRequest",
"type": "Interface",
"label": "GetOneAgentPolicyRequest",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.GetOneAgentPolicyRequest.params",
"type": "Object",
"label": "params",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts",
"lineNumber": 28
},
"signature": [
"{ agentPolicyId: string; }"
]
}
],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts",
"lineNumber": 27
},
"initialIsOpen": false
},
{
"id": "def-common.GetOneAgentPolicyResponse",
"type": "Interface",
"label": "GetOneAgentPolicyResponse",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.GetOneAgentPolicyResponse.item",
"type": "Object",
"label": "item",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts",
"lineNumber": 34
},
"signature": [
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.AgentPolicy",
"text": "AgentPolicy"
}
]
}
],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts",
"lineNumber": 33
},
"initialIsOpen": false
},
{
"id": "def-common.GetOneAgentRequest",
"type": "Interface",
"label": "GetOneAgentRequest",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.GetOneAgentRequest.params",
"type": "Object",
"label": "params",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts",
"lineNumber": 37
},
"signature": [
"{ agentId: string; }"
]
}
],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts",
"lineNumber": 36
},
"initialIsOpen": false
},
{
"id": "def-common.GetOneAgentResponse",
"type": "Interface",
"label": "GetOneAgentResponse",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.GetOneAgentResponse.item",
"type": "Object",
"label": "item",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts",
"lineNumber": 43
},
"signature": [
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.Agent",
"text": "Agent"
}
]
}
],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts",
"lineNumber": 42
},
"initialIsOpen": false
},
{
"id": "def-common.GetOneEnrollmentAPIKeyRequest",
"type": "Interface",
"label": "GetOneEnrollmentAPIKeyRequest",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.GetOneEnrollmentAPIKeyRequest.params",
"type": "Object",
"label": "params",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts",
"lineNumber": 26
},
"signature": [
"{ keyId: string; }"
]
}
],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts",
"lineNumber": 25
},
"initialIsOpen": false
},
{
"id": "def-common.GetOneEnrollmentAPIKeyResponse",
"type": "Interface",
"label": "GetOneEnrollmentAPIKeyResponse",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.GetOneEnrollmentAPIKeyResponse.item",
"type": "Object",
"label": "item",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts",
"lineNumber": 32
},
"signature": [
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.EnrollmentAPIKey",
"text": "EnrollmentAPIKey"
}
]
}
],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts",
"lineNumber": 31
},
"initialIsOpen": false
},
{
"id": "def-common.GetOneOutputRequest",
"type": "Interface",
"label": "GetOneOutputRequest",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.GetOneOutputRequest.params",
"type": "Object",
"label": "params",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/output.ts",
"lineNumber": 15
},
"signature": [
"{ outputId: string; }"
]
}
],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/output.ts",
"lineNumber": 14
},
"initialIsOpen": false
},
{
"id": "def-common.GetOneOutputResponse",
"type": "Interface",
"label": "GetOneOutputResponse",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.GetOneOutputResponse.item",
"type": "CompoundType",
"label": "item",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/output.ts",
"lineNumber": 11
},
"signature": [
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.Output",
"text": "Output"
}
]
}
],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/output.ts",
"lineNumber": 10
},
"initialIsOpen": false
},
{
"id": "def-common.GetOnePackagePolicyRequest",
"type": "Interface",
"label": "GetOnePackagePolicyRequest",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.GetOnePackagePolicyRequest.params",
"type": "Object",
"label": "params",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts",
"lineNumber": 26
},
"signature": [
"{ packagePolicyId: string; }"
]
}
],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts",
"lineNumber": 25
},
"initialIsOpen": false
},
{
"id": "def-common.GetOnePackagePolicyResponse",
"type": "Interface",
"label": "GetOnePackagePolicyResponse",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.GetOnePackagePolicyResponse.item",
"type": "Object",
"label": "item",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts",
"lineNumber": 32
},
"signature": [
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.PackagePolicy",
"text": "PackagePolicy"
}
]
}
],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts",
"lineNumber": 31
},
"initialIsOpen": false
},
{
"id": "def-common.GetOutputsResponse",
"type": "Interface",
"label": "GetOutputsResponse",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.GetOutputsResponse.items",
"type": "Array",
"label": "items",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/output.ts",
"lineNumber": 37
},
"signature": [
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.Output",
"text": "Output"
},
"[]"
]
},
{
"tags": [],
"id": "def-common.GetOutputsResponse.total",
"type": "number",
"label": "total",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/output.ts",
"lineNumber": 38
}
},
{
"tags": [],
"id": "def-common.GetOutputsResponse.page",
"type": "number",
"label": "page",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/output.ts",
"lineNumber": 39
}
},
{
"tags": [],
"id": "def-common.GetOutputsResponse.perPage",
"type": "number",
"label": "perPage",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/output.ts",
"lineNumber": 40
}
}
],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/output.ts",
"lineNumber": 36
},
"initialIsOpen": false
},
{
"id": "def-common.GetPackagePoliciesRequest",
"type": "Interface",
"label": "GetPackagePoliciesRequest",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.GetPackagePoliciesRequest.query",
"type": "Object",
"label": "query",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts",
"lineNumber": 11
},
"signature": [
"{ page: number; perPage: number; kuery?: string | undefined; }"
]
}
],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts",
"lineNumber": 10
},
"initialIsOpen": false
},
{
"id": "def-common.GetPackagePoliciesResponse",
"type": "Interface",
"label": "GetPackagePoliciesResponse",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.GetPackagePoliciesResponse.items",
"type": "Array",
"label": "items",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts",
"lineNumber": 19
},
"signature": [
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.PackagePolicy",
"text": "PackagePolicy"
},
"[]"
]
},
{
"tags": [],
"id": "def-common.GetPackagePoliciesResponse.total",
"type": "number",
"label": "total",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts",
"lineNumber": 20
}
},
{
"tags": [],
"id": "def-common.GetPackagePoliciesResponse.page",
"type": "number",
"label": "page",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts",
"lineNumber": 21
}
},
{
"tags": [],
"id": "def-common.GetPackagePoliciesResponse.perPage",
"type": "number",
"label": "perPage",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts",
"lineNumber": 22
}
}
],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts",
"lineNumber": 18
},
"initialIsOpen": false
},
{
"id": "def-common.GetPackagesRequest",
"type": "Interface",
"label": "GetPackagesRequest",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.GetPackagesRequest.query",
"type": "Object",
"label": "query",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts",
"lineNumber": 28
},
"signature": [
"{ category?: string | undefined; experimental?: boolean | undefined; }"
]
}
],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts",
"lineNumber": 27
},
"initialIsOpen": false
},
{
"id": "def-common.GetPackagesResponse",
"type": "Interface",
"label": "GetPackagesResponse",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.GetPackagesResponse.response",
"type": "Array",
"label": "response",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts",
"lineNumber": 35
},
"signature": [
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.Installable",
"text": "Installable"
},
"<Pick<",
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.RegistryPackage",
"text": "RegistryPackage"
},
", \"type\" | \"description\" | \"title\" | \"name\" | \"version\" | \"path\" | \"download\" | \"data_streams\" | \"release\" | \"icons\" | \"policy_templates\" | \"internal\">>[]"
]
}
],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts",
"lineNumber": 34
},
"initialIsOpen": false
},
{
"id": "def-common.GetSettingsResponse",
"type": "Interface",
"label": "GetSettingsResponse",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.GetSettingsResponse.item",
"type": "Object",
"label": "item",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/settings.ts",
"lineNumber": 11
},
"signature": [
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.Settings",
"text": "Settings"
}
]
}
],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/settings.ts",
"lineNumber": 10
},
"initialIsOpen": false
},
{
"id": "def-common.GetStatsRequest",
"type": "Interface",
"label": "GetStatsRequest",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.GetStatsRequest.params",
"type": "Object",
"label": "params",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts",
"lineNumber": 60
},
"signature": [
"{ pkgname: string; }"
]
}
],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts",
"lineNumber": 59
},
"initialIsOpen": false
},
{
"id": "def-common.GetStatsResponse",
"type": "Interface",
"label": "GetStatsResponse",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.GetStatsResponse.response",
"type": "Object",
"label": "response",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts",
"lineNumber": 66
},
"signature": [
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.PackageUsageStats",
"text": "PackageUsageStats"
}
]
}
],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts",
"lineNumber": 65
},
"initialIsOpen": false
},
{
"id": "def-common.IBulkInstallPackageHTTPError",
"type": "Interface",
"label": "IBulkInstallPackageHTTPError",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.IBulkInstallPackageHTTPError.name",
"type": "string",
"label": "name",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts",
"lineNumber": 80
}
},
{
"tags": [],
"id": "def-common.IBulkInstallPackageHTTPError.statusCode",
"type": "number",
"label": "statusCode",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts",
"lineNumber": 81
}
},
{
"tags": [],
"id": "def-common.IBulkInstallPackageHTTPError.error",
"type": "CompoundType",
"label": "error",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts",
"lineNumber": 82
},
"signature": [
"string | Error"
]
}
],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts",
"lineNumber": 79
},
"initialIsOpen": false
},
{
"id": "def-common.IndexTemplate",
"type": "Interface",
"label": "IndexTemplate",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.IndexTemplate.priority",
"type": "number",
"label": "priority",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"lineNumber": 383
}
},
{
"tags": [],
"id": "def-common.IndexTemplate.index_patterns",
"type": "Array",
"label": "index_patterns",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"lineNumber": 384
},
"signature": [
"string[]"
]
},
{
"tags": [],
"id": "def-common.IndexTemplate.template",
"type": "Object",
"label": "template",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"lineNumber": 385
},
"signature": [
"{ settings: any; mappings: any; }"
]
},
{
"tags": [],
"id": "def-common.IndexTemplate.data_stream",
"type": "Object",
"label": "data_stream",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"lineNumber": 389
},
"signature": [
"{ hidden?: boolean | undefined; }"
]
},
{
"tags": [],
"id": "def-common.IndexTemplate.composed_of",
"type": "Array",
"label": "composed_of",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"lineNumber": 390
},
"signature": [
"string[]"
]
},
{
"tags": [],
"id": "def-common.IndexTemplate._meta",
"type": "Uncategorized",
"label": "_meta",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"lineNumber": 391
},
"signature": [
"object"
]
}
],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"lineNumber": 382
},
"initialIsOpen": false
},
{
"id": "def-common.IndexTemplateMappings",
"type": "Interface",
"label": "IndexTemplateMappings",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.IndexTemplateMappings.properties",
"type": "Any",
"label": "properties",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"lineNumber": 376
},
"signature": [
"any"
]
}
],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"lineNumber": 375
},
"initialIsOpen": false
},
{
"id": "def-common.Installation",
"type": "Interface",
"label": "Installation",
"signature": [
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.Installation",
"text": "Installation"
},
" extends ",
"SavedObjectAttributes"
],
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.Installation.installed_kibana",
"type": "Array",
"label": "installed_kibana",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"lineNumber": 331
},
"signature": [
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.KibanaAssetReference",
"text": "KibanaAssetReference"
},
"[]"
]
},
{
"tags": [],
"id": "def-common.Installation.installed_es",
"type": "Array",
"label": "installed_es",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"lineNumber": 332
},
"signature": [
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.EsAssetReference",
"text": "EsAssetReference"
},
"[]"
]
},
{
"tags": [],
"id": "def-common.Installation.package_assets",
"type": "Array",
"label": "package_assets",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"lineNumber": 333
},
"signature": [
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.PackageAssetReference",
"text": "PackageAssetReference"
},
"[] | undefined"
]
},
{
"tags": [],
"id": "def-common.Installation.es_index_patterns",
"type": "Object",
"label": "es_index_patterns",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"lineNumber": 334
},
"signature": [
"Record<string, string>"
]
},
{
"tags": [],
"id": "def-common.Installation.name",
"type": "string",
"label": "name",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"lineNumber": 335
}
},
{
"tags": [],
"id": "def-common.Installation.version",
"type": "string",
"label": "version",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"lineNumber": 336
}
},
{
"tags": [],
"id": "def-common.Installation.install_status",
"type": "CompoundType",
"label": "install_status",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"lineNumber": 337
},
"signature": [
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.EpmPackageInstallStatus",
"text": "EpmPackageInstallStatus"
}
]
},
{
"tags": [],
"id": "def-common.Installation.install_version",
"type": "string",
"label": "install_version",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"lineNumber": 338
}
},
{
"tags": [],
"id": "def-common.Installation.install_started_at",
"type": "string",
"label": "install_started_at",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"lineNumber": 339
}
},
{
"tags": [],
"id": "def-common.Installation.install_source",
"type": "CompoundType",
"label": "install_source",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"lineNumber": 340
},
"signature": [
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.InstallSource",
"text": "InstallSource"
}
]
}
],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"lineNumber": 330
},
"initialIsOpen": false
},
{
"id": "def-common.InstallPackageRequest",
"type": "Interface",
"label": "InstallPackageRequest",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.InstallPackageRequest.params",
"type": "Object",
"label": "params",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts",
"lineNumber": 70
},
"signature": [
"{ pkgkey: string; }"
]
}
],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts",
"lineNumber": 69
},
"initialIsOpen": false
},
{
"id": "def-common.InstallPackageResponse",
"type": "Interface",
"label": "InstallPackageResponse",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.InstallPackageResponse.response",
"type": "Array",
"label": "response",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts",
"lineNumber": 76
},
"signature": [
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.AssetReference",
"text": "AssetReference"
},
"[]"
]
}
],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts",
"lineNumber": 75
},
"initialIsOpen": false
},
{
"id": "def-common.InstallResult",
"type": "Interface",
"label": "InstallResult",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.InstallResult.assets",
"type": "Array",
"label": "assets",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts",
"lineNumber": 86
},
"signature": [
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.AssetReference",
"text": "AssetReference"
},
"[]"
]
},
{
"tags": [],
"id": "def-common.InstallResult.status",
"type": "CompoundType",
"label": "status",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts",
"lineNumber": 87
},
"signature": [
"\"installed\" | \"already_installed\""
]
}
],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts",
"lineNumber": 85
},
"initialIsOpen": false
},
{
"id": "def-common.InstallScriptRequest",
"type": "Interface",
"label": "InstallScriptRequest",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.InstallScriptRequest.params",
"type": "Object",
"label": "params",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/install_script.ts",
"lineNumber": 9
},
"signature": [
"{ osType: \"macos\"; }"
]
}
],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/install_script.ts",
"lineNumber": 8
},
"initialIsOpen": false
},
{
"id": "def-common.ListResult",
"type": "Interface",
"label": "ListResult",
"signature": [
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.ListResult",
"text": "ListResult"
},
"<T>"
],
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.ListResult.items",
"type": "Array",
"label": "items",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/common.ts",
"lineNumber": 19
},
"signature": [
"T[]"
]
},
{
"tags": [],
"id": "def-common.ListResult.total",
"type": "number",
"label": "total",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/common.ts",
"lineNumber": 20
}
},
{
"tags": [],
"id": "def-common.ListResult.page",
"type": "number",
"label": "page",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/common.ts",
"lineNumber": 21
}
},
{
"tags": [],
"id": "def-common.ListResult.perPage",
"type": "number",
"label": "perPage",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/common.ts",
"lineNumber": 22
}
}
],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/common.ts",
"lineNumber": 18
},
"initialIsOpen": false
},
{
"id": "def-common.ListWithKuery",
"type": "Interface",
"label": "ListWithKuery",
"signature": [
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.ListWithKuery",
"text": "ListWithKuery"
},
" extends ",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreHttpPluginApi",
"section": "def-public.HttpFetchQuery",
"text": "HttpFetchQuery"
}
],
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.ListWithKuery.page",
"type": "number",
"label": "page",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/common.ts",
"lineNumber": 11
},
"signature": [
"number | undefined"
]
},
{
"tags": [],
"id": "def-common.ListWithKuery.perPage",
"type": "number",
"label": "perPage",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/common.ts",
"lineNumber": 12
},
"signature": [
"number | undefined"
]
},
{
"tags": [],
"id": "def-common.ListWithKuery.sortField",
"type": "string",
"label": "sortField",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/common.ts",
"lineNumber": 13
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-common.ListWithKuery.sortOrder",
"type": "CompoundType",
"label": "sortOrder",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/common.ts",
"lineNumber": 14
},
"signature": [
"\"asc\" | \"desc\" | undefined"
]
},
{
"tags": [],
"id": "def-common.ListWithKuery.kuery",
"type": "string",
"label": "kuery",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/common.ts",
"lineNumber": 15
},
"signature": [
"string | undefined"
]
}
],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/common.ts",
"lineNumber": 10
},
"initialIsOpen": false
},
{
"id": "def-common.MessageResponse",
"type": "Interface",
"label": "MessageResponse",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.MessageResponse.response",
"type": "string",
"label": "response",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts",
"lineNumber": 107
}
}
],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts",
"lineNumber": 106
},
"initialIsOpen": false
},
{
"id": "def-common.NewAgentAction",
"type": "Interface",
"label": "NewAgentAction",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.NewAgentAction.type",
"type": "CompoundType",
"label": "type",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
"lineNumber": 42
},
"signature": [
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.AgentActionType",
"text": "AgentActionType"
}
]
},
{
"tags": [],
"id": "def-common.NewAgentAction.data",
"type": "Any",
"label": "data",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
"lineNumber": 43
},
"signature": [
"any"
]
},
{
"tags": [],
"id": "def-common.NewAgentAction.sent_at",
"type": "string",
"label": "sent_at",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
"lineNumber": 44
},
"signature": [
"string | undefined"
]
}
],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
"lineNumber": 41
},
"initialIsOpen": false
},
{
"id": "def-common.NewAgentEvent",
"type": "Interface",
"label": "NewAgentEvent",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.NewAgentEvent.type",
"type": "CompoundType",
"label": "type",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
"lineNumber": 97
},
"signature": [
"\"STATE\" | \"ERROR\" | \"ACTION_RESULT\" | \"ACTION\""
]
},
{
"tags": [],
"id": "def-common.NewAgentEvent.subtype",
"type": "CompoundType",
"label": "subtype",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
"lineNumber": 98
},
"signature": [
"\"RUNNING\" | \"STARTING\" | \"IN_PROGRESS\" | \"CONFIG\" | \"FAILED\" | \"STOPPING\" | \"STOPPED\" | \"DEGRADED\" | \"UPDATING\" | \"DATA_DUMP\" | \"ACKNOWLEDGED\" | \"UNKNOWN\""
]
},
{
"tags": [],
"id": "def-common.NewAgentEvent.timestamp",
"type": "string",
"label": "timestamp",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
"lineNumber": 113
}
},
{
"tags": [],
"id": "def-common.NewAgentEvent.message",
"type": "string",
"label": "message",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
"lineNumber": 114
}
},
{
"tags": [],
"id": "def-common.NewAgentEvent.payload",
"type": "Any",
"label": "payload",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
"lineNumber": 115
},
"signature": [
"any"
]
},
{
"tags": [],
"id": "def-common.NewAgentEvent.agent_id",
"type": "string",
"label": "agent_id",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
"lineNumber": 116
}
},
{
"tags": [],
"id": "def-common.NewAgentEvent.action_id",
"type": "string",
"label": "action_id",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
"lineNumber": 117
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-common.NewAgentEvent.policy_id",
"type": "string",
"label": "policy_id",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
"lineNumber": 118
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-common.NewAgentEvent.stream_id",
"type": "string",
"label": "stream_id",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
"lineNumber": 119
},
"signature": [
"string | undefined"
]
}
],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
"lineNumber": 96
},
"initialIsOpen": false
},
{
"id": "def-common.NewAgentPolicy",
"type": "Interface",
"label": "NewAgentPolicy",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.NewAgentPolicy.name",
"type": "string",
"label": "name",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts",
"lineNumber": 17
}
},
{
"tags": [],
"id": "def-common.NewAgentPolicy.namespace",
"type": "string",
"label": "namespace",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts",
"lineNumber": 18
}
},
{
"tags": [],
"id": "def-common.NewAgentPolicy.description",
"type": "string",
"label": "description",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts",
"lineNumber": 19
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-common.NewAgentPolicy.is_default",
"type": "CompoundType",
"label": "is_default",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts",
"lineNumber": 20
},
"signature": [
"boolean | undefined"
]
},
{
"tags": [],
"id": "def-common.NewAgentPolicy.is_default_fleet_server",
"type": "CompoundType",
"label": "is_default_fleet_server",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts",
"lineNumber": 21
},
"signature": [
"boolean | undefined"
]
},
{
"tags": [],
"id": "def-common.NewAgentPolicy.is_managed",
"type": "CompoundType",
"label": "is_managed",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts",
"lineNumber": 22
},
"signature": [
"boolean | undefined"
]
},
{
"tags": [],
"id": "def-common.NewAgentPolicy.monitoring_enabled",
"type": "Array",
"label": "monitoring_enabled",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts",
"lineNumber": 23
},
"signature": [
"(\"metrics\" | \"logs\")[] | undefined"
]
}
],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts",
"lineNumber": 16
},
"initialIsOpen": false
},
{
"id": "def-common.NewOutput",
"type": "Interface",
"label": "NewOutput",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.NewOutput.is_default",
"type": "boolean",
"label": "is_default",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/output.ts",
"lineNumber": 14
}
},
{
"tags": [],
"id": "def-common.NewOutput.name",
"type": "string",
"label": "name",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/output.ts",
"lineNumber": 15
}
},
{
"tags": [],
"id": "def-common.NewOutput.type",
"type": "string",
"label": "type",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/output.ts",
"lineNumber": 16
},
"signature": [
"\"elasticsearch\""
]
},
{
"tags": [],
"id": "def-common.NewOutput.hosts",
"type": "Array",
"label": "hosts",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/output.ts",
"lineNumber": 17
},
"signature": [
"string[] | undefined"
]
},
{
"tags": [],
"id": "def-common.NewOutput.ca_sha256",
"type": "string",
"label": "ca_sha256",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/output.ts",
"lineNumber": 18
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-common.NewOutput.api_key",
"type": "string",
"label": "api_key",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/output.ts",
"lineNumber": 19
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-common.NewOutput.fleet_enroll_username",
"type": "string",
"label": "fleet_enroll_username",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/output.ts",
"lineNumber": 20
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-common.NewOutput.fleet_enroll_password",
"type": "string",
"label": "fleet_enroll_password",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/output.ts",
"lineNumber": 21
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-common.NewOutput.config",
"type": "Object",
"label": "config",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/output.ts",
"lineNumber": 22
},
"signature": [
"Record<string, any> | undefined"
]
},
{
"tags": [],
"id": "def-common.NewOutput.config_yaml",
"type": "string",
"label": "config_yaml",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/output.ts",
"lineNumber": 23
},
"signature": [
"string | undefined"
]
}
],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/output.ts",
"lineNumber": 13
},
"initialIsOpen": false
},
{
"id": "def-common.NewPackagePolicy",
"type": "Interface",
"label": "NewPackagePolicy",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.NewPackagePolicy.name",
"type": "string",
"label": "name",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/package_policy.ts",
"lineNumber": 50
}
},
{
"tags": [],
"id": "def-common.NewPackagePolicy.description",
"type": "string",
"label": "description",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/package_policy.ts",
"lineNumber": 51
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-common.NewPackagePolicy.namespace",
"type": "string",
"label": "namespace",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/package_policy.ts",
"lineNumber": 52
}
},
{
"tags": [],
"id": "def-common.NewPackagePolicy.enabled",
"type": "boolean",
"label": "enabled",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/package_policy.ts",
"lineNumber": 53
}
},
{
"tags": [],
"id": "def-common.NewPackagePolicy.policy_id",
"type": "string",
"label": "policy_id",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/package_policy.ts",
"lineNumber": 54
}
},
{
"tags": [],
"id": "def-common.NewPackagePolicy.output_id",
"type": "string",
"label": "output_id",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/package_policy.ts",
"lineNumber": 55
}
},
{
"tags": [],
"id": "def-common.NewPackagePolicy.package",
"type": "Object",
"label": "package",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/package_policy.ts",
"lineNumber": 56
},
"signature": [
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.PackagePolicyPackage",
"text": "PackagePolicyPackage"
},
" | undefined"
]
},
{
"tags": [],
"id": "def-common.NewPackagePolicy.inputs",
"type": "Array",
"label": "inputs",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/package_policy.ts",
"lineNumber": 57
},
"signature": [
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.NewPackagePolicyInput",
"text": "NewPackagePolicyInput"
},
"[]"
]
}
],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/package_policy.ts",
"lineNumber": 49
},
"initialIsOpen": false
},
{
"id": "def-common.NewPackagePolicyInput",
"type": "Interface",
"label": "NewPackagePolicyInput",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.NewPackagePolicyInput.type",
"type": "string",
"label": "type",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/package_policy.ts",
"lineNumber": 37
}
},
{
"tags": [],
"id": "def-common.NewPackagePolicyInput.enabled",
"type": "boolean",
"label": "enabled",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/package_policy.ts",
"lineNumber": 38
}
},
{
"tags": [],
"id": "def-common.NewPackagePolicyInput.vars",
"type": "Object",
"label": "vars",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/package_policy.ts",
"lineNumber": 39
},
"signature": [
"Record<string, ",
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.PackagePolicyConfigRecordEntry",
"text": "PackagePolicyConfigRecordEntry"
},
"> | undefined"
]
},
{
"tags": [],
"id": "def-common.NewPackagePolicyInput.config",
"type": "Object",
"label": "config",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/package_policy.ts",
"lineNumber": 40
},
"signature": [
"Record<string, ",
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.PackagePolicyConfigRecordEntry",
"text": "PackagePolicyConfigRecordEntry"
},
"> | undefined"
]
},
{
"tags": [],
"id": "def-common.NewPackagePolicyInput.streams",
"type": "Array",
"label": "streams",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/package_policy.ts",
"lineNumber": 41
},
"signature": [
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.NewPackagePolicyInputStream",
"text": "NewPackagePolicyInputStream"
},
"[]"
]
}
],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/package_policy.ts",
"lineNumber": 36
},
"initialIsOpen": false
},
{
"id": "def-common.NewPackagePolicyInputStream",
"type": "Interface",
"label": "NewPackagePolicyInputStream",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.NewPackagePolicyInputStream.enabled",
"type": "boolean",
"label": "enabled",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/package_policy.ts",
"lineNumber": 22
}
},
{
"tags": [],
"id": "def-common.NewPackagePolicyInputStream.data_stream",
"type": "Object",
"label": "data_stream",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/package_policy.ts",
"lineNumber": 23
},
"signature": [
"{ dataset: string; type: string; }"
]
},
{
"tags": [],
"id": "def-common.NewPackagePolicyInputStream.vars",
"type": "Object",
"label": "vars",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/package_policy.ts",
"lineNumber": 27
},
"signature": [
"Record<string, ",
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.PackagePolicyConfigRecordEntry",
"text": "PackagePolicyConfigRecordEntry"
},
"> | undefined"
]
},
{
"tags": [],
"id": "def-common.NewPackagePolicyInputStream.config",
"type": "Object",
"label": "config",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/package_policy.ts",
"lineNumber": 28
},
"signature": [
"Record<string, ",
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.PackagePolicyConfigRecordEntry",
"text": "PackagePolicyConfigRecordEntry"
},
"> | undefined"
]
}
],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/package_policy.ts",
"lineNumber": 21
},
"initialIsOpen": false
},
{
"id": "def-common.PackagePolicy",
"type": "Interface",
"label": "PackagePolicy",
"signature": [
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.PackagePolicy",
"text": "PackagePolicy"
},
" extends Pick<",
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.NewPackagePolicy",
"text": "NewPackagePolicy"
},
", \"enabled\" | \"description\" | \"name\" | \"package\" | \"namespace\" | \"policy_id\" | \"output_id\">"
],
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.PackagePolicy.id",
"type": "string",
"label": "id",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/package_policy.ts",
"lineNumber": 65
}
},
{
"tags": [],
"id": "def-common.PackagePolicy.inputs",
"type": "Array",
"label": "inputs",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/package_policy.ts",
"lineNumber": 66
},
"signature": [
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.PackagePolicyInput",
"text": "PackagePolicyInput"
},
"[]"
]
},
{
"tags": [],
"id": "def-common.PackagePolicy.version",
"type": "string",
"label": "version",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/package_policy.ts",
"lineNumber": 67
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-common.PackagePolicy.revision",
"type": "number",
"label": "revision",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/package_policy.ts",
"lineNumber": 68
}
},
{
"tags": [],
"id": "def-common.PackagePolicy.updated_at",
"type": "string",
"label": "updated_at",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/package_policy.ts",
"lineNumber": 69
}
},
{
"tags": [],
"id": "def-common.PackagePolicy.updated_by",
"type": "string",
"label": "updated_by",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/package_policy.ts",
"lineNumber": 70
}
},
{
"tags": [],
"id": "def-common.PackagePolicy.created_at",
"type": "string",
"label": "created_at",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/package_policy.ts",
"lineNumber": 71
}
},
{
"tags": [],
"id": "def-common.PackagePolicy.created_by",
"type": "string",
"label": "created_by",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/package_policy.ts",
"lineNumber": 72
}
}
],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/package_policy.ts",
"lineNumber": 64
},
"initialIsOpen": false
},
{
"id": "def-common.PackagePolicyConfigRecordEntry",
"type": "Interface",
"label": "PackagePolicyConfigRecordEntry",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.PackagePolicyConfigRecordEntry.type",
"type": "string",
"label": "type",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/package_policy.ts",
"lineNumber": 15
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-common.PackagePolicyConfigRecordEntry.value",
"type": "Any",
"label": "value",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/package_policy.ts",
"lineNumber": 16
},
"signature": [
"any"
]
}
],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/package_policy.ts",
"lineNumber": 14
},
"initialIsOpen": false
},
{
"id": "def-common.PackagePolicyInput",
"type": "Interface",
"label": "PackagePolicyInput",
"signature": [
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.PackagePolicyInput",
"text": "PackagePolicyInput"
},
" extends Pick<",
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.NewPackagePolicyInput",
"text": "NewPackagePolicyInput"
},
", \"type\" | \"enabled\" | \"config\" | \"vars\">"
],
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.PackagePolicyInput.streams",
"type": "Array",
"label": "streams",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/package_policy.ts",
"lineNumber": 45
},
"signature": [
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.PackagePolicyInputStream",
"text": "PackagePolicyInputStream"
},
"[]"
]
},
{
"tags": [],
"id": "def-common.PackagePolicyInput.compiled_input",
"type": "Any",
"label": "compiled_input",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/package_policy.ts",
"lineNumber": 46
},
"signature": [
"any"
]
}
],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/package_policy.ts",
"lineNumber": 44
},
"initialIsOpen": false
},
{
"id": "def-common.PackagePolicyInputStream",
"type": "Interface",
"label": "PackagePolicyInputStream",
"signature": [
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.PackagePolicyInputStream",
"text": "PackagePolicyInputStream"
},
" extends ",
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.NewPackagePolicyInputStream",
"text": "NewPackagePolicyInputStream"
}
],
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.PackagePolicyInputStream.id",
"type": "string",
"label": "id",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/package_policy.ts",
"lineNumber": 32
}
},
{
"tags": [],
"id": "def-common.PackagePolicyInputStream.compiled_stream",
"type": "Any",
"label": "compiled_stream",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/package_policy.ts",
"lineNumber": 33
},
"signature": [
"any"
]
}
],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/package_policy.ts",
"lineNumber": 31
},
"initialIsOpen": false
},
{
"id": "def-common.PackagePolicyPackage",
"type": "Interface",
"label": "PackagePolicyPackage",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.PackagePolicyPackage.name",
"type": "string",
"label": "name",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/package_policy.ts",
"lineNumber": 9
}
},
{
"tags": [],
"id": "def-common.PackagePolicyPackage.title",
"type": "string",
"label": "title",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/package_policy.ts",
"lineNumber": 10
}
},
{
"tags": [],
"id": "def-common.PackagePolicyPackage.version",
"type": "string",
"label": "version",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/package_policy.ts",
"lineNumber": 11
}
}
],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/package_policy.ts",
"lineNumber": 8
},
"initialIsOpen": false
},
{
"id": "def-common.PackageSpecIcon",
"type": "Interface",
"label": "PackageSpecIcon",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.PackageSpecIcon.src",
"type": "string",
"label": "src",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/package_spec.ts",
"lineNumber": 61
}
},
{
"tags": [],
"id": "def-common.PackageSpecIcon.title",
"type": "string",
"label": "title",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/package_spec.ts",
"lineNumber": 62
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-common.PackageSpecIcon.size",
"type": "string",
"label": "size",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/package_spec.ts",
"lineNumber": 63
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-common.PackageSpecIcon.type",
"type": "string",
"label": "type",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/package_spec.ts",
"lineNumber": 64
},
"signature": [
"string | undefined"
]
}
],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/package_spec.ts",
"lineNumber": 60
},
"initialIsOpen": false
},
{
"id": "def-common.PackageSpecManifest",
"type": "Interface",
"label": "PackageSpecManifest",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.PackageSpecManifest.format_version",
"type": "string",
"label": "format_version",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/package_spec.ts",
"lineNumber": 12
}
},
{
"tags": [],
"id": "def-common.PackageSpecManifest.name",
"type": "string",
"label": "name",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/package_spec.ts",
"lineNumber": 13
}
},
{
"tags": [],
"id": "def-common.PackageSpecManifest.title",
"type": "string",
"label": "title",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/package_spec.ts",
"lineNumber": 14
}
},
{
"tags": [],
"id": "def-common.PackageSpecManifest.description",
"type": "string",
"label": "description",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/package_spec.ts",
"lineNumber": 15
}
},
{
"tags": [],
"id": "def-common.PackageSpecManifest.version",
"type": "string",
"label": "version",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/package_spec.ts",
"lineNumber": 16
}
},
{
"tags": [],
"id": "def-common.PackageSpecManifest.license",
"type": "string",
"label": "license",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/package_spec.ts",
"lineNumber": 17
},
"signature": [
"\"basic\" | undefined"
]
},
{
"tags": [],
"id": "def-common.PackageSpecManifest.type",
"type": "string",
"label": "type",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/package_spec.ts",
"lineNumber": 18
},
"signature": [
"\"integration\" | undefined"
]
},
{
"tags": [],
"id": "def-common.PackageSpecManifest.release",
"type": "CompoundType",
"label": "release",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/package_spec.ts",
"lineNumber": 19
},
"signature": [
"\"experimental\" | \"beta\" | \"ga\""
]
},
{
"tags": [],
"id": "def-common.PackageSpecManifest.categories",
"type": "Array",
"label": "categories",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/package_spec.ts",
"lineNumber": 20
},
"signature": [
"(\"custom\" | \"security\" | \"monitoring\" | \"aws\" | \"azure\" | \"cloud\" | \"config_management\" | \"containers\" | \"crm\" | \"datastore\" | \"elastic_stack\" | \"google_cloud\" | \"kubernetes\" | \"languages\" | \"message_queue\" | \"network\" | \"notification\" | \"os_system\" | \"productivity\" | \"support\" | \"ticketing\" | \"version_control\" | \"web\" | undefined)[] | undefined"
]
},
{
"tags": [],
"id": "def-common.PackageSpecManifest.conditions",
"type": "Object",
"label": "conditions",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/package_spec.ts",
"lineNumber": 21
},
"signature": [
"Record<\"kibana\", { version: string; }> | undefined"
]
},
{
"tags": [],
"id": "def-common.PackageSpecManifest.icons",
"type": "Array",
"label": "icons",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/package_spec.ts",
"lineNumber": 22
},
"signature": [
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.PackageSpecIcon",
"text": "PackageSpecIcon"
},
"[] | undefined"
]
},
{
"tags": [],
"id": "def-common.PackageSpecManifest.screenshots",
"type": "Array",
"label": "screenshots",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/package_spec.ts",
"lineNumber": 23
},
"signature": [
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.PackageSpecScreenshot",
"text": "PackageSpecScreenshot"
},
"[] | undefined"
]
},
{
"tags": [],
"id": "def-common.PackageSpecManifest.policy_templates",
"type": "Array",
"label": "policy_templates",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/package_spec.ts",
"lineNumber": 24
},
"signature": [
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.RegistryPolicyTemplate",
"text": "RegistryPolicyTemplate"
},
"[] | undefined"
]
},
{
"tags": [],
"id": "def-common.PackageSpecManifest.owner",
"type": "Object",
"label": "owner",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/package_spec.ts",
"lineNumber": 25
},
"signature": [
"{ github: string; }"
]
}
],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/package_spec.ts",
"lineNumber": 11
},
"initialIsOpen": false
},
{
"id": "def-common.PackageSpecScreenshot",
"type": "Interface",
"label": "PackageSpecScreenshot",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.PackageSpecScreenshot.src",
"type": "string",
"label": "src",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/package_spec.ts",
"lineNumber": 68
}
},
{
"tags": [],
"id": "def-common.PackageSpecScreenshot.title",
"type": "string",
"label": "title",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/package_spec.ts",
"lineNumber": 69
}
},
{
"tags": [],
"id": "def-common.PackageSpecScreenshot.size",
"type": "string",
"label": "size",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/package_spec.ts",
"lineNumber": 70
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-common.PackageSpecScreenshot.type",
"type": "string",
"label": "type",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/package_spec.ts",
"lineNumber": 71
},
"signature": [
"string | undefined"
]
}
],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/package_spec.ts",
"lineNumber": 67
},
"initialIsOpen": false
},
{
"id": "def-common.PackageUsageStats",
"type": "Interface",
"label": "PackageUsageStats",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.PackageUsageStats.agent_policy_count",
"type": "number",
"label": "agent_policy_count",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"lineNumber": 344
}
}
],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"lineNumber": 343
},
"initialIsOpen": false
},
{
"id": "def-common.PostAgentAcksRequest",
"type": "Interface",
"label": "PostAgentAcksRequest",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.PostAgentAcksRequest.body",
"type": "Object",
"label": "body",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts",
"lineNumber": 80
},
"signature": [
"{ events: ",
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.AgentEvent",
"text": "AgentEvent"
},
"[]; }"
]
},
{
"tags": [],
"id": "def-common.PostAgentAcksRequest.params",
"type": "Object",
"label": "params",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts",
"lineNumber": 83
},
"signature": [
"{ agentId: string; }"
]
}
],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts",
"lineNumber": 79
},
"initialIsOpen": false
},
{
"id": "def-common.PostAgentAcksResponse",
"type": "Interface",
"label": "PostAgentAcksResponse",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.PostAgentAcksResponse.action",
"type": "string",
"label": "action",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts",
"lineNumber": 89
}
}
],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts",
"lineNumber": 88
},
"initialIsOpen": false
},
{
"id": "def-common.PostAgentCheckinRequest",
"type": "Interface",
"label": "PostAgentCheckinRequest",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.PostAgentCheckinRequest.params",
"type": "Object",
"label": "params",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts",
"lineNumber": 47
},
"signature": [
"{ agentId: string; }"
]
},
{
"tags": [],
"id": "def-common.PostAgentCheckinRequest.body",
"type": "Object",
"label": "body",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts",
"lineNumber": 50
},
"signature": [
"{ status?: \"online\" | \"error\" | \"degraded\" | undefined; local_metadata?: Record<string, any> | undefined; events?: ",
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.NewAgentEvent",
"text": "NewAgentEvent"
},
"[] | undefined; }"
]
}
],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts",
"lineNumber": 46
},
"initialIsOpen": false
},
{
"id": "def-common.PostAgentCheckinResponse",
"type": "Interface",
"label": "PostAgentCheckinResponse",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.PostAgentCheckinResponse.action",
"type": "string",
"label": "action",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts",
"lineNumber": 58
}
},
{
"tags": [],
"id": "def-common.PostAgentCheckinResponse.actions",
"type": "Array",
"label": "actions",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts",
"lineNumber": 60
},
"signature": [
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.AgentAction",
"text": "AgentAction"
},
"[]"
]
}
],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts",
"lineNumber": 57
},
"initialIsOpen": false
},
{
"id": "def-common.PostAgentEnrollRequest",
"type": "Interface",
"label": "PostAgentEnrollRequest",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.PostAgentEnrollRequest.body",
"type": "Object",
"label": "body",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts",
"lineNumber": 64
},
"signature": [
"{ type: ",
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.AgentType",
"text": "AgentType"
},
"; metadata: { local: Record<string, any>; user_provided: Record<string, any>; }; }"
]
}
],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts",
"lineNumber": 63
},
"initialIsOpen": false
},
{
"id": "def-common.PostAgentEnrollResponse",
"type": "Interface",
"label": "PostAgentEnrollResponse",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.PostAgentEnrollResponse.action",
"type": "string",
"label": "action",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts",
"lineNumber": 74
}
},
{
"tags": [],
"id": "def-common.PostAgentEnrollResponse.item",
"type": "CompoundType",
"label": "item",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts",
"lineNumber": 76
},
"signature": [
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.Agent",
"text": "Agent"
},
" & { status: ",
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.AgentStatus",
"text": "AgentStatus"
},
"; }"
]
}
],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts",
"lineNumber": 73
},
"initialIsOpen": false
},
{
"id": "def-common.PostAgentUnenrollRequest",
"type": "Interface",
"label": "PostAgentUnenrollRequest",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.PostAgentUnenrollRequest.params",
"type": "Object",
"label": "params",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts",
"lineNumber": 106
},
"signature": [
"{ agentId: string; }"
]
},
{
"tags": [],
"id": "def-common.PostAgentUnenrollRequest.body",
"type": "Object",
"label": "body",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts",
"lineNumber": 109
},
"signature": [
"{ force?: boolean | undefined; }"
]
}
],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts",
"lineNumber": 105
},
"initialIsOpen": false
},
{
"id": "def-common.PostAgentUnenrollResponse",
"type": "Interface",
"label": "PostAgentUnenrollResponse",
"description": [],
"tags": [],
"children": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts",
"lineNumber": 115
},
"initialIsOpen": false
},
{
"id": "def-common.PostAgentUpgradeRequest",
"type": "Interface",
"label": "PostAgentUpgradeRequest",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.PostAgentUpgradeRequest.params",
"type": "Object",
"label": "params",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts",
"lineNumber": 128
},
"signature": [
"{ agentId: string; }"
]
},
{
"tags": [],
"id": "def-common.PostAgentUpgradeRequest.body",
"type": "Object",
"label": "body",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts",
"lineNumber": 131
},
"signature": [
"{ source_uri?: string | undefined; version: string; }"
]
}
],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts",
"lineNumber": 127
},
"initialIsOpen": false
},
{
"id": "def-common.PostAgentUpgradeResponse",
"type": "Interface",
"label": "PostAgentUpgradeResponse",
"description": [],
"tags": [],
"children": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts",
"lineNumber": 154
},
"initialIsOpen": false
},
{
"id": "def-common.PostBulkAgentReassignRequest",
"type": "Interface",
"label": "PostBulkAgentReassignRequest",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.PostBulkAgentReassignRequest.body",
"type": "Object",
"label": "body",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts",
"lineNumber": 167
},
"signature": [
"{ policy_id: string; agents: string | string[]; }"
]
}
],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts",
"lineNumber": 166
},
"initialIsOpen": false
},
{
"id": "def-common.PostBulkAgentUnenrollRequest",
"type": "Interface",
"label": "PostBulkAgentUnenrollRequest",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.PostBulkAgentUnenrollRequest.body",
"type": "Object",
"label": "body",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts",
"lineNumber": 118
},
"signature": [
"{ agents: string | string[]; force?: boolean | undefined; }"
]
}
],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts",
"lineNumber": 117
},
"initialIsOpen": false
},
{
"id": "def-common.PostBulkAgentUnenrollResponse",
"type": "Interface",
"label": "PostBulkAgentUnenrollResponse",
"description": [],
"tags": [],
"children": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts",
"lineNumber": 125
},
"initialIsOpen": false
},
{
"id": "def-common.PostBulkAgentUpgradeRequest",
"type": "Interface",
"label": "PostBulkAgentUpgradeRequest",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.PostBulkAgentUpgradeRequest.body",
"type": "Object",
"label": "body",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts",
"lineNumber": 138
},
"signature": [
"{ agents: string | string[]; source_uri?: string | undefined; version: string; }"
]
}
],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts",
"lineNumber": 137
},
"initialIsOpen": false
},
{
"id": "def-common.PostEnrollmentAPIKeyRequest",
"type": "Interface",
"label": "PostEnrollmentAPIKeyRequest",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.PostEnrollmentAPIKeyRequest.body",
"type": "Object",
"label": "body",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts",
"lineNumber": 46
},
"signature": [
"{ name?: string | undefined; policy_id: string; expiration?: string | undefined; }"
]
}
],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts",
"lineNumber": 45
},
"initialIsOpen": false
},
{
"id": "def-common.PostEnrollmentAPIKeyResponse",
"type": "Interface",
"label": "PostEnrollmentAPIKeyResponse",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.PostEnrollmentAPIKeyResponse.action",
"type": "string",
"label": "action",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts",
"lineNumber": 54
}
},
{
"tags": [],
"id": "def-common.PostEnrollmentAPIKeyResponse.item",
"type": "Object",
"label": "item",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts",
"lineNumber": 55
},
"signature": [
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.EnrollmentAPIKey",
"text": "EnrollmentAPIKey"
}
]
}
],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts",
"lineNumber": 53
},
"initialIsOpen": false
},
{
"id": "def-common.PostIngestSetupResponse",
"type": "Interface",
"label": "PostIngestSetupResponse",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.PostIngestSetupResponse.isInitialized",
"type": "boolean",
"label": "isInitialized",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/ingest_setup.ts",
"lineNumber": 9
}
}
],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/ingest_setup.ts",
"lineNumber": 8
},
"initialIsOpen": false
},
{
"id": "def-common.PostNewAgentActionRequest",
"type": "Interface",
"label": "PostNewAgentActionRequest",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.PostNewAgentActionRequest.body",
"type": "Object",
"label": "body",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts",
"lineNumber": 93
},
"signature": [
"{ action: ",
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.NewAgentAction",
"text": "NewAgentAction"
},
"; }"
]
},
{
"tags": [],
"id": "def-common.PostNewAgentActionRequest.params",
"type": "Object",
"label": "params",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts",
"lineNumber": 96
},
"signature": [
"{ agentId: string; }"
]
}
],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts",
"lineNumber": 92
},
"initialIsOpen": false
},
{
"id": "def-common.PostNewAgentActionResponse",
"type": "Interface",
"label": "PostNewAgentActionResponse",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.PostNewAgentActionResponse.item",
"type": "Object",
"label": "item",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts",
"lineNumber": 102
},
"signature": [
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.AgentAction",
"text": "AgentAction"
}
]
}
],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts",
"lineNumber": 101
},
"initialIsOpen": false
},
{
"id": "def-common.PutAgentReassignRequest",
"type": "Interface",
"label": "PutAgentReassignRequest",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.PutAgentReassignRequest.params",
"type": "Object",
"label": "params",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts",
"lineNumber": 157
},
"signature": [
"{ agentId: string; }"
]
},
{
"tags": [],
"id": "def-common.PutAgentReassignRequest.body",
"type": "Object",
"label": "body",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts",
"lineNumber": 160
},
"signature": [
"{ policy_id: string; }"
]
}
],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts",
"lineNumber": 156
},
"initialIsOpen": false
},
{
"id": "def-common.PutAgentReassignResponse",
"type": "Interface",
"label": "PutAgentReassignResponse",
"description": [],
"tags": [],
"children": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts",
"lineNumber": 164
},
"initialIsOpen": false
},
{
"id": "def-common.PutOutputRequest",
"type": "Interface",
"label": "PutOutputRequest",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.PutOutputRequest.params",
"type": "Object",
"label": "params",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/output.ts",
"lineNumber": 21
},
"signature": [
"{ outputId: string; }"
]
},
{
"tags": [],
"id": "def-common.PutOutputRequest.body",
"type": "Object",
"label": "body",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/output.ts",
"lineNumber": 24
},
"signature": [
"{ hosts?: string[] | undefined; ca_sha256?: string | undefined; config?: Record<string, any> | undefined; config_yaml?: string | undefined; }"
]
}
],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/output.ts",
"lineNumber": 20
},
"initialIsOpen": false
},
{
"id": "def-common.PutOutputResponse",
"type": "Interface",
"label": "PutOutputResponse",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.PutOutputResponse.item",
"type": "CompoundType",
"label": "item",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/output.ts",
"lineNumber": 33
},
"signature": [
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.Output",
"text": "Output"
}
]
}
],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/output.ts",
"lineNumber": 32
},
"initialIsOpen": false
},
{
"id": "def-common.PutSettingsRequest",
"type": "Interface",
"label": "PutSettingsRequest",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.PutSettingsRequest.body",
"type": "Object",
"label": "body",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/settings.ts",
"lineNumber": 15
},
"signature": [
"Partial<Pick<",
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.Settings",
"text": "Settings"
},
", \"kibana_urls\" | \"kibana_ca_sha256\" | \"has_seen_add_data_notice\">>"
]
}
],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/settings.ts",
"lineNumber": 14
},
"initialIsOpen": false
},
{
"id": "def-common.PutSettingsResponse",
"type": "Interface",
"label": "PutSettingsResponse",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.PutSettingsResponse.item",
"type": "Object",
"label": "item",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/settings.ts",
"lineNumber": 19
},
"signature": [
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.Settings",
"text": "Settings"
}
]
}
],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/settings.ts",
"lineNumber": 18
},
"initialIsOpen": false
},
{
"id": "def-common.RegistryDataStream",
"type": "Interface",
"label": "RegistryDataStream",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.RegistryDataStream.[RegistryDataStreamKeys.type]",
"type": "string",
"label": "[RegistryDataStreamKeys.type]",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"lineNumber": 258
}
},
{
"tags": [],
"id": "def-common.RegistryDataStream.[RegistryDataStreamKeys.ilm_policy]",
"type": "string",
"label": "[RegistryDataStreamKeys.ilm_policy]",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"lineNumber": 259
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-common.RegistryDataStream.[RegistryDataStreamKeys.hidden]",
"type": "CompoundType",
"label": "[RegistryDataStreamKeys.hidden]",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"lineNumber": 260
},
"signature": [
"boolean | undefined"
]
},
{
"tags": [],
"id": "def-common.RegistryDataStream.[RegistryDataStreamKeys.dataset]",
"type": "string",
"label": "[RegistryDataStreamKeys.dataset]",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"lineNumber": 261
}
},
{
"tags": [],
"id": "def-common.RegistryDataStream.[RegistryDataStreamKeys.title]",
"type": "string",
"label": "[RegistryDataStreamKeys.title]",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"lineNumber": 262
}
},
{
"tags": [],
"id": "def-common.RegistryDataStream.[RegistryDataStreamKeys.release]",
"type": "string",
"label": "[RegistryDataStreamKeys.release]",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"lineNumber": 263
}
},
{
"tags": [],
"id": "def-common.RegistryDataStream.[RegistryDataStreamKeys.streams]",
"type": "Array",
"label": "[RegistryDataStreamKeys.streams]",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"lineNumber": 264
},
"signature": [
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.RegistryStream",
"text": "RegistryStream"
},
"[] | undefined"
]
},
{
"tags": [],
"id": "def-common.RegistryDataStream.[RegistryDataStreamKeys.package]",
"type": "string",
"label": "[RegistryDataStreamKeys.package]",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"lineNumber": 265
}
},
{
"tags": [],
"id": "def-common.RegistryDataStream.[RegistryDataStreamKeys.path]",
"type": "string",
"label": "[RegistryDataStreamKeys.path]",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"lineNumber": 266
}
},
{
"tags": [],
"id": "def-common.RegistryDataStream.[RegistryDataStreamKeys.ingest_pipeline]",
"type": "string",
"label": "[RegistryDataStreamKeys.ingest_pipeline]",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"lineNumber": 267
}
},
{
"tags": [],
"id": "def-common.RegistryDataStream.[RegistryDataStreamKeys.elasticsearch]",
"type": "Object",
"label": "[RegistryDataStreamKeys.elasticsearch]",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"lineNumber": 268
},
"signature": [
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.RegistryElasticsearch",
"text": "RegistryElasticsearch"
},
" | undefined"
]
},
{
"tags": [],
"id": "def-common.RegistryDataStream.[RegistryDataStreamKeys.dataset_is_prefix]",
"type": "CompoundType",
"label": "[RegistryDataStreamKeys.dataset_is_prefix]",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"lineNumber": 269
},
"signature": [
"boolean | undefined"
]
}
],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"lineNumber": 257
},
"initialIsOpen": false
},
{
"id": "def-common.RegistryElasticsearch",
"type": "Interface",
"label": "RegistryElasticsearch",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.RegistryElasticsearch.'index_template.settings'",
"type": "Uncategorized",
"label": "'index_template.settings'",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"lineNumber": 273
},
"signature": [
"object | undefined"
]
},
{
"tags": [],
"id": "def-common.RegistryElasticsearch.'index_template.mappings'",
"type": "Uncategorized",
"label": "'index_template.mappings'",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"lineNumber": 274
},
"signature": [
"object | undefined"
]
}
],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"lineNumber": 272
},
"initialIsOpen": false
},
{
"id": "def-common.RegistryImage",
"type": "Interface",
"label": "RegistryImage",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.RegistryImage.src",
"type": "string",
"label": "src",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"lineNumber": 113
}
},
{
"tags": [],
"id": "def-common.RegistryImage.path",
"type": "string",
"label": "path",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"lineNumber": 114
}
},
{
"tags": [],
"id": "def-common.RegistryImage.title",
"type": "string",
"label": "title",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"lineNumber": 115
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-common.RegistryImage.size",
"type": "string",
"label": "size",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"lineNumber": 116
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-common.RegistryImage.type",
"type": "string",
"label": "type",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"lineNumber": 117
},
"signature": [
"string | undefined"
]
}
],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"lineNumber": 112
},
"initialIsOpen": false
},
{
"id": "def-common.RegistryInput",
"type": "Interface",
"label": "RegistryInput",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.RegistryInput.[RegistryInputKeys.type]",
"type": "string",
"label": "[RegistryInputKeys.type]",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"lineNumber": 146
}
},
{
"tags": [],
"id": "def-common.RegistryInput.[RegistryInputKeys.title]",
"type": "string",
"label": "[RegistryInputKeys.title]",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"lineNumber": 147
}
},
{
"tags": [],
"id": "def-common.RegistryInput.[RegistryInputKeys.description]",
"type": "string",
"label": "[RegistryInputKeys.description]",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"lineNumber": 148
}
},
{
"tags": [],
"id": "def-common.RegistryInput.[RegistryInputKeys.template_path]",
"type": "string",
"label": "[RegistryInputKeys.template_path]",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"lineNumber": 149
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-common.RegistryInput.[RegistryInputKeys.condition]",
"type": "string",
"label": "[RegistryInputKeys.condition]",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"lineNumber": 150
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-common.RegistryInput.[RegistryInputKeys.vars]",
"type": "Array",
"label": "[RegistryInputKeys.vars]",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"lineNumber": 151
},
"signature": [
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.RegistryVarsEntry",
"text": "RegistryVarsEntry"
},
"[] | undefined"
]
}
],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"lineNumber": 145
},
"initialIsOpen": false
},
{
"id": "def-common.RegistryPolicyTemplate",
"type": "Interface",
"label": "RegistryPolicyTemplate",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.RegistryPolicyTemplate.[RegistryPolicyTemplateKeys.name]",
"type": "string",
"label": "[RegistryPolicyTemplateKeys.name]",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"lineNumber": 129
}
},
{
"tags": [],
"id": "def-common.RegistryPolicyTemplate.[RegistryPolicyTemplateKeys.title]",
"type": "string",
"label": "[RegistryPolicyTemplateKeys.title]",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"lineNumber": 130
}
},
{
"tags": [],
"id": "def-common.RegistryPolicyTemplate.[RegistryPolicyTemplateKeys.description]",
"type": "string",
"label": "[RegistryPolicyTemplateKeys.description]",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"lineNumber": 131
}
},
{
"tags": [],
"id": "def-common.RegistryPolicyTemplate.[RegistryPolicyTemplateKeys.inputs]",
"type": "Array",
"label": "[RegistryPolicyTemplateKeys.inputs]",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"lineNumber": 132
},
"signature": [
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.RegistryInput",
"text": "RegistryInput"
},
"[] | undefined"
]
},
{
"tags": [],
"id": "def-common.RegistryPolicyTemplate.[RegistryPolicyTemplateKeys.multiple]",
"type": "CompoundType",
"label": "[RegistryPolicyTemplateKeys.multiple]",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"lineNumber": 133
},
"signature": [
"boolean | undefined"
]
}
],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"lineNumber": 128
},
"initialIsOpen": false
},
{
"id": "def-common.RegistryStream",
"type": "Interface",
"label": "RegistryStream",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.RegistryStream.[RegistryStreamKeys.input]",
"type": "string",
"label": "[RegistryStreamKeys.input]",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"lineNumber": 164
}
},
{
"tags": [],
"id": "def-common.RegistryStream.[RegistryStreamKeys.title]",
"type": "string",
"label": "[RegistryStreamKeys.title]",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"lineNumber": 165
}
},
{
"tags": [],
"id": "def-common.RegistryStream.[RegistryStreamKeys.description]",
"type": "string",
"label": "[RegistryStreamKeys.description]",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"lineNumber": 166
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-common.RegistryStream.[RegistryStreamKeys.enabled]",
"type": "CompoundType",
"label": "[RegistryStreamKeys.enabled]",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"lineNumber": 167
},
"signature": [
"boolean | undefined"
]
},
{
"tags": [],
"id": "def-common.RegistryStream.[RegistryStreamKeys.vars]",
"type": "Array",
"label": "[RegistryStreamKeys.vars]",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"lineNumber": 168
},
"signature": [
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.RegistryVarsEntry",
"text": "RegistryVarsEntry"
},
"[] | undefined"
]
},
{
"tags": [],
"id": "def-common.RegistryStream.[RegistryStreamKeys.template_path]",
"type": "string",
"label": "[RegistryStreamKeys.template_path]",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"lineNumber": 169
}
}
],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"lineNumber": 163
},
"initialIsOpen": false
},
{
"id": "def-common.RegistryVarsEntry",
"type": "Interface",
"label": "RegistryVarsEntry",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.RegistryVarsEntry.[RegistryVarsEntryKeys.name]",
"type": "string",
"label": "[RegistryVarsEntryKeys.name]",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"lineNumber": 294
}
},
{
"tags": [],
"id": "def-common.RegistryVarsEntry.[RegistryVarsEntryKeys.title]",
"type": "string",
"label": "[RegistryVarsEntryKeys.title]",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"lineNumber": 295
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-common.RegistryVarsEntry.[RegistryVarsEntryKeys.description]",
"type": "string",
"label": "[RegistryVarsEntryKeys.description]",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"lineNumber": 296
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-common.RegistryVarsEntry.[RegistryVarsEntryKeys.type]",
"type": "CompoundType",
"label": "[RegistryVarsEntryKeys.type]",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"lineNumber": 297
},
"signature": [
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.RegistryVarType",
"text": "RegistryVarType"
}
]
},
{
"tags": [],
"id": "def-common.RegistryVarsEntry.[RegistryVarsEntryKeys.required]",
"type": "CompoundType",
"label": "[RegistryVarsEntryKeys.required]",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"lineNumber": 298
},
"signature": [
"boolean | undefined"
]
},
{
"tags": [],
"id": "def-common.RegistryVarsEntry.[RegistryVarsEntryKeys.show_user]",
"type": "CompoundType",
"label": "[RegistryVarsEntryKeys.show_user]",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"lineNumber": 299
},
"signature": [
"boolean | undefined"
]
},
{
"tags": [],
"id": "def-common.RegistryVarsEntry.[RegistryVarsEntryKeys.multi]",
"type": "CompoundType",
"label": "[RegistryVarsEntryKeys.multi]",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"lineNumber": 300
},
"signature": [
"boolean | undefined"
]
},
{
"tags": [],
"id": "def-common.RegistryVarsEntry.[RegistryVarsEntryKeys.default]",
"type": "CompoundType",
"label": "[RegistryVarsEntryKeys.default]",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"lineNumber": 301
},
"signature": [
"string | string[] | undefined"
]
},
{
"tags": [],
"id": "def-common.RegistryVarsEntry.[RegistryVarsEntryKeys.os]",
"type": "Object",
"label": "[RegistryVarsEntryKeys.os]",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"lineNumber": 302
},
"signature": [
"{ [key: string]: { default: string | string[]; }; } | undefined"
]
}
],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"lineNumber": 293
},
"initialIsOpen": false
},
{
"id": "def-common.ServiceRequirements",
"type": "Interface",
"label": "ServiceRequirements",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.ServiceRequirements.versions",
"type": "string",
"label": "versions",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"lineNumber": 175
}
}
],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"lineNumber": 174
},
"initialIsOpen": false
},
{
"id": "def-common.Settings",
"type": "Interface",
"label": "Settings",
"signature": [
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.Settings",
"text": "Settings"
},
" extends ",
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.BaseSettings",
"text": "BaseSettings"
}
],
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.Settings.id",
"type": "string",
"label": "id",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/settings.ts",
"lineNumber": 17
}
}
],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/settings.ts",
"lineNumber": 16
},
"initialIsOpen": false
},
{
"id": "def-common.SettingsSOAttributes",
"type": "Interface",
"label": "SettingsSOAttributes",
"signature": [
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.SettingsSOAttributes",
"text": "SettingsSOAttributes"
},
" extends ",
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.BaseSettings",
"text": "BaseSettings"
},
",",
"SavedObjectAttributes"
],
"description": [],
"tags": [],
"children": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/settings.ts",
"lineNumber": 20
},
"initialIsOpen": false
},
{
"id": "def-common.TemplateRef",
"type": "Interface",
"label": "TemplateRef",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.TemplateRef.templateName",
"type": "string",
"label": "templateName",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"lineNumber": 395
}
},
{
"tags": [],
"id": "def-common.TemplateRef.indexTemplate",
"type": "Object",
"label": "indexTemplate",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"lineNumber": 396
},
"signature": [
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.IndexTemplate",
"text": "IndexTemplate"
}
]
}
],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"lineNumber": 394
},
"initialIsOpen": false
},
{
"id": "def-common.UpdateAgentPolicyResponse",
"type": "Interface",
"label": "UpdateAgentPolicyResponse",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.UpdateAgentPolicyResponse.item",
"type": "Object",
"label": "item",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts",
"lineNumber": 50
},
"signature": [
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.AgentPolicy",
"text": "AgentPolicy"
}
]
}
],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts",
"lineNumber": 49
},
"initialIsOpen": false
},
{
"id": "def-common.UpdateAgentRequest",
"type": "Interface",
"label": "UpdateAgentRequest",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.UpdateAgentRequest.params",
"type": "Object",
"label": "params",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts",
"lineNumber": 206
},
"signature": [
"{ agentId: string; }"
]
},
{
"tags": [],
"id": "def-common.UpdateAgentRequest.body",
"type": "Object",
"label": "body",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts",
"lineNumber": 209
},
"signature": [
"{ user_provided_metadata: Record<string, any>; }"
]
}
],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts",
"lineNumber": 205
},
"initialIsOpen": false
},
{
"id": "def-common.UpdatePackagePolicy",
"type": "Interface",
"label": "UpdatePackagePolicy",
"signature": [
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.UpdatePackagePolicy",
"text": "UpdatePackagePolicy"
},
" extends ",
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.NewPackagePolicy",
"text": "NewPackagePolicy"
}
],
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.UpdatePackagePolicy.version",
"type": "string",
"label": "version",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/package_policy.ts",
"lineNumber": 61
},
"signature": [
"string | undefined"
]
}
],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/package_policy.ts",
"lineNumber": 60
},
"initialIsOpen": false
}
],
"enums": [
{
"id": "def-common.ElasticsearchAssetType",
"type": "Enum",
"label": "ElasticsearchAssetType",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"lineNumber": 67
},
"initialIsOpen": false
},
{
"id": "def-common.InstallStatus",
"type": "Enum",
"label": "InstallStatus",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"lineNumber": 26
},
"initialIsOpen": false
},
{
"id": "def-common.KibanaAssetType",
"type": "Enum",
"label": "KibanaAssetType",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"lineNumber": 46
},
"initialIsOpen": false
},
{
"id": "def-common.KibanaSavedObjectType",
"type": "Enum",
"label": "KibanaSavedObjectType",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"lineNumber": 58
},
"initialIsOpen": false
},
{
"id": "def-common.RegistryDataStreamKeys",
"type": "Enum",
"label": "RegistryDataStreamKeys",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"lineNumber": 242
},
"initialIsOpen": false
},
{
"id": "def-common.RegistryInputKeys",
"type": "Enum",
"label": "RegistryInputKeys",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"lineNumber": 136
},
"initialIsOpen": false
},
{
"id": "def-common.RegistryPolicyTemplateKeys",
"type": "Enum",
"label": "RegistryPolicyTemplateKeys",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"lineNumber": 120
},
"initialIsOpen": false
},
{
"id": "def-common.RegistryStreamKeys",
"type": "Enum",
"label": "RegistryStreamKeys",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"lineNumber": 154
},
"initialIsOpen": false
},
{
"id": "def-common.RegistryVarsEntryKeys",
"type": "Enum",
"label": "RegistryVarsEntryKeys",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"lineNumber": 278
},
"initialIsOpen": false
}
],
"misc": [
{
"tags": [],
"id": "def-common.AGENT_ACTION_SAVED_OBJECT_TYPE",
"type": "string",
"label": "AGENT_ACTION_SAVED_OBJECT_TYPE",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/constants/agent.ts",
"lineNumber": 12
},
"signature": [
"\"fleet-agent-actions\""
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-common.AGENT_ACTIONS_INDEX",
"type": "string",
"label": "AGENT_ACTIONS_INDEX",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/constants/agent.ts",
"lineNumber": 30
},
"signature": [
"\".fleet-actions\""
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-common.AGENT_EVENT_SAVED_OBJECT_TYPE",
"type": "string",
"label": "AGENT_EVENT_SAVED_OBJECT_TYPE",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/constants/agent.ts",
"lineNumber": 11
},
"signature": [
"\"fleet-agent-events\""
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-common.AGENT_POLICY_API_ROOT",
"type": "string",
"label": "AGENT_POLICY_API_ROOT",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
"lineNumber": 14
},
"initialIsOpen": false
},
{
"tags": [],
"id": "def-common.AGENT_POLICY_INDEX",
"type": "string",
"label": "AGENT_POLICY_INDEX",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/constants/agent_policy.ts",
"lineNumber": 13
},
"signature": [
"\".fleet-policies\""
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-common.AGENT_POLICY_ROLLOUT_RATE_LIMIT_INTERVAL_MS",
"type": "number",
"label": "AGENT_POLICY_ROLLOUT_RATE_LIMIT_INTERVAL_MS",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/constants/agent.ts",
"lineNumber": 26
},
"signature": [
"1000"
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-common.AGENT_POLICY_ROLLOUT_RATE_LIMIT_REQUEST_PER_INTERVAL",
"type": "number",
"label": "AGENT_POLICY_ROLLOUT_RATE_LIMIT_REQUEST_PER_INTERVAL",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/constants/agent.ts",
"lineNumber": 27
},
"signature": [
"5"
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-common.AGENT_POLICY_SAVED_OBJECT_TYPE",
"type": "string",
"label": "AGENT_POLICY_SAVED_OBJECT_TYPE",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/constants/agent_policy.ts",
"lineNumber": 12
},
"signature": [
"\"ingest-agent-policies\""
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-common.AGENT_POLLING_INTERVAL",
"type": "number",
"label": "AGENT_POLLING_INTERVAL",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/constants/agent.ts",
"lineNumber": 22
},
"signature": [
"1000"
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-common.AGENT_POLLING_REQUEST_TIMEOUT_MARGIN_MS",
"type": "number",
"label": "AGENT_POLLING_REQUEST_TIMEOUT_MARGIN_MS",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/constants/agent.ts",
"lineNumber": 19
},
"signature": [
"20000"
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-common.AGENT_POLLING_REQUEST_TIMEOUT_MS",
"type": "number",
"label": "AGENT_POLLING_REQUEST_TIMEOUT_MS",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/constants/agent.ts",
"lineNumber": 18
},
"signature": [
"300000"
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-common.AGENT_POLLING_THRESHOLD_MS",
"type": "number",
"label": "AGENT_POLLING_THRESHOLD_MS",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/constants/agent.ts",
"lineNumber": 21
},
"signature": [
"30000"
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-common.AGENT_SAVED_OBJECT_TYPE",
"type": "string",
"label": "AGENT_SAVED_OBJECT_TYPE",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/constants/agent.ts",
"lineNumber": 8
},
"signature": [
"\"fleet-agents\""
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-common.AGENT_TYPE_EPHEMERAL",
"type": "string",
"label": "AGENT_TYPE_EPHEMERAL",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/constants/agent.ts",
"lineNumber": 15
},
"signature": [
"\"EPHEMERAL\""
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-common.AGENT_TYPE_PERMANENT",
"type": "string",
"label": "AGENT_TYPE_PERMANENT",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/constants/agent.ts",
"lineNumber": 14
},
"signature": [
"\"PERMANENT\""
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-common.AGENT_TYPE_TEMPORARY",
"type": "string",
"label": "AGENT_TYPE_TEMPORARY",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/constants/agent.ts",
"lineNumber": 16
},
"signature": [
"\"TEMPORARY\""
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-common.AGENT_UPDATE_ACTIONS_INTERVAL_MS",
"type": "number",
"label": "AGENT_UPDATE_ACTIONS_INTERVAL_MS",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/constants/agent.ts",
"lineNumber": 24
},
"signature": [
"5000"
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-common.AGENT_UPDATE_LAST_CHECKIN_INTERVAL_MS",
"type": "number",
"label": "AGENT_UPDATE_LAST_CHECKIN_INTERVAL_MS",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/constants/agent.ts",
"lineNumber": 23
},
"signature": [
"30000"
],
"initialIsOpen": false
},
{
"id": "def-common.AgentActionSOAttributes",
"type": "Type",
"label": "AgentActionSOAttributes",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
"lineNumber": 87
},
"signature": [
"CommonAgentActionSOAttributes & { agent_id: string; }"
],
"initialIsOpen": false
},
{
"id": "def-common.AgentActionType",
"type": "Type",
"label": "AgentActionType",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
"lineNumber": 34
},
"signature": [
"\"POLICY_CHANGE\" | \"UNENROLL\" | \"UPGRADE\" | \"SETTINGS\" | \"POLICY_REASSIGN\""
],
"initialIsOpen": false
},
{
"id": "def-common.AgentAssetType",
"type": "Type",
"label": "AgentAssetType",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"lineNumber": 40
},
"signature": [
"{ readonly Input: \"input\"; }"
],
"initialIsOpen": false
},
{
"id": "def-common.AgentEventSOAttributes",
"type": "Type",
"label": "AgentEventSOAttributes",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
"lineNumber": 126
},
"signature": [
"NewAgentEvent"
],
"initialIsOpen": false
},
{
"id": "def-common.AgentPolicyActionSOAttributes",
"type": "Type",
"label": "AgentPolicyActionSOAttributes",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
"lineNumber": 90
},
"signature": [
"CommonAgentActionSOAttributes & { policy_id: string; policy_revision: number; }"
],
"initialIsOpen": false
},
{
"id": "def-common.AgentPolicyActionV7_9",
"type": "Type",
"label": "AgentPolicyActionV7_9",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
"lineNumber": 71
},
"signature": [
"Pick<AgentPolicyAction, \"id\" | \"policy_id\" | \"policy_revision\" | \"created_at\" | \"ack_data\" | \"sent_at\"> & { type: 'CONFIG_CHANGE'; data: { config: FullAgentPolicy;}; }"
],
"initialIsOpen": false
},
{
"id": "def-common.AgentPolicySOAttributes",
"type": "Type",
"label": "AgentPolicySOAttributes",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts",
"lineNumber": 36
},
"signature": [
"{ status: ValueOf<{ readonly Active: \"active\"; readonly Inactive: \"inactive\"; }>; description?: string | undefined; name: string; updated_at: string; namespace: string; is_default?: boolean | undefined; updated_by: string; revision: number; package_policies: string[] | PackagePolicy[]; is_managed: boolean; is_default_fleet_server?: boolean | undefined; monitoring_enabled?: (\"metrics\" | \"logs\")[] | undefined; }"
],
"initialIsOpen": false
},
{
"id": "def-common.AgentPolicyStatus",
"type": "Type",
"label": "AgentPolicyStatus",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts",
"lineNumber": 14
},
"signature": [
"{ readonly Active: \"active\"; readonly Inactive: \"inactive\"; }"
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-common.AGENTS_INDEX",
"type": "string",
"label": "AGENTS_INDEX",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/constants/agent.ts",
"lineNumber": 29
},
"signature": [
"\".fleet-agents\""
],
"initialIsOpen": false
},
{
"id": "def-common.AgentStatus",
"type": "Type",
"label": "AgentStatus",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
"lineNumber": 21
},
"signature": [
"\"warning\" | \"offline\" | \"online\" | \"error\" | \"inactive\" | \"enrolling\" | \"unenrolling\" | \"updating\" | \"degraded\""
],
"initialIsOpen": false
},
{
"id": "def-common.AgentType",
"type": "Type",
"label": "AgentType",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
"lineNumber": 16
},
"signature": [
"\"PERMANENT\" | \"EPHEMERAL\" | \"TEMPORARY\""
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-common.API_ROOT",
"type": "string",
"label": "API_ROOT",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
"lineNumber": 10
},
"signature": [
"\"/api/fleet\""
],
"initialIsOpen": false
},
{
"id": "def-common.ArchivePackage",
"type": "Type",
"label": "ArchivePackage",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"lineNumber": 80
},
"signature": [
"PackageSpecManifest & Pick<RegistryPackage, \"data_streams\" | \"assets\" | \"readme\" | \"internal\">"
],
"initialIsOpen": false
},
{
"id": "def-common.AssetReference",
"type": "Type",
"label": "AssetReference",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"lineNumber": 358
},
"signature": [
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.EsAssetReference",
"text": "EsAssetReference"
},
" | ",
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.KibanaAssetReference",
"text": "KibanaAssetReference"
}
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-common.ASSETS_SAVED_OBJECT_TYPE",
"type": "string",
"label": "ASSETS_SAVED_OBJECT_TYPE",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/constants/epm.ts",
"lineNumber": 9
},
"signature": [
"\"epm-packages-assets\""
],
"initialIsOpen": false
},
{
"id": "def-common.AssetsGroupedByServiceByType",
"type": "Type",
"label": "AssetsGroupedByServiceByType",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"lineNumber": 220
},
"signature": [
"Record<\"kibana\", Record<KibanaAssetType, KibanaAssetParts[]>> & Record<\"elasticsearch\", Record<ElasticsearchAssetType, ElasticsearchAssetParts[]>>"
],
"initialIsOpen": false
},
{
"id": "def-common.AssetType",
"type": "Type",
"label": "AssetType",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"lineNumber": 41
},
"signature": [
"\"input\" | ",
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.KibanaAssetType",
"text": "KibanaAssetType"
},
".dashboard | ",
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.KibanaAssetType",
"text": "KibanaAssetType"
},
".visualization | ",
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.KibanaAssetType",
"text": "KibanaAssetType"
},
".search | ",
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.KibanaAssetType",
"text": "KibanaAssetType"
},
".indexPattern | ",
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.KibanaAssetType",
"text": "KibanaAssetType"
}
],
"initialIsOpen": false
},
{
"id": "def-common.AssetTypeToParts",
"type": "Type",
"label": "AssetTypeToParts",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"lineNumber": 219
},
"signature": [
"Record<KibanaAssetType, KibanaAssetParts[]> & Record<ElasticsearchAssetType, ElasticsearchAssetParts[]>"
],
"initialIsOpen": false
},
{
"id": "def-common.BaseAgentActionSOAttributes",
"type": "Type",
"label": "BaseAgentActionSOAttributes",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
"lineNumber": 94
},
"signature": [
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.AgentActionSOAttributes",
"text": "AgentActionSOAttributes"
},
" | ",
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.AgentPolicyActionSOAttributes",
"text": "AgentPolicyActionSOAttributes"
}
],
"initialIsOpen": false
},
{
"id": "def-common.CategoryId",
"type": "Type",
"label": "CategoryId",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"lineNumber": 204
},
"signature": [
"string"
],
"initialIsOpen": false
},
{
"id": "def-common.CategorySummaryList",
"type": "Type",
"label": "CategorySummaryList",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"lineNumber": 203
},
"signature": [
"CategorySummaryItem[]"
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-common.DATA_STREAM_API_ROOT",
"type": "string",
"label": "DATA_STREAM_API_ROOT",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
"lineNumber": 12
},
"initialIsOpen": false
},
{
"id": "def-common.DataType",
"type": "Type",
"label": "DataType",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"lineNumber": 76
},
"signature": [
"{ readonly Logs: \"logs\"; readonly Metrics: \"metrics\"; }"
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-common.DEFAULT_AGENT_POLICIES_PACKAGES",
"type": "Array",
"label": "DEFAULT_AGENT_POLICIES_PACKAGES",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/constants/agent_policy.ts",
"lineNumber": 48
},
"signature": [
"\"system\"[]"
],
"initialIsOpen": false
},
{
"id": "def-common.DefaultPackages",
"type": "Type",
"label": "DefaultPackages",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"lineNumber": 373
},
"signature": [
"{ readonly System: \"system\"; readonly Endpoint: \"endpoint\"; readonly ElasticAgent: \"elastic_agent\"; }"
],
"initialIsOpen": false
},
{
"id": "def-common.DeletePackagePoliciesResponse",
"type": "Type",
"label": "DeletePackagePoliciesResponse",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts",
"lineNumber": 55
},
"signature": [
"{ id: string; name?: string | undefined; success: boolean; }[]"
],
"initialIsOpen": false
},
{
"id": "def-common.DetailViewPanelName",
"type": "Type",
"label": "DetailViewPanelName",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"lineNumber": 38
},
"signature": [
"\"custom\" | \"overview\" | \"policies\" | \"settings\""
],
"initialIsOpen": false
},
{
"id": "def-common.ElasticsearchAssetParts",
"type": "Type",
"label": "ElasticsearchAssetParts",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"lineNumber": 231
},
"signature": [
"AssetParts & { service: Extract<ServiceName, 'elasticsearch'>; type: ElasticsearchAssetType; }"
],
"initialIsOpen": false
},
{
"id": "def-common.ElasticsearchAssetTypeToParts",
"type": "Type",
"label": "ElasticsearchAssetTypeToParts",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"lineNumber": 237
},
"signature": [
"{ component_template: ElasticsearchAssetParts[]; ingest_pipeline: ElasticsearchAssetParts[]; index_template: ElasticsearchAssetParts[]; ilm_policy: ElasticsearchAssetParts[]; transform: ElasticsearchAssetParts[]; data_stream_ilm_policy: ElasticsearchAssetParts[]; }"
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-common.ENROLLMENT_API_KEYS_INDEX",
"type": "string",
"label": "ENROLLMENT_API_KEYS_INDEX",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/constants/enrollment_api_key.ts",
"lineNumber": 10
},
"signature": [
"\".fleet-enrollment-api-keys\""
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-common.ENROLLMENT_API_KEYS_SAVED_OBJECT_TYPE",
"type": "string",
"label": "ENROLLMENT_API_KEYS_SAVED_OBJECT_TYPE",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/constants/enrollment_api_key.ts",
"lineNumber": 8
},
"signature": [
"\"fleet-enrollment-api-keys\""
],
"initialIsOpen": false
},
{
"id": "def-common.EnrollmentAPIKeySOAttributes",
"type": "Type",
"label": "EnrollmentAPIKeySOAttributes",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/enrollment_api_key.ts",
"lineNumber": 18
},
"signature": [
"{ name?: string | undefined; active: boolean; policy_id?: string | undefined; created_at: string; api_key: string; api_key_id: string; }"
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-common.EPM_API_ROOT",
"type": "string",
"label": "EPM_API_ROOT",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
"lineNumber": 11
},
"initialIsOpen": false
},
{
"id": "def-common.EpmPackageInstallStatus",
"type": "Type",
"label": "EpmPackageInstallStatus",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"lineNumber": 36
},
"signature": [
"\"installed\" | \"installing\""
],
"initialIsOpen": false
},
{
"id": "def-common.EsAssetReference",
"type": "Type",
"label": "EsAssetReference",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"lineNumber": 363
},
"signature": [
"Pick<SavedObjectReference, \"id\"> & { type: ElasticsearchAssetType; }"
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-common.FLEET_API_ROOT_7_9",
"type": "string",
"label": "FLEET_API_ROOT_7_9",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
"lineNumber": 15
},
"signature": [
"\"/api/ingest_manager/fleet\""
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-common.FLEET_SERVER_ARTIFACTS_INDEX",
"type": "string",
"label": "FLEET_SERVER_ARTIFACTS_INDEX",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/constants/index.ts",
"lineNumber": 27
},
"signature": [
"\".fleet-artifacts\""
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-common.FLEET_SERVER_INDICES",
"type": "Array",
"label": "FLEET_SERVER_INDICES",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/constants/index.ts",
"lineNumber": 29
},
"signature": [
"string[]"
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-common.FLEET_SERVER_INDICES_VERSION",
"type": "number",
"label": "FLEET_SERVER_INDICES_VERSION",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/constants/index.ts",
"lineNumber": 25
},
"signature": [
"1"
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-common.FLEET_SERVER_PACKAGE",
"type": "string",
"label": "FLEET_SERVER_PACKAGE",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/constants/epm.ts",
"lineNumber": 12
},
"signature": [
"\"fleet_server\""
],
"initialIsOpen": false
},
{
"id": "def-common.GetAgentPoliciesResponseItem",
"type": "Type",
"label": "GetAgentPoliciesResponseItem",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts",
"lineNumber": 18
},
"signature": [
"AgentPolicy & { agents?: number | undefined; }"
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-common.GLOBAL_SETTINGS_SAVED_OBJECT_TYPE",
"type": "string",
"label": "GLOBAL_SETTINGS_SAVED_OBJECT_TYPE",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/constants/settings.ts",
"lineNumber": 8
},
"signature": [
"\"ingest_manager_settings\""
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-common.INSTALL_SCRIPT_API_ROUTES",
"type": "string",
"label": "INSTALL_SCRIPT_API_ROUTES",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
"lineNumber": 121
},
"initialIsOpen": false
},
{
"id": "def-common.Installable",
"type": "Type",
"label": "Installable",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"lineNumber": 347
},
"signature": [
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.Installed",
"text": "Installed"
},
"<T> | ",
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.NotInstalled",
"text": "NotInstalled"
},
"<T>"
],
"initialIsOpen": false
},
{
"id": "def-common.InstallablePackage",
"type": "Type",
"label": "InstallablePackage",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"lineNumber": 78
},
"signature": [
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.RegistryPackage",
"text": "RegistryPackage"
},
" | ",
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.ArchivePackage",
"text": "ArchivePackage"
}
],
"initialIsOpen": false
},
{
"id": "def-common.InstallationStatus",
"type": "Type",
"label": "InstallationStatus",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"lineNumber": 24
},
"signature": [
"{ readonly Installed: \"installed\"; readonly NotInstalled: \"not_installed\"; }"
],
"initialIsOpen": false
},
{
"id": "def-common.Installed",
"type": "Type",
"label": "Installed",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"lineNumber": 349
},
"signature": [
"T & { status: InstallationStatus['Installed']; savedObject: SavedObject<Installation>; }"
],
"initialIsOpen": false
},
{
"id": "def-common.InstallSource",
"type": "Type",
"label": "InstallSource",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"lineNumber": 34
},
"signature": [
"\"registry\" | \"upload\""
],
"initialIsOpen": false
},
{
"id": "def-common.InstallType",
"type": "Type",
"label": "InstallType",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"lineNumber": 33
},
"signature": [
"\"update\" | \"reinstall\" | \"reupdate\" | \"rollback\" | \"install\""
],
"initialIsOpen": false
},
{
"id": "def-common.KibanaAssetParts",
"type": "Type",
"label": "KibanaAssetParts",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"lineNumber": 226
},
"signature": [
"AssetParts & { service: Extract<ServiceName, 'kibana'>; type: KibanaAssetType; }"
],
"initialIsOpen": false
},
{
"id": "def-common.KibanaAssetReference",
"type": "Type",
"label": "KibanaAssetReference",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"lineNumber": 360
},
"signature": [
"Pick<SavedObjectReference, \"id\"> & { type: KibanaSavedObjectType; }"
],
"initialIsOpen": false
},
{
"id": "def-common.KibanaAssetTypeToParts",
"type": "Type",
"label": "KibanaAssetTypeToParts",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"lineNumber": 236
},
"signature": [
"{ dashboard: KibanaAssetParts[]; visualization: KibanaAssetParts[]; search: KibanaAssetParts[]; index_pattern: KibanaAssetParts[]; map: KibanaAssetParts[]; lens: KibanaAssetParts[]; }"
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-common.LIMITED_CONCURRENCY_ROUTE_TAG",
"type": "string",
"label": "LIMITED_CONCURRENCY_ROUTE_TAG",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
"lineNumber": 17
},
"signature": [
"\"ingest:limited-concurrency\""
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-common.MAX_TIME_COMPLETE_INSTALL",
"type": "number",
"label": "MAX_TIME_COMPLETE_INSTALL",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/constants/epm.ts",
"lineNumber": 10
},
"signature": [
"60000"
],
"initialIsOpen": false
},
{
"id": "def-common.NotInstalled",
"type": "Type",
"label": "NotInstalled",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"lineNumber": 354
},
"signature": [
"T & { status: InstallationStatus['NotInstalled']; }"
],
"initialIsOpen": false
},
{
"id": "def-common.Output",
"type": "Type",
"label": "Output",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/output.ts",
"lineNumber": 28
},
"signature": [
"NewOutput & { id: string; }"
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-common.OUTPUT_SAVED_OBJECT_TYPE",
"type": "string",
"label": "OUTPUT_SAVED_OBJECT_TYPE",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/constants/output.ts",
"lineNumber": 10
},
"signature": [
"\"ingest-outputs\""
],
"initialIsOpen": false
},
{
"id": "def-common.OutputSOAttributes",
"type": "Type",
"label": "OutputSOAttributes",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/output.ts",
"lineNumber": 26
},
"signature": [
"NewOutput"
],
"initialIsOpen": false
},
{
"id": "def-common.OutputType",
"type": "Type",
"label": "OutputType",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/output.ts",
"lineNumber": 11
},
"signature": [
"{ readonly Elasticsearch: \"elasticsearch\"; }"
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-common.PACKAGE_POLICY_API_ROOT",
"type": "string",
"label": "PACKAGE_POLICY_API_ROOT",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
"lineNumber": 13
},
"initialIsOpen": false
},
{
"tags": [],
"id": "def-common.PACKAGE_POLICY_SAVED_OBJECT_TYPE",
"type": "string",
"label": "PACKAGE_POLICY_SAVED_OBJECT_TYPE",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/constants/package_policy.ts",
"lineNumber": 8
},
"signature": [
"\"ingest-package-policies\""
],
"initialIsOpen": false
},
{
"id": "def-common.PackageAssetReference",
"type": "Type",
"label": "PackageAssetReference",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"lineNumber": 367
},
"signature": [
"Pick<SavedObjectReference, \"id\"> & { type: typeof ASSETS_SAVED_OBJECT_TYPE; }"
],
"initialIsOpen": false
},
{
"id": "def-common.PackageInfo",
"type": "Type",
"label": "PackageInfo",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"lineNumber": 326
},
"signature": [
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.Installed",
"text": "Installed"
},
"<Merge<",
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.RegistryPackage",
"text": "RegistryPackage"
},
", ",
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.EpmPackageAdditions",
"text": "EpmPackageAdditions"
},
">> | ",
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.NotInstalled",
"text": "NotInstalled"
},
"<Merge<",
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.RegistryPackage",
"text": "RegistryPackage"
}
],
"initialIsOpen": false
},
{
"id": "def-common.PackageList",
"type": "Type",
"label": "PackageList",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"lineNumber": 322
},
"signature": [
"Installable<Pick<RegistryPackage, \"type\" | \"description\" | \"title\" | \"name\" | \"version\" | \"path\" | \"download\" | \"data_streams\" | \"release\" | \"icons\" | \"policy_templates\" | \"internal\">>[]"
],
"initialIsOpen": false
},
{
"id": "def-common.PackageListItem",
"type": "Type",
"label": "PackageListItem",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"lineNumber": 324
},
"signature": [
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.Installed",
"text": "Installed"
},
"<Pick<",
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.RegistryPackage",
"text": "RegistryPackage"
},
", \"type\" | \"description\" | \"title\" | \"name\" | \"version\" | \"path\" | \"download\" | \"data_streams\" | \"release\" | \"icons\" | \"policy_templates\" | \"internal\">> | ",
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.NotInstalled",
"text": "NotInstalled"
},
"<Pick<",
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.RegistryPackage",
"text": "RegistryPackage"
},
", \"type\" | \"description\" | \"title\" | \"name\" | \"version\" | \"path\" | \"download\" | \"data_streams\" | \"release\" | \"icons\" | \"policy_templates\" | \"internal\">>"
],
"initialIsOpen": false
},
{
"id": "def-common.PackagePolicyConfigRecord",
"type": "Type",
"label": "PackagePolicyConfigRecord",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/package_policy.ts",
"lineNumber": 19
},
"signature": [
"{ [x: string]: PackagePolicyConfigRecordEntry; }"
],
"initialIsOpen": false
},
{
"id": "def-common.PackagePolicySOAttributes",
"type": "Type",
"label": "PackagePolicySOAttributes",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/package_policy.ts",
"lineNumber": 75
},
"signature": [
"{ enabled: boolean; description?: string | undefined; name: string; package?: PackagePolicyPackage | undefined; updated_at: string; namespace: string; inputs: PackagePolicyInput[]; policy_id: string; output_id: string; updated_by: string; revision: number; created_at: string; created_by: string; }"
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-common.PACKAGES_SAVED_OBJECT_TYPE",
"type": "string",
"label": "PACKAGES_SAVED_OBJECT_TYPE",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/constants/epm.ts",
"lineNumber": 8
},
"signature": [
"\"epm-packages\""
],
"initialIsOpen": false
},
{
"id": "def-common.PackagesGroupedByStatus",
"type": "Type",
"label": "PackagesGroupedByStatus",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"lineNumber": 325
},
"signature": [
"{ installed: PackageList; not_installed: PackageList; }"
],
"initialIsOpen": false
},
{
"id": "def-common.PackageSpecCategory",
"type": "Type",
"label": "PackageSpecCategory",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/package_spec.ts",
"lineNumber": 28
},
"signature": [
"\"custom\" | \"security\" | \"monitoring\" | \"aws\" | \"azure\" | \"cloud\" | \"config_management\" | \"containers\" | \"crm\" | \"datastore\" | \"elastic_stack\" | \"google_cloud\" | \"kubernetes\" | \"languages\" | \"message_queue\" | \"network\" | \"notification\" | \"os_system\" | \"productivity\" | \"support\" | \"ticketing\" | \"version_control\" | \"web\""
],
"initialIsOpen": false
},
{
"id": "def-common.PackageSpecConditions",
"type": "Type",
"label": "PackageSpecConditions",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/package_spec.ts",
"lineNumber": 53
},
"signature": [
"{ kibana: { version: string; }; }"
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-common.PLUGIN_ID",
"type": "string",
"label": "PLUGIN_ID",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/constants/plugin.ts",
"lineNumber": 8
},
"signature": [
"\"fleet\""
],
"initialIsOpen": false
},
{
"id": "def-common.PostBulkAgentReassignResponse",
"type": "Type",
"label": "PostBulkAgentReassignResponse",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts",
"lineNumber": 173
},
"signature": [
"{ [x: string]: { success: boolean; error?: string | undefined; }; }"
],
"initialIsOpen": false
},
{
"id": "def-common.PostBulkAgentUpgradeResponse",
"type": "Type",
"label": "PostBulkAgentUpgradeResponse",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts",
"lineNumber": 145
},
"signature": [
"{ [x: string]: { success: boolean; error?: string | undefined; }; }"
],
"initialIsOpen": false
},
{
"id": "def-common.RegistryPackage",
"type": "Type",
"label": "RegistryPackage",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"lineNumber": 84
},
"signature": [
"PackageSpecManifest & Partial<Pick<PackageSpecManifest, \"title\" | \"release\">> & RegistryAdditionalProperties & RegistryOverridePropertyValue"
],
"initialIsOpen": false
},
{
"id": "def-common.RegistryRelease",
"type": "Type",
"label": "RegistryRelease",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"lineNumber": 111
},
"signature": [
"\"experimental\" | \"beta\" | \"ga\""
],
"initialIsOpen": false
},
{
"id": "def-common.RegistrySearchResult",
"type": "Type",
"label": "RegistrySearchResult",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"lineNumber": 183
},
"signature": [
"{ type?: \"integration\" | undefined; description: string; title: string; name: string; version: string; path: string; download: string; data_streams?: RegistryDataStream[] | undefined; release: \"experimental\" | \"beta\" | \"ga\"; icons?: (",
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.PackageSpecIcon",
"text": "PackageSpecIcon"
},
"[] & RegistryImage[]) | undefined; policy_templates?: RegistryPolicyTemplate[] | undefined; internal?: boolean | undefined; }"
],
"initialIsOpen": false
},
{
"id": "def-common.RegistrySearchResults",
"type": "Type",
"label": "RegistrySearchResults",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"lineNumber": 181
},
"signature": [
"Pick<RegistryPackage, \"type\" | \"description\" | \"title\" | \"name\" | \"version\" | \"path\" | \"download\" | \"data_streams\" | \"release\" | \"icons\" | \"policy_templates\" | \"internal\">[]"
],
"initialIsOpen": false
},
{
"id": "def-common.RegistryVarType",
"type": "Type",
"label": "RegistryVarType",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"lineNumber": 277
},
"signature": [
"\"string\" | \"text\" | \"password\" | \"integer\" | \"bool\" | \"yaml\""
],
"initialIsOpen": false
},
{
"id": "def-common.RequiredPackage",
"type": "Type",
"label": "RequiredPackage",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"lineNumber": 371
},
"signature": [
"{ readonly System: \"system\"; readonly Endpoint: \"endpoint\"; readonly ElasticAgent: \"elastic_agent\"; }"
],
"initialIsOpen": false
},
{
"id": "def-common.RequirementsByServiceName",
"type": "Type",
"label": "RequirementsByServiceName",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"lineNumber": 211
},
"signature": [
"undefined | Record<\"kibana\", { version: string; }>"
],
"initialIsOpen": false
},
{
"id": "def-common.RequirementVersion",
"type": "Type",
"label": "RequirementVersion",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"lineNumber": 172
},
"signature": [
"string"
],
"initialIsOpen": false
},
{
"id": "def-common.RequirementVersionRange",
"type": "Type",
"label": "RequirementVersionRange",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"lineNumber": 173
},
"signature": [
"string"
],
"initialIsOpen": false
},
{
"id": "def-common.ScreenshotItem",
"type": "Type",
"label": "ScreenshotItem",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"lineNumber": 199
},
"signature": [
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.RegistryImage",
"text": "RegistryImage"
},
" | ",
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.PackageSpecScreenshot",
"text": "PackageSpecScreenshot"
}
],
"initialIsOpen": false
},
{
"id": "def-common.ServiceName",
"type": "Type",
"label": "ServiceName",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"lineNumber": 39
},
"signature": [
"\"kibana\" | \"elasticsearch\""
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-common.SETUP_API_ROUTE",
"type": "string",
"label": "SETUP_API_ROUTE",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
"lineNumber": 119
},
"initialIsOpen": false
},
{
"id": "def-common.SimplifiedAgentStatus",
"type": "Type",
"label": "SimplifiedAgentStatus",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
"lineNumber": 32
},
"signature": [
"\"offline\" | \"inactive\" | \"updating\" | \"healthy\" | \"unhealthy\""
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-common.SO_SEARCH_LIMIT",
"type": "number",
"label": "SO_SEARCH_LIMIT",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/constants/index.ts",
"lineNumber": 23
},
"signature": [
"10000"
],
"initialIsOpen": false
},
{
"id": "def-common.UpdateAgentPolicyRequest",
"type": "Type",
"label": "UpdateAgentPolicyRequest",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts",
"lineNumber": 45
},
"signature": [
"GetOneAgentPolicyRequest & { body: NewAgentPolicy; }"
],
"initialIsOpen": false
},
{
"id": "def-common.UpdatePackagePolicyRequest",
"type": "Type",
"label": "UpdatePackagePolicyRequest",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts",
"lineNumber": 43
},
"signature": [
"GetOnePackagePolicyRequest & { body: UpdatePackagePolicy; }"
],
"initialIsOpen": false
},
{
"id": "def-common.UpdatePackagePolicyResponse",
"type": "Type",
"label": "UpdatePackagePolicyResponse",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts",
"lineNumber": 47
},
"signature": [
"CreatePackagePolicyResponse"
],
"initialIsOpen": false
},
{
"id": "def-common.ValueOf",
"type": "Type",
"label": "ValueOf",
"tags": [],
"description": [
"\nCreates a Union Type for all the values of an object"
],
"source": {
"path": "x-pack/plugins/fleet/common/types/index.ts",
"lineNumber": 44
},
"signature": [
"T[keyof T]"
],
"initialIsOpen": false
}
],
"objects": [
{
"id": "def-common.AGENT_API_ROUTES",
"type": "Object",
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.AGENT_API_ROUTES.LIST_PATTERN",
"type": "string",
"label": "LIST_PATTERN",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
"lineNumber": 83
}
},
{
"tags": [],
"id": "def-common.AGENT_API_ROUTES.INFO_PATTERN",
"type": "string",
"label": "INFO_PATTERN",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
"lineNumber": 84
}
},
{
"tags": [],
"id": "def-common.AGENT_API_ROUTES.UPDATE_PATTERN",
"type": "string",
"label": "UPDATE_PATTERN",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
"lineNumber": 85
}
},
{
"tags": [],
"id": "def-common.AGENT_API_ROUTES.DELETE_PATTERN",
"type": "string",
"label": "DELETE_PATTERN",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
"lineNumber": 86
}
},
{
"tags": [],
"id": "def-common.AGENT_API_ROUTES.EVENTS_PATTERN",
"type": "string",
"label": "EVENTS_PATTERN",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
"lineNumber": 87
}
},
{
"tags": [],
"id": "def-common.AGENT_API_ROUTES.CHECKIN_PATTERN",
"type": "string",
"label": "CHECKIN_PATTERN",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
"lineNumber": 88
}
},
{
"tags": [],
"id": "def-common.AGENT_API_ROUTES.ACKS_PATTERN",
"type": "string",
"label": "ACKS_PATTERN",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
"lineNumber": 89
}
},
{
"tags": [],
"id": "def-common.AGENT_API_ROUTES.ACTIONS_PATTERN",
"type": "string",
"label": "ACTIONS_PATTERN",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
"lineNumber": 90
}
},
{
"tags": [],
"id": "def-common.AGENT_API_ROUTES.ENROLL_PATTERN",
"type": "string",
"label": "ENROLL_PATTERN",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
"lineNumber": 91
}
},
{
"tags": [],
"id": "def-common.AGENT_API_ROUTES.UNENROLL_PATTERN",
"type": "string",
"label": "UNENROLL_PATTERN",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
"lineNumber": 92
}
},
{
"tags": [],
"id": "def-common.AGENT_API_ROUTES.BULK_UNENROLL_PATTERN",
"type": "string",
"label": "BULK_UNENROLL_PATTERN",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
"lineNumber": 93
}
},
{
"tags": [],
"id": "def-common.AGENT_API_ROUTES.REASSIGN_PATTERN",
"type": "string",
"label": "REASSIGN_PATTERN",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
"lineNumber": 94
}
},
{
"tags": [],
"id": "def-common.AGENT_API_ROUTES.BULK_REASSIGN_PATTERN",
"type": "string",
"label": "BULK_REASSIGN_PATTERN",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
"lineNumber": 95
}
},
{
"tags": [],
"id": "def-common.AGENT_API_ROUTES.STATUS_PATTERN",
"type": "string",
"label": "STATUS_PATTERN",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
"lineNumber": 96
}
},
{
"tags": [],
"id": "def-common.AGENT_API_ROUTES.UPGRADE_PATTERN",
"type": "string",
"label": "UPGRADE_PATTERN",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
"lineNumber": 97
}
},
{
"tags": [],
"id": "def-common.AGENT_API_ROUTES.BULK_UPGRADE_PATTERN",
"type": "string",
"label": "BULK_UPGRADE_PATTERN",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
"lineNumber": 98
}
}
],
"description": [],
"label": "AGENT_API_ROUTES",
"source": {
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
"lineNumber": 82
},
"initialIsOpen": false
},
{
"id": "def-common.AGENT_API_ROUTES_7_9",
"type": "Object",
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.AGENT_API_ROUTES_7_9.CHECKIN_PATTERN",
"type": "string",
"label": "CHECKIN_PATTERN",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
"lineNumber": 101
}
},
{
"tags": [],
"id": "def-common.AGENT_API_ROUTES_7_9.ACKS_PATTERN",
"type": "string",
"label": "ACKS_PATTERN",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
"lineNumber": 102
}
},
{
"tags": [],
"id": "def-common.AGENT_API_ROUTES_7_9.ENROLL_PATTERN",
"type": "string",
"label": "ENROLL_PATTERN",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
"lineNumber": 103
}
}
],
"description": [],
"label": "AGENT_API_ROUTES_7_9",
"source": {
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
"lineNumber": 100
},
"initialIsOpen": false
},
{
"id": "def-common.AGENT_POLICY_API_ROUTES",
"type": "Object",
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.AGENT_POLICY_API_ROUTES.LIST_PATTERN",
"type": "string",
"label": "LIST_PATTERN",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
"lineNumber": 53
}
},
{
"tags": [],
"id": "def-common.AGENT_POLICY_API_ROUTES.INFO_PATTERN",
"type": "string",
"label": "INFO_PATTERN",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
"lineNumber": 54
}
},
{
"tags": [],
"id": "def-common.AGENT_POLICY_API_ROUTES.CREATE_PATTERN",
"type": "string",
"label": "CREATE_PATTERN",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
"lineNumber": 55
}
},
{
"tags": [],
"id": "def-common.AGENT_POLICY_API_ROUTES.UPDATE_PATTERN",
"type": "string",
"label": "UPDATE_PATTERN",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
"lineNumber": 56
}
},
{
"tags": [],
"id": "def-common.AGENT_POLICY_API_ROUTES.COPY_PATTERN",
"type": "string",
"label": "COPY_PATTERN",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
"lineNumber": 57
}
},
{
"tags": [],
"id": "def-common.AGENT_POLICY_API_ROUTES.DELETE_PATTERN",
"type": "string",
"label": "DELETE_PATTERN",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
"lineNumber": 58
}
},
{
"tags": [],
"id": "def-common.AGENT_POLICY_API_ROUTES.FULL_INFO_PATTERN",
"type": "string",
"label": "FULL_INFO_PATTERN",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
"lineNumber": 59
}
},
{
"tags": [],
"id": "def-common.AGENT_POLICY_API_ROUTES.FULL_INFO_DOWNLOAD_PATTERN",
"type": "string",
"label": "FULL_INFO_DOWNLOAD_PATTERN",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
"lineNumber": 60
}
}
],
"description": [],
"label": "AGENT_POLICY_API_ROUTES",
"source": {
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
"lineNumber": 52
},
"initialIsOpen": false
},
{
"tags": [],
"id": "def-common.agentAssetTypes",
"type": "Object",
"label": "agentAssetTypes",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/constants/epm.ts",
"lineNumber": 23
},
"signature": [
"{ readonly Input: \"input\"; }"
],
"initialIsOpen": false
},
{
"id": "def-common.agentPolicyRouteService",
"type": "Object",
"tags": [],
"children": [
{
"id": "def-common.agentPolicyRouteService.getListPath",
"type": "Function",
"children": [],
"signature": [
"() => string"
],
"description": [],
"label": "getListPath",
"source": {
"path": "x-pack/plugins/fleet/common/services/routes.ts",
"lineNumber": 87
},
"tags": [],
"returnComment": []
},
{
"id": "def-common.agentPolicyRouteService.getInfoPath",
"type": "Function",
"children": [
{
"type": "string",
"label": "agentPolicyId",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/services/routes.ts",
"lineNumber": 91
}
}
],
"signature": [
"(agentPolicyId: string) => string"
],
"description": [],
"label": "getInfoPath",
"source": {
"path": "x-pack/plugins/fleet/common/services/routes.ts",
"lineNumber": 91
},
"tags": [],
"returnComment": []
},
{
"id": "def-common.agentPolicyRouteService.getCreatePath",
"type": "Function",
"children": [],
"signature": [
"() => string"
],
"description": [],
"label": "getCreatePath",
"source": {
"path": "x-pack/plugins/fleet/common/services/routes.ts",
"lineNumber": 95
},
"tags": [],
"returnComment": []
},
{
"id": "def-common.agentPolicyRouteService.getUpdatePath",
"type": "Function",
"children": [
{
"type": "string",
"label": "agentPolicyId",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/services/routes.ts",
"lineNumber": 99
}
}
],
"signature": [
"(agentPolicyId: string) => string"
],
"description": [],
"label": "getUpdatePath",
"source": {
"path": "x-pack/plugins/fleet/common/services/routes.ts",
"lineNumber": 99
},
"tags": [],
"returnComment": []
},
{
"id": "def-common.agentPolicyRouteService.getCopyPath",
"type": "Function",
"children": [
{
"type": "string",
"label": "agentPolicyId",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/services/routes.ts",
"lineNumber": 103
}
}
],
"signature": [
"(agentPolicyId: string) => string"
],
"description": [],
"label": "getCopyPath",
"source": {
"path": "x-pack/plugins/fleet/common/services/routes.ts",
"lineNumber": 103
},
"tags": [],
"returnComment": []
},
{
"id": "def-common.agentPolicyRouteService.getDeletePath",
"type": "Function",
"children": [],
"signature": [
"() => string"
],
"description": [],
"label": "getDeletePath",
"source": {
"path": "x-pack/plugins/fleet/common/services/routes.ts",
"lineNumber": 107
},
"tags": [],
"returnComment": []
},
{
"id": "def-common.agentPolicyRouteService.getInfoFullPath",
"type": "Function",
"children": [
{
"type": "string",
"label": "agentPolicyId",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/services/routes.ts",
"lineNumber": 111
}
}
],
"signature": [
"(agentPolicyId: string) => string"
],
"description": [],
"label": "getInfoFullPath",
"source": {
"path": "x-pack/plugins/fleet/common/services/routes.ts",
"lineNumber": 111
},
"tags": [],
"returnComment": []
},
{
"id": "def-common.agentPolicyRouteService.getInfoFullDownloadPath",
"type": "Function",
"children": [
{
"type": "string",
"label": "agentPolicyId",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/services/routes.ts",
"lineNumber": 115
}
}
],
"signature": [
"(agentPolicyId: string) => string"
],
"description": [],
"label": "getInfoFullDownloadPath",
"source": {
"path": "x-pack/plugins/fleet/common/services/routes.ts",
"lineNumber": 115
},
"tags": [],
"returnComment": []
}
],
"description": [],
"label": "agentPolicyRouteService",
"source": {
"path": "x-pack/plugins/fleet/common/services/routes.ts",
"lineNumber": 86
},
"initialIsOpen": false
},
{
"tags": [],
"id": "def-common.agentPolicyStatuses",
"type": "Object",
"label": "agentPolicyStatuses",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/constants/agent_policy.ts",
"lineNumber": 14
},
"signature": [
"{ readonly Active: \"active\"; readonly Inactive: \"inactive\"; }"
],
"initialIsOpen": false
},
{
"id": "def-common.agentRouteService",
"type": "Object",
"tags": [],
"children": [
{
"id": "def-common.agentRouteService.getInfoPath",
"type": "Function",
"children": [
{
"type": "string",
"label": "agentId",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/services/routes.ts",
"lineNumber": 135
}
}
],
"signature": [
"(agentId: string) => string"
],
"description": [],
"label": "getInfoPath",
"source": {
"path": "x-pack/plugins/fleet/common/services/routes.ts",
"lineNumber": 135
},
"tags": [],
"returnComment": []
},
{
"id": "def-common.agentRouteService.getUpdatePath",
"type": "Function",
"children": [
{
"type": "string",
"label": "agentId",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/services/routes.ts",
"lineNumber": 136
}
}
],
"signature": [
"(agentId: string) => string"
],
"description": [],
"label": "getUpdatePath",
"source": {
"path": "x-pack/plugins/fleet/common/services/routes.ts",
"lineNumber": 136
},
"tags": [],
"returnComment": []
},
{
"id": "def-common.agentRouteService.getEventsPath",
"type": "Function",
"children": [
{
"type": "string",
"label": "agentId",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/services/routes.ts",
"lineNumber": 137
}
}
],
"signature": [
"(agentId: string) => string"
],
"description": [],
"label": "getEventsPath",
"source": {
"path": "x-pack/plugins/fleet/common/services/routes.ts",
"lineNumber": 137
},
"tags": [],
"returnComment": []
},
{
"id": "def-common.agentRouteService.getUnenrollPath",
"type": "Function",
"children": [
{
"type": "string",
"label": "agentId",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/services/routes.ts",
"lineNumber": 138
}
}
],
"signature": [
"(agentId: string) => string"
],
"description": [],
"label": "getUnenrollPath",
"source": {
"path": "x-pack/plugins/fleet/common/services/routes.ts",
"lineNumber": 138
},
"tags": [],
"returnComment": []
},
{
"id": "def-common.agentRouteService.getBulkUnenrollPath",
"type": "Function",
"children": [],
"signature": [
"() => string"
],
"description": [],
"label": "getBulkUnenrollPath",
"source": {
"path": "x-pack/plugins/fleet/common/services/routes.ts",
"lineNumber": 140
},
"tags": [],
"returnComment": []
},
{
"id": "def-common.agentRouteService.getReassignPath",
"type": "Function",
"children": [
{
"type": "string",
"label": "agentId",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/services/routes.ts",
"lineNumber": 141
}
}
],
"signature": [
"(agentId: string) => string"
],
"description": [],
"label": "getReassignPath",
"source": {
"path": "x-pack/plugins/fleet/common/services/routes.ts",
"lineNumber": 141
},
"tags": [],
"returnComment": []
},
{
"id": "def-common.agentRouteService.getBulkReassignPath",
"type": "Function",
"children": [],
"signature": [
"() => string"
],
"description": [],
"label": "getBulkReassignPath",
"source": {
"path": "x-pack/plugins/fleet/common/services/routes.ts",
"lineNumber": 143
},
"tags": [],
"returnComment": []
},
{
"id": "def-common.agentRouteService.getUpgradePath",
"type": "Function",
"children": [
{
"type": "string",
"label": "agentId",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/services/routes.ts",
"lineNumber": 144
}
}
],
"signature": [
"(agentId: string) => string"
],
"description": [],
"label": "getUpgradePath",
"source": {
"path": "x-pack/plugins/fleet/common/services/routes.ts",
"lineNumber": 144
},
"tags": [],
"returnComment": []
},
{
"id": "def-common.agentRouteService.getBulkUpgradePath",
"type": "Function",
"children": [],
"signature": [
"() => string"
],
"description": [],
"label": "getBulkUpgradePath",
"source": {
"path": "x-pack/plugins/fleet/common/services/routes.ts",
"lineNumber": 146
},
"tags": [],
"returnComment": []
},
{
"id": "def-common.agentRouteService.getListPath",
"type": "Function",
"children": [],
"signature": [
"() => string"
],
"description": [],
"label": "getListPath",
"source": {
"path": "x-pack/plugins/fleet/common/services/routes.ts",
"lineNumber": 147
},
"tags": [],
"returnComment": []
},
{
"id": "def-common.agentRouteService.getStatusPath",
"type": "Function",
"children": [],
"signature": [
"() => string"
],
"description": [],
"label": "getStatusPath",
"source": {
"path": "x-pack/plugins/fleet/common/services/routes.ts",
"lineNumber": 148
},
"tags": [],
"returnComment": []
},
{
"id": "def-common.agentRouteService.getCreateActionPath",
"type": "Function",
"children": [
{
"type": "string",
"label": "agentId",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/services/routes.ts",
"lineNumber": 149
}
}
],
"signature": [
"(agentId: string) => string"
],
"description": [],
"label": "getCreateActionPath",
"source": {
"path": "x-pack/plugins/fleet/common/services/routes.ts",
"lineNumber": 149
},
"tags": [],
"returnComment": []
}
],
"description": [],
"label": "agentRouteService",
"source": {
"path": "x-pack/plugins/fleet/common/services/routes.ts",
"lineNumber": 134
},
"initialIsOpen": false
},
{
"id": "def-common.AGENTS_SETUP_API_ROUTES",
"type": "Object",
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.AGENTS_SETUP_API_ROUTES.INFO_PATTERN",
"type": "string",
"label": "INFO_PATTERN",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
"lineNumber": 115
}
},
{
"tags": [],
"id": "def-common.AGENTS_SETUP_API_ROUTES.CREATE_PATTERN",
"type": "string",
"label": "CREATE_PATTERN",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
"lineNumber": 116
}
}
],
"description": [],
"label": "AGENTS_SETUP_API_ROUTES",
"source": {
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
"lineNumber": 114
},
"initialIsOpen": false
},
{
"id": "def-common.AgentStatusKueryHelper",
"type": "Object",
"label": "AgentStatusKueryHelper",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/services/index.ts",
"lineNumber": 9
},
"signature": [
"typeof ",
"x-pack/plugins/fleet/common/services/agent_status"
],
"initialIsOpen": false
},
{
"id": "def-common.APP_API_ROUTES",
"type": "Object",
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.APP_API_ROUTES.CHECK_PERMISSIONS_PATTERN",
"type": "string",
"label": "CHECK_PERMISSIONS_PATTERN",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
"lineNumber": 78
}
}
],
"description": [],
"label": "APP_API_ROUTES",
"source": {
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
"lineNumber": 77
},
"initialIsOpen": false
},
{
"id": "def-common.appRoutesService",
"type": "Object",
"tags": [],
"children": [
{
"id": "def-common.appRoutesService.getCheckPermissionsPath",
"type": "Function",
"children": [],
"signature": [
"() => string"
],
"description": [],
"label": "getCheckPermissionsPath",
"source": {
"path": "x-pack/plugins/fleet/common/services/routes.ts",
"lineNumber": 166
},
"tags": [],
"returnComment": []
}
],
"description": [],
"label": "appRoutesService",
"source": {
"path": "x-pack/plugins/fleet/common/services/routes.ts",
"lineNumber": 165
},
"initialIsOpen": false
},
{
"id": "def-common.DATA_STREAM_API_ROUTES",
"type": "Object",
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.DATA_STREAM_API_ROUTES.LIST_PATTERN",
"type": "string",
"label": "LIST_PATTERN",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
"lineNumber": 39
}
}
],
"description": [],
"label": "DATA_STREAM_API_ROUTES",
"source": {
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
"lineNumber": 38
},
"initialIsOpen": false
},
{
"id": "def-common.dataStreamRouteService",
"type": "Object",
"tags": [],
"children": [
{
"id": "def-common.dataStreamRouteService.getListPath",
"type": "Function",
"children": [],
"signature": [
"() => string"
],
"description": [],
"label": "getListPath",
"source": {
"path": "x-pack/plugins/fleet/common/services/routes.ts",
"lineNumber": 124
},
"tags": [],
"returnComment": []
}
],
"description": [],
"label": "dataStreamRouteService",
"source": {
"path": "x-pack/plugins/fleet/common/services/routes.ts",
"lineNumber": 123
},
"initialIsOpen": false
},
{
"tags": [],
"id": "def-common.dataTypes",
"type": "Object",
"label": "dataTypes",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/constants/epm.ts",
"lineNumber": 27
},
"signature": [
"{ readonly Logs: \"logs\"; readonly Metrics: \"metrics\"; }"
],
"initialIsOpen": false
},
{
"id": "def-common.DEFAULT_AGENT_POLICY",
"type": "Object",
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.DEFAULT_AGENT_POLICY.name",
"type": "string",
"label": "name",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/constants/agent_policy.ts",
"lineNumber": 23
}
},
{
"tags": [],
"id": "def-common.DEFAULT_AGENT_POLICY.namespace",
"type": "string",
"label": "namespace",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/constants/agent_policy.ts",
"lineNumber": 24
}
},
{
"tags": [],
"id": "def-common.DEFAULT_AGENT_POLICY.description",
"type": "string",
"label": "description",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/constants/agent_policy.ts",
"lineNumber": 25
}
},
{
"tags": [],
"id": "def-common.DEFAULT_AGENT_POLICY.status",
"type": "string",
"label": "status",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/constants/agent_policy.ts",
"lineNumber": 26
},
"signature": [
"\"active\""
]
},
{
"tags": [],
"id": "def-common.DEFAULT_AGENT_POLICY.package_policies",
"type": "Array",
"label": "package_policies",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/constants/agent_policy.ts",
"lineNumber": 27
},
"signature": [
"never[]"
]
},
{
"tags": [],
"id": "def-common.DEFAULT_AGENT_POLICY.is_default",
"type": "boolean",
"label": "is_default",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/constants/agent_policy.ts",
"lineNumber": 28
},
"signature": [
"true"
]
},
{
"tags": [],
"id": "def-common.DEFAULT_AGENT_POLICY.is_managed",
"type": "boolean",
"label": "is_managed",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/constants/agent_policy.ts",
"lineNumber": 29
},
"signature": [
"false"
]
},
{
"tags": [],
"id": "def-common.DEFAULT_AGENT_POLICY.monitoring_enabled",
"type": "Array",
"label": "monitoring_enabled",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/constants/agent_policy.ts",
"lineNumber": 30
},
"signature": [
"(\"metrics\" | \"logs\")[]"
]
}
],
"description": [],
"label": "DEFAULT_AGENT_POLICY",
"source": {
"path": "x-pack/plugins/fleet/common/constants/agent_policy.ts",
"lineNumber": 19
},
"initialIsOpen": false
},
{
"id": "def-common.DEFAULT_FLEET_SERVER_AGENT_POLICY",
"type": "Object",
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.DEFAULT_FLEET_SERVER_AGENT_POLICY.name",
"type": "string",
"label": "name",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/constants/agent_policy.ts",
"lineNumber": 37
}
},
{
"tags": [],
"id": "def-common.DEFAULT_FLEET_SERVER_AGENT_POLICY.namespace",
"type": "string",
"label": "namespace",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/constants/agent_policy.ts",
"lineNumber": 38
}
},
{
"tags": [],
"id": "def-common.DEFAULT_FLEET_SERVER_AGENT_POLICY.description",
"type": "string",
"label": "description",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/constants/agent_policy.ts",
"lineNumber": 39
}
},
{
"tags": [],
"id": "def-common.DEFAULT_FLEET_SERVER_AGENT_POLICY.status",
"type": "string",
"label": "status",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/constants/agent_policy.ts",
"lineNumber": 40
},
"signature": [
"\"active\""
]
},
{
"tags": [],
"id": "def-common.DEFAULT_FLEET_SERVER_AGENT_POLICY.package_policies",
"type": "Array",
"label": "package_policies",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/constants/agent_policy.ts",
"lineNumber": 41
},
"signature": [
"never[]"
]
},
{
"tags": [],
"id": "def-common.DEFAULT_FLEET_SERVER_AGENT_POLICY.is_default",
"type": "boolean",
"label": "is_default",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/constants/agent_policy.ts",
"lineNumber": 42
},
"signature": [
"false"
]
},
{
"tags": [],
"id": "def-common.DEFAULT_FLEET_SERVER_AGENT_POLICY.is_default_fleet_server",
"type": "boolean",
"label": "is_default_fleet_server",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/constants/agent_policy.ts",
"lineNumber": 43
},
"signature": [
"true"
]
},
{
"tags": [],
"id": "def-common.DEFAULT_FLEET_SERVER_AGENT_POLICY.is_managed",
"type": "boolean",
"label": "is_managed",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/constants/agent_policy.ts",
"lineNumber": 44
},
"signature": [
"false"
]
},
{
"tags": [],
"id": "def-common.DEFAULT_FLEET_SERVER_AGENT_POLICY.monitoring_enabled",
"type": "Array",
"label": "monitoring_enabled",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/constants/agent_policy.ts",
"lineNumber": 45
},
"signature": [
"(\"metrics\" | \"logs\")[]"
]
}
],
"description": [],
"label": "DEFAULT_FLEET_SERVER_AGENT_POLICY",
"source": {
"path": "x-pack/plugins/fleet/common/constants/agent_policy.ts",
"lineNumber": 33
},
"initialIsOpen": false
},
{
"id": "def-common.DEFAULT_OUTPUT",
"type": "Object",
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.DEFAULT_OUTPUT.name",
"type": "string",
"label": "name",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/constants/output.ts",
"lineNumber": 17
}
},
{
"tags": [],
"id": "def-common.DEFAULT_OUTPUT.is_default",
"type": "boolean",
"label": "is_default",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/constants/output.ts",
"lineNumber": 18
},
"signature": [
"true"
]
},
{
"tags": [],
"id": "def-common.DEFAULT_OUTPUT.type",
"type": "string",
"label": "type",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/constants/output.ts",
"lineNumber": 19
},
"signature": [
"\"elasticsearch\""
]
},
{
"tags": [],
"id": "def-common.DEFAULT_OUTPUT.hosts",
"type": "Array",
"label": "hosts",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/constants/output.ts",
"lineNumber": 20
},
"signature": [
"string[]"
]
}
],
"description": [],
"label": "DEFAULT_OUTPUT",
"source": {
"path": "x-pack/plugins/fleet/common/constants/output.ts",
"lineNumber": 16
},
"initialIsOpen": false
},
{
"tags": [],
"id": "def-common.defaultPackages",
"type": "Object",
"label": "defaultPackages",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/constants/epm.ts",
"lineNumber": 21
},
"signature": [
"{ readonly System: \"system\"; readonly Endpoint: \"endpoint\"; readonly ElasticAgent: \"elastic_agent\"; }"
],
"initialIsOpen": false
},
{
"id": "def-common.ENROLLMENT_API_KEY_ROUTES",
"type": "Object",
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.ENROLLMENT_API_KEY_ROUTES.CREATE_PATTERN",
"type": "string",
"label": "CREATE_PATTERN",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
"lineNumber": 107
}
},
{
"tags": [],
"id": "def-common.ENROLLMENT_API_KEY_ROUTES.LIST_PATTERN",
"type": "string",
"label": "LIST_PATTERN",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
"lineNumber": 108
}
},
{
"tags": [],
"id": "def-common.ENROLLMENT_API_KEY_ROUTES.INFO_PATTERN",
"type": "string",
"label": "INFO_PATTERN",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
"lineNumber": 109
}
},
{
"tags": [],
"id": "def-common.ENROLLMENT_API_KEY_ROUTES.DELETE_PATTERN",
"type": "string",
"label": "DELETE_PATTERN",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
"lineNumber": 110
}
}
],
"description": [],
"label": "ENROLLMENT_API_KEY_ROUTES",
"source": {
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
"lineNumber": 106
},
"initialIsOpen": false
},
{
"id": "def-common.enrollmentAPIKeyRouteService",
"type": "Object",
"tags": [],
"children": [
{
"id": "def-common.enrollmentAPIKeyRouteService.getListPath",
"type": "Function",
"children": [],
"signature": [
"() => string"
],
"description": [],
"label": "getListPath",
"source": {
"path": "x-pack/plugins/fleet/common/services/routes.ts",
"lineNumber": 170
},
"tags": [],
"returnComment": []
},
{
"id": "def-common.enrollmentAPIKeyRouteService.getCreatePath",
"type": "Function",
"children": [],
"signature": [
"() => string"
],
"description": [],
"label": "getCreatePath",
"source": {
"path": "x-pack/plugins/fleet/common/services/routes.ts",
"lineNumber": 171
},
"tags": [],
"returnComment": []
},
{
"id": "def-common.enrollmentAPIKeyRouteService.getInfoPath",
"type": "Function",
"children": [
{
"type": "string",
"label": "keyId",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/services/routes.ts",
"lineNumber": 172
}
}
],
"signature": [
"(keyId: string) => string"
],
"description": [],
"label": "getInfoPath",
"source": {
"path": "x-pack/plugins/fleet/common/services/routes.ts",
"lineNumber": 172
},
"tags": [],
"returnComment": []
},
{
"id": "def-common.enrollmentAPIKeyRouteService.getDeletePath",
"type": "Function",
"children": [
{
"type": "string",
"label": "keyId",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/services/routes.ts",
"lineNumber": 173
}
}
],
"signature": [
"(keyId: string) => string"
],
"description": [],
"label": "getDeletePath",
"source": {
"path": "x-pack/plugins/fleet/common/services/routes.ts",
"lineNumber": 173
},
"tags": [],
"returnComment": []
}
],
"description": [],
"label": "enrollmentAPIKeyRouteService",
"source": {
"path": "x-pack/plugins/fleet/common/services/routes.ts",
"lineNumber": 169
},
"initialIsOpen": false
},
{
"id": "def-common.EPM_API_ROUTES",
"type": "Object",
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.EPM_API_ROUTES.BULK_INSTALL_PATTERN",
"type": "string",
"label": "BULK_INSTALL_PATTERN",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
"lineNumber": 25
}
},
{
"tags": [],
"id": "def-common.EPM_API_ROUTES.LIST_PATTERN",
"type": "string",
"label": "LIST_PATTERN",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
"lineNumber": 26
}
},
{
"tags": [],
"id": "def-common.EPM_API_ROUTES.LIMITED_LIST_PATTERN",
"type": "string",
"label": "LIMITED_LIST_PATTERN",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
"lineNumber": 27
}
},
{
"tags": [],
"id": "def-common.EPM_API_ROUTES.INFO_PATTERN",
"type": "string",
"label": "INFO_PATTERN",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
"lineNumber": 28
}
},
{
"tags": [],
"id": "def-common.EPM_API_ROUTES.INSTALL_FROM_REGISTRY_PATTERN",
"type": "string",
"label": "INSTALL_FROM_REGISTRY_PATTERN",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
"lineNumber": 29
}
},
{
"tags": [],
"id": "def-common.EPM_API_ROUTES.INSTALL_BY_UPLOAD_PATTERN",
"type": "string",
"label": "INSTALL_BY_UPLOAD_PATTERN",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
"lineNumber": 30
}
},
{
"tags": [],
"id": "def-common.EPM_API_ROUTES.DELETE_PATTERN",
"type": "string",
"label": "DELETE_PATTERN",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
"lineNumber": 31
}
},
{
"tags": [],
"id": "def-common.EPM_API_ROUTES.FILEPATH_PATTERN",
"type": "string",
"label": "FILEPATH_PATTERN",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
"lineNumber": 32
}
},
{
"tags": [],
"id": "def-common.EPM_API_ROUTES.CATEGORIES_PATTERN",
"type": "string",
"label": "CATEGORIES_PATTERN",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
"lineNumber": 33
}
},
{
"tags": [],
"id": "def-common.EPM_API_ROUTES.STATS_PATTERN",
"type": "string",
"label": "STATS_PATTERN",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
"lineNumber": 34
}
}
],
"description": [],
"label": "EPM_API_ROUTES",
"source": {
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
"lineNumber": 24
},
"initialIsOpen": false
},
{
"id": "def-common.epmRouteService",
"type": "Object",
"tags": [],
"children": [
{
"id": "def-common.epmRouteService.getCategoriesPath",
"type": "Function",
"children": [],
"signature": [
"() => string"
],
"description": [],
"label": "getCategoriesPath",
"source": {
"path": "x-pack/plugins/fleet/common/services/routes.ts",
"lineNumber": 24
},
"tags": [],
"returnComment": []
},
{
"id": "def-common.epmRouteService.getListPath",
"type": "Function",
"children": [],
"signature": [
"() => string"
],
"description": [],
"label": "getListPath",
"source": {
"path": "x-pack/plugins/fleet/common/services/routes.ts",
"lineNumber": 28
},
"tags": [],
"returnComment": []
},
{
"id": "def-common.epmRouteService.getListLimitedPath",
"type": "Function",
"children": [],
"signature": [
"() => string"
],
"description": [],
"label": "getListLimitedPath",
"source": {
"path": "x-pack/plugins/fleet/common/services/routes.ts",
"lineNumber": 32
},
"tags": [],
"returnComment": []
},
{
"id": "def-common.epmRouteService.getInfoPath",
"type": "Function",
"children": [
{
"type": "string",
"label": "pkgkey",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/services/routes.ts",
"lineNumber": 36
}
}
],
"signature": [
"(pkgkey: string) => string"
],
"description": [],
"label": "getInfoPath",
"source": {
"path": "x-pack/plugins/fleet/common/services/routes.ts",
"lineNumber": 36
},
"tags": [],
"returnComment": []
},
{
"id": "def-common.epmRouteService.getStatsPath",
"type": "Function",
"children": [
{
"type": "string",
"label": "pkgName",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/services/routes.ts",
"lineNumber": 40
}
}
],
"signature": [
"(pkgName: string) => string"
],
"description": [],
"label": "getStatsPath",
"source": {
"path": "x-pack/plugins/fleet/common/services/routes.ts",
"lineNumber": 40
},
"tags": [],
"returnComment": []
},
{
"id": "def-common.epmRouteService.getFilePath",
"type": "Function",
"children": [
{
"type": "string",
"label": "filePath",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/services/routes.ts",
"lineNumber": 44
}
}
],
"signature": [
"(filePath: string) => string"
],
"description": [],
"label": "getFilePath",
"source": {
"path": "x-pack/plugins/fleet/common/services/routes.ts",
"lineNumber": 44
},
"tags": [],
"returnComment": []
},
{
"id": "def-common.epmRouteService.getInstallPath",
"type": "Function",
"children": [
{
"type": "string",
"label": "pkgkey",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/services/routes.ts",
"lineNumber": 48
}
}
],
"signature": [
"(pkgkey: string) => string"
],
"description": [],
"label": "getInstallPath",
"source": {
"path": "x-pack/plugins/fleet/common/services/routes.ts",
"lineNumber": 48
},
"tags": [],
"returnComment": []
},
{
"id": "def-common.epmRouteService.getBulkInstallPath",
"type": "Function",
"children": [],
"signature": [
"() => string"
],
"description": [],
"label": "getBulkInstallPath",
"source": {
"path": "x-pack/plugins/fleet/common/services/routes.ts",
"lineNumber": 55
},
"tags": [],
"returnComment": []
},
{
"id": "def-common.epmRouteService.getRemovePath",
"type": "Function",
"children": [
{
"type": "string",
"label": "pkgkey",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/services/routes.ts",
"lineNumber": 59
}
}
],
"signature": [
"(pkgkey: string) => string"
],
"description": [],
"label": "getRemovePath",
"source": {
"path": "x-pack/plugins/fleet/common/services/routes.ts",
"lineNumber": 59
},
"tags": [],
"returnComment": []
}
],
"description": [],
"label": "epmRouteService",
"source": {
"path": "x-pack/plugins/fleet/common/services/routes.ts",
"lineNumber": 23
},
"initialIsOpen": false
},
{
"id": "def-common.fleetSetupRouteService",
"type": "Object",
"tags": [],
"children": [
{
"id": "def-common.fleetSetupRouteService.getFleetSetupPath",
"type": "Function",
"children": [],
"signature": [
"() => string"
],
"description": [],
"label": "getFleetSetupPath",
"source": {
"path": "x-pack/plugins/fleet/common/services/routes.ts",
"lineNumber": 130
},
"tags": [],
"returnComment": []
},
{
"id": "def-common.fleetSetupRouteService.postFleetSetupPath",
"type": "Function",
"children": [],
"signature": [
"() => string"
],
"description": [],
"label": "postFleetSetupPath",
"source": {
"path": "x-pack/plugins/fleet/common/services/routes.ts",
"lineNumber": 131
},
"tags": [],
"returnComment": []
}
],
"description": [],
"label": "fleetSetupRouteService",
"source": {
"path": "x-pack/plugins/fleet/common/services/routes.ts",
"lineNumber": 129
},
"initialIsOpen": false
},
{
"tags": [],
"id": "def-common.installationStatuses",
"type": "Object",
"label": "installationStatuses",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/constants/epm.ts",
"lineNumber": 32
},
"signature": [
"{ readonly Installed: \"installed\"; readonly NotInstalled: \"not_installed\"; }"
],
"initialIsOpen": false
},
{
"id": "def-common.OUTPUT_API_ROUTES",
"type": "Object",
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.OUTPUT_API_ROUTES.LIST_PATTERN",
"type": "string",
"label": "LIST_PATTERN",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
"lineNumber": 65
}
},
{
"tags": [],
"id": "def-common.OUTPUT_API_ROUTES.INFO_PATTERN",
"type": "string",
"label": "INFO_PATTERN",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
"lineNumber": 66
}
},
{
"tags": [],
"id": "def-common.OUTPUT_API_ROUTES.UPDATE_PATTERN",
"type": "string",
"label": "UPDATE_PATTERN",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
"lineNumber": 67
}
}
],
"description": [],
"label": "OUTPUT_API_ROUTES",
"source": {
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
"lineNumber": 64
},
"initialIsOpen": false
},
{
"id": "def-common.outputRoutesService",
"type": "Object",
"tags": [],
"children": [
{
"id": "def-common.outputRoutesService.getInfoPath",
"type": "Function",
"children": [
{
"type": "string",
"label": "outputId",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/services/routes.ts",
"lineNumber": 154
}
}
],
"signature": [
"(outputId: string) => string"
],
"description": [],
"label": "getInfoPath",
"source": {
"path": "x-pack/plugins/fleet/common/services/routes.ts",
"lineNumber": 154
},
"tags": [],
"returnComment": []
},
{
"id": "def-common.outputRoutesService.getUpdatePath",
"type": "Function",
"children": [
{
"type": "string",
"label": "outputId",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/services/routes.ts",
"lineNumber": 155
}
}
],
"signature": [
"(outputId: string) => string"
],
"description": [],
"label": "getUpdatePath",
"source": {
"path": "x-pack/plugins/fleet/common/services/routes.ts",
"lineNumber": 155
},
"tags": [],
"returnComment": []
},
{
"id": "def-common.outputRoutesService.getListPath",
"type": "Function",
"children": [],
"signature": [
"() => string"
],
"description": [],
"label": "getListPath",
"source": {
"path": "x-pack/plugins/fleet/common/services/routes.ts",
"lineNumber": 157
},
"tags": [],
"returnComment": []
}
],
"description": [],
"label": "outputRoutesService",
"source": {
"path": "x-pack/plugins/fleet/common/services/routes.ts",
"lineNumber": 153
},
"initialIsOpen": false
},
{
"tags": [],
"id": "def-common.outputType",
"type": "Object",
"label": "outputType",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/constants/output.ts",
"lineNumber": 12
},
"signature": [
"{ readonly Elasticsearch: \"elasticsearch\"; }"
],
"initialIsOpen": false
},
{
"id": "def-common.PACKAGE_POLICY_API_ROUTES",
"type": "Object",
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.PACKAGE_POLICY_API_ROUTES.LIST_PATTERN",
"type": "string",
"label": "LIST_PATTERN",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
"lineNumber": 44
}
},
{
"tags": [],
"id": "def-common.PACKAGE_POLICY_API_ROUTES.INFO_PATTERN",
"type": "string",
"label": "INFO_PATTERN",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
"lineNumber": 45
}
},
{
"tags": [],
"id": "def-common.PACKAGE_POLICY_API_ROUTES.CREATE_PATTERN",
"type": "string",
"label": "CREATE_PATTERN",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
"lineNumber": 46
}
},
{
"tags": [],
"id": "def-common.PACKAGE_POLICY_API_ROUTES.UPDATE_PATTERN",
"type": "string",
"label": "UPDATE_PATTERN",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
"lineNumber": 47
}
},
{
"tags": [],
"id": "def-common.PACKAGE_POLICY_API_ROUTES.DELETE_PATTERN",
"type": "string",
"label": "DELETE_PATTERN",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
"lineNumber": 48
}
}
],
"description": [],
"label": "PACKAGE_POLICY_API_ROUTES",
"source": {
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
"lineNumber": 43
},
"initialIsOpen": false
},
{
"id": "def-common.packagePolicyRouteService",
"type": "Object",
"tags": [],
"children": [
{
"id": "def-common.packagePolicyRouteService.getListPath",
"type": "Function",
"children": [],
"signature": [
"() => string"
],
"description": [],
"label": "getListPath",
"source": {
"path": "x-pack/plugins/fleet/common/services/routes.ts",
"lineNumber": 65
},
"tags": [],
"returnComment": []
},
{
"id": "def-common.packagePolicyRouteService.getInfoPath",
"type": "Function",
"children": [
{
"type": "string",
"label": "packagePolicyId",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/services/routes.ts",
"lineNumber": 69
}
}
],
"signature": [
"(packagePolicyId: string) => string"
],
"description": [],
"label": "getInfoPath",
"source": {
"path": "x-pack/plugins/fleet/common/services/routes.ts",
"lineNumber": 69
},
"tags": [],
"returnComment": []
},
{
"id": "def-common.packagePolicyRouteService.getCreatePath",
"type": "Function",
"children": [],
"signature": [
"() => string"
],
"description": [],
"label": "getCreatePath",
"source": {
"path": "x-pack/plugins/fleet/common/services/routes.ts",
"lineNumber": 73
},
"tags": [],
"returnComment": []
},
{
"id": "def-common.packagePolicyRouteService.getUpdatePath",
"type": "Function",
"children": [
{
"type": "string",
"label": "packagePolicyId",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/services/routes.ts",
"lineNumber": 77
}
}
],
"signature": [
"(packagePolicyId: string) => string"
],
"description": [],
"label": "getUpdatePath",
"source": {
"path": "x-pack/plugins/fleet/common/services/routes.ts",
"lineNumber": 77
},
"tags": [],
"returnComment": []
},
{
"id": "def-common.packagePolicyRouteService.getDeletePath",
"type": "Function",
"children": [],
"signature": [
"() => string"
],
"description": [],
"label": "getDeletePath",
"source": {
"path": "x-pack/plugins/fleet/common/services/routes.ts",
"lineNumber": 81
},
"tags": [],
"returnComment": []
}
],
"description": [],
"label": "packagePolicyRouteService",
"source": {
"path": "x-pack/plugins/fleet/common/services/routes.ts",
"lineNumber": 64
},
"initialIsOpen": false
},
{
"tags": [],
"id": "def-common.requiredPackages",
"type": "Object",
"label": "requiredPackages",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/constants/epm.ts",
"lineNumber": 14
},
"signature": [
"{ readonly System: \"system\"; readonly Endpoint: \"endpoint\"; readonly ElasticAgent: \"elastic_agent\"; }"
],
"initialIsOpen": false
},
{
"id": "def-common.SETTINGS_API_ROUTES",
"type": "Object",
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.SETTINGS_API_ROUTES.INFO_PATTERN",
"type": "string",
"label": "INFO_PATTERN",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
"lineNumber": 72
}
},
{
"tags": [],
"id": "def-common.SETTINGS_API_ROUTES.UPDATE_PATTERN",
"type": "string",
"label": "UPDATE_PATTERN",
"description": [],
"source": {
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
"lineNumber": 73
}
}
],
"description": [],
"label": "SETTINGS_API_ROUTES",
"source": {
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
"lineNumber": 71
},
"initialIsOpen": false
},
{
"id": "def-common.settingsRoutesService",
"type": "Object",
"tags": [],
"children": [
{
"id": "def-common.settingsRoutesService.getInfoPath",
"type": "Function",
"children": [],
"signature": [
"() => string"
],
"description": [],
"label": "getInfoPath",
"source": {
"path": "x-pack/plugins/fleet/common/services/routes.ts",
"lineNumber": 161
},
"tags": [],
"returnComment": []
},
{
"id": "def-common.settingsRoutesService.getUpdatePath",
"type": "Function",
"children": [],
"signature": [
"() => string"
],
"description": [],
"label": "getUpdatePath",
"source": {
"path": "x-pack/plugins/fleet/common/services/routes.ts",
"lineNumber": 162
},
"tags": [],
"returnComment": []
}
],
"description": [],
"label": "settingsRoutesService",
"source": {
"path": "x-pack/plugins/fleet/common/services/routes.ts",
"lineNumber": 160
},
"initialIsOpen": false
},
{
"id": "def-common.setupRouteService",
"type": "Object",
"tags": [],
"children": [
{
"id": "def-common.setupRouteService.getSetupPath",
"type": "Function",
"children": [],
"signature": [
"() => string"
],
"description": [],
"label": "getSetupPath",
"source": {
"path": "x-pack/plugins/fleet/common/services/routes.ts",
"lineNumber": 178
},
"tags": [],
"returnComment": []
}
],
"description": [],
"label": "setupRouteService",
"source": {
"path": "x-pack/plugins/fleet/common/services/routes.ts",
"lineNumber": 177
},
"initialIsOpen": false
}
]
}
}
Reference in a new issue View git blame Copy permalink