21883 lines
748 KiB
JSON
21883 lines
748 KiB
JSON
{
|
|
"id": "fleet",
|
|
"client": {
|
|
"classes": [],
|
|
"functions": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-public.CustomAssetsAccordion",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "CustomAssetsAccordion",
|
|
"description": [],
|
|
"signature": [
|
|
"({ views, initialIsOpen, }: React.PropsWithChildren<",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "public",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-public.CustomAssetsAccordionProps",
|
|
"text": "CustomAssetsAccordionProps"
|
|
},
|
|
">) => JSX.Element"
|
|
],
|
|
"path": "x-pack/plugins/fleet/public/components/custom_assets_accordion.tsx",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-public.CustomAssetsAccordion.$1",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "{\n views,\n initialIsOpen = false,\n}",
|
|
"description": [],
|
|
"signature": [
|
|
"React.PropsWithChildren<",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "public",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-public.CustomAssetsAccordionProps",
|
|
"text": "CustomAssetsAccordionProps"
|
|
},
|
|
">"
|
|
],
|
|
"path": "x-pack/plugins/fleet/public/components/custom_assets_accordion.tsx",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-public.pkgKeyFromPackageInfo",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "pkgKeyFromPackageInfo",
|
|
"description": [],
|
|
"signature": [
|
|
"<T extends { name: string; version: string; }>(packageInfo: T) => string"
|
|
],
|
|
"path": "x-pack/plugins/fleet/public/services/pkg_key_from_package_info.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-public.pkgKeyFromPackageInfo.$1",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "packageInfo",
|
|
"description": [],
|
|
"signature": [
|
|
"T"
|
|
],
|
|
"path": "x-pack/plugins/fleet/public/services/pkg_key_from_package_info.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"interfaces": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-public.AgentDetailsReassignPolicyAction",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "AgentDetailsReassignPolicyAction",
|
|
"description": [
|
|
"\nSupported routing state for the agent policy details page routes with deploy agents action"
|
|
],
|
|
"path": "x-pack/plugins/fleet/public/types/intra_app_route_state.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-public.AgentDetailsReassignPolicyAction.onDoneNavigateTo",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "onDoneNavigateTo",
|
|
"description": [
|
|
"On done, navigate to the given app"
|
|
],
|
|
"signature": [
|
|
"[appId: string, options?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCoreApplicationPluginApi",
|
|
"section": "def-public.NavigateToAppOptions",
|
|
"text": "NavigateToAppOptions"
|
|
},
|
|
" | undefined] | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/public/types/intra_app_route_state.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-public.AgentEnrollmentFlyoutFinalStepExtension",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "AgentEnrollmentFlyoutFinalStepExtension",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/public/types/ui_extensions.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-public.AgentEnrollmentFlyoutFinalStepExtension.package",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "package",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/public/types/ui_extensions.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-public.AgentEnrollmentFlyoutFinalStepExtension.view",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "view",
|
|
"description": [],
|
|
"signature": [
|
|
"\"agent-enrollment-flyout\""
|
|
],
|
|
"path": "x-pack/plugins/fleet/public/types/ui_extensions.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-public.AgentEnrollmentFlyoutFinalStepExtension.title",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "title",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/public/types/ui_extensions.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-public.AgentEnrollmentFlyoutFinalStepExtension.Component",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "Component",
|
|
"description": [],
|
|
"signature": [
|
|
"React.ComponentClass<{}, any> | React.FunctionComponent<{}>"
|
|
],
|
|
"path": "x-pack/plugins/fleet/public/types/ui_extensions.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-public.AgentPolicyDetailsDeployAgentAction",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "AgentPolicyDetailsDeployAgentAction",
|
|
"description": [
|
|
"\nSupported routing state for the agent policy details page routes with deploy agents action"
|
|
],
|
|
"path": "x-pack/plugins/fleet/public/types/intra_app_route_state.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-public.AgentPolicyDetailsDeployAgentAction.onDoneNavigateTo",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "onDoneNavigateTo",
|
|
"description": [
|
|
"On done, navigate to the given app"
|
|
],
|
|
"signature": [
|
|
"[appId: string, options?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCoreApplicationPluginApi",
|
|
"section": "def-public.NavigateToAppOptions",
|
|
"text": "NavigateToAppOptions"
|
|
},
|
|
" | undefined] | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/public/types/intra_app_route_state.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-public.CreatePackagePolicyRouteState",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "CreatePackagePolicyRouteState",
|
|
"description": [
|
|
"\nSupported routing state for the create package policy page routes"
|
|
],
|
|
"path": "x-pack/plugins/fleet/public/types/intra_app_route_state.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-public.CreatePackagePolicyRouteState.onSaveNavigateTo",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "onSaveNavigateTo",
|
|
"description": [
|
|
"On a successful save of the package policy, use navigate to the given app"
|
|
],
|
|
"signature": [
|
|
"[appId: string, options?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCoreApplicationPluginApi",
|
|
"section": "def-public.NavigateToAppOptions",
|
|
"text": "NavigateToAppOptions"
|
|
},
|
|
" | undefined] | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/public/types/intra_app_route_state.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-public.CreatePackagePolicyRouteState.onCancelNavigateTo",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "onCancelNavigateTo",
|
|
"description": [
|
|
"On cancel, navigate to the given app"
|
|
],
|
|
"signature": [
|
|
"[appId: string, options?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCoreApplicationPluginApi",
|
|
"section": "def-public.NavigateToAppOptions",
|
|
"text": "NavigateToAppOptions"
|
|
},
|
|
" | undefined] | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/public/types/intra_app_route_state.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-public.CreatePackagePolicyRouteState.onCancelUrl",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "onCancelUrl",
|
|
"description": [
|
|
"Url to be used on cancel links"
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/public/types/intra_app_route_state.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-public.CreatePackagePolicyRouteState.onSaveQueryParams",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "onSaveQueryParams",
|
|
"description": [
|
|
"supported query params for onSaveNavigateTo path"
|
|
],
|
|
"signature": [
|
|
"{ showAddAgentHelp?: boolean | { renameKey?: string | undefined; policyIdAsValue?: boolean | undefined; } | undefined; openEnrollmentFlyout?: boolean | { renameKey?: string | undefined; policyIdAsValue?: boolean | undefined; } | undefined; } | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/public/types/intra_app_route_state.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-public.CustomAssetsAccordionProps",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "CustomAssetsAccordionProps",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/public/components/custom_assets_accordion.tsx",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-public.CustomAssetsAccordionProps.views",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "views",
|
|
"description": [],
|
|
"signature": [
|
|
"{ name: string; url: string; description: string; }[]"
|
|
],
|
|
"path": "x-pack/plugins/fleet/public/components/custom_assets_accordion.tsx",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-public.CustomAssetsAccordionProps.initialIsOpen",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "initialIsOpen",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/public/components/custom_assets_accordion.tsx",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-public.IntegrationsAppBrowseRouteState",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "IntegrationsAppBrowseRouteState",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/public/types/intra_app_route_state.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-public.IntegrationsAppBrowseRouteState.forAgentPolicyId",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "forAgentPolicyId",
|
|
"description": [
|
|
"The agent policy that we are browsing integrations for"
|
|
],
|
|
"path": "x-pack/plugins/fleet/public/types/intra_app_route_state.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-public.NewPackagePolicy",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "NewPackagePolicy",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/package_policy.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-public.NewPackagePolicy.name",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "name",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/package_policy.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-public.NewPackagePolicy.description",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "description",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/package_policy.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-public.NewPackagePolicy.namespace",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "namespace",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/package_policy.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-public.NewPackagePolicy.enabled",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "enabled",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/package_policy.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-public.NewPackagePolicy.policy_id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "policy_id",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/package_policy.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-public.NewPackagePolicy.output_id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "output_id",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/package_policy.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-public.NewPackagePolicy.package",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "package",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.PackagePolicyPackage",
|
|
"text": "PackagePolicyPackage"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/package_policy.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-public.NewPackagePolicy.inputs",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "inputs",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.NewPackagePolicyInput",
|
|
"text": "NewPackagePolicyInput"
|
|
},
|
|
"[]"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/package_policy.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-public.NewPackagePolicy.vars",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "vars",
|
|
"description": [],
|
|
"signature": [
|
|
"Record<string, ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.PackagePolicyConfigRecordEntry",
|
|
"text": "PackagePolicyConfigRecordEntry"
|
|
},
|
|
"> | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/package_policy.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-public.NewPackagePolicy.elasticsearch",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "elasticsearch",
|
|
"description": [],
|
|
"signature": [
|
|
"{ privileges?: { cluster?: string[] | undefined; } | undefined; } | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/package_policy.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-public.PackageAssetsExtension",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "PackageAssetsExtension",
|
|
"description": [
|
|
"Extension point registration contract for Integration details Assets view"
|
|
],
|
|
"path": "x-pack/plugins/fleet/public/types/ui_extensions.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-public.PackageAssetsExtension.package",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "package",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/public/types/ui_extensions.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-public.PackageAssetsExtension.view",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "view",
|
|
"description": [],
|
|
"signature": [
|
|
"\"package-detail-assets\""
|
|
],
|
|
"path": "x-pack/plugins/fleet/public/types/ui_extensions.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-public.PackageAssetsExtension.Component",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "Component",
|
|
"description": [],
|
|
"signature": [
|
|
"React.ExoticComponent<{ children?: React.ReactNode; } | React.RefAttributes<React.Component<{}, any, any>>> & { readonly _result: React.ComponentType<{}>; }"
|
|
],
|
|
"path": "x-pack/plugins/fleet/public/types/ui_extensions.ts",
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-public.PackageAssetsExtension.Component.$1",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "props",
|
|
"description": [],
|
|
"signature": [
|
|
"P"
|
|
],
|
|
"path": "node_modules/@types/react/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-public.PackageCustomExtension",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "PackageCustomExtension",
|
|
"description": [
|
|
"Extension point registration contract for Integration details Custom view"
|
|
],
|
|
"path": "x-pack/plugins/fleet/public/types/ui_extensions.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-public.PackageCustomExtension.package",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "package",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/public/types/ui_extensions.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-public.PackageCustomExtension.view",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "view",
|
|
"description": [],
|
|
"signature": [
|
|
"\"package-detail-custom\""
|
|
],
|
|
"path": "x-pack/plugins/fleet/public/types/ui_extensions.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-public.PackageCustomExtension.Component",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "Component",
|
|
"description": [],
|
|
"signature": [
|
|
"React.ExoticComponent<(",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "public",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-public.PackageCustomExtensionComponentProps",
|
|
"text": "PackageCustomExtensionComponentProps"
|
|
},
|
|
" & React.RefAttributes<React.Component<",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "public",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-public.PackageCustomExtensionComponentProps",
|
|
"text": "PackageCustomExtensionComponentProps"
|
|
},
|
|
", any, any>>) | React.PropsWithChildren<",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "public",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-public.PackageCustomExtensionComponentProps",
|
|
"text": "PackageCustomExtensionComponentProps"
|
|
},
|
|
">> & { readonly _result: React.ComponentType<",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "public",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-public.PackageCustomExtensionComponentProps",
|
|
"text": "PackageCustomExtensionComponentProps"
|
|
},
|
|
">; }"
|
|
],
|
|
"path": "x-pack/plugins/fleet/public/types/ui_extensions.ts",
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-public.PackageCustomExtension.Component.$1",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "props",
|
|
"description": [],
|
|
"signature": [
|
|
"P"
|
|
],
|
|
"path": "node_modules/@types/react/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-public.PackageCustomExtensionComponentProps",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "PackageCustomExtensionComponentProps",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/public/types/ui_extensions.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-public.PackageCustomExtensionComponentProps.pkgkey",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "pkgkey",
|
|
"description": [
|
|
"The package key value that should be used used for URLs"
|
|
],
|
|
"path": "x-pack/plugins/fleet/public/types/ui_extensions.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-public.PackageCustomExtensionComponentProps.packageInfo",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "packageInfo",
|
|
"description": [],
|
|
"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.Installing",
|
|
"text": "Installing"
|
|
},
|
|
"<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"
|
|
},
|
|
", ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.EpmPackageAdditions",
|
|
"text": "EpmPackageAdditions"
|
|
},
|
|
">> | ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.InstallFailed",
|
|
"text": "InstallFailed"
|
|
},
|
|
"<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.Installed",
|
|
"text": "Installed"
|
|
},
|
|
"<Merge<",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.ArchivePackage",
|
|
"text": "ArchivePackage"
|
|
},
|
|
", ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.EpmPackageAdditions",
|
|
"text": "EpmPackageAdditions"
|
|
},
|
|
">> | ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.Installing",
|
|
"text": "Installing"
|
|
},
|
|
"<Merge<",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.ArchivePackage",
|
|
"text": "ArchivePackage"
|
|
},
|
|
", ",
|
|
{
|
|
"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.ArchivePackage",
|
|
"text": "ArchivePackage"
|
|
},
|
|
", ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.EpmPackageAdditions",
|
|
"text": "EpmPackageAdditions"
|
|
},
|
|
">> | ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.InstallFailed",
|
|
"text": "InstallFailed"
|
|
},
|
|
"<Merge<",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.ArchivePackage",
|
|
"text": "ArchivePackage"
|
|
},
|
|
", ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.EpmPackageAdditions",
|
|
"text": "EpmPackageAdditions"
|
|
},
|
|
">>"
|
|
],
|
|
"path": "x-pack/plugins/fleet/public/types/ui_extensions.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-public.PackagePolicyCreateExtension",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "PackagePolicyCreateExtension",
|
|
"description": [
|
|
"Extension point registration contract for Integration Policy Create views"
|
|
],
|
|
"path": "x-pack/plugins/fleet/public/types/ui_extensions.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-public.PackagePolicyCreateExtension.package",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "package",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/public/types/ui_extensions.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-public.PackagePolicyCreateExtension.view",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "view",
|
|
"description": [],
|
|
"signature": [
|
|
"\"package-policy-create\""
|
|
],
|
|
"path": "x-pack/plugins/fleet/public/types/ui_extensions.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-public.PackagePolicyCreateExtension.Component",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "Component",
|
|
"description": [],
|
|
"signature": [
|
|
"React.ExoticComponent<(",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "public",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-public.PackagePolicyCreateExtensionComponentProps",
|
|
"text": "PackagePolicyCreateExtensionComponentProps"
|
|
},
|
|
" & React.RefAttributes<React.Component<",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "public",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-public.PackagePolicyCreateExtensionComponentProps",
|
|
"text": "PackagePolicyCreateExtensionComponentProps"
|
|
},
|
|
", any, any>>) | React.PropsWithChildren<",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "public",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-public.PackagePolicyCreateExtensionComponentProps",
|
|
"text": "PackagePolicyCreateExtensionComponentProps"
|
|
},
|
|
">> & { readonly _result: React.ComponentType<",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "public",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-public.PackagePolicyCreateExtensionComponentProps",
|
|
"text": "PackagePolicyCreateExtensionComponentProps"
|
|
},
|
|
">; }"
|
|
],
|
|
"path": "x-pack/plugins/fleet/public/types/ui_extensions.ts",
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-public.PackagePolicyCreateExtension.Component.$1",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "props",
|
|
"description": [],
|
|
"signature": [
|
|
"P"
|
|
],
|
|
"path": "node_modules/@types/react/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-public.PackagePolicyCreateExtensionComponentProps",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "PackagePolicyCreateExtensionComponentProps",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/public/types/ui_extensions.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-public.PackagePolicyCreateExtensionComponentProps.newPolicy",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "newPolicy",
|
|
"description": [
|
|
"The integration policy being created"
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.NewPackagePolicy",
|
|
"text": "NewPackagePolicy"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/fleet/public/types/ui_extensions.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-public.PackagePolicyCreateExtensionComponentProps.onChange",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"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"
|
|
],
|
|
"signature": [
|
|
"(opts: { isValid: boolean; updatedPolicy: ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.NewPackagePolicy",
|
|
"text": "NewPackagePolicy"
|
|
},
|
|
"; }) => void"
|
|
],
|
|
"path": "x-pack/plugins/fleet/public/types/ui_extensions.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-public.PackagePolicyCreateExtensionComponentProps.onChange.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "opts",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/public/types/ui_extensions.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-public.PackagePolicyCreateExtensionComponentProps.onChange.$1.isValid",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "isValid",
|
|
"description": [
|
|
"is current form state is valid"
|
|
],
|
|
"path": "x-pack/plugins/fleet/public/types/ui_extensions.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-public.PackagePolicyCreateExtensionComponentProps.onChange.$1.updatedPolicy",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "updatedPolicy",
|
|
"description": [
|
|
"The updated Integration Policy to be merged back and included in the API call"
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.NewPackagePolicy",
|
|
"text": "NewPackagePolicy"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/fleet/public/types/ui_extensions.ts",
|
|
"deprecated": false
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-public.PackagePolicyEditExtension",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "PackagePolicyEditExtension",
|
|
"description": [
|
|
"Extension point registration contract for Integration Policy Edit views"
|
|
],
|
|
"path": "x-pack/plugins/fleet/public/types/ui_extensions.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-public.PackagePolicyEditExtension.package",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "package",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/public/types/ui_extensions.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-public.PackagePolicyEditExtension.view",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "view",
|
|
"description": [],
|
|
"signature": [
|
|
"\"package-policy-edit\""
|
|
],
|
|
"path": "x-pack/plugins/fleet/public/types/ui_extensions.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-public.PackagePolicyEditExtension.useLatestPackageVersion",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "useLatestPackageVersion",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/public/types/ui_extensions.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-public.PackagePolicyEditExtension.Component",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "Component",
|
|
"description": [],
|
|
"signature": [
|
|
"React.ExoticComponent<(",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "public",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-public.PackagePolicyEditExtensionComponentProps",
|
|
"text": "PackagePolicyEditExtensionComponentProps"
|
|
},
|
|
" & React.RefAttributes<React.Component<",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "public",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-public.PackagePolicyEditExtensionComponentProps",
|
|
"text": "PackagePolicyEditExtensionComponentProps"
|
|
},
|
|
", any, any>>) | React.PropsWithChildren<",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "public",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-public.PackagePolicyEditExtensionComponentProps",
|
|
"text": "PackagePolicyEditExtensionComponentProps"
|
|
},
|
|
">> & { readonly _result: React.ComponentType<",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "public",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-public.PackagePolicyEditExtensionComponentProps",
|
|
"text": "PackagePolicyEditExtensionComponentProps"
|
|
},
|
|
">; }"
|
|
],
|
|
"path": "x-pack/plugins/fleet/public/types/ui_extensions.ts",
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-public.PackagePolicyEditExtension.Component.$1",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "props",
|
|
"description": [],
|
|
"signature": [
|
|
"P"
|
|
],
|
|
"path": "node_modules/@types/react/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-public.PackagePolicyEditExtensionComponentProps",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "PackagePolicyEditExtensionComponentProps",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/public/types/ui_extensions.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-public.PackagePolicyEditExtensionComponentProps.policy",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "policy",
|
|
"description": [
|
|
"The current integration policy being edited"
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.PackagePolicy",
|
|
"text": "PackagePolicy"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/fleet/public/types/ui_extensions.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-public.PackagePolicyEditExtensionComponentProps.newPolicy",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "newPolicy",
|
|
"description": [
|
|
"The new (updated) integration policy that will be saved"
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.NewPackagePolicy",
|
|
"text": "NewPackagePolicy"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/fleet/public/types/ui_extensions.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-public.PackagePolicyEditExtensionComponentProps.onChange",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"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."
|
|
],
|
|
"signature": [
|
|
"(opts: { isValid: boolean; updatedPolicy: Partial<",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.NewPackagePolicy",
|
|
"text": "NewPackagePolicy"
|
|
},
|
|
">; }) => void"
|
|
],
|
|
"path": "x-pack/plugins/fleet/public/types/ui_extensions.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-public.PackagePolicyEditExtensionComponentProps.onChange.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "opts",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/public/types/ui_extensions.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-public.PackagePolicyEditExtensionComponentProps.onChange.$1.isValid",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "isValid",
|
|
"description": [
|
|
"is current form state is valid"
|
|
],
|
|
"path": "x-pack/plugins/fleet/public/types/ui_extensions.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-public.PackagePolicyEditExtensionComponentProps.onChange.$1.updatedPolicy",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "updatedPolicy",
|
|
"description": [
|
|
"The updated Integration Policy to be merged back and included in the API call"
|
|
],
|
|
"signature": [
|
|
"{ name?: string | undefined; description?: string | undefined; namespace?: string | undefined; enabled?: boolean | undefined; policy_id?: string | undefined; output_id?: string | undefined; package?: ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.PackagePolicyPackage",
|
|
"text": "PackagePolicyPackage"
|
|
},
|
|
" | undefined; inputs?: ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.NewPackagePolicyInput",
|
|
"text": "NewPackagePolicyInput"
|
|
},
|
|
"[] | undefined; vars?: Record<string, ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.PackagePolicyConfigRecordEntry",
|
|
"text": "PackagePolicyConfigRecordEntry"
|
|
},
|
|
"> | undefined; elasticsearch?: { privileges?: { cluster?: string[] | undefined; } | undefined; } | undefined; }"
|
|
],
|
|
"path": "x-pack/plugins/fleet/public/types/ui_extensions.ts",
|
|
"deprecated": false
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-public.PackagePolicyEditTabsExtension",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "PackagePolicyEditTabsExtension",
|
|
"description": [
|
|
"Extension point registration contract for Integration Policy Edit tabs views"
|
|
],
|
|
"path": "x-pack/plugins/fleet/public/types/ui_extensions.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-public.PackagePolicyEditTabsExtension.package",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "package",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/public/types/ui_extensions.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-public.PackagePolicyEditTabsExtension.view",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "view",
|
|
"description": [],
|
|
"signature": [
|
|
"\"package-policy-edit-tabs\""
|
|
],
|
|
"path": "x-pack/plugins/fleet/public/types/ui_extensions.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-public.PackagePolicyEditTabsExtension.tabs",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "tabs",
|
|
"description": [],
|
|
"signature": [
|
|
"{ title: string; Component: React.LazyExoticComponent<React.ComponentType<",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "public",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-public.PackagePolicyEditExtensionComponentProps",
|
|
"text": "PackagePolicyEditExtensionComponentProps"
|
|
},
|
|
">>; }[]"
|
|
],
|
|
"path": "x-pack/plugins/fleet/public/types/ui_extensions.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-public.UIExtensionsStorage",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "UIExtensionsStorage",
|
|
"description": [
|
|
"Internal storage for registered UI Extension Points"
|
|
],
|
|
"path": "x-pack/plugins/fleet/public/types/ui_extensions.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-public.UIExtensionsStorage.Unnamed",
|
|
"type": "Any",
|
|
"tags": [],
|
|
"label": "Unnamed",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"path": "x-pack/plugins/fleet/public/types/ui_extensions.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"enums": [],
|
|
"misc": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-public.AnyIntraAppRouteState",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "AnyIntraAppRouteState",
|
|
"description": [
|
|
"\nAll possible Route states."
|
|
],
|
|
"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"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/fleet/public/types/intra_app_route_state.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-public.OnSaveQueryParamKeys",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "OnSaveQueryParamKeys",
|
|
"description": [
|
|
"\nSupported query parameters for CreatePackagePolicyRouteState"
|
|
],
|
|
"signature": [
|
|
"\"showAddAgentHelp\" | \"openEnrollmentFlyout\""
|
|
],
|
|
"path": "x-pack/plugins/fleet/public/types/intra_app_route_state.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-public.OnSaveQueryParamOpts",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "OnSaveQueryParamOpts",
|
|
"description": [
|
|
"\nQuery string parameter options for CreatePackagePolicyRouteState"
|
|
],
|
|
"signature": [
|
|
"boolean | { renameKey?: string | undefined; policyIdAsValue?: boolean | undefined; }"
|
|
],
|
|
"path": "x-pack/plugins/fleet/public/types/intra_app_route_state.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-public.PackageAssetsComponent",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "PackageAssetsComponent",
|
|
"description": [
|
|
"\nUI Component Extension for displaying custom views under the Assets tab for a given Integration"
|
|
],
|
|
"signature": [
|
|
"React.ComponentClass<{}, any> | React.FunctionComponent<{}>"
|
|
],
|
|
"path": "x-pack/plugins/fleet/public/types/ui_extensions.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-public.PackageCustomExtensionComponent",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "PackageCustomExtensionComponent",
|
|
"description": [
|
|
"\nUI Component Extension is used to display a Custom tab (and view) under a given Integration"
|
|
],
|
|
"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"
|
|
},
|
|
">"
|
|
],
|
|
"path": "x-pack/plugins/fleet/public/types/ui_extensions.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-public.PackagePolicyCreateExtensionComponent",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "PackagePolicyCreateExtensionComponent",
|
|
"description": [
|
|
"\nUI Component Extension is used on the pages displaying the ability to Create an\nIntegration Policy"
|
|
],
|
|
"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"
|
|
},
|
|
">"
|
|
],
|
|
"path": "x-pack/plugins/fleet/public/types/ui_extensions.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-public.PackagePolicyEditExtensionComponent",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "PackagePolicyEditExtensionComponent",
|
|
"description": [
|
|
"\nUI Component Extension is used on the pages displaying the ability to edit an\nIntegration Policy"
|
|
],
|
|
"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"
|
|
},
|
|
">"
|
|
],
|
|
"path": "x-pack/plugins/fleet/public/types/ui_extensions.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-public.UIExtensionPoint",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "UIExtensionPoint",
|
|
"description": [
|
|
"Fleet UI Extension Point"
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "public",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-public.PackagePolicyEditExtension",
|
|
"text": "PackagePolicyEditExtension"
|
|
},
|
|
" | ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "public",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-public.PackagePolicyEditTabsExtension",
|
|
"text": "PackagePolicyEditTabsExtension"
|
|
},
|
|
" | ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "public",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-public.PackageCustomExtension",
|
|
"text": "PackageCustomExtension"
|
|
},
|
|
" | ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "public",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-public.PackagePolicyCreateExtension",
|
|
"text": "PackagePolicyCreateExtension"
|
|
},
|
|
" | ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "public",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-public.PackageAssetsExtension",
|
|
"text": "PackageAssetsExtension"
|
|
},
|
|
" | ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "public",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-public.AgentEnrollmentFlyoutFinalStepExtension",
|
|
"text": "AgentEnrollmentFlyoutFinalStepExtension"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/fleet/public/types/ui_extensions.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-public.UIExtensionRegistrationCallback",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "UIExtensionRegistrationCallback",
|
|
"description": [
|
|
"Register a Fleet UI extension"
|
|
],
|
|
"signature": [
|
|
"(extensionPoint: ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "public",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-public.UIExtensionPoint",
|
|
"text": "UIExtensionPoint"
|
|
},
|
|
") => void"
|
|
],
|
|
"path": "x-pack/plugins/fleet/public/types/ui_extensions.ts",
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-public.UIExtensionRegistrationCallback.$1",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "extensionPoint",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "public",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-public.PackagePolicyEditExtension",
|
|
"text": "PackagePolicyEditExtension"
|
|
},
|
|
" | ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "public",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-public.PackagePolicyEditTabsExtension",
|
|
"text": "PackagePolicyEditTabsExtension"
|
|
},
|
|
" | ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "public",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-public.PackageCustomExtension",
|
|
"text": "PackageCustomExtension"
|
|
},
|
|
" | ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "public",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-public.PackagePolicyCreateExtension",
|
|
"text": "PackagePolicyCreateExtension"
|
|
},
|
|
" | ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "public",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-public.PackageAssetsExtension",
|
|
"text": "PackageAssetsExtension"
|
|
},
|
|
" | ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "public",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-public.AgentEnrollmentFlyoutFinalStepExtension",
|
|
"text": "AgentEnrollmentFlyoutFinalStepExtension"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/fleet/public/types/ui_extensions.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"objects": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-public.pagePathGetters",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "pagePathGetters",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/public/constants/page_paths.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-public.pagePathGetters.base",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "base",
|
|
"description": [],
|
|
"signature": [
|
|
"() => [string, string]"
|
|
],
|
|
"path": "x-pack/plugins/fleet/public/constants/page_paths.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-public.pagePathGetters.overview",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "overview",
|
|
"description": [],
|
|
"signature": [
|
|
"() => [string, string]"
|
|
],
|
|
"path": "x-pack/plugins/fleet/public/constants/page_paths.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-public.pagePathGetters.integrations",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "integrations",
|
|
"description": [],
|
|
"signature": [
|
|
"() => [string, string]"
|
|
],
|
|
"path": "x-pack/plugins/fleet/public/constants/page_paths.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-public.pagePathGetters.integrations_all",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "integrations_all",
|
|
"description": [],
|
|
"signature": [
|
|
"({ searchTerm, category }: { searchTerm?: string | undefined; category?: string | undefined; }) => [string, string]"
|
|
],
|
|
"path": "x-pack/plugins/fleet/public/constants/page_paths.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-public.pagePathGetters.integrations_all.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "{ searchTerm, category }",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/public/constants/page_paths.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-public.pagePathGetters.integrations_all.$1.searchTerm",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "searchTerm",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/public/constants/page_paths.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-public.pagePathGetters.integrations_all.$1.category",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "category",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/public/constants/page_paths.ts",
|
|
"deprecated": false
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-public.pagePathGetters.integrations_installed",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "integrations_installed",
|
|
"description": [],
|
|
"signature": [
|
|
"({ query, category }: { query?: string | undefined; category?: string | undefined; }) => [string, string]"
|
|
],
|
|
"path": "x-pack/plugins/fleet/public/constants/page_paths.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-public.pagePathGetters.integrations_installed.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "{ query, category }",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/public/constants/page_paths.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-public.pagePathGetters.integrations_installed.$1.query",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "query",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/public/constants/page_paths.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-public.pagePathGetters.integrations_installed.$1.category",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "category",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/public/constants/page_paths.ts",
|
|
"deprecated": false
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-public.pagePathGetters.integration_details_overview",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "integration_details_overview",
|
|
"description": [],
|
|
"signature": [
|
|
"({ pkgkey, integration }: ",
|
|
"DynamicPagePathValues",
|
|
") => [string, string]"
|
|
],
|
|
"path": "x-pack/plugins/fleet/public/constants/page_paths.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-public.pagePathGetters.integration_details_overview.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "{ pkgkey, integration }",
|
|
"description": [],
|
|
"signature": [
|
|
"DynamicPagePathValues"
|
|
],
|
|
"path": "x-pack/plugins/fleet/public/constants/page_paths.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-public.pagePathGetters.integration_details_policies",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "integration_details_policies",
|
|
"description": [],
|
|
"signature": [
|
|
"({ pkgkey, integration, addAgentToPolicyId }: ",
|
|
"DynamicPagePathValues",
|
|
") => [string, string]"
|
|
],
|
|
"path": "x-pack/plugins/fleet/public/constants/page_paths.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-public.pagePathGetters.integration_details_policies.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "{ pkgkey, integration, addAgentToPolicyId }",
|
|
"description": [],
|
|
"signature": [
|
|
"DynamicPagePathValues"
|
|
],
|
|
"path": "x-pack/plugins/fleet/public/constants/page_paths.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-public.pagePathGetters.integration_details_assets",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "integration_details_assets",
|
|
"description": [],
|
|
"signature": [
|
|
"({ pkgkey, integration }: ",
|
|
"DynamicPagePathValues",
|
|
") => [string, string]"
|
|
],
|
|
"path": "x-pack/plugins/fleet/public/constants/page_paths.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-public.pagePathGetters.integration_details_assets.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "{ pkgkey, integration }",
|
|
"description": [],
|
|
"signature": [
|
|
"DynamicPagePathValues"
|
|
],
|
|
"path": "x-pack/plugins/fleet/public/constants/page_paths.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-public.pagePathGetters.integration_details_settings",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "integration_details_settings",
|
|
"description": [],
|
|
"signature": [
|
|
"({ pkgkey, integration }: ",
|
|
"DynamicPagePathValues",
|
|
") => [string, string]"
|
|
],
|
|
"path": "x-pack/plugins/fleet/public/constants/page_paths.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-public.pagePathGetters.integration_details_settings.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "{ pkgkey, integration }",
|
|
"description": [],
|
|
"signature": [
|
|
"DynamicPagePathValues"
|
|
],
|
|
"path": "x-pack/plugins/fleet/public/constants/page_paths.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-public.pagePathGetters.integration_details_custom",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "integration_details_custom",
|
|
"description": [],
|
|
"signature": [
|
|
"({ pkgkey, integration }: ",
|
|
"DynamicPagePathValues",
|
|
") => [string, string]"
|
|
],
|
|
"path": "x-pack/plugins/fleet/public/constants/page_paths.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-public.pagePathGetters.integration_details_custom.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "{ pkgkey, integration }",
|
|
"description": [],
|
|
"signature": [
|
|
"DynamicPagePathValues"
|
|
],
|
|
"path": "x-pack/plugins/fleet/public/constants/page_paths.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-public.pagePathGetters.integration_policy_edit",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "integration_policy_edit",
|
|
"description": [],
|
|
"signature": [
|
|
"({ packagePolicyId }: ",
|
|
"DynamicPagePathValues",
|
|
") => [string, string]"
|
|
],
|
|
"path": "x-pack/plugins/fleet/public/constants/page_paths.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-public.pagePathGetters.integration_policy_edit.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "{ packagePolicyId }",
|
|
"description": [],
|
|
"signature": [
|
|
"DynamicPagePathValues"
|
|
],
|
|
"path": "x-pack/plugins/fleet/public/constants/page_paths.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-public.pagePathGetters.policies",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "policies",
|
|
"description": [],
|
|
"signature": [
|
|
"() => [string, string]"
|
|
],
|
|
"path": "x-pack/plugins/fleet/public/constants/page_paths.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-public.pagePathGetters.policies_list",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "policies_list",
|
|
"description": [],
|
|
"signature": [
|
|
"() => [string, string]"
|
|
],
|
|
"path": "x-pack/plugins/fleet/public/constants/page_paths.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-public.pagePathGetters.policy_details",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "policy_details",
|
|
"description": [],
|
|
"signature": [
|
|
"({ policyId, tabId }: ",
|
|
"DynamicPagePathValues",
|
|
") => [string, string]"
|
|
],
|
|
"path": "x-pack/plugins/fleet/public/constants/page_paths.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-public.pagePathGetters.policy_details.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "{ policyId, tabId }",
|
|
"description": [],
|
|
"signature": [
|
|
"DynamicPagePathValues"
|
|
],
|
|
"path": "x-pack/plugins/fleet/public/constants/page_paths.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-public.pagePathGetters.add_integration_to_policy",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "add_integration_to_policy",
|
|
"description": [],
|
|
"signature": [
|
|
"({ pkgkey, integration, agentPolicyId }: ",
|
|
"DynamicPagePathValues",
|
|
") => [string, string]"
|
|
],
|
|
"path": "x-pack/plugins/fleet/public/constants/page_paths.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-public.pagePathGetters.add_integration_to_policy.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "{ pkgkey, integration, agentPolicyId }",
|
|
"description": [],
|
|
"signature": [
|
|
"DynamicPagePathValues"
|
|
],
|
|
"path": "x-pack/plugins/fleet/public/constants/page_paths.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-public.pagePathGetters.edit_integration",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "edit_integration",
|
|
"description": [],
|
|
"signature": [
|
|
"({ policyId, packagePolicyId }: ",
|
|
"DynamicPagePathValues",
|
|
") => [string, string]"
|
|
],
|
|
"path": "x-pack/plugins/fleet/public/constants/page_paths.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-public.pagePathGetters.edit_integration.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "{ policyId, packagePolicyId }",
|
|
"description": [],
|
|
"signature": [
|
|
"DynamicPagePathValues"
|
|
],
|
|
"path": "x-pack/plugins/fleet/public/constants/page_paths.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-public.pagePathGetters.upgrade_package_policy",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "upgrade_package_policy",
|
|
"description": [],
|
|
"signature": [
|
|
"({ policyId, packagePolicyId }: ",
|
|
"DynamicPagePathValues",
|
|
") => [string, string]"
|
|
],
|
|
"path": "x-pack/plugins/fleet/public/constants/page_paths.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-public.pagePathGetters.upgrade_package_policy.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "{ policyId, packagePolicyId }",
|
|
"description": [],
|
|
"signature": [
|
|
"DynamicPagePathValues"
|
|
],
|
|
"path": "x-pack/plugins/fleet/public/constants/page_paths.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-public.pagePathGetters.agent_list",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "agent_list",
|
|
"description": [],
|
|
"signature": [
|
|
"({ kuery }: ",
|
|
"DynamicPagePathValues",
|
|
") => [string, string]"
|
|
],
|
|
"path": "x-pack/plugins/fleet/public/constants/page_paths.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-public.pagePathGetters.agent_list.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "{ kuery }",
|
|
"description": [],
|
|
"signature": [
|
|
"DynamicPagePathValues"
|
|
],
|
|
"path": "x-pack/plugins/fleet/public/constants/page_paths.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-public.pagePathGetters.agent_details",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "agent_details",
|
|
"description": [],
|
|
"signature": [
|
|
"({ agentId, tabId, logQuery }: ",
|
|
"DynamicPagePathValues",
|
|
") => [string, string]"
|
|
],
|
|
"path": "x-pack/plugins/fleet/public/constants/page_paths.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-public.pagePathGetters.agent_details.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "{ agentId, tabId, logQuery }",
|
|
"description": [],
|
|
"signature": [
|
|
"DynamicPagePathValues"
|
|
],
|
|
"path": "x-pack/plugins/fleet/public/constants/page_paths.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-public.pagePathGetters.agent_details_logs",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "agent_details_logs",
|
|
"description": [],
|
|
"signature": [
|
|
"({ agentId }: ",
|
|
"DynamicPagePathValues",
|
|
") => [string, string]"
|
|
],
|
|
"path": "x-pack/plugins/fleet/public/constants/page_paths.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-public.pagePathGetters.agent_details_logs.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "{ agentId }",
|
|
"description": [],
|
|
"signature": [
|
|
"DynamicPagePathValues"
|
|
],
|
|
"path": "x-pack/plugins/fleet/public/constants/page_paths.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-public.pagePathGetters.enrollment_tokens",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "enrollment_tokens",
|
|
"description": [],
|
|
"signature": [
|
|
"() => [string, string]"
|
|
],
|
|
"path": "x-pack/plugins/fleet/public/constants/page_paths.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-public.pagePathGetters.data_streams",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "data_streams",
|
|
"description": [],
|
|
"signature": [
|
|
"() => [string, string]"
|
|
],
|
|
"path": "x-pack/plugins/fleet/public/constants/page_paths.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"setup": {
|
|
"parentPluginId": "fleet",
|
|
"id": "def-public.FleetSetup",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "FleetSetup",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/public/plugin.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"lifecycle": "setup",
|
|
"initialIsOpen": true
|
|
},
|
|
"start": {
|
|
"parentPluginId": "fleet",
|
|
"id": "def-public.FleetStart",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "FleetStart",
|
|
"description": [
|
|
"\nDescribes public Fleet plugin contract returned at the `start` stage."
|
|
],
|
|
"path": "x-pack/plugins/fleet/public/plugin.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-public.FleetStart.registerExtension",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "registerExtension",
|
|
"description": [],
|
|
"signature": [
|
|
"(extensionPoint: ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "public",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-public.UIExtensionPoint",
|
|
"text": "UIExtensionPoint"
|
|
},
|
|
") => void"
|
|
],
|
|
"path": "x-pack/plugins/fleet/public/plugin.ts",
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-public.FleetStart.registerExtension.$1",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "extensionPoint",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "public",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-public.PackagePolicyEditExtension",
|
|
"text": "PackagePolicyEditExtension"
|
|
},
|
|
" | ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "public",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-public.PackagePolicyEditTabsExtension",
|
|
"text": "PackagePolicyEditTabsExtension"
|
|
},
|
|
" | ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "public",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-public.PackageCustomExtension",
|
|
"text": "PackageCustomExtension"
|
|
},
|
|
" | ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "public",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-public.PackagePolicyCreateExtension",
|
|
"text": "PackagePolicyCreateExtension"
|
|
},
|
|
" | ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "public",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-public.PackageAssetsExtension",
|
|
"text": "PackageAssetsExtension"
|
|
},
|
|
" | ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "public",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-public.AgentEnrollmentFlyoutFinalStepExtension",
|
|
"text": "AgentEnrollmentFlyoutFinalStepExtension"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/fleet/public/types/ui_extensions.ts",
|
|
"deprecated": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-public.FleetStart.isInitialized",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "isInitialized",
|
|
"description": [],
|
|
"signature": [
|
|
"() => Promise<true>"
|
|
],
|
|
"path": "x-pack/plugins/fleet/public/plugin.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"lifecycle": "start",
|
|
"initialIsOpen": true
|
|
}
|
|
},
|
|
"server": {
|
|
"classes": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"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"
|
|
],
|
|
"path": "x-pack/plugins/fleet/server/errors/index.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"functions": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-server.getRegistryUrl",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getRegistryUrl",
|
|
"description": [],
|
|
"signature": [
|
|
"() => string"
|
|
],
|
|
"path": "x-pack/plugins/fleet/server/services/epm/registry/registry_url.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-server.relativeDownloadUrlFromArtifact",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "relativeDownloadUrlFromArtifact",
|
|
"description": [],
|
|
"signature": [
|
|
"<T extends Pick<",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "server",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-server.Artifact",
|
|
"text": "Artifact"
|
|
},
|
|
", \"decodedSha256\" | \"identifier\">>({ identifier, decodedSha256, }: T) => string"
|
|
],
|
|
"path": "x-pack/plugins/fleet/server/services/artifacts/mappings.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-server.relativeDownloadUrlFromArtifact.$1",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "{\n identifier,\n decodedSha256,\n}",
|
|
"description": [],
|
|
"signature": [
|
|
"T"
|
|
],
|
|
"path": "x-pack/plugins/fleet/server/services/artifacts/mappings.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"interfaces": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-server.AgentPolicyServiceInterface",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "AgentPolicyServiceInterface",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/server/services/index.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-server.AgentPolicyServiceInterface.get",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "get",
|
|
"description": [],
|
|
"signature": [
|
|
"(soClient: Pick<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsClient",
|
|
"text": "SavedObjectsClient"
|
|
},
|
|
", \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"delete\" | \"find\" | \"bulkGet\" | \"bulkResolve\" | \"get\" | \"resolve\" | \"update\" | \"collectMultiNamespaceReferences\" | \"updateObjectsSpaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\" | \"errors\">, id: string, withPackagePolicies?: boolean) => Promise<",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.AgentPolicy",
|
|
"text": "AgentPolicy"
|
|
},
|
|
" | null>"
|
|
],
|
|
"path": "x-pack/plugins/fleet/server/services/index.ts",
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-server.AgentPolicyServiceInterface.get.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "soClient",
|
|
"description": [],
|
|
"signature": [
|
|
"{ create: <T = unknown>(type: string, attributes: T, options?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsCreateOptions",
|
|
"text": "SavedObjectsCreateOptions"
|
|
},
|
|
" | undefined) => Promise<",
|
|
"SavedObject",
|
|
"<T>>; bulkCreate: <T = unknown>(objects: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsBulkCreateObject",
|
|
"text": "SavedObjectsBulkCreateObject"
|
|
},
|
|
"<T>[], options?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsCreateOptions",
|
|
"text": "SavedObjectsCreateOptions"
|
|
},
|
|
" | undefined) => Promise<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsBulkResponse",
|
|
"text": "SavedObjectsBulkResponse"
|
|
},
|
|
"<T>>; checkConflicts: (objects?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsCheckConflictsObject",
|
|
"text": "SavedObjectsCheckConflictsObject"
|
|
},
|
|
"[], options?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsBaseOptions",
|
|
"text": "SavedObjectsBaseOptions"
|
|
},
|
|
") => Promise<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsCheckConflictsResponse",
|
|
"text": "SavedObjectsCheckConflictsResponse"
|
|
},
|
|
">; delete: (type: string, id: string, options?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsDeleteOptions",
|
|
"text": "SavedObjectsDeleteOptions"
|
|
},
|
|
") => Promise<{}>; find: <T = unknown, A = unknown>(options: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsFindOptions",
|
|
"text": "SavedObjectsFindOptions"
|
|
},
|
|
") => Promise<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsFindResponse",
|
|
"text": "SavedObjectsFindResponse"
|
|
},
|
|
"<T, A>>; bulkGet: <T = unknown>(objects?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsBulkGetObject",
|
|
"text": "SavedObjectsBulkGetObject"
|
|
},
|
|
"[], options?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsBaseOptions",
|
|
"text": "SavedObjectsBaseOptions"
|
|
},
|
|
") => Promise<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsBulkResponse",
|
|
"text": "SavedObjectsBulkResponse"
|
|
},
|
|
"<T>>; bulkResolve: <T = unknown>(objects: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsBulkResolveObject",
|
|
"text": "SavedObjectsBulkResolveObject"
|
|
},
|
|
"[], options?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsBaseOptions",
|
|
"text": "SavedObjectsBaseOptions"
|
|
},
|
|
" | undefined) => Promise<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsBulkResolveResponse",
|
|
"text": "SavedObjectsBulkResolveResponse"
|
|
},
|
|
"<T>>; get: <T = unknown>(type: string, id: string, options?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsBaseOptions",
|
|
"text": "SavedObjectsBaseOptions"
|
|
},
|
|
") => Promise<",
|
|
"SavedObject",
|
|
"<T>>; resolve: <T = unknown>(type: string, id: string, options?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsBaseOptions",
|
|
"text": "SavedObjectsBaseOptions"
|
|
},
|
|
") => Promise<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsResolveResponse",
|
|
"text": "SavedObjectsResolveResponse"
|
|
},
|
|
"<T>>; update: <T = unknown>(type: string, id: string, attributes: Partial<T>, options?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsUpdateOptions",
|
|
"text": "SavedObjectsUpdateOptions"
|
|
},
|
|
"<T>) => Promise<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsUpdateResponse",
|
|
"text": "SavedObjectsUpdateResponse"
|
|
},
|
|
"<T>>; collectMultiNamespaceReferences: (objects: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsCollectMultiNamespaceReferencesObject",
|
|
"text": "SavedObjectsCollectMultiNamespaceReferencesObject"
|
|
},
|
|
"[], options?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsCollectMultiNamespaceReferencesOptions",
|
|
"text": "SavedObjectsCollectMultiNamespaceReferencesOptions"
|
|
},
|
|
" | undefined) => Promise<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsCollectMultiNamespaceReferencesResponse",
|
|
"text": "SavedObjectsCollectMultiNamespaceReferencesResponse"
|
|
},
|
|
">; updateObjectsSpaces: (objects: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsUpdateObjectsSpacesObject",
|
|
"text": "SavedObjectsUpdateObjectsSpacesObject"
|
|
},
|
|
"[], spacesToAdd: string[], spacesToRemove: string[], options?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsUpdateObjectsSpacesOptions",
|
|
"text": "SavedObjectsUpdateObjectsSpacesOptions"
|
|
},
|
|
" | undefined) => Promise<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsUpdateObjectsSpacesResponse",
|
|
"text": "SavedObjectsUpdateObjectsSpacesResponse"
|
|
},
|
|
">; bulkUpdate: <T = unknown>(objects: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsBulkUpdateObject",
|
|
"text": "SavedObjectsBulkUpdateObject"
|
|
},
|
|
"<T>[], options?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsBulkUpdateOptions",
|
|
"text": "SavedObjectsBulkUpdateOptions"
|
|
},
|
|
" | undefined) => Promise<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsBulkUpdateResponse",
|
|
"text": "SavedObjectsBulkUpdateResponse"
|
|
},
|
|
"<T>>; removeReferencesTo: (type: string, id: string, options?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsRemoveReferencesToOptions",
|
|
"text": "SavedObjectsRemoveReferencesToOptions"
|
|
},
|
|
" | undefined) => Promise<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsRemoveReferencesToResponse",
|
|
"text": "SavedObjectsRemoveReferencesToResponse"
|
|
},
|
|
">; openPointInTimeForType: (type: string | string[], options?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsOpenPointInTimeOptions",
|
|
"text": "SavedObjectsOpenPointInTimeOptions"
|
|
},
|
|
") => Promise<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsOpenPointInTimeResponse",
|
|
"text": "SavedObjectsOpenPointInTimeResponse"
|
|
},
|
|
">; closePointInTime: (id: string, options?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsBaseOptions",
|
|
"text": "SavedObjectsBaseOptions"
|
|
},
|
|
" | undefined) => Promise<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsClosePointInTimeResponse",
|
|
"text": "SavedObjectsClosePointInTimeResponse"
|
|
},
|
|
">; createPointInTimeFinder: <T = unknown, A = unknown>(findOptions: Pick<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsFindOptions",
|
|
"text": "SavedObjectsFindOptions"
|
|
},
|
|
", \"type\" | \"filter\" | \"aggs\" | \"fields\" | \"perPage\" | \"sortField\" | \"sortOrder\" | \"search\" | \"searchFields\" | \"rootSearchFields\" | \"hasReference\" | \"hasReferenceOperator\" | \"defaultSearchOperator\" | \"namespaces\" | \"typeToNamespacesMap\" | \"preference\">, dependencies?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsCreatePointInTimeFinderDependencies",
|
|
"text": "SavedObjectsCreatePointInTimeFinderDependencies"
|
|
},
|
|
" | undefined) => ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.ISavedObjectsPointInTimeFinder",
|
|
"text": "ISavedObjectsPointInTimeFinder"
|
|
},
|
|
"<T, A>; errors: typeof ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsErrorHelpers",
|
|
"text": "SavedObjectsErrorHelpers"
|
|
},
|
|
"; }"
|
|
],
|
|
"path": "x-pack/plugins/fleet/server/services/agent_policy.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-server.AgentPolicyServiceInterface.get.$2",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/server/services/agent_policy.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-server.AgentPolicyServiceInterface.get.$3",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "withPackagePolicies",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/server/services/agent_policy.ts",
|
|
"deprecated": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-server.AgentPolicyServiceInterface.list",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "list",
|
|
"description": [],
|
|
"signature": [
|
|
"(soClient: Pick<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsClient",
|
|
"text": "SavedObjectsClient"
|
|
},
|
|
", \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"delete\" | \"find\" | \"bulkGet\" | \"bulkResolve\" | \"get\" | \"resolve\" | \"update\" | \"collectMultiNamespaceReferences\" | \"updateObjectsSpaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\" | \"errors\">, 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; }>"
|
|
],
|
|
"path": "x-pack/plugins/fleet/server/services/index.ts",
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-server.AgentPolicyServiceInterface.list.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "soClient",
|
|
"description": [],
|
|
"signature": [
|
|
"{ create: <T = unknown>(type: string, attributes: T, options?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsCreateOptions",
|
|
"text": "SavedObjectsCreateOptions"
|
|
},
|
|
" | undefined) => Promise<",
|
|
"SavedObject",
|
|
"<T>>; bulkCreate: <T = unknown>(objects: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsBulkCreateObject",
|
|
"text": "SavedObjectsBulkCreateObject"
|
|
},
|
|
"<T>[], options?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsCreateOptions",
|
|
"text": "SavedObjectsCreateOptions"
|
|
},
|
|
" | undefined) => Promise<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsBulkResponse",
|
|
"text": "SavedObjectsBulkResponse"
|
|
},
|
|
"<T>>; checkConflicts: (objects?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsCheckConflictsObject",
|
|
"text": "SavedObjectsCheckConflictsObject"
|
|
},
|
|
"[], options?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsBaseOptions",
|
|
"text": "SavedObjectsBaseOptions"
|
|
},
|
|
") => Promise<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsCheckConflictsResponse",
|
|
"text": "SavedObjectsCheckConflictsResponse"
|
|
},
|
|
">; delete: (type: string, id: string, options?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsDeleteOptions",
|
|
"text": "SavedObjectsDeleteOptions"
|
|
},
|
|
") => Promise<{}>; find: <T = unknown, A = unknown>(options: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsFindOptions",
|
|
"text": "SavedObjectsFindOptions"
|
|
},
|
|
") => Promise<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsFindResponse",
|
|
"text": "SavedObjectsFindResponse"
|
|
},
|
|
"<T, A>>; bulkGet: <T = unknown>(objects?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsBulkGetObject",
|
|
"text": "SavedObjectsBulkGetObject"
|
|
},
|
|
"[], options?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsBaseOptions",
|
|
"text": "SavedObjectsBaseOptions"
|
|
},
|
|
") => Promise<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsBulkResponse",
|
|
"text": "SavedObjectsBulkResponse"
|
|
},
|
|
"<T>>; bulkResolve: <T = unknown>(objects: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsBulkResolveObject",
|
|
"text": "SavedObjectsBulkResolveObject"
|
|
},
|
|
"[], options?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsBaseOptions",
|
|
"text": "SavedObjectsBaseOptions"
|
|
},
|
|
" | undefined) => Promise<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsBulkResolveResponse",
|
|
"text": "SavedObjectsBulkResolveResponse"
|
|
},
|
|
"<T>>; get: <T = unknown>(type: string, id: string, options?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsBaseOptions",
|
|
"text": "SavedObjectsBaseOptions"
|
|
},
|
|
") => Promise<",
|
|
"SavedObject",
|
|
"<T>>; resolve: <T = unknown>(type: string, id: string, options?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsBaseOptions",
|
|
"text": "SavedObjectsBaseOptions"
|
|
},
|
|
") => Promise<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsResolveResponse",
|
|
"text": "SavedObjectsResolveResponse"
|
|
},
|
|
"<T>>; update: <T = unknown>(type: string, id: string, attributes: Partial<T>, options?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsUpdateOptions",
|
|
"text": "SavedObjectsUpdateOptions"
|
|
},
|
|
"<T>) => Promise<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsUpdateResponse",
|
|
"text": "SavedObjectsUpdateResponse"
|
|
},
|
|
"<T>>; collectMultiNamespaceReferences: (objects: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsCollectMultiNamespaceReferencesObject",
|
|
"text": "SavedObjectsCollectMultiNamespaceReferencesObject"
|
|
},
|
|
"[], options?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsCollectMultiNamespaceReferencesOptions",
|
|
"text": "SavedObjectsCollectMultiNamespaceReferencesOptions"
|
|
},
|
|
" | undefined) => Promise<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsCollectMultiNamespaceReferencesResponse",
|
|
"text": "SavedObjectsCollectMultiNamespaceReferencesResponse"
|
|
},
|
|
">; updateObjectsSpaces: (objects: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsUpdateObjectsSpacesObject",
|
|
"text": "SavedObjectsUpdateObjectsSpacesObject"
|
|
},
|
|
"[], spacesToAdd: string[], spacesToRemove: string[], options?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsUpdateObjectsSpacesOptions",
|
|
"text": "SavedObjectsUpdateObjectsSpacesOptions"
|
|
},
|
|
" | undefined) => Promise<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsUpdateObjectsSpacesResponse",
|
|
"text": "SavedObjectsUpdateObjectsSpacesResponse"
|
|
},
|
|
">; bulkUpdate: <T = unknown>(objects: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsBulkUpdateObject",
|
|
"text": "SavedObjectsBulkUpdateObject"
|
|
},
|
|
"<T>[], options?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsBulkUpdateOptions",
|
|
"text": "SavedObjectsBulkUpdateOptions"
|
|
},
|
|
" | undefined) => Promise<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsBulkUpdateResponse",
|
|
"text": "SavedObjectsBulkUpdateResponse"
|
|
},
|
|
"<T>>; removeReferencesTo: (type: string, id: string, options?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsRemoveReferencesToOptions",
|
|
"text": "SavedObjectsRemoveReferencesToOptions"
|
|
},
|
|
" | undefined) => Promise<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsRemoveReferencesToResponse",
|
|
"text": "SavedObjectsRemoveReferencesToResponse"
|
|
},
|
|
">; openPointInTimeForType: (type: string | string[], options?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsOpenPointInTimeOptions",
|
|
"text": "SavedObjectsOpenPointInTimeOptions"
|
|
},
|
|
") => Promise<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsOpenPointInTimeResponse",
|
|
"text": "SavedObjectsOpenPointInTimeResponse"
|
|
},
|
|
">; closePointInTime: (id: string, options?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsBaseOptions",
|
|
"text": "SavedObjectsBaseOptions"
|
|
},
|
|
" | undefined) => Promise<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsClosePointInTimeResponse",
|
|
"text": "SavedObjectsClosePointInTimeResponse"
|
|
},
|
|
">; createPointInTimeFinder: <T = unknown, A = unknown>(findOptions: Pick<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsFindOptions",
|
|
"text": "SavedObjectsFindOptions"
|
|
},
|
|
", \"type\" | \"filter\" | \"aggs\" | \"fields\" | \"perPage\" | \"sortField\" | \"sortOrder\" | \"search\" | \"searchFields\" | \"rootSearchFields\" | \"hasReference\" | \"hasReferenceOperator\" | \"defaultSearchOperator\" | \"namespaces\" | \"typeToNamespacesMap\" | \"preference\">, dependencies?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsCreatePointInTimeFinderDependencies",
|
|
"text": "SavedObjectsCreatePointInTimeFinderDependencies"
|
|
},
|
|
" | undefined) => ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.ISavedObjectsPointInTimeFinder",
|
|
"text": "ISavedObjectsPointInTimeFinder"
|
|
},
|
|
"<T, A>; errors: typeof ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsErrorHelpers",
|
|
"text": "SavedObjectsErrorHelpers"
|
|
},
|
|
"; }"
|
|
],
|
|
"path": "x-pack/plugins/fleet/server/services/agent_policy.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-server.AgentPolicyServiceInterface.list.$2",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "options",
|
|
"description": [],
|
|
"signature": [
|
|
"Readonly<{ page?: number | undefined; perPage?: number | undefined; sortField?: string | undefined; sortOrder?: \"asc\" | \"desc\" | undefined; kuery?: any; showUpgradeable?: boolean | undefined; } & {}> & { withPackagePolicies?: boolean | undefined; }"
|
|
],
|
|
"path": "x-pack/plugins/fleet/server/services/agent_policy.ts",
|
|
"deprecated": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-server.AgentPolicyServiceInterface.getDefaultAgentPolicyId",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getDefaultAgentPolicyId",
|
|
"description": [],
|
|
"signature": [
|
|
"(soClient: Pick<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsClient",
|
|
"text": "SavedObjectsClient"
|
|
},
|
|
", \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"delete\" | \"find\" | \"bulkGet\" | \"bulkResolve\" | \"get\" | \"resolve\" | \"update\" | \"collectMultiNamespaceReferences\" | \"updateObjectsSpaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\" | \"errors\">) => Promise<string>"
|
|
],
|
|
"path": "x-pack/plugins/fleet/server/services/index.ts",
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-server.AgentPolicyServiceInterface.getDefaultAgentPolicyId.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "soClient",
|
|
"description": [],
|
|
"signature": [
|
|
"{ create: <T = unknown>(type: string, attributes: T, options?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsCreateOptions",
|
|
"text": "SavedObjectsCreateOptions"
|
|
},
|
|
" | undefined) => Promise<",
|
|
"SavedObject",
|
|
"<T>>; bulkCreate: <T = unknown>(objects: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsBulkCreateObject",
|
|
"text": "SavedObjectsBulkCreateObject"
|
|
},
|
|
"<T>[], options?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsCreateOptions",
|
|
"text": "SavedObjectsCreateOptions"
|
|
},
|
|
" | undefined) => Promise<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsBulkResponse",
|
|
"text": "SavedObjectsBulkResponse"
|
|
},
|
|
"<T>>; checkConflicts: (objects?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsCheckConflictsObject",
|
|
"text": "SavedObjectsCheckConflictsObject"
|
|
},
|
|
"[], options?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsBaseOptions",
|
|
"text": "SavedObjectsBaseOptions"
|
|
},
|
|
") => Promise<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsCheckConflictsResponse",
|
|
"text": "SavedObjectsCheckConflictsResponse"
|
|
},
|
|
">; delete: (type: string, id: string, options?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsDeleteOptions",
|
|
"text": "SavedObjectsDeleteOptions"
|
|
},
|
|
") => Promise<{}>; find: <T = unknown, A = unknown>(options: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsFindOptions",
|
|
"text": "SavedObjectsFindOptions"
|
|
},
|
|
") => Promise<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsFindResponse",
|
|
"text": "SavedObjectsFindResponse"
|
|
},
|
|
"<T, A>>; bulkGet: <T = unknown>(objects?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsBulkGetObject",
|
|
"text": "SavedObjectsBulkGetObject"
|
|
},
|
|
"[], options?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsBaseOptions",
|
|
"text": "SavedObjectsBaseOptions"
|
|
},
|
|
") => Promise<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsBulkResponse",
|
|
"text": "SavedObjectsBulkResponse"
|
|
},
|
|
"<T>>; bulkResolve: <T = unknown>(objects: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsBulkResolveObject",
|
|
"text": "SavedObjectsBulkResolveObject"
|
|
},
|
|
"[], options?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsBaseOptions",
|
|
"text": "SavedObjectsBaseOptions"
|
|
},
|
|
" | undefined) => Promise<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsBulkResolveResponse",
|
|
"text": "SavedObjectsBulkResolveResponse"
|
|
},
|
|
"<T>>; get: <T = unknown>(type: string, id: string, options?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsBaseOptions",
|
|
"text": "SavedObjectsBaseOptions"
|
|
},
|
|
") => Promise<",
|
|
"SavedObject",
|
|
"<T>>; resolve: <T = unknown>(type: string, id: string, options?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsBaseOptions",
|
|
"text": "SavedObjectsBaseOptions"
|
|
},
|
|
") => Promise<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsResolveResponse",
|
|
"text": "SavedObjectsResolveResponse"
|
|
},
|
|
"<T>>; update: <T = unknown>(type: string, id: string, attributes: Partial<T>, options?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsUpdateOptions",
|
|
"text": "SavedObjectsUpdateOptions"
|
|
},
|
|
"<T>) => Promise<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsUpdateResponse",
|
|
"text": "SavedObjectsUpdateResponse"
|
|
},
|
|
"<T>>; collectMultiNamespaceReferences: (objects: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsCollectMultiNamespaceReferencesObject",
|
|
"text": "SavedObjectsCollectMultiNamespaceReferencesObject"
|
|
},
|
|
"[], options?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsCollectMultiNamespaceReferencesOptions",
|
|
"text": "SavedObjectsCollectMultiNamespaceReferencesOptions"
|
|
},
|
|
" | undefined) => Promise<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsCollectMultiNamespaceReferencesResponse",
|
|
"text": "SavedObjectsCollectMultiNamespaceReferencesResponse"
|
|
},
|
|
">; updateObjectsSpaces: (objects: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsUpdateObjectsSpacesObject",
|
|
"text": "SavedObjectsUpdateObjectsSpacesObject"
|
|
},
|
|
"[], spacesToAdd: string[], spacesToRemove: string[], options?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsUpdateObjectsSpacesOptions",
|
|
"text": "SavedObjectsUpdateObjectsSpacesOptions"
|
|
},
|
|
" | undefined) => Promise<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsUpdateObjectsSpacesResponse",
|
|
"text": "SavedObjectsUpdateObjectsSpacesResponse"
|
|
},
|
|
">; bulkUpdate: <T = unknown>(objects: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsBulkUpdateObject",
|
|
"text": "SavedObjectsBulkUpdateObject"
|
|
},
|
|
"<T>[], options?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsBulkUpdateOptions",
|
|
"text": "SavedObjectsBulkUpdateOptions"
|
|
},
|
|
" | undefined) => Promise<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsBulkUpdateResponse",
|
|
"text": "SavedObjectsBulkUpdateResponse"
|
|
},
|
|
"<T>>; removeReferencesTo: (type: string, id: string, options?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsRemoveReferencesToOptions",
|
|
"text": "SavedObjectsRemoveReferencesToOptions"
|
|
},
|
|
" | undefined) => Promise<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsRemoveReferencesToResponse",
|
|
"text": "SavedObjectsRemoveReferencesToResponse"
|
|
},
|
|
">; openPointInTimeForType: (type: string | string[], options?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsOpenPointInTimeOptions",
|
|
"text": "SavedObjectsOpenPointInTimeOptions"
|
|
},
|
|
") => Promise<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsOpenPointInTimeResponse",
|
|
"text": "SavedObjectsOpenPointInTimeResponse"
|
|
},
|
|
">; closePointInTime: (id: string, options?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsBaseOptions",
|
|
"text": "SavedObjectsBaseOptions"
|
|
},
|
|
" | undefined) => Promise<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsClosePointInTimeResponse",
|
|
"text": "SavedObjectsClosePointInTimeResponse"
|
|
},
|
|
">; createPointInTimeFinder: <T = unknown, A = unknown>(findOptions: Pick<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsFindOptions",
|
|
"text": "SavedObjectsFindOptions"
|
|
},
|
|
", \"type\" | \"filter\" | \"aggs\" | \"fields\" | \"perPage\" | \"sortField\" | \"sortOrder\" | \"search\" | \"searchFields\" | \"rootSearchFields\" | \"hasReference\" | \"hasReferenceOperator\" | \"defaultSearchOperator\" | \"namespaces\" | \"typeToNamespacesMap\" | \"preference\">, dependencies?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsCreatePointInTimeFinderDependencies",
|
|
"text": "SavedObjectsCreatePointInTimeFinderDependencies"
|
|
},
|
|
" | undefined) => ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.ISavedObjectsPointInTimeFinder",
|
|
"text": "ISavedObjectsPointInTimeFinder"
|
|
},
|
|
"<T, A>; errors: typeof ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsErrorHelpers",
|
|
"text": "SavedObjectsErrorHelpers"
|
|
},
|
|
"; }"
|
|
],
|
|
"path": "x-pack/plugins/fleet/server/services/agent_policy.ts",
|
|
"deprecated": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-server.AgentPolicyServiceInterface.getFullAgentPolicy",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getFullAgentPolicy",
|
|
"description": [],
|
|
"signature": [
|
|
"(soClient: Pick<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsClient",
|
|
"text": "SavedObjectsClient"
|
|
},
|
|
", \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"delete\" | \"find\" | \"bulkGet\" | \"bulkResolve\" | \"get\" | \"resolve\" | \"update\" | \"collectMultiNamespaceReferences\" | \"updateObjectsSpaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\" | \"errors\">, id: string, options?: { standalone: boolean; } | undefined) => Promise<",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.FullAgentPolicy",
|
|
"text": "FullAgentPolicy"
|
|
},
|
|
" | null>"
|
|
],
|
|
"path": "x-pack/plugins/fleet/server/services/index.ts",
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-server.AgentPolicyServiceInterface.getFullAgentPolicy.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "soClient",
|
|
"description": [],
|
|
"signature": [
|
|
"{ create: <T = unknown>(type: string, attributes: T, options?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsCreateOptions",
|
|
"text": "SavedObjectsCreateOptions"
|
|
},
|
|
" | undefined) => Promise<",
|
|
"SavedObject",
|
|
"<T>>; bulkCreate: <T = unknown>(objects: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsBulkCreateObject",
|
|
"text": "SavedObjectsBulkCreateObject"
|
|
},
|
|
"<T>[], options?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsCreateOptions",
|
|
"text": "SavedObjectsCreateOptions"
|
|
},
|
|
" | undefined) => Promise<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsBulkResponse",
|
|
"text": "SavedObjectsBulkResponse"
|
|
},
|
|
"<T>>; checkConflicts: (objects?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsCheckConflictsObject",
|
|
"text": "SavedObjectsCheckConflictsObject"
|
|
},
|
|
"[], options?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsBaseOptions",
|
|
"text": "SavedObjectsBaseOptions"
|
|
},
|
|
") => Promise<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsCheckConflictsResponse",
|
|
"text": "SavedObjectsCheckConflictsResponse"
|
|
},
|
|
">; delete: (type: string, id: string, options?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsDeleteOptions",
|
|
"text": "SavedObjectsDeleteOptions"
|
|
},
|
|
") => Promise<{}>; find: <T = unknown, A = unknown>(options: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsFindOptions",
|
|
"text": "SavedObjectsFindOptions"
|
|
},
|
|
") => Promise<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsFindResponse",
|
|
"text": "SavedObjectsFindResponse"
|
|
},
|
|
"<T, A>>; bulkGet: <T = unknown>(objects?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsBulkGetObject",
|
|
"text": "SavedObjectsBulkGetObject"
|
|
},
|
|
"[], options?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsBaseOptions",
|
|
"text": "SavedObjectsBaseOptions"
|
|
},
|
|
") => Promise<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsBulkResponse",
|
|
"text": "SavedObjectsBulkResponse"
|
|
},
|
|
"<T>>; bulkResolve: <T = unknown>(objects: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsBulkResolveObject",
|
|
"text": "SavedObjectsBulkResolveObject"
|
|
},
|
|
"[], options?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsBaseOptions",
|
|
"text": "SavedObjectsBaseOptions"
|
|
},
|
|
" | undefined) => Promise<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsBulkResolveResponse",
|
|
"text": "SavedObjectsBulkResolveResponse"
|
|
},
|
|
"<T>>; get: <T = unknown>(type: string, id: string, options?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsBaseOptions",
|
|
"text": "SavedObjectsBaseOptions"
|
|
},
|
|
") => Promise<",
|
|
"SavedObject",
|
|
"<T>>; resolve: <T = unknown>(type: string, id: string, options?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsBaseOptions",
|
|
"text": "SavedObjectsBaseOptions"
|
|
},
|
|
") => Promise<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsResolveResponse",
|
|
"text": "SavedObjectsResolveResponse"
|
|
},
|
|
"<T>>; update: <T = unknown>(type: string, id: string, attributes: Partial<T>, options?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsUpdateOptions",
|
|
"text": "SavedObjectsUpdateOptions"
|
|
},
|
|
"<T>) => Promise<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsUpdateResponse",
|
|
"text": "SavedObjectsUpdateResponse"
|
|
},
|
|
"<T>>; collectMultiNamespaceReferences: (objects: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsCollectMultiNamespaceReferencesObject",
|
|
"text": "SavedObjectsCollectMultiNamespaceReferencesObject"
|
|
},
|
|
"[], options?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsCollectMultiNamespaceReferencesOptions",
|
|
"text": "SavedObjectsCollectMultiNamespaceReferencesOptions"
|
|
},
|
|
" | undefined) => Promise<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsCollectMultiNamespaceReferencesResponse",
|
|
"text": "SavedObjectsCollectMultiNamespaceReferencesResponse"
|
|
},
|
|
">; updateObjectsSpaces: (objects: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsUpdateObjectsSpacesObject",
|
|
"text": "SavedObjectsUpdateObjectsSpacesObject"
|
|
},
|
|
"[], spacesToAdd: string[], spacesToRemove: string[], options?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsUpdateObjectsSpacesOptions",
|
|
"text": "SavedObjectsUpdateObjectsSpacesOptions"
|
|
},
|
|
" | undefined) => Promise<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsUpdateObjectsSpacesResponse",
|
|
"text": "SavedObjectsUpdateObjectsSpacesResponse"
|
|
},
|
|
">; bulkUpdate: <T = unknown>(objects: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsBulkUpdateObject",
|
|
"text": "SavedObjectsBulkUpdateObject"
|
|
},
|
|
"<T>[], options?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsBulkUpdateOptions",
|
|
"text": "SavedObjectsBulkUpdateOptions"
|
|
},
|
|
" | undefined) => Promise<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsBulkUpdateResponse",
|
|
"text": "SavedObjectsBulkUpdateResponse"
|
|
},
|
|
"<T>>; removeReferencesTo: (type: string, id: string, options?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsRemoveReferencesToOptions",
|
|
"text": "SavedObjectsRemoveReferencesToOptions"
|
|
},
|
|
" | undefined) => Promise<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsRemoveReferencesToResponse",
|
|
"text": "SavedObjectsRemoveReferencesToResponse"
|
|
},
|
|
">; openPointInTimeForType: (type: string | string[], options?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsOpenPointInTimeOptions",
|
|
"text": "SavedObjectsOpenPointInTimeOptions"
|
|
},
|
|
") => Promise<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsOpenPointInTimeResponse",
|
|
"text": "SavedObjectsOpenPointInTimeResponse"
|
|
},
|
|
">; closePointInTime: (id: string, options?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsBaseOptions",
|
|
"text": "SavedObjectsBaseOptions"
|
|
},
|
|
" | undefined) => Promise<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsClosePointInTimeResponse",
|
|
"text": "SavedObjectsClosePointInTimeResponse"
|
|
},
|
|
">; createPointInTimeFinder: <T = unknown, A = unknown>(findOptions: Pick<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsFindOptions",
|
|
"text": "SavedObjectsFindOptions"
|
|
},
|
|
", \"type\" | \"filter\" | \"aggs\" | \"fields\" | \"perPage\" | \"sortField\" | \"sortOrder\" | \"search\" | \"searchFields\" | \"rootSearchFields\" | \"hasReference\" | \"hasReferenceOperator\" | \"defaultSearchOperator\" | \"namespaces\" | \"typeToNamespacesMap\" | \"preference\">, dependencies?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsCreatePointInTimeFinderDependencies",
|
|
"text": "SavedObjectsCreatePointInTimeFinderDependencies"
|
|
},
|
|
" | undefined) => ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.ISavedObjectsPointInTimeFinder",
|
|
"text": "ISavedObjectsPointInTimeFinder"
|
|
},
|
|
"<T, A>; errors: typeof ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsErrorHelpers",
|
|
"text": "SavedObjectsErrorHelpers"
|
|
},
|
|
"; }"
|
|
],
|
|
"path": "x-pack/plugins/fleet/server/services/agent_policy.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-server.AgentPolicyServiceInterface.getFullAgentPolicy.$2",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/server/services/agent_policy.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-server.AgentPolicyServiceInterface.getFullAgentPolicy.$3",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "options",
|
|
"description": [],
|
|
"signature": [
|
|
"{ standalone: boolean; } | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/server/services/agent_policy.ts",
|
|
"deprecated": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-server.AgentPolicyServiceInterface.getByIds",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getByIds",
|
|
"description": [],
|
|
"signature": [
|
|
"(soClient: Pick<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsClient",
|
|
"text": "SavedObjectsClient"
|
|
},
|
|
", \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"delete\" | \"find\" | \"bulkGet\" | \"bulkResolve\" | \"get\" | \"resolve\" | \"update\" | \"collectMultiNamespaceReferences\" | \"updateObjectsSpaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\" | \"errors\">, ids: string[], options?: { fields?: string[] | undefined; }) => Promise<",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.AgentPolicy",
|
|
"text": "AgentPolicy"
|
|
},
|
|
"[]>"
|
|
],
|
|
"path": "x-pack/plugins/fleet/server/services/index.ts",
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-server.AgentPolicyServiceInterface.getByIds.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "soClient",
|
|
"description": [],
|
|
"signature": [
|
|
"{ create: <T = unknown>(type: string, attributes: T, options?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsCreateOptions",
|
|
"text": "SavedObjectsCreateOptions"
|
|
},
|
|
" | undefined) => Promise<",
|
|
"SavedObject",
|
|
"<T>>; bulkCreate: <T = unknown>(objects: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsBulkCreateObject",
|
|
"text": "SavedObjectsBulkCreateObject"
|
|
},
|
|
"<T>[], options?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsCreateOptions",
|
|
"text": "SavedObjectsCreateOptions"
|
|
},
|
|
" | undefined) => Promise<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsBulkResponse",
|
|
"text": "SavedObjectsBulkResponse"
|
|
},
|
|
"<T>>; checkConflicts: (objects?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsCheckConflictsObject",
|
|
"text": "SavedObjectsCheckConflictsObject"
|
|
},
|
|
"[], options?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsBaseOptions",
|
|
"text": "SavedObjectsBaseOptions"
|
|
},
|
|
") => Promise<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsCheckConflictsResponse",
|
|
"text": "SavedObjectsCheckConflictsResponse"
|
|
},
|
|
">; delete: (type: string, id: string, options?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsDeleteOptions",
|
|
"text": "SavedObjectsDeleteOptions"
|
|
},
|
|
") => Promise<{}>; find: <T = unknown, A = unknown>(options: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsFindOptions",
|
|
"text": "SavedObjectsFindOptions"
|
|
},
|
|
") => Promise<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsFindResponse",
|
|
"text": "SavedObjectsFindResponse"
|
|
},
|
|
"<T, A>>; bulkGet: <T = unknown>(objects?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsBulkGetObject",
|
|
"text": "SavedObjectsBulkGetObject"
|
|
},
|
|
"[], options?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsBaseOptions",
|
|
"text": "SavedObjectsBaseOptions"
|
|
},
|
|
") => Promise<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsBulkResponse",
|
|
"text": "SavedObjectsBulkResponse"
|
|
},
|
|
"<T>>; bulkResolve: <T = unknown>(objects: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsBulkResolveObject",
|
|
"text": "SavedObjectsBulkResolveObject"
|
|
},
|
|
"[], options?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsBaseOptions",
|
|
"text": "SavedObjectsBaseOptions"
|
|
},
|
|
" | undefined) => Promise<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsBulkResolveResponse",
|
|
"text": "SavedObjectsBulkResolveResponse"
|
|
},
|
|
"<T>>; get: <T = unknown>(type: string, id: string, options?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsBaseOptions",
|
|
"text": "SavedObjectsBaseOptions"
|
|
},
|
|
") => Promise<",
|
|
"SavedObject",
|
|
"<T>>; resolve: <T = unknown>(type: string, id: string, options?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsBaseOptions",
|
|
"text": "SavedObjectsBaseOptions"
|
|
},
|
|
") => Promise<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsResolveResponse",
|
|
"text": "SavedObjectsResolveResponse"
|
|
},
|
|
"<T>>; update: <T = unknown>(type: string, id: string, attributes: Partial<T>, options?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsUpdateOptions",
|
|
"text": "SavedObjectsUpdateOptions"
|
|
},
|
|
"<T>) => Promise<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsUpdateResponse",
|
|
"text": "SavedObjectsUpdateResponse"
|
|
},
|
|
"<T>>; collectMultiNamespaceReferences: (objects: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsCollectMultiNamespaceReferencesObject",
|
|
"text": "SavedObjectsCollectMultiNamespaceReferencesObject"
|
|
},
|
|
"[], options?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsCollectMultiNamespaceReferencesOptions",
|
|
"text": "SavedObjectsCollectMultiNamespaceReferencesOptions"
|
|
},
|
|
" | undefined) => Promise<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsCollectMultiNamespaceReferencesResponse",
|
|
"text": "SavedObjectsCollectMultiNamespaceReferencesResponse"
|
|
},
|
|
">; updateObjectsSpaces: (objects: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsUpdateObjectsSpacesObject",
|
|
"text": "SavedObjectsUpdateObjectsSpacesObject"
|
|
},
|
|
"[], spacesToAdd: string[], spacesToRemove: string[], options?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsUpdateObjectsSpacesOptions",
|
|
"text": "SavedObjectsUpdateObjectsSpacesOptions"
|
|
},
|
|
" | undefined) => Promise<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsUpdateObjectsSpacesResponse",
|
|
"text": "SavedObjectsUpdateObjectsSpacesResponse"
|
|
},
|
|
">; bulkUpdate: <T = unknown>(objects: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsBulkUpdateObject",
|
|
"text": "SavedObjectsBulkUpdateObject"
|
|
},
|
|
"<T>[], options?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsBulkUpdateOptions",
|
|
"text": "SavedObjectsBulkUpdateOptions"
|
|
},
|
|
" | undefined) => Promise<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsBulkUpdateResponse",
|
|
"text": "SavedObjectsBulkUpdateResponse"
|
|
},
|
|
"<T>>; removeReferencesTo: (type: string, id: string, options?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsRemoveReferencesToOptions",
|
|
"text": "SavedObjectsRemoveReferencesToOptions"
|
|
},
|
|
" | undefined) => Promise<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsRemoveReferencesToResponse",
|
|
"text": "SavedObjectsRemoveReferencesToResponse"
|
|
},
|
|
">; openPointInTimeForType: (type: string | string[], options?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsOpenPointInTimeOptions",
|
|
"text": "SavedObjectsOpenPointInTimeOptions"
|
|
},
|
|
") => Promise<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsOpenPointInTimeResponse",
|
|
"text": "SavedObjectsOpenPointInTimeResponse"
|
|
},
|
|
">; closePointInTime: (id: string, options?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsBaseOptions",
|
|
"text": "SavedObjectsBaseOptions"
|
|
},
|
|
" | undefined) => Promise<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsClosePointInTimeResponse",
|
|
"text": "SavedObjectsClosePointInTimeResponse"
|
|
},
|
|
">; createPointInTimeFinder: <T = unknown, A = unknown>(findOptions: Pick<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsFindOptions",
|
|
"text": "SavedObjectsFindOptions"
|
|
},
|
|
", \"type\" | \"filter\" | \"aggs\" | \"fields\" | \"perPage\" | \"sortField\" | \"sortOrder\" | \"search\" | \"searchFields\" | \"rootSearchFields\" | \"hasReference\" | \"hasReferenceOperator\" | \"defaultSearchOperator\" | \"namespaces\" | \"typeToNamespacesMap\" | \"preference\">, dependencies?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsCreatePointInTimeFinderDependencies",
|
|
"text": "SavedObjectsCreatePointInTimeFinderDependencies"
|
|
},
|
|
" | undefined) => ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.ISavedObjectsPointInTimeFinder",
|
|
"text": "ISavedObjectsPointInTimeFinder"
|
|
},
|
|
"<T, A>; errors: typeof ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsErrorHelpers",
|
|
"text": "SavedObjectsErrorHelpers"
|
|
},
|
|
"; }"
|
|
],
|
|
"path": "x-pack/plugins/fleet/server/services/agent_policy.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-server.AgentPolicyServiceInterface.getByIds.$2",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "ids",
|
|
"description": [],
|
|
"signature": [
|
|
"string[]"
|
|
],
|
|
"path": "x-pack/plugins/fleet/server/services/agent_policy.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-server.AgentPolicyServiceInterface.getByIds.$3",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "options",
|
|
"description": [],
|
|
"signature": [
|
|
"{ fields?: string[] | undefined; }"
|
|
],
|
|
"path": "x-pack/plugins/fleet/server/services/agent_policy.ts",
|
|
"deprecated": false
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-server.AgentService",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "AgentService",
|
|
"description": [
|
|
"\nA service that provides exported functions that return information about an Agent"
|
|
],
|
|
"path": "x-pack/plugins/fleet/server/services/index.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-server.AgentService.getAgent",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getAgent",
|
|
"description": [
|
|
"\nGet an Agent by id"
|
|
],
|
|
"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.Agent",
|
|
"text": "Agent"
|
|
},
|
|
">"
|
|
],
|
|
"path": "x-pack/plugins/fleet/server/services/index.ts",
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-server.AgentService.getAgent.$1",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "esClient",
|
|
"description": [],
|
|
"signature": [
|
|
"Pick<",
|
|
"KibanaClient",
|
|
", \"monitoring\" | \"security\" | \"create\" | \"name\" | \"index\" | \"delete\" | \"get\" | \"update\" | \"closePointInTime\" | \"search\" | \"transform\" | \"eql\" | \"helpers\" | \"asyncSearch\" | \"autoscaling\" | \"bulk\" | \"cat\" | \"ccr\" | \"clearScroll\" | \"cluster\" | \"count\" | \"danglingIndices\" | \"deleteByQuery\" | \"deleteByQueryRethrottle\" | \"deleteScript\" | \"enrich\" | \"exists\" | \"existsSource\" | \"explain\" | \"features\" | \"fieldCaps\" | \"fleet\" | \"getScript\" | \"getScriptContext\" | \"getScriptLanguages\" | \"getSource\" | \"graph\" | \"ilm\" | \"indices\" | \"info\" | \"ingest\" | \"knnSearch\" | \"license\" | \"logstash\" | \"mget\" | \"migration\" | \"ml\" | \"msearch\" | \"msearchTemplate\" | \"mtermvectors\" | \"nodes\" | \"openPointInTime\" | \"ping\" | \"putScript\" | \"rankEval\" | \"reindex\" | \"reindexRethrottle\" | \"renderSearchTemplate\" | \"rollup\" | \"scriptsPainlessExecute\" | \"scroll\" | \"searchMvt\" | \"searchShards\" | \"searchTemplate\" | \"searchableSnapshots\" | \"shutdown\" | \"slm\" | \"snapshot\" | \"sql\" | \"ssl\" | \"tasks\" | \"termsEnum\" | \"termvectors\" | \"textStructure\" | \"updateByQuery\" | \"updateByQueryRethrottle\" | \"watcher\" | \"xpack\"> & { transport: { request<TResponse = unknown>(params: ",
|
|
"TransportRequestParams",
|
|
", options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<TResponse, unknown>>; }; }"
|
|
],
|
|
"path": "x-pack/plugins/fleet/server/services/agents/crud.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-server.AgentService.getAgent.$2",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "agentId",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/server/services/agents/crud.ts",
|
|
"deprecated": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-server.AgentService.getAgentStatusById",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getAgentStatusById",
|
|
"description": [
|
|
"\nReturn the status by the Agent's id"
|
|
],
|
|
"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"
|
|
},
|
|
">"
|
|
],
|
|
"path": "x-pack/plugins/fleet/server/services/index.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-server.AgentService.getAgentStatusById.$1",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "esClient",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-server.ElasticsearchClient",
|
|
"text": "ElasticsearchClient"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/fleet/server/services/index.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-server.AgentService.getAgentStatusById.$2",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "agentId",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "x-pack/plugins/fleet/server/services/index.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-server.AgentService.getAgentStatusForAgentPolicy",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getAgentStatusForAgentPolicy",
|
|
"description": [
|
|
"\nReturn the status by the Agent's Policy id"
|
|
],
|
|
"signature": [
|
|
"(esClient: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-server.ElasticsearchClient",
|
|
"text": "ElasticsearchClient"
|
|
},
|
|
", agentPolicyId?: string | undefined, filterKuery?: string | undefined) => Promise<{ events: number; total: number; online: number; error: number; offline: number; other: number; updating: number; }>"
|
|
],
|
|
"path": "x-pack/plugins/fleet/server/services/index.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-server.AgentService.getAgentStatusForAgentPolicy.$1",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "esClient",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-server.ElasticsearchClient",
|
|
"text": "ElasticsearchClient"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/fleet/server/services/index.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-server.AgentService.getAgentStatusForAgentPolicy.$2",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "agentPolicyId",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/server/services/index.ts",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-server.AgentService.getAgentStatusForAgentPolicy.$3",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "filterKuery",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/server/services/index.ts",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-server.AgentService.listAgents",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "listAgents",
|
|
"description": [
|
|
"\nList agents"
|
|
],
|
|
"signature": [
|
|
"(esClient: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-server.ElasticsearchClient",
|
|
"text": "ElasticsearchClient"
|
|
},
|
|
", options: Readonly<{ page?: number | undefined; perPage?: number | undefined; sortField?: string | undefined; sortOrder?: \"asc\" | \"desc\" | undefined; kuery?: any; showUpgradeable?: boolean | undefined; } & {}> & { showInactive: boolean; }) => Promise<{ agents: ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.Agent",
|
|
"text": "Agent"
|
|
},
|
|
"[]; total: number; page: number; perPage: number; }>"
|
|
],
|
|
"path": "x-pack/plugins/fleet/server/services/index.ts",
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-server.AgentService.listAgents.$1",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "esClient",
|
|
"description": [],
|
|
"signature": [
|
|
"Pick<",
|
|
"KibanaClient",
|
|
", \"monitoring\" | \"security\" | \"create\" | \"name\" | \"index\" | \"delete\" | \"get\" | \"update\" | \"closePointInTime\" | \"search\" | \"transform\" | \"eql\" | \"helpers\" | \"asyncSearch\" | \"autoscaling\" | \"bulk\" | \"cat\" | \"ccr\" | \"clearScroll\" | \"cluster\" | \"count\" | \"danglingIndices\" | \"deleteByQuery\" | \"deleteByQueryRethrottle\" | \"deleteScript\" | \"enrich\" | \"exists\" | \"existsSource\" | \"explain\" | \"features\" | \"fieldCaps\" | \"fleet\" | \"getScript\" | \"getScriptContext\" | \"getScriptLanguages\" | \"getSource\" | \"graph\" | \"ilm\" | \"indices\" | \"info\" | \"ingest\" | \"knnSearch\" | \"license\" | \"logstash\" | \"mget\" | \"migration\" | \"ml\" | \"msearch\" | \"msearchTemplate\" | \"mtermvectors\" | \"nodes\" | \"openPointInTime\" | \"ping\" | \"putScript\" | \"rankEval\" | \"reindex\" | \"reindexRethrottle\" | \"renderSearchTemplate\" | \"rollup\" | \"scriptsPainlessExecute\" | \"scroll\" | \"searchMvt\" | \"searchShards\" | \"searchTemplate\" | \"searchableSnapshots\" | \"shutdown\" | \"slm\" | \"snapshot\" | \"sql\" | \"ssl\" | \"tasks\" | \"termsEnum\" | \"termvectors\" | \"textStructure\" | \"updateByQuery\" | \"updateByQueryRethrottle\" | \"watcher\" | \"xpack\"> & { transport: { request<TResponse = unknown>(params: ",
|
|
"TransportRequestParams",
|
|
", options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<TResponse, unknown>>; }; }"
|
|
],
|
|
"path": "x-pack/plugins/fleet/server/services/agents/crud.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-server.AgentService.listAgents.$2",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "options",
|
|
"description": [],
|
|
"signature": [
|
|
"Readonly<{ page?: number | undefined; perPage?: number | undefined; sortField?: string | undefined; sortOrder?: \"asc\" | \"desc\" | undefined; kuery?: any; showUpgradeable?: boolean | undefined; } & {}> & { showInactive: boolean; }"
|
|
],
|
|
"path": "x-pack/plugins/fleet/server/services/agents/crud.ts",
|
|
"deprecated": false
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-server.Artifact",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "Artifact",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "server",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-server.Artifact",
|
|
"text": "Artifact"
|
|
},
|
|
" extends ",
|
|
"NewArtifact"
|
|
],
|
|
"path": "x-pack/plugins/fleet/server/services/artifacts/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-server.Artifact.id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/server/services/artifacts/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-server.Artifact.created",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "created",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/server/services/artifacts/types.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-server.ArtifactsClientInterface",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "ArtifactsClientInterface",
|
|
"description": [
|
|
"\nThe interface exposed out of Fleet's Artifact service via the client class"
|
|
],
|
|
"path": "x-pack/plugins/fleet/server/services/artifacts/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-server.ArtifactsClientInterface.getArtifact",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getArtifact",
|
|
"description": [],
|
|
"signature": [
|
|
"(id: string) => Promise<",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "server",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-server.Artifact",
|
|
"text": "Artifact"
|
|
},
|
|
" | undefined>"
|
|
],
|
|
"path": "x-pack/plugins/fleet/server/services/artifacts/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-server.ArtifactsClientInterface.getArtifact.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "x-pack/plugins/fleet/server/services/artifacts/types.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-server.ArtifactsClientInterface.createArtifact",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "createArtifact",
|
|
"description": [],
|
|
"signature": [
|
|
"(options: ",
|
|
"ArtifactsClientCreateOptions",
|
|
") => Promise<",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "server",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-server.Artifact",
|
|
"text": "Artifact"
|
|
},
|
|
">"
|
|
],
|
|
"path": "x-pack/plugins/fleet/server/services/artifacts/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-server.ArtifactsClientInterface.createArtifact.$1",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "options",
|
|
"description": [],
|
|
"signature": [
|
|
"ArtifactsClientCreateOptions"
|
|
],
|
|
"path": "x-pack/plugins/fleet/server/services/artifacts/types.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-server.ArtifactsClientInterface.deleteArtifact",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "deleteArtifact",
|
|
"description": [],
|
|
"signature": [
|
|
"(id: string) => Promise<void>"
|
|
],
|
|
"path": "x-pack/plugins/fleet/server/services/artifacts/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-server.ArtifactsClientInterface.deleteArtifact.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "x-pack/plugins/fleet/server/services/artifacts/types.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-server.ArtifactsClientInterface.listArtifacts",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "listArtifacts",
|
|
"description": [],
|
|
"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"
|
|
},
|
|
">>"
|
|
],
|
|
"path": "x-pack/plugins/fleet/server/services/artifacts/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-server.ArtifactsClientInterface.listArtifacts.$1",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "options",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "server",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-server.ListArtifactsProps",
|
|
"text": "ListArtifactsProps"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/server/services/artifacts/types.ts",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-server.ArtifactsClientInterface.encodeContent",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "encodeContent",
|
|
"description": [],
|
|
"signature": [
|
|
"(content: string) => Promise<Pick<",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "server",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-server.Artifact",
|
|
"text": "Artifact"
|
|
},
|
|
", \"body\" | \"compressionAlgorithm\" | \"decodedSha256\" | \"decodedSize\" | \"encodedSha256\" | \"encodedSize\">>"
|
|
],
|
|
"path": "x-pack/plugins/fleet/server/services/artifacts/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-server.ArtifactsClientInterface.encodeContent.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "content",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "x-pack/plugins/fleet/server/services/artifacts/types.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-server.ArtifactsClientInterface.generateHash",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "generateHash",
|
|
"description": [],
|
|
"signature": [
|
|
"(content: string) => string"
|
|
],
|
|
"path": "x-pack/plugins/fleet/server/services/artifacts/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-server.ArtifactsClientInterface.generateHash.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "content",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "x-pack/plugins/fleet/server/services/artifacts/types.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-server.ESIndexPatternService",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "ESIndexPatternService",
|
|
"description": [
|
|
"\nService to return the index pattern of EPM packages"
|
|
],
|
|
"path": "x-pack/plugins/fleet/server/services/index.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-server.ESIndexPatternService.getESIndexPattern",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getESIndexPattern",
|
|
"description": [],
|
|
"signature": [
|
|
"(savedObjectsClient: Pick<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsClient",
|
|
"text": "SavedObjectsClient"
|
|
},
|
|
", \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"delete\" | \"find\" | \"bulkGet\" | \"bulkResolve\" | \"get\" | \"resolve\" | \"update\" | \"collectMultiNamespaceReferences\" | \"updateObjectsSpaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\" | \"errors\">, pkgName: string, datasetPath: string) => Promise<string | undefined>"
|
|
],
|
|
"path": "x-pack/plugins/fleet/server/services/index.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-server.ESIndexPatternService.getESIndexPattern.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "savedObjectsClient",
|
|
"description": [],
|
|
"signature": [
|
|
"Pick<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsClient",
|
|
"text": "SavedObjectsClient"
|
|
},
|
|
", \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"delete\" | \"find\" | \"bulkGet\" | \"bulkResolve\" | \"get\" | \"resolve\" | \"update\" | \"collectMultiNamespaceReferences\" | \"updateObjectsSpaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\" | \"errors\">"
|
|
],
|
|
"path": "x-pack/plugins/fleet/server/services/index.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-server.ESIndexPatternService.getESIndexPattern.$2",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "pkgName",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "x-pack/plugins/fleet/server/services/index.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-server.ESIndexPatternService.getESIndexPattern.$3",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "datasetPath",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "x-pack/plugins/fleet/server/services/index.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-server.FleetSetupDeps",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "FleetSetupDeps",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/server/plugin.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-server.FleetSetupDeps.licensing",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "licensing",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "licensing",
|
|
"scope": "server",
|
|
"docId": "kibLicensingPluginApi",
|
|
"section": "def-server.LicensingPluginSetup",
|
|
"text": "LicensingPluginSetup"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/fleet/server/plugin.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-server.FleetSetupDeps.security",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "security",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "security",
|
|
"scope": "server",
|
|
"docId": "kibSecurityPluginApi",
|
|
"section": "def-server.SecurityPluginSetup",
|
|
"text": "SecurityPluginSetup"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/server/plugin.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-server.FleetSetupDeps.features",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "features",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "features",
|
|
"scope": "server",
|
|
"docId": "kibFeaturesPluginApi",
|
|
"section": "def-server.PluginSetupContract",
|
|
"text": "PluginSetupContract"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/server/plugin.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-server.FleetSetupDeps.encryptedSavedObjects",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "encryptedSavedObjects",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "encryptedSavedObjects",
|
|
"scope": "server",
|
|
"docId": "kibEncryptedSavedObjectsPluginApi",
|
|
"section": "def-server.EncryptedSavedObjectsPluginSetup",
|
|
"text": "EncryptedSavedObjectsPluginSetup"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/fleet/server/plugin.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-server.FleetSetupDeps.cloud",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "cloud",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "cloud",
|
|
"scope": "server",
|
|
"docId": "kibCloudPluginApi",
|
|
"section": "def-server.CloudSetup",
|
|
"text": "CloudSetup"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/server/plugin.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-server.FleetSetupDeps.usageCollection",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "usageCollection",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "usageCollection",
|
|
"scope": "server",
|
|
"docId": "kibUsageCollectionPluginApi",
|
|
"section": "def-server.UsageCollectionSetup",
|
|
"text": "UsageCollectionSetup"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/server/plugin.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-server.PackageService",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "PackageService",
|
|
"description": [
|
|
"\nService that provides exported function that return information about EPM packages"
|
|
],
|
|
"path": "x-pack/plugins/fleet/server/services/index.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-server.PackageService.getInstallation",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getInstallation",
|
|
"description": [],
|
|
"signature": [
|
|
"(options: { savedObjectsClient: Pick<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsClient",
|
|
"text": "SavedObjectsClient"
|
|
},
|
|
", \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"delete\" | \"find\" | \"bulkGet\" | \"bulkResolve\" | \"get\" | \"resolve\" | \"update\" | \"collectMultiNamespaceReferences\" | \"updateObjectsSpaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\" | \"errors\">; pkgName: string; }) => Promise<",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.Installation",
|
|
"text": "Installation"
|
|
},
|
|
" | undefined>"
|
|
],
|
|
"path": "x-pack/plugins/fleet/server/services/index.ts",
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-server.PackageService.getInstallation.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "options",
|
|
"description": [],
|
|
"signature": [
|
|
"{ savedObjectsClient: Pick<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsClient",
|
|
"text": "SavedObjectsClient"
|
|
},
|
|
", \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"delete\" | \"find\" | \"bulkGet\" | \"bulkResolve\" | \"get\" | \"resolve\" | \"update\" | \"collectMultiNamespaceReferences\" | \"updateObjectsSpaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\" | \"errors\">; pkgName: string; }"
|
|
],
|
|
"path": "x-pack/plugins/fleet/server/services/epm/packages/get.ts",
|
|
"deprecated": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-server.PackageService.ensureInstalledPackage",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "ensureInstalledPackage",
|
|
"description": [],
|
|
"signature": [
|
|
"(options: { savedObjectsClient: Pick<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsClient",
|
|
"text": "SavedObjectsClient"
|
|
},
|
|
", \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"delete\" | \"find\" | \"bulkGet\" | \"bulkResolve\" | \"get\" | \"resolve\" | \"update\" | \"collectMultiNamespaceReferences\" | \"updateObjectsSpaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\" | \"errors\">; pkgName: string; esClient: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-server.ElasticsearchClient",
|
|
"text": "ElasticsearchClient"
|
|
},
|
|
"; pkgVersion?: string | undefined; }) => Promise<",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.Installation",
|
|
"text": "Installation"
|
|
},
|
|
">"
|
|
],
|
|
"path": "x-pack/plugins/fleet/server/services/index.ts",
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-server.PackageService.ensureInstalledPackage.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "options",
|
|
"description": [],
|
|
"signature": [
|
|
"{ savedObjectsClient: Pick<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsClient",
|
|
"text": "SavedObjectsClient"
|
|
},
|
|
", \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"delete\" | \"find\" | \"bulkGet\" | \"bulkResolve\" | \"get\" | \"resolve\" | \"update\" | \"collectMultiNamespaceReferences\" | \"updateObjectsSpaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\" | \"errors\">; pkgName: string; esClient: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-server.ElasticsearchClient",
|
|
"text": "ElasticsearchClient"
|
|
},
|
|
"; pkgVersion?: string | undefined; }"
|
|
],
|
|
"path": "x-pack/plugins/fleet/server/services/epm/packages/install.ts",
|
|
"deprecated": false
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"enums": [],
|
|
"misc": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-server.ExternalCallback",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "ExternalCallback",
|
|
"description": [
|
|
"\nCallbacks supported by the Fleet plugin"
|
|
],
|
|
"signature": [
|
|
"ExternalCallbackCreate",
|
|
" | ",
|
|
"ExternalCallbackDelete",
|
|
" | ",
|
|
"ExternalCallbackUpdate"
|
|
],
|
|
"path": "x-pack/plugins/fleet/server/types/extensions.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-server.FleetConfigType",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "FleetConfigType",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"path": "x-pack/plugins/fleet/server/index.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-server.ListArtifactsProps",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "ListArtifactsProps",
|
|
"description": [],
|
|
"signature": [
|
|
"Pick<Readonly<{ page?: number | undefined; perPage?: number | undefined; sortField?: string | undefined; sortOrder?: \"asc\" | \"desc\" | undefined; kuery?: any; showUpgradeable?: boolean | undefined; } & {}>, \"page\" | \"perPage\" | \"sortOrder\" | \"kuery\"> & { sortField?: string | undefined; }"
|
|
],
|
|
"path": "x-pack/plugins/fleet/server/services/artifacts/types.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-server.PackagePolicyServiceInterface",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "PackagePolicyServiceInterface",
|
|
"description": [],
|
|
"signature": [
|
|
"PackagePolicyService"
|
|
],
|
|
"path": "x-pack/plugins/fleet/server/services/package_policy.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-server.PostPackagePolicyCreateCallback",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "PostPackagePolicyCreateCallback",
|
|
"description": [],
|
|
"signature": [
|
|
"(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"
|
|
},
|
|
">"
|
|
],
|
|
"path": "x-pack/plugins/fleet/server/types/extensions.ts",
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-server.PostPackagePolicyCreateCallback.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "newPackagePolicy",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.NewPackagePolicy",
|
|
"text": "NewPackagePolicy"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/fleet/server/types/extensions.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-server.PostPackagePolicyCreateCallback.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "context",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-server.RequestHandlerContext",
|
|
"text": "RequestHandlerContext"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/fleet/server/types/extensions.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-server.PostPackagePolicyCreateCallback.$3",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "request",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreHttpPluginApi",
|
|
"section": "def-server.KibanaRequest",
|
|
"text": "KibanaRequest"
|
|
},
|
|
"<unknown, unknown, unknown, any>"
|
|
],
|
|
"path": "x-pack/plugins/fleet/server/types/extensions.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-server.PostPackagePolicyDeleteCallback",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "PostPackagePolicyDeleteCallback",
|
|
"description": [],
|
|
"signature": [
|
|
"(deletedPackagePolicies: ",
|
|
"_DeepReadonlyArray",
|
|
"<{ id: string; name?: string | undefined; success: boolean; package?: ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.PackagePolicyPackage",
|
|
"text": "PackagePolicyPackage"
|
|
},
|
|
" | undefined; }>) => Promise<void>"
|
|
],
|
|
"path": "x-pack/plugins/fleet/server/types/extensions.ts",
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-server.PostPackagePolicyDeleteCallback.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "deletedPackagePolicies",
|
|
"description": [],
|
|
"signature": [
|
|
"_DeepReadonlyArray",
|
|
"<{ id: string; name?: string | undefined; success: boolean; package?: ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.PackagePolicyPackage",
|
|
"text": "PackagePolicyPackage"
|
|
},
|
|
" | undefined; }>"
|
|
],
|
|
"path": "x-pack/plugins/fleet/server/types/extensions.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-server.PutPackagePolicyUpdateCallback",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "PutPackagePolicyUpdateCallback",
|
|
"description": [],
|
|
"signature": [
|
|
"(updatePackagePolicy: ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.UpdatePackagePolicy",
|
|
"text": "UpdatePackagePolicy"
|
|
},
|
|
", 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.UpdatePackagePolicy",
|
|
"text": "UpdatePackagePolicy"
|
|
},
|
|
">"
|
|
],
|
|
"path": "x-pack/plugins/fleet/server/types/extensions.ts",
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-server.PutPackagePolicyUpdateCallback.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "updatePackagePolicy",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.UpdatePackagePolicy",
|
|
"text": "UpdatePackagePolicy"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/fleet/server/types/extensions.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-server.PutPackagePolicyUpdateCallback.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "context",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-server.RequestHandlerContext",
|
|
"text": "RequestHandlerContext"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/fleet/server/types/extensions.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-server.PutPackagePolicyUpdateCallback.$3",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "request",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreHttpPluginApi",
|
|
"section": "def-server.KibanaRequest",
|
|
"text": "KibanaRequest"
|
|
},
|
|
"<unknown, unknown, unknown, any>"
|
|
],
|
|
"path": "x-pack/plugins/fleet/server/types/extensions.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"objects": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-server.apm",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "apm",
|
|
"description": [],
|
|
"signature": [
|
|
"Agent"
|
|
],
|
|
"path": "node_modules/elastic-apm-node/index.d.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-server.apm",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "apm",
|
|
"description": [],
|
|
"signature": [
|
|
"Agent"
|
|
],
|
|
"path": "node_modules/elastic-apm-node/index.d.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"setup": {
|
|
"parentPluginId": "fleet",
|
|
"id": "def-server.FleetSetupContract",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "FleetSetupContract",
|
|
"description": [],
|
|
"signature": [
|
|
"void"
|
|
],
|
|
"path": "x-pack/plugins/fleet/server/plugin.ts",
|
|
"deprecated": false,
|
|
"lifecycle": "setup",
|
|
"initialIsOpen": true
|
|
},
|
|
"start": {
|
|
"parentPluginId": "fleet",
|
|
"id": "def-server.FleetStartContract",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "FleetStartContract",
|
|
"description": [
|
|
"\nDescribes public Fleet plugin contract returned at the `startup` stage."
|
|
],
|
|
"path": "x-pack/plugins/fleet/server/plugin.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-server.FleetStartContract.fleetSetupCompleted",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "fleetSetupCompleted",
|
|
"description": [
|
|
"\nreturns a promise that resolved when fleet setup has been completed regardless if it was successful or failed).\nAny consumer of fleet start services should first `await` for this promise to be resolved before using those\nservices"
|
|
],
|
|
"signature": [
|
|
"() => Promise<void>"
|
|
],
|
|
"path": "x-pack/plugins/fleet/server/plugin.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-server.FleetStartContract.esIndexPatternService",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "esIndexPatternService",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "server",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-server.ESIndexPatternService",
|
|
"text": "ESIndexPatternService"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/fleet/server/plugin.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-server.FleetStartContract.packageService",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "packageService",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "server",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-server.PackageService",
|
|
"text": "PackageService"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/fleet/server/plugin.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-server.FleetStartContract.agentService",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "agentService",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "server",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-server.AgentService",
|
|
"text": "AgentService"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/fleet/server/plugin.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-server.FleetStartContract.packagePolicyService",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "packagePolicyService",
|
|
"description": [
|
|
"\nServices for Fleet's package policies"
|
|
],
|
|
"signature": [
|
|
"PackagePolicyService"
|
|
],
|
|
"path": "x-pack/plugins/fleet/server/plugin.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-server.FleetStartContract.agentPolicyService",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "agentPolicyService",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "server",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-server.AgentPolicyServiceInterface",
|
|
"text": "AgentPolicyServiceInterface"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/fleet/server/plugin.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-server.FleetStartContract.registerExternalCallback",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "registerExternalCallback",
|
|
"description": [
|
|
"\nRegister callbacks for inclusion in fleet API processing"
|
|
],
|
|
"signature": [
|
|
"(...args: ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "server",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-server.ExternalCallback",
|
|
"text": "ExternalCallback"
|
|
},
|
|
") => void"
|
|
],
|
|
"path": "x-pack/plugins/fleet/server/plugin.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-server.FleetStartContract.registerExternalCallback.$1",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "args",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "server",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-server.ExternalCallback",
|
|
"text": "ExternalCallback"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/fleet/server/plugin.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-server.FleetStartContract.createArtifactsClient",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "createArtifactsClient",
|
|
"description": [
|
|
"\nCreate a Fleet Artifact Client instance"
|
|
],
|
|
"signature": [
|
|
"(packageName: string) => ",
|
|
"FleetArtifactsClient"
|
|
],
|
|
"path": "x-pack/plugins/fleet/server/plugin.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-server.FleetStartContract.createArtifactsClient.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "packageName",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "x-pack/plugins/fleet/server/plugin.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"lifecycle": "start",
|
|
"initialIsOpen": true
|
|
}
|
|
},
|
|
"common": {
|
|
"classes": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.LicenseService",
|
|
"type": "Class",
|
|
"tags": [],
|
|
"label": "LicenseService",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/services/license.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.LicenseService.start",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "start",
|
|
"description": [],
|
|
"signature": [
|
|
"(license$: ",
|
|
"Observable",
|
|
"<",
|
|
"ILicense",
|
|
">) => void"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/services/license.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.LicenseService.start.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "license$",
|
|
"description": [],
|
|
"signature": [
|
|
"Observable",
|
|
"<",
|
|
"ILicense",
|
|
">"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/services/license.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.LicenseService.stop",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "stop",
|
|
"description": [],
|
|
"signature": [
|
|
"() => void"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/services/license.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.LicenseService.getLicenseInformation",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getLicenseInformation",
|
|
"description": [],
|
|
"signature": [
|
|
"() => ",
|
|
"ILicense",
|
|
" | null"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/services/license.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.LicenseService.getLicenseInformation$",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getLicenseInformation$",
|
|
"description": [],
|
|
"signature": [
|
|
"() => ",
|
|
"Observable",
|
|
"<",
|
|
"ILicense",
|
|
"> | null"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/services/license.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.LicenseService.isGoldPlus",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "isGoldPlus",
|
|
"description": [],
|
|
"signature": [
|
|
"() => boolean | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/services/license.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.LicenseService.isEnterprise",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "isEnterprise",
|
|
"description": [],
|
|
"signature": [
|
|
"() => boolean | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/services/license.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.LicenseService.hasAtLeast",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "hasAtLeast",
|
|
"description": [],
|
|
"signature": [
|
|
"(licenseType: \"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\") => boolean | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/services/license.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.LicenseService.hasAtLeast.$1",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "licenseType",
|
|
"description": [],
|
|
"signature": [
|
|
"\"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\""
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/services/license.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"functions": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.countValidationErrors",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "countValidationErrors",
|
|
"description": [],
|
|
"signature": [
|
|
"(validationResults: ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.PackagePolicyConfigValidationResults",
|
|
"text": "PackagePolicyConfigValidationResults"
|
|
},
|
|
" | ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.PackagePolicyValidationResults",
|
|
"text": "PackagePolicyValidationResults"
|
|
},
|
|
" | ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.PackagePolicyInputValidationResults",
|
|
"text": "PackagePolicyInputValidationResults"
|
|
},
|
|
") => number"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/services/validate_package_policy.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.countValidationErrors.$1",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "validationResults",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.PackagePolicyConfigValidationResults",
|
|
"text": "PackagePolicyConfigValidationResults"
|
|
},
|
|
" | ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.PackagePolicyValidationResults",
|
|
"text": "PackagePolicyValidationResults"
|
|
},
|
|
" | ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.PackagePolicyInputValidationResults",
|
|
"text": "PackagePolicyInputValidationResults"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/services/validate_package_policy.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.decodeCloudId",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "decodeCloudId",
|
|
"description": [],
|
|
"signature": [
|
|
"(cid: string) => { host: string; defaultPort: string; elasticsearchUrl: string; kibanaUrl: string; } | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/services/decode_cloud_id.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.decodeCloudId.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "cid",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/services/decode_cloud_id.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.doesAgentPolicyAlreadyIncludePackage",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "doesAgentPolicyAlreadyIncludePackage",
|
|
"description": [],
|
|
"signature": [
|
|
"(agentPolicy: ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.AgentPolicy",
|
|
"text": "AgentPolicy"
|
|
},
|
|
", packageName: string) => boolean"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/services/limited_package.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.doesAgentPolicyAlreadyIncludePackage.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "agentPolicy",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.AgentPolicy",
|
|
"text": "AgentPolicy"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/services/limited_package.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.doesAgentPolicyAlreadyIncludePackage.$2",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "packageName",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/services/limited_package.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.doesPackageHaveIntegrations",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "doesPackageHaveIntegrations",
|
|
"description": [],
|
|
"signature": [
|
|
"(pkgInfo: ",
|
|
{
|
|
"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.Installing",
|
|
"text": "Installing"
|
|
},
|
|
"<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"
|
|
},
|
|
", ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.EpmPackageAdditions",
|
|
"text": "EpmPackageAdditions"
|
|
},
|
|
">> | ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.InstallFailed",
|
|
"text": "InstallFailed"
|
|
},
|
|
"<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.Installed",
|
|
"text": "Installed"
|
|
},
|
|
"<Merge<",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.ArchivePackage",
|
|
"text": "ArchivePackage"
|
|
},
|
|
", ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.EpmPackageAdditions",
|
|
"text": "EpmPackageAdditions"
|
|
},
|
|
">> | ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.Installing",
|
|
"text": "Installing"
|
|
},
|
|
"<Merge<",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.ArchivePackage",
|
|
"text": "ArchivePackage"
|
|
},
|
|
", ",
|
|
{
|
|
"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.ArchivePackage",
|
|
"text": "ArchivePackage"
|
|
},
|
|
", ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.EpmPackageAdditions",
|
|
"text": "EpmPackageAdditions"
|
|
},
|
|
">> | ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.InstallFailed",
|
|
"text": "InstallFailed"
|
|
},
|
|
"<Merge<",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.ArchivePackage",
|
|
"text": "ArchivePackage"
|
|
},
|
|
", ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.EpmPackageAdditions",
|
|
"text": "EpmPackageAdditions"
|
|
},
|
|
">> | (Pick<",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.RegistryPackage",
|
|
"text": "RegistryPackage"
|
|
},
|
|
", \"type\" | \"title\" | \"description\" | \"icons\" | \"categories\" | \"name\" | \"version\" | \"path\" | \"download\" | \"internal\" | \"data_streams\" | \"release\" | \"policy_templates\"> & { status: \"installed\"; savedObject: ",
|
|
"SavedObject",
|
|
"<",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.Installation",
|
|
"text": "Installation"
|
|
},
|
|
">; } & { integration?: string | undefined; id: string; }) | (Pick<",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.RegistryPackage",
|
|
"text": "RegistryPackage"
|
|
},
|
|
", \"type\" | \"title\" | \"description\" | \"icons\" | \"categories\" | \"name\" | \"version\" | \"path\" | \"download\" | \"internal\" | \"data_streams\" | \"release\" | \"policy_templates\"> & { status: \"installing\"; savedObject: ",
|
|
"SavedObject",
|
|
"<",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.Installation",
|
|
"text": "Installation"
|
|
},
|
|
">; } & { integration?: string | undefined; id: string; }) | (Pick<",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.RegistryPackage",
|
|
"text": "RegistryPackage"
|
|
},
|
|
", \"type\" | \"title\" | \"description\" | \"icons\" | \"categories\" | \"name\" | \"version\" | \"path\" | \"download\" | \"internal\" | \"data_streams\" | \"release\" | \"policy_templates\"> & { status: \"not_installed\"; } & { integration?: string | undefined; id: string; }) | (Pick<",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.RegistryPackage",
|
|
"text": "RegistryPackage"
|
|
},
|
|
", \"type\" | \"title\" | \"description\" | \"icons\" | \"categories\" | \"name\" | \"version\" | \"path\" | \"download\" | \"internal\" | \"data_streams\" | \"release\" | \"policy_templates\"> & { status: \"install_failed\"; } & { integration?: string | undefined; id: string; })) => boolean"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/services/packages_with_integrations.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.doesPackageHaveIntegrations.$1",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "pkgInfo",
|
|
"description": [],
|
|
"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.Installing",
|
|
"text": "Installing"
|
|
},
|
|
"<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"
|
|
},
|
|
", ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.EpmPackageAdditions",
|
|
"text": "EpmPackageAdditions"
|
|
},
|
|
">> | ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.InstallFailed",
|
|
"text": "InstallFailed"
|
|
},
|
|
"<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.Installed",
|
|
"text": "Installed"
|
|
},
|
|
"<Merge<",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.ArchivePackage",
|
|
"text": "ArchivePackage"
|
|
},
|
|
", ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.EpmPackageAdditions",
|
|
"text": "EpmPackageAdditions"
|
|
},
|
|
">> | ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.Installing",
|
|
"text": "Installing"
|
|
},
|
|
"<Merge<",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.ArchivePackage",
|
|
"text": "ArchivePackage"
|
|
},
|
|
", ",
|
|
{
|
|
"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.ArchivePackage",
|
|
"text": "ArchivePackage"
|
|
},
|
|
", ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.EpmPackageAdditions",
|
|
"text": "EpmPackageAdditions"
|
|
},
|
|
">> | ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.InstallFailed",
|
|
"text": "InstallFailed"
|
|
},
|
|
"<Merge<",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.ArchivePackage",
|
|
"text": "ArchivePackage"
|
|
},
|
|
", ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.EpmPackageAdditions",
|
|
"text": "EpmPackageAdditions"
|
|
},
|
|
">> | (Pick<",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.RegistryPackage",
|
|
"text": "RegistryPackage"
|
|
},
|
|
", \"type\" | \"title\" | \"description\" | \"icons\" | \"categories\" | \"name\" | \"version\" | \"path\" | \"download\" | \"internal\" | \"data_streams\" | \"release\" | \"policy_templates\"> & { status: \"installed\"; savedObject: ",
|
|
"SavedObject",
|
|
"<",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.Installation",
|
|
"text": "Installation"
|
|
},
|
|
">; } & { integration?: string | undefined; id: string; }) | (Pick<",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.RegistryPackage",
|
|
"text": "RegistryPackage"
|
|
},
|
|
", \"type\" | \"title\" | \"description\" | \"icons\" | \"categories\" | \"name\" | \"version\" | \"path\" | \"download\" | \"internal\" | \"data_streams\" | \"release\" | \"policy_templates\"> & { status: \"installing\"; savedObject: ",
|
|
"SavedObject",
|
|
"<",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.Installation",
|
|
"text": "Installation"
|
|
},
|
|
">; } & { integration?: string | undefined; id: string; }) | (Pick<",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.RegistryPackage",
|
|
"text": "RegistryPackage"
|
|
},
|
|
", \"type\" | \"title\" | \"description\" | \"icons\" | \"categories\" | \"name\" | \"version\" | \"path\" | \"download\" | \"internal\" | \"data_streams\" | \"release\" | \"policy_templates\"> & { status: \"not_installed\"; } & { integration?: string | undefined; id: string; }) | (Pick<",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.RegistryPackage",
|
|
"text": "RegistryPackage"
|
|
},
|
|
", \"type\" | \"title\" | \"description\" | \"icons\" | \"categories\" | \"name\" | \"version\" | \"path\" | \"download\" | \"internal\" | \"data_streams\" | \"release\" | \"policy_templates\"> & { status: \"install_failed\"; } & { integration?: string | undefined; id: string; })"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/services/packages_with_integrations.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.entries",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "entries",
|
|
"description": [],
|
|
"signature": [
|
|
"<T>(o: T) => [keyof T, T[keyof T]][]"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/index.ts",
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.entries.$1",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "o",
|
|
"description": [],
|
|
"signature": [
|
|
"T"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/index.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.fullAgentPolicyToYaml",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "fullAgentPolicyToYaml",
|
|
"description": [],
|
|
"signature": [
|
|
"(policy: ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.FullAgentPolicy",
|
|
"text": "FullAgentPolicy"
|
|
},
|
|
", toYaml: (obj: any, opts?: jsyaml.DumpOptions | undefined) => string) => string"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/services/full_agent_policy_to_yaml.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.fullAgentPolicyToYaml.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "policy",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.FullAgentPolicy",
|
|
"text": "FullAgentPolicy"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/services/full_agent_policy_to_yaml.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.fullAgentPolicyToYaml.$2",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "toYaml",
|
|
"description": [],
|
|
"signature": [
|
|
"typeof jsyaml.safeDump"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/services/full_agent_policy_to_yaml.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.getStreamsForInputType",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getStreamsForInputType",
|
|
"description": [],
|
|
"signature": [
|
|
"(inputType: string, packageInfo: ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.PackageInfo",
|
|
"text": "PackageInfo"
|
|
},
|
|
", dataStreamPaths?: string[]) => (",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.RegistryStream",
|
|
"text": "RegistryStream"
|
|
},
|
|
" & { data_stream: { type: string; dataset: string; }; })[]"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/services/package_to_package_policy.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.getStreamsForInputType.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "inputType",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/services/package_to_package_policy.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.getStreamsForInputType.$2",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "packageInfo",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.PackageInfo",
|
|
"text": "PackageInfo"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/services/package_to_package_policy.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.getStreamsForInputType.$3",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "dataStreamPaths",
|
|
"description": [],
|
|
"signature": [
|
|
"string[]"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/services/package_to_package_policy.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.isAgentUpgradeable",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "isAgentUpgradeable",
|
|
"description": [],
|
|
"signature": [
|
|
"(agent: ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.Agent",
|
|
"text": "Agent"
|
|
},
|
|
", kibanaVersion: string) => boolean"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/services/is_agent_upgradeable.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.isAgentUpgradeable.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "agent",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.Agent",
|
|
"text": "Agent"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/services/is_agent_upgradeable.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.isAgentUpgradeable.$2",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "kibanaVersion",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/services/is_agent_upgradeable.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.isDiffPathProtocol",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "isDiffPathProtocol",
|
|
"description": [],
|
|
"signature": [
|
|
"(kibanaUrls: string[]) => boolean"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/services/is_diff_path_protocol.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.isDiffPathProtocol.$1",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "kibanaUrls",
|
|
"description": [],
|
|
"signature": [
|
|
"string[]"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/services/is_diff_path_protocol.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.isPackageLimited",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "isPackageLimited",
|
|
"description": [],
|
|
"signature": [
|
|
"(packageInfo: ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.PackageInfo",
|
|
"text": "PackageInfo"
|
|
},
|
|
") => boolean"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/services/limited_package.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.isPackageLimited.$1",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "packageInfo",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.PackageInfo",
|
|
"text": "PackageInfo"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/services/limited_package.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.isValidNamespace",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "isValidNamespace",
|
|
"description": [],
|
|
"signature": [
|
|
"(namespace: string) => { valid: boolean; error?: string | undefined; }"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/services/is_valid_namespace.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.isValidNamespace.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "namespace",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/services/is_valid_namespace.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.normalizeHostsForAgents",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "normalizeHostsForAgents",
|
|
"description": [],
|
|
"signature": [
|
|
"(host: string) => string"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/services/hosts_utils.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.normalizeHostsForAgents.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "host",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/services/hosts_utils.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.packageToPackagePolicy",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "packageToPackagePolicy",
|
|
"description": [
|
|
"\nBuilds a `NewPackagePolicy` structure based on a package\n"
|
|
],
|
|
"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, integrationToEnable?: string | undefined) => ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.NewPackagePolicy",
|
|
"text": "NewPackagePolicy"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/services/package_to_package_policy.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.packageToPackagePolicy.$1",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "packageInfo",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.PackageInfo",
|
|
"text": "PackageInfo"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/services/package_to_package_policy.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.packageToPackagePolicy.$2",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "agentPolicyId",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/services/package_to_package_policy.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.packageToPackagePolicy.$3",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "outputId",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/services/package_to_package_policy.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.packageToPackagePolicy.$4",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "namespace",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/services/package_to_package_policy.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.packageToPackagePolicy.$5",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "packagePolicyName",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/services/package_to_package_policy.ts",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.packageToPackagePolicy.$6",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "description",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/services/package_to_package_policy.ts",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.packageToPackagePolicy.$7",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "integrationToEnable",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/services/package_to_package_policy.ts",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.packageToPackagePolicyInputs",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "packageToPackagePolicyInputs",
|
|
"description": [],
|
|
"signature": [
|
|
"(packageInfo: ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.PackageInfo",
|
|
"text": "PackageInfo"
|
|
},
|
|
", integrationToEnable?: string | undefined) => ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.NewPackagePolicyInput",
|
|
"text": "NewPackagePolicyInput"
|
|
},
|
|
"[]"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/services/package_to_package_policy.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.packageToPackagePolicyInputs.$1",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "packageInfo",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.PackageInfo",
|
|
"text": "PackageInfo"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/services/package_to_package_policy.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.packageToPackagePolicyInputs.$2",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "integrationToEnable",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/services/package_to_package_policy.ts",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.storedPackagePoliciesToAgentInputs",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "storedPackagePoliciesToAgentInputs",
|
|
"description": [],
|
|
"signature": [
|
|
"(packagePolicies: ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.PackagePolicy",
|
|
"text": "PackagePolicy"
|
|
},
|
|
"[], outputId?: string) => ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.FullAgentPolicyInput",
|
|
"text": "FullAgentPolicyInput"
|
|
},
|
|
"[]"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/services/package_policies_to_agent_inputs.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.storedPackagePoliciesToAgentInputs.$1",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "packagePolicies",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.PackagePolicy",
|
|
"text": "PackagePolicy"
|
|
},
|
|
"[]"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/services/package_policies_to_agent_inputs.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.storedPackagePoliciesToAgentInputs.$2",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "outputId",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/services/package_policies_to_agent_inputs.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.validatePackagePolicy",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "validatePackagePolicy",
|
|
"description": [],
|
|
"signature": [
|
|
"(packagePolicy: ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.NewPackagePolicy",
|
|
"text": "NewPackagePolicy"
|
|
},
|
|
", packageInfo: ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.PackageInfo",
|
|
"text": "PackageInfo"
|
|
},
|
|
", safeLoadYaml: (yaml: string) => any) => ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.PackagePolicyValidationResults",
|
|
"text": "PackagePolicyValidationResults"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/services/validate_package_policy.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.validatePackagePolicy.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "packagePolicy",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.NewPackagePolicy",
|
|
"text": "NewPackagePolicy"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/services/validate_package_policy.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.validatePackagePolicy.$2",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "packageInfo",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.PackageInfo",
|
|
"text": "PackageInfo"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/services/validate_package_policy.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.validatePackagePolicy.$3",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "safeLoadYaml",
|
|
"description": [],
|
|
"signature": [
|
|
"(yaml: string) => any"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/services/validate_package_policy.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.validatePackagePolicyConfig",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "validatePackagePolicyConfig",
|
|
"description": [],
|
|
"signature": [
|
|
"(configEntry: ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.PackagePolicyConfigRecordEntry",
|
|
"text": "PackagePolicyConfigRecordEntry"
|
|
},
|
|
", varDef: ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.RegistryVarsEntry",
|
|
"text": "RegistryVarsEntry"
|
|
},
|
|
", varName: string, safeLoadYaml: (yaml: string) => any) => string[] | null"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/services/validate_package_policy.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.validatePackagePolicyConfig.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "configEntry",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.PackagePolicyConfigRecordEntry",
|
|
"text": "PackagePolicyConfigRecordEntry"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/services/validate_package_policy.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.validatePackagePolicyConfig.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "varDef",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.RegistryVarsEntry",
|
|
"text": "RegistryVarsEntry"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/services/validate_package_policy.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.validatePackagePolicyConfig.$3",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "varName",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/services/validate_package_policy.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.validatePackagePolicyConfig.$4",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "safeLoadYaml",
|
|
"description": [],
|
|
"signature": [
|
|
"(yaml: string) => any"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/services/validate_package_policy.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.validationHasErrors",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "validationHasErrors",
|
|
"description": [],
|
|
"signature": [
|
|
"(validationResults: ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.PackagePolicyConfigValidationResults",
|
|
"text": "PackagePolicyConfigValidationResults"
|
|
},
|
|
" | ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.PackagePolicyValidationResults",
|
|
"text": "PackagePolicyValidationResults"
|
|
},
|
|
" | ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.PackagePolicyInputValidationResults",
|
|
"text": "PackagePolicyInputValidationResults"
|
|
},
|
|
") => boolean"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/services/validate_package_policy.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.validationHasErrors.$1",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "validationResults",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.PackagePolicyConfigValidationResults",
|
|
"text": "PackagePolicyConfigValidationResults"
|
|
},
|
|
" | ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.PackagePolicyValidationResults",
|
|
"text": "PackagePolicyValidationResults"
|
|
},
|
|
" | ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.PackagePolicyInputValidationResults",
|
|
"text": "PackagePolicyInputValidationResults"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/services/validate_package_policy.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"interfaces": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.Agent",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "Agent",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.Agent",
|
|
"text": "Agent"
|
|
},
|
|
" extends AgentBase"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.Agent.id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.Agent.access_api_key",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "access_api_key",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.Agent.status",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "status",
|
|
"description": [],
|
|
"signature": [
|
|
"\"offline\" | \"online\" | \"error\" | \"warning\" | \"inactive\" | \"enrolling\" | \"unenrolling\" | \"updating\" | \"degraded\" | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.Agent.packages",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "packages",
|
|
"description": [],
|
|
"signature": [
|
|
"string[]"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.AgentAction",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "AgentAction",
|
|
"description": [],
|
|
"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"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.AgentAction.type",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
"\"POLICY_CHANGE\" | \"UNENROLL\" | \"UPGRADE\" | \"SETTINGS\" | \"POLICY_REASSIGN\""
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.AgentAction.data",
|
|
"type": "Any",
|
|
"tags": [],
|
|
"label": "data",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.AgentAction.sent_at",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "sent_at",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.AgentAction.id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.AgentAction.agent_id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "agent_id",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.AgentAction.created_at",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "created_at",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.AgentAction.ack_data",
|
|
"type": "Any",
|
|
"tags": [],
|
|
"label": "ack_data",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.AgentMetadata",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "AgentMetadata",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.AgentMetadata.Unnamed",
|
|
"type": "Any",
|
|
"tags": [],
|
|
"label": "Unnamed",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.AgentPolicy",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "AgentPolicy",
|
|
"description": [],
|
|
"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"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.AgentPolicy.id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.AgentPolicy.status",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "status",
|
|
"description": [],
|
|
"signature": [
|
|
"\"active\" | \"inactive\""
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.AgentPolicy.package_policies",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "package_policies",
|
|
"description": [],
|
|
"signature": [
|
|
"string[] | ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.PackagePolicy",
|
|
"text": "PackagePolicy"
|
|
},
|
|
"[]"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.AgentPolicy.is_managed",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "is_managed",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.AgentPolicy.updated_at",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "updated_at",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.AgentPolicy.updated_by",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "updated_by",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.AgentPolicy.revision",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "revision",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.AgentPolicyAction",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "AgentPolicyAction",
|
|
"description": [],
|
|
"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"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.AgentPolicyAction.id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.AgentPolicyAction.type",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
"\"POLICY_CHANGE\" | \"UNENROLL\" | \"UPGRADE\" | \"SETTINGS\" | \"POLICY_REASSIGN\""
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.AgentPolicyAction.data",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "data",
|
|
"description": [],
|
|
"signature": [
|
|
"{ policy: ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.FullAgentPolicy",
|
|
"text": "FullAgentPolicy"
|
|
},
|
|
"; }"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.AgentPolicyAction.policy_id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "policy_id",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.AgentPolicyAction.policy_revision",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "policy_revision",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.AgentPolicyAction.created_at",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "created_at",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.AgentPolicyAction.ack_data",
|
|
"type": "Any",
|
|
"tags": [],
|
|
"label": "ack_data",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.AgentSOAttributes",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "AgentSOAttributes",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.AgentSOAttributes",
|
|
"text": "AgentSOAttributes"
|
|
},
|
|
" extends AgentBase"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.AgentSOAttributes.packages",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "packages",
|
|
"description": [],
|
|
"signature": [
|
|
"string[] | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.AssetParts",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "AssetParts",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.AssetParts.pkgkey",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "pkgkey",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.AssetParts.dataset",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "dataset",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.AssetParts.service",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "service",
|
|
"description": [],
|
|
"signature": [
|
|
"\"kibana\" | \"elasticsearch\""
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.AssetParts.type",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
"\"input\" | \"doc\" | \"notice\" | ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.KibanaAssetType",
|
|
"text": "KibanaAssetType"
|
|
},
|
|
" | ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.ElasticsearchAssetType",
|
|
"text": "ElasticsearchAssetType"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.AssetParts.file",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "file",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.BaseSettings",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "BaseSettings",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/settings.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.BaseSettings.has_seen_add_data_notice",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "has_seen_add_data_notice",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/settings.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.BaseSettings.has_seen_fleet_migration_notice",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "has_seen_fleet_migration_notice",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/settings.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.BaseSettings.fleet_server_hosts",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "fleet_server_hosts",
|
|
"description": [],
|
|
"signature": [
|
|
"string[]"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/settings.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.BulkInstallPackageInfo",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "BulkInstallPackageInfo",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.BulkInstallPackageInfo.name",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "name",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.BulkInstallPackageInfo.version",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "version",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.BulkInstallPackageInfo.result",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "result",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.InstallResult",
|
|
"text": "InstallResult"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.BulkInstallPackagesRequest",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "BulkInstallPackagesRequest",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.BulkInstallPackagesRequest.body",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "body",
|
|
"description": [],
|
|
"signature": [
|
|
"{ packages: string[]; }"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.BulkInstallPackagesResponse",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "BulkInstallPackagesResponse",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.BulkInstallPackagesResponse.response",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "response",
|
|
"description": [],
|
|
"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"
|
|
},
|
|
")[]"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.CategorySummaryItem",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "CategorySummaryItem",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.CategorySummaryItem.id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.CategorySummaryItem.title",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "title",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.CategorySummaryItem.count",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "count",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.CheckPermissionsResponse",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "CheckPermissionsResponse",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/app.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.CheckPermissionsResponse.error",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "error",
|
|
"description": [],
|
|
"signature": [
|
|
"\"MISSING_SECURITY\" | \"MISSING_SUPERUSER_ROLE\" | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/app.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.CheckPermissionsResponse.success",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "success",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/app.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.CopyAgentPolicyRequest",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "CopyAgentPolicyRequest",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.CopyAgentPolicyRequest.body",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "body",
|
|
"description": [],
|
|
"signature": [
|
|
"{ description?: string | undefined; name: string; }"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.CopyAgentPolicyResponse",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "CopyAgentPolicyResponse",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.CopyAgentPolicyResponse.item",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "item",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.AgentPolicy",
|
|
"text": "AgentPolicy"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.CreateAgentPolicyRequest",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "CreateAgentPolicyRequest",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.CreateAgentPolicyRequest.body",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "body",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.NewAgentPolicy",
|
|
"text": "NewAgentPolicy"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.CreateAgentPolicyResponse",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "CreateAgentPolicyResponse",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.CreateAgentPolicyResponse.item",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "item",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.AgentPolicy",
|
|
"text": "AgentPolicy"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.CreatePackagePolicyRequest",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "CreatePackagePolicyRequest",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.CreatePackagePolicyRequest.body",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "body",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.NewPackagePolicy",
|
|
"text": "NewPackagePolicy"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.CreatePackagePolicyResponse",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "CreatePackagePolicyResponse",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.CreatePackagePolicyResponse.item",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "item",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.PackagePolicy",
|
|
"text": "PackagePolicy"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.DataStream",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "DataStream",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/data_stream.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.DataStream.index",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "index",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/data_stream.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.DataStream.dataset",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "dataset",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/data_stream.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.DataStream.namespace",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "namespace",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/data_stream.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.DataStream.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/data_stream.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.DataStream.package",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "package",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/data_stream.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.DataStream.package_version",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "package_version",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/data_stream.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.DataStream.last_activity_ms",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "last_activity_ms",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/data_stream.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.DataStream.size_in_bytes",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "size_in_bytes",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/data_stream.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.DataStream.dashboards",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "dashboards",
|
|
"description": [],
|
|
"signature": [
|
|
"{ id: string; title: string; }[]"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/data_stream.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.DefaultPackagesInstallationError",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "DefaultPackagesInstallationError",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.DefaultPackagesInstallationError.installType",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "installType",
|
|
"description": [],
|
|
"signature": [
|
|
"\"update\" | \"unknown\" | \"reinstall\" | \"reupdate\" | \"rollback\" | \"install\""
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.DefaultPackagesInstallationError.error",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "error",
|
|
"description": [],
|
|
"signature": [
|
|
"Error"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.DeleteAgentPolicyRequest",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "DeleteAgentPolicyRequest",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.DeleteAgentPolicyRequest.body",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "body",
|
|
"description": [],
|
|
"signature": [
|
|
"{ agentPolicyId: string; }"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.DeleteAgentPolicyResponse",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "DeleteAgentPolicyResponse",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.DeleteAgentPolicyResponse.id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.DeleteAgentPolicyResponse.name",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "name",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.DeleteAgentRequest",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "DeleteAgentRequest",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.DeleteAgentRequest.params",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "params",
|
|
"description": [],
|
|
"signature": [
|
|
"{ agentId: string; }"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.DeleteEnrollmentAPIKeyRequest",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "DeleteEnrollmentAPIKeyRequest",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.DeleteEnrollmentAPIKeyRequest.params",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "params",
|
|
"description": [],
|
|
"signature": [
|
|
"{ keyId: string; }"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.DeleteEnrollmentAPIKeyResponse",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "DeleteEnrollmentAPIKeyResponse",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.DeleteEnrollmentAPIKeyResponse.action",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "action",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.DeletePackagePoliciesRequest",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "DeletePackagePoliciesRequest",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.DeletePackagePoliciesRequest.body",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "body",
|
|
"description": [],
|
|
"signature": [
|
|
"{ packagePolicyIds: string[]; }"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.DeletePackageRequest",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "DeletePackageRequest",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.DeletePackageRequest.params",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "params",
|
|
"description": [],
|
|
"signature": [
|
|
"{ pkgkey: string; }"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.DeletePackageResponse",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "DeletePackageResponse",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.DeletePackageResponse.response",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "response",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.AssetReference",
|
|
"text": "AssetReference"
|
|
},
|
|
"[]"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.EnrollmentAPIKey",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "EnrollmentAPIKey",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/enrollment_api_key.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.EnrollmentAPIKey.id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/enrollment_api_key.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.EnrollmentAPIKey.api_key_id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "api_key_id",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/enrollment_api_key.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.EnrollmentAPIKey.api_key",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "api_key",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/enrollment_api_key.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.EnrollmentAPIKey.name",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "name",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/enrollment_api_key.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.EnrollmentAPIKey.active",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "active",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/enrollment_api_key.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.EnrollmentAPIKey.policy_id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "policy_id",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/enrollment_api_key.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.EnrollmentAPIKey.created_at",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "created_at",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/enrollment_api_key.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.EpmPackageAdditions",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "EpmPackageAdditions",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.EpmPackageAdditions.title",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "title",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.EpmPackageAdditions.latestVersion",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "latestVersion",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.EpmPackageAdditions.assets",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "assets",
|
|
"description": [],
|
|
"signature": [
|
|
"Record<\"kibana\", Record<",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.KibanaAssetType",
|
|
"text": "KibanaAssetType"
|
|
},
|
|
", ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.KibanaAssetParts",
|
|
"text": "KibanaAssetParts"
|
|
},
|
|
"[]>> & Record<\"elasticsearch\", Record<",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.ElasticsearchAssetType",
|
|
"text": "ElasticsearchAssetType"
|
|
},
|
|
", ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.ElasticsearchAssetParts",
|
|
"text": "ElasticsearchAssetParts"
|
|
},
|
|
"[]>>"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.EpmPackageAdditions.removable",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "removable",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.EpmPackageAdditions.notice",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "notice",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.EpmPackageAdditions.keepPoliciesUpToDate",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "keepPoliciesUpToDate",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.FleetConfigType",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "FleetConfigType",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/index.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.FleetConfigType.enabled",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "enabled",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/index.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.FleetConfigType.registryUrl",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "registryUrl",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/index.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.FleetConfigType.registryProxyUrl",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "registryProxyUrl",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/index.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.FleetConfigType.agents",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "agents",
|
|
"description": [],
|
|
"signature": [
|
|
"{ enabled: boolean; elasticsearch: { hosts?: string[] | undefined; ca_sha256?: string | undefined; }; fleet_server?: { hosts?: string[] | undefined; } | undefined; }"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/index.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.FleetConfigType.agentPolicies",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "agentPolicies",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.PreconfiguredAgentPolicy",
|
|
"text": "PreconfiguredAgentPolicy"
|
|
},
|
|
"[] | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/index.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.FleetConfigType.packages",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "packages",
|
|
"description": [],
|
|
"signature": [
|
|
"Pick<",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.PackagePolicyPackage",
|
|
"text": "PackagePolicyPackage"
|
|
},
|
|
", \"name\" | \"version\">[] | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/index.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.FleetConfigType.outputs",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "outputs",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.PreconfiguredOutput",
|
|
"text": "PreconfiguredOutput"
|
|
},
|
|
"[] | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/index.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.FleetConfigType.agentIdVerificationEnabled",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "agentIdVerificationEnabled",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/index.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.FleetConfigType.developer",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "developer",
|
|
"description": [],
|
|
"signature": [
|
|
"{ disableRegistryVersionCheck?: boolean | undefined; } | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/index.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.FleetServerAgent",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "FleetServerAgent",
|
|
"description": [
|
|
"\nAn Elastic Agent that has enrolled into Fleet"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.FleetServerAgent._version",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "_version",
|
|
"description": [
|
|
"\nThe version of the document in the index"
|
|
],
|
|
"signature": [
|
|
"number | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.FleetServerAgent.shared_id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "shared_id",
|
|
"description": [
|
|
"\nShared ID"
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.FleetServerAgent.type",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [
|
|
"\nType"
|
|
],
|
|
"signature": [
|
|
"\"PERMANENT\" | \"EPHEMERAL\" | \"TEMPORARY\""
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.FleetServerAgent.active",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "active",
|
|
"description": [
|
|
"\nActive flag"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.FleetServerAgent.enrolled_at",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "enrolled_at",
|
|
"description": [
|
|
"\nDate/time the Elastic Agent enrolled"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.FleetServerAgent.unenrolled_at",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "unenrolled_at",
|
|
"description": [
|
|
"\nDate/time the Elastic Agent unenrolled"
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.FleetServerAgent.unenrollment_started_at",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "unenrollment_started_at",
|
|
"description": [
|
|
"\nDate/time the Elastic Agent unenrolled started"
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.FleetServerAgent.upgraded_at",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "upgraded_at",
|
|
"description": [
|
|
"\nDate/time the Elastic Agent was last upgraded"
|
|
],
|
|
"signature": [
|
|
"string | null | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.FleetServerAgent.upgrade_started_at",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "upgrade_started_at",
|
|
"description": [
|
|
"\nDate/time the Elastic Agent started the current upgrade"
|
|
],
|
|
"signature": [
|
|
"string | null | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.FleetServerAgent.access_api_key_id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "access_api_key_id",
|
|
"description": [
|
|
"\nID of the API key the Elastic Agent must used to contact Fleet Server"
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.FleetServerAgent.agent",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "agent",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.FleetServerAgentMetadata",
|
|
"text": "FleetServerAgentMetadata"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.FleetServerAgent.user_provided_metadata",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "user_provided_metadata",
|
|
"description": [
|
|
"\nUser provided metadata information for the Elastic Agent"
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.AgentMetadata",
|
|
"text": "AgentMetadata"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.FleetServerAgent.local_metadata",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "local_metadata",
|
|
"description": [
|
|
"\nLocal metadata information for the Elastic Agent"
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.AgentMetadata",
|
|
"text": "AgentMetadata"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.FleetServerAgent.policy_id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "policy_id",
|
|
"description": [
|
|
"\nThe policy ID for the Elastic Agent"
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.FleetServerAgent.policy_revision_idx",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "policy_revision_idx",
|
|
"description": [
|
|
"\nThe current policy revision_idx for the Elastic Agent"
|
|
],
|
|
"signature": [
|
|
"number | null | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.FleetServerAgent.policy_coordinator_idx",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "policy_coordinator_idx",
|
|
"description": [
|
|
"\nThe current policy coordinator for the Elastic Agent"
|
|
],
|
|
"signature": [
|
|
"number | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.FleetServerAgent.last_updated",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "last_updated",
|
|
"description": [
|
|
"\nDate/time the Elastic Agent was last updated"
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.FleetServerAgent.last_checkin",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "last_checkin",
|
|
"description": [
|
|
"\nDate/time the Elastic Agent checked in last time"
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.FleetServerAgent.last_checkin_status",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "last_checkin_status",
|
|
"description": [
|
|
"\nLst checkin status"
|
|
],
|
|
"signature": [
|
|
"\"online\" | \"error\" | \"updating\" | \"degraded\" | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.FleetServerAgent.default_api_key_id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "default_api_key_id",
|
|
"description": [
|
|
"\nID of the API key the Elastic Agent uses to authenticate with elasticsearch"
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.FleetServerAgent.default_api_key",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "default_api_key",
|
|
"description": [
|
|
"\nAPI key the Elastic Agent uses to authenticate with elasticsearch"
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.FleetServerAgent.updated_at",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "updated_at",
|
|
"description": [
|
|
"\nDate/time the Elastic Agent was last updated"
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.FleetServerAgent.packages",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "packages",
|
|
"description": [
|
|
"\nPackages array"
|
|
],
|
|
"signature": [
|
|
"string[] | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.FleetServerAgent.action_seq_no",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "action_seq_no",
|
|
"description": [
|
|
"\nThe last acknowledged action sequence number for the Elastic Agent"
|
|
],
|
|
"signature": [
|
|
"number | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.FleetServerAgentAction",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "FleetServerAgentAction",
|
|
"description": [
|
|
"\nAn Elastic Agent action"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.FleetServerAgentAction._id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "_id",
|
|
"description": [
|
|
"\nThe unique identifier for action document"
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.FleetServerAgentAction._seq_no",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "_seq_no",
|
|
"description": [
|
|
"\nThe action sequence number"
|
|
],
|
|
"signature": [
|
|
"number | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.FleetServerAgentAction.action_id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"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."
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.FleetServerAgentAction.timestamp",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "'@timestamp'",
|
|
"description": [
|
|
"\nDate/time the action was created"
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.FleetServerAgentAction.expiration",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "expiration",
|
|
"description": [
|
|
"\nThe action expiration date/time"
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.FleetServerAgentAction.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [
|
|
"\nThe action type. APP_ACTION is the value for the actions that suppose to be routed to the endpoints/beats."
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.FleetServerAgentAction.input_id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "input_id",
|
|
"description": [
|
|
"\nThe input identifier the actions should be routed to."
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.FleetServerAgentAction.agents",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"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"
|
|
],
|
|
"signature": [
|
|
"string[] | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.FleetServerAgentAction.data",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "data",
|
|
"description": [
|
|
"\nThe opaque payload."
|
|
],
|
|
"signature": [
|
|
"{ [k: string]: unknown; } | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.FleetServerAgentAction.Unnamed",
|
|
"type": "Any",
|
|
"tags": [],
|
|
"label": "Unnamed",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.FleetServerAgentMetadata",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "FleetServerAgentMetadata",
|
|
"description": [
|
|
"\nAn Elastic Agent metadata"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.FleetServerAgentMetadata.id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [
|
|
"\nThe unique identifier for the Elastic Agent"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.FleetServerAgentMetadata.version",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "version",
|
|
"description": [
|
|
"\nThe version of the Elastic Agent"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.FleetServerAgentMetadata.Unnamed",
|
|
"type": "Any",
|
|
"tags": [],
|
|
"label": "Unnamed",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.FleetServerEnrollmentAPIKey",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "FleetServerEnrollmentAPIKey",
|
|
"description": [
|
|
"\nAn Elastic Agent enrollment API key"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/enrollment_api_key.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.FleetServerEnrollmentAPIKey.active",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "active",
|
|
"description": [
|
|
"\nTrue when the key is active"
|
|
],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/enrollment_api_key.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.FleetServerEnrollmentAPIKey.api_key_id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "api_key_id",
|
|
"description": [
|
|
"\nThe unique identifier for the enrollment key, currently xid"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/enrollment_api_key.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.FleetServerEnrollmentAPIKey.api_key",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "api_key",
|
|
"description": [
|
|
"\nApi key"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/enrollment_api_key.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.FleetServerEnrollmentAPIKey.name",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "name",
|
|
"description": [
|
|
"\nEnrollment key name"
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/enrollment_api_key.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.FleetServerEnrollmentAPIKey.policy_id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "policy_id",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/enrollment_api_key.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.FleetServerEnrollmentAPIKey.expire_at",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "expire_at",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/enrollment_api_key.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.FleetServerEnrollmentAPIKey.created_at",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "created_at",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/enrollment_api_key.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.FleetServerEnrollmentAPIKey.updated_at",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "updated_at",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/enrollment_api_key.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.FleetServerPolicy",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "FleetServerPolicy",
|
|
"description": [
|
|
"\nA policy that an Elastic Agent is attached to"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.FleetServerPolicy.timestamp",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "'@timestamp'",
|
|
"description": [
|
|
"\nDate/time the policy revision was created"
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.FleetServerPolicy.policy_id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "policy_id",
|
|
"description": [
|
|
"\nThe ID of the policy"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.FleetServerPolicy.revision_idx",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "revision_idx",
|
|
"description": [
|
|
"\nThe revision index of the policy"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.FleetServerPolicy.coordinator_idx",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "coordinator_idx",
|
|
"description": [
|
|
"\nThe coordinator index of the policy"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.FleetServerPolicy.data",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "data",
|
|
"description": [
|
|
"\nThe opaque payload."
|
|
],
|
|
"signature": [
|
|
"{ [k: string]: unknown; }"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.FleetServerPolicy.default_fleet_server",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "default_fleet_server",
|
|
"description": [
|
|
"\nTrue when this policy is the default policy to start Fleet Server"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.FleetServerPolicy.unenroll_timeout",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "unenroll_timeout",
|
|
"description": [
|
|
"\nAuto unenroll any Elastic Agents which have not checked in for this many seconds"
|
|
],
|
|
"signature": [
|
|
"number | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.FullAgentPolicy",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "FullAgentPolicy",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.FullAgentPolicy.id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.FullAgentPolicy.outputs",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "outputs",
|
|
"description": [],
|
|
"signature": [
|
|
"{ [key: string]: ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.FullAgentPolicyOutput",
|
|
"text": "FullAgentPolicyOutput"
|
|
},
|
|
"; }"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.FullAgentPolicy.output_permissions",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "output_permissions",
|
|
"description": [],
|
|
"signature": [
|
|
"{ [output: string]: ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.FullAgentPolicyOutputPermissions",
|
|
"text": "FullAgentPolicyOutputPermissions"
|
|
},
|
|
"; } | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.FullAgentPolicy.fleet",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "fleet",
|
|
"description": [],
|
|
"signature": [
|
|
"{ hosts: string[]; } | { kibana: ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.FullAgentPolicyKibanaConfig",
|
|
"text": "FullAgentPolicyKibanaConfig"
|
|
},
|
|
"; } | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.FullAgentPolicy.inputs",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "inputs",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.FullAgentPolicyInput",
|
|
"text": "FullAgentPolicyInput"
|
|
},
|
|
"[]"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.FullAgentPolicy.revision",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "revision",
|
|
"description": [],
|
|
"signature": [
|
|
"number | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.FullAgentPolicy.agent",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "agent",
|
|
"description": [],
|
|
"signature": [
|
|
"{ monitoring: { namespace?: string | undefined; use_output?: string | undefined; enabled: boolean; metrics: boolean; logs: boolean; }; } | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.FullAgentPolicyInput",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "FullAgentPolicyInput",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.FullAgentPolicyInput.id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.FullAgentPolicyInput.name",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "name",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.FullAgentPolicyInput.revision",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "revision",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.FullAgentPolicyInput.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.FullAgentPolicyInput.data_stream",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "data_stream",
|
|
"description": [],
|
|
"signature": [
|
|
"{ namespace: string; }"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.FullAgentPolicyInput.use_output",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "use_output",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.FullAgentPolicyInput.meta",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "meta",
|
|
"description": [],
|
|
"signature": [
|
|
"{ [key: string]: unknown; package?: Pick<",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.PackagePolicyPackage",
|
|
"text": "PackagePolicyPackage"
|
|
},
|
|
", \"name\" | \"version\"> | undefined; } | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.FullAgentPolicyInput.streams",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "streams",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.FullAgentPolicyInputStream",
|
|
"text": "FullAgentPolicyInputStream"
|
|
},
|
|
"[] | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.FullAgentPolicyInput.Unnamed",
|
|
"type": "Any",
|
|
"tags": [],
|
|
"label": "Unnamed",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.FullAgentPolicyInputStream",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "FullAgentPolicyInputStream",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.FullAgentPolicyInputStream.id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.FullAgentPolicyInputStream.data_stream",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "data_stream",
|
|
"description": [],
|
|
"signature": [
|
|
"{ dataset: string; type: string; }"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.FullAgentPolicyInputStream.Unnamed",
|
|
"type": "Any",
|
|
"tags": [],
|
|
"label": "Unnamed",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.FullAgentPolicyKibanaConfig",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "FullAgentPolicyKibanaConfig",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.FullAgentPolicyKibanaConfig.hosts",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "hosts",
|
|
"description": [],
|
|
"signature": [
|
|
"string[]"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.FullAgentPolicyKibanaConfig.protocol",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "protocol",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.FullAgentPolicyKibanaConfig.path",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "path",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.FullAgentPolicyOutputPermissions",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "FullAgentPolicyOutputPermissions",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.FullAgentPolicyOutputPermissions.Unnamed",
|
|
"type": "Any",
|
|
"tags": [],
|
|
"label": "Unnamed",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.GenerateServiceTokenResponse",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "GenerateServiceTokenResponse",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/app.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.GenerateServiceTokenResponse.name",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "name",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/app.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.GenerateServiceTokenResponse.value",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "value",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/app.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.GetAgentPoliciesRequest",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "GetAgentPoliciesRequest",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.GetAgentPoliciesRequest.query",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "query",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.ListWithKuery",
|
|
"text": "ListWithKuery"
|
|
},
|
|
" & { full?: boolean | undefined; }"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.GetAgentPoliciesResponse",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "GetAgentPoliciesResponse",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.GetAgentPoliciesResponse.items",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "items",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.GetAgentPoliciesResponseItem",
|
|
"text": "GetAgentPoliciesResponseItem"
|
|
},
|
|
"[]"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.GetAgentPoliciesResponse.total",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "total",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.GetAgentPoliciesResponse.page",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "page",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.GetAgentPoliciesResponse.perPage",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "perPage",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.GetAgentsRequest",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "GetAgentsRequest",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.GetAgentsRequest.query",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "query",
|
|
"description": [],
|
|
"signature": [
|
|
"{ page: number; perPage: number; kuery?: string | undefined; showInactive: boolean; showUpgradeable?: boolean | undefined; }"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.GetAgentsResponse",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "GetAgentsResponse",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.GetAgentsResponse.list",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "list",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.Agent",
|
|
"text": "Agent"
|
|
},
|
|
"[]"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.GetAgentsResponse.total",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "total",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.GetAgentsResponse.totalInactive",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "totalInactive",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.GetAgentsResponse.page",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "page",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.GetAgentsResponse.perPage",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "perPage",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.GetAgentStatusRequest",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "GetAgentStatusRequest",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.GetAgentStatusRequest.query",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "query",
|
|
"description": [],
|
|
"signature": [
|
|
"{ kuery?: string | undefined; policyId?: string | undefined; }"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.GetAgentStatusResponse",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "GetAgentStatusResponse",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.GetAgentStatusResponse.results",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "results",
|
|
"description": [],
|
|
"signature": [
|
|
"{ events: number; total: number; online: number; error: number; offline: number; other: number; updating: number; }"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.GetCategoriesRequest",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "GetCategoriesRequest",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.GetCategoriesRequest.query",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "query",
|
|
"description": [],
|
|
"signature": [
|
|
"{ experimental?: boolean | undefined; include_policy_templates?: boolean | undefined; }"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.GetCategoriesResponse",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "GetCategoriesResponse",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.GetCategoriesResponse.response",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "response",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.CategorySummaryItem",
|
|
"text": "CategorySummaryItem"
|
|
},
|
|
"[]"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.GetDataStreamsResponse",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "GetDataStreamsResponse",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/data_stream.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.GetDataStreamsResponse.data_streams",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "data_streams",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.DataStream",
|
|
"text": "DataStream"
|
|
},
|
|
"[]"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/data_stream.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.GetEnrollmentAPIKeysRequest",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "GetEnrollmentAPIKeysRequest",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.GetEnrollmentAPIKeysRequest.query",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "query",
|
|
"description": [],
|
|
"signature": [
|
|
"{ page: number; perPage: number; kuery?: string | undefined; }"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.GetEnrollmentAPIKeysResponse",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "GetEnrollmentAPIKeysResponse",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.GetEnrollmentAPIKeysResponse.list",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "list",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.EnrollmentAPIKey",
|
|
"text": "EnrollmentAPIKey"
|
|
},
|
|
"[]"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.GetEnrollmentAPIKeysResponse.total",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "total",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.GetEnrollmentAPIKeysResponse.page",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "page",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.GetEnrollmentAPIKeysResponse.perPage",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "perPage",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.GetFileRequest",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "GetFileRequest",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.GetFileRequest.params",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "params",
|
|
"description": [],
|
|
"signature": [
|
|
"{ pkgkey: string; filePath: string; }"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.GetFleetStatusResponse",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "GetFleetStatusResponse",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/fleet_setup.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.GetFleetStatusResponse.isReady",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "isReady",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/fleet_setup.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.GetFleetStatusResponse.missing_requirements",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "missing_requirements",
|
|
"description": [],
|
|
"signature": [
|
|
"(\"fleet_server\" | \"security_required\" | \"tls_required\" | \"api_keys\" | \"fleet_admin_user\" | \"encrypted_saved_object_encryption_key_required\")[]"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/fleet_setup.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.GetFullAgentConfigMapResponse",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "GetFullAgentConfigMapResponse",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.GetFullAgentConfigMapResponse.item",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "item",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.GetFullAgentPolicyRequest",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "GetFullAgentPolicyRequest",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.GetFullAgentPolicyRequest.params",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "params",
|
|
"description": [],
|
|
"signature": [
|
|
"{ agentPolicyId: string; }"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.GetFullAgentPolicyResponse",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "GetFullAgentPolicyResponse",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.GetFullAgentPolicyResponse.item",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "item",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.FullAgentPolicy",
|
|
"text": "FullAgentPolicy"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.GetInfoRequest",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "GetInfoRequest",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.GetInfoRequest.params",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "params",
|
|
"description": [],
|
|
"signature": [
|
|
"{ pkgkey: string; }"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.GetInfoResponse",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "GetInfoResponse",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.GetInfoResponse.response",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "response",
|
|
"description": [],
|
|
"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.Installing",
|
|
"text": "Installing"
|
|
},
|
|
"<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"
|
|
},
|
|
", ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.EpmPackageAdditions",
|
|
"text": "EpmPackageAdditions"
|
|
},
|
|
">> | ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.InstallFailed",
|
|
"text": "InstallFailed"
|
|
},
|
|
"<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.Installed",
|
|
"text": "Installed"
|
|
},
|
|
"<Merge<",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.ArchivePackage",
|
|
"text": "ArchivePackage"
|
|
},
|
|
", ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.EpmPackageAdditions",
|
|
"text": "EpmPackageAdditions"
|
|
},
|
|
">> | ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.Installing",
|
|
"text": "Installing"
|
|
},
|
|
"<Merge<",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.ArchivePackage",
|
|
"text": "ArchivePackage"
|
|
},
|
|
", ",
|
|
{
|
|
"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.ArchivePackage",
|
|
"text": "ArchivePackage"
|
|
},
|
|
", ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.EpmPackageAdditions",
|
|
"text": "EpmPackageAdditions"
|
|
},
|
|
">> | ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.InstallFailed",
|
|
"text": "InstallFailed"
|
|
},
|
|
"<Merge<",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.ArchivePackage",
|
|
"text": "ArchivePackage"
|
|
},
|
|
", ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.EpmPackageAdditions",
|
|
"text": "EpmPackageAdditions"
|
|
},
|
|
">>"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.GetLimitedPackagesResponse",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "GetLimitedPackagesResponse",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.GetLimitedPackagesResponse.response",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "response",
|
|
"description": [],
|
|
"signature": [
|
|
"string[]"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.GetOneAgentPolicyRequest",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "GetOneAgentPolicyRequest",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.GetOneAgentPolicyRequest.params",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "params",
|
|
"description": [],
|
|
"signature": [
|
|
"{ agentPolicyId: string; }"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.GetOneAgentPolicyResponse",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "GetOneAgentPolicyResponse",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.GetOneAgentPolicyResponse.item",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "item",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.AgentPolicy",
|
|
"text": "AgentPolicy"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.GetOneAgentRequest",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "GetOneAgentRequest",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.GetOneAgentRequest.params",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "params",
|
|
"description": [],
|
|
"signature": [
|
|
"{ agentId: string; }"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.GetOneAgentResponse",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "GetOneAgentResponse",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.GetOneAgentResponse.item",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "item",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.Agent",
|
|
"text": "Agent"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.GetOneEnrollmentAPIKeyRequest",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "GetOneEnrollmentAPIKeyRequest",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.GetOneEnrollmentAPIKeyRequest.params",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "params",
|
|
"description": [],
|
|
"signature": [
|
|
"{ keyId: string; }"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.GetOneEnrollmentAPIKeyResponse",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "GetOneEnrollmentAPIKeyResponse",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.GetOneEnrollmentAPIKeyResponse.item",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "item",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.EnrollmentAPIKey",
|
|
"text": "EnrollmentAPIKey"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.GetOneOutputRequest",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "GetOneOutputRequest",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/output.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.GetOneOutputRequest.params",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "params",
|
|
"description": [],
|
|
"signature": [
|
|
"{ outputId: string; }"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/output.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.GetOneOutputResponse",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "GetOneOutputResponse",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/output.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.GetOneOutputResponse.item",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "item",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.NewOutput",
|
|
"text": "NewOutput"
|
|
},
|
|
" & { id: string; }"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/output.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.GetOnePackagePolicyRequest",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "GetOnePackagePolicyRequest",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.GetOnePackagePolicyRequest.params",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "params",
|
|
"description": [],
|
|
"signature": [
|
|
"{ packagePolicyId: string; }"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.GetOnePackagePolicyResponse",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "GetOnePackagePolicyResponse",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.GetOnePackagePolicyResponse.item",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "item",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.PackagePolicy",
|
|
"text": "PackagePolicy"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.GetOutputsResponse",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "GetOutputsResponse",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/output.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.GetOutputsResponse.items",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "items",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.Output",
|
|
"text": "Output"
|
|
},
|
|
"[]"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/output.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.GetOutputsResponse.total",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "total",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/output.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.GetOutputsResponse.page",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "page",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/output.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.GetOutputsResponse.perPage",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "perPage",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/output.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.GetPackagePoliciesRequest",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "GetPackagePoliciesRequest",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.GetPackagePoliciesRequest.query",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "query",
|
|
"description": [],
|
|
"signature": [
|
|
"{ page: number; perPage: number; kuery?: string | undefined; }"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.GetPackagePoliciesResponse",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "GetPackagePoliciesResponse",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.GetPackagePoliciesResponse.items",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "items",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.PackagePolicy",
|
|
"text": "PackagePolicy"
|
|
},
|
|
"[]"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.GetPackagePoliciesResponse.total",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "total",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.GetPackagePoliciesResponse.page",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "page",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.GetPackagePoliciesResponse.perPage",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "perPage",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.GetPackagesRequest",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "GetPackagesRequest",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.GetPackagesRequest.query",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "query",
|
|
"description": [],
|
|
"signature": [
|
|
"{ category?: string | undefined; experimental?: boolean | undefined; }"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.GetPackagesResponse",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "GetPackagesResponse",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.GetPackagesResponse.response",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "response",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.PackageListItem",
|
|
"text": "PackageListItem"
|
|
},
|
|
"[]"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.GetSettingsResponse",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "GetSettingsResponse",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/settings.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.GetSettingsResponse.item",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "item",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.Settings",
|
|
"text": "Settings"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/settings.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.GetStatsRequest",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "GetStatsRequest",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.GetStatsRequest.params",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "params",
|
|
"description": [],
|
|
"signature": [
|
|
"{ pkgname: string; }"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.GetStatsResponse",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "GetStatsResponse",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.GetStatsResponse.response",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "response",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.PackageUsageStats",
|
|
"text": "PackageUsageStats"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.IBulkInstallPackageHTTPError",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "IBulkInstallPackageHTTPError",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.IBulkInstallPackageHTTPError.name",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "name",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.IBulkInstallPackageHTTPError.statusCode",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "statusCode",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.IBulkInstallPackageHTTPError.error",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "error",
|
|
"description": [],
|
|
"signature": [
|
|
"string | Error"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.IndexTemplate",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "IndexTemplate",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.IndexTemplate.priority",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "priority",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.IndexTemplate.index_patterns",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "index_patterns",
|
|
"description": [],
|
|
"signature": [
|
|
"string[]"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.IndexTemplate.template",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "template",
|
|
"description": [],
|
|
"signature": [
|
|
"{ settings: any; mappings: any; }"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.IndexTemplate.data_stream",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "data_stream",
|
|
"description": [],
|
|
"signature": [
|
|
"{ hidden?: boolean | undefined; }"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.IndexTemplate.composed_of",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "composed_of",
|
|
"description": [],
|
|
"signature": [
|
|
"string[]"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.IndexTemplate._meta",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "_meta",
|
|
"description": [],
|
|
"signature": [
|
|
"object"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.IndexTemplateEntry",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "IndexTemplateEntry",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.IndexTemplateEntry.templateName",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "templateName",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.IndexTemplateEntry.indexTemplate",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "indexTemplate",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.IndexTemplate",
|
|
"text": "IndexTemplate"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.IndexTemplateMappings",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "IndexTemplateMappings",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.IndexTemplateMappings.properties",
|
|
"type": "Any",
|
|
"tags": [],
|
|
"label": "properties",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.Installation",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "Installation",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.Installation",
|
|
"text": "Installation"
|
|
},
|
|
" extends ",
|
|
"SavedObjectAttributes"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.Installation.installed_kibana",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "installed_kibana",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.KibanaAssetReference",
|
|
"text": "KibanaAssetReference"
|
|
},
|
|
"[]"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.Installation.installed_es",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "installed_es",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.EsAssetReference",
|
|
"text": "EsAssetReference"
|
|
},
|
|
"[]"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.Installation.package_assets",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "package_assets",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.PackageAssetReference",
|
|
"text": "PackageAssetReference"
|
|
},
|
|
"[] | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.Installation.es_index_patterns",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "es_index_patterns",
|
|
"description": [],
|
|
"signature": [
|
|
"{ [x: string]: string; }"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.Installation.name",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "name",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.Installation.version",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "version",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.Installation.install_status",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "install_status",
|
|
"description": [],
|
|
"signature": [
|
|
"\"installed\" | \"installing\" | \"install_failed\""
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.Installation.install_version",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "install_version",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.Installation.install_started_at",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "install_started_at",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.Installation.install_source",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "install_source",
|
|
"description": [],
|
|
"signature": [
|
|
"\"registry\" | \"upload\""
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.Installation.keep_policies_up_to_date",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "keep_policies_up_to_date",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.InstallPackageRequest",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "InstallPackageRequest",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.InstallPackageRequest.params",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "params",
|
|
"description": [],
|
|
"signature": [
|
|
"{ pkgkey: string; }"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.InstallPackageResponse",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "InstallPackageResponse",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.InstallPackageResponse.response",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "response",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.AssetReference",
|
|
"text": "AssetReference"
|
|
},
|
|
"[]"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.InstallResult",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "InstallResult",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.InstallResult.assets",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "assets",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.AssetReference",
|
|
"text": "AssetReference"
|
|
},
|
|
"[] | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.InstallResult.status",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "status",
|
|
"description": [],
|
|
"signature": [
|
|
"\"installed\" | \"already_installed\" | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.InstallResult.error",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "error",
|
|
"description": [],
|
|
"signature": [
|
|
"Error | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.InstallResult.installType",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "installType",
|
|
"description": [],
|
|
"signature": [
|
|
"\"update\" | \"unknown\" | \"reinstall\" | \"reupdate\" | \"rollback\" | \"install\""
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.IntegrationCardItem",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "IntegrationCardItem",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.IntegrationCardItem.url",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "url",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.IntegrationCardItem.release",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "release",
|
|
"description": [],
|
|
"signature": [
|
|
"\"experimental\" | \"beta\" | \"ga\" | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.IntegrationCardItem.description",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "description",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.IntegrationCardItem.name",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "name",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.IntegrationCardItem.title",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "title",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.IntegrationCardItem.version",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "version",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.IntegrationCardItem.icons",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "icons",
|
|
"description": [],
|
|
"signature": [
|
|
"(",
|
|
{
|
|
"pluginId": "customIntegrations",
|
|
"scope": "common",
|
|
"docId": "kibCustomIntegrationsPluginApi",
|
|
"section": "def-common.CustomIntegrationIcon",
|
|
"text": "CustomIntegrationIcon"
|
|
},
|
|
" | ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.PackageSpecIcon",
|
|
"text": "PackageSpecIcon"
|
|
},
|
|
")[]"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.IntegrationCardItem.integration",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "integration",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.IntegrationCardItem.id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.IntegrationCardItem.categories",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "categories",
|
|
"description": [],
|
|
"signature": [
|
|
"string[]"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.ListResult",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "ListResult",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.ListResult",
|
|
"text": "ListResult"
|
|
},
|
|
"<T>"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/common.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.ListResult.items",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "items",
|
|
"description": [],
|
|
"signature": [
|
|
"T[]"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/common.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.ListResult.total",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "total",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/common.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.ListResult.page",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "page",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/common.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.ListResult.perPage",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "perPage",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/common.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.ListWithKuery",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "ListWithKuery",
|
|
"description": [],
|
|
"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"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/common.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.ListWithKuery.page",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "page",
|
|
"description": [],
|
|
"signature": [
|
|
"number | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/common.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.ListWithKuery.perPage",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "perPage",
|
|
"description": [],
|
|
"signature": [
|
|
"number | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/common.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.ListWithKuery.sortField",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "sortField",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/common.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.ListWithKuery.sortOrder",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "sortOrder",
|
|
"description": [],
|
|
"signature": [
|
|
"\"asc\" | \"desc\" | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/common.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.ListWithKuery.kuery",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "kuery",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/common.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.MessageResponse",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "MessageResponse",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.MessageResponse.response",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "response",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.NewAgentAction",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "NewAgentAction",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.NewAgentAction.type",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
"\"POLICY_CHANGE\" | \"UNENROLL\" | \"UPGRADE\" | \"SETTINGS\" | \"POLICY_REASSIGN\""
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.NewAgentAction.data",
|
|
"type": "Any",
|
|
"tags": [],
|
|
"label": "data",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.NewAgentAction.sent_at",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "sent_at",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.NewAgentPolicy",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "NewAgentPolicy",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.NewAgentPolicy.name",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "name",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.NewAgentPolicy.namespace",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "namespace",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.NewAgentPolicy.description",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "description",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.NewAgentPolicy.is_default",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "is_default",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.NewAgentPolicy.is_default_fleet_server",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "is_default_fleet_server",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.NewAgentPolicy.is_managed",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "is_managed",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.NewAgentPolicy.monitoring_enabled",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "monitoring_enabled",
|
|
"description": [],
|
|
"signature": [
|
|
"(\"metrics\" | \"logs\")[] | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.NewAgentPolicy.unenroll_timeout",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "unenroll_timeout",
|
|
"description": [],
|
|
"signature": [
|
|
"number | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.NewAgentPolicy.is_preconfigured",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "is_preconfigured",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.NewAgentPolicy.data_output_id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "data_output_id",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.NewAgentPolicy.monitoring_output_id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "monitoring_output_id",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.NewOutput",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "NewOutput",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/output.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.NewOutput.is_default",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "is_default",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/output.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.NewOutput.name",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "name",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/output.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.NewOutput.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
"\"elasticsearch\""
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/output.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.NewOutput.hosts",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "hosts",
|
|
"description": [],
|
|
"signature": [
|
|
"string[] | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/output.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.NewOutput.ca_sha256",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "ca_sha256",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/output.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.NewOutput.api_key",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "api_key",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/output.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.NewOutput.config_yaml",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "config_yaml",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/output.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.NewOutput.is_preconfigured",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "is_preconfigured",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/output.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.NewPackagePolicy",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "NewPackagePolicy",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/package_policy.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.NewPackagePolicy.name",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "name",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/package_policy.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.NewPackagePolicy.description",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "description",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/package_policy.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.NewPackagePolicy.namespace",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "namespace",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/package_policy.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.NewPackagePolicy.enabled",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "enabled",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/package_policy.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.NewPackagePolicy.policy_id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "policy_id",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/package_policy.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.NewPackagePolicy.output_id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "output_id",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/package_policy.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.NewPackagePolicy.package",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "package",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.PackagePolicyPackage",
|
|
"text": "PackagePolicyPackage"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/package_policy.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.NewPackagePolicy.inputs",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "inputs",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.NewPackagePolicyInput",
|
|
"text": "NewPackagePolicyInput"
|
|
},
|
|
"[]"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/package_policy.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.NewPackagePolicy.vars",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "vars",
|
|
"description": [],
|
|
"signature": [
|
|
"Record<string, ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.PackagePolicyConfigRecordEntry",
|
|
"text": "PackagePolicyConfigRecordEntry"
|
|
},
|
|
"> | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/package_policy.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.NewPackagePolicy.elasticsearch",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "elasticsearch",
|
|
"description": [],
|
|
"signature": [
|
|
"{ privileges?: { cluster?: string[] | undefined; } | undefined; } | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/package_policy.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.NewPackagePolicyInput",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "NewPackagePolicyInput",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/package_policy.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.NewPackagePolicyInput.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/package_policy.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.NewPackagePolicyInput.policy_template",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "policy_template",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/package_policy.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.NewPackagePolicyInput.enabled",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "enabled",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/package_policy.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.NewPackagePolicyInput.keep_enabled",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "keep_enabled",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/package_policy.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.NewPackagePolicyInput.vars",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "vars",
|
|
"description": [],
|
|
"signature": [
|
|
"Record<string, ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.PackagePolicyConfigRecordEntry",
|
|
"text": "PackagePolicyConfigRecordEntry"
|
|
},
|
|
"> | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/package_policy.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.NewPackagePolicyInput.config",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "config",
|
|
"description": [],
|
|
"signature": [
|
|
"Record<string, ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.PackagePolicyConfigRecordEntry",
|
|
"text": "PackagePolicyConfigRecordEntry"
|
|
},
|
|
"> | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/package_policy.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.NewPackagePolicyInput.streams",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "streams",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.NewPackagePolicyInputStream",
|
|
"text": "NewPackagePolicyInputStream"
|
|
},
|
|
"[]"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/package_policy.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.NewPackagePolicyInputStream",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "NewPackagePolicyInputStream",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/package_policy.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.NewPackagePolicyInputStream.enabled",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "enabled",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/package_policy.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.NewPackagePolicyInputStream.keep_enabled",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "keep_enabled",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/package_policy.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.NewPackagePolicyInputStream.data_stream",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "data_stream",
|
|
"description": [],
|
|
"signature": [
|
|
"{ dataset: string; type: string; elasticsearch?: { privileges?: { indices?: string[] | undefined; } | undefined; } | undefined; }"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/package_policy.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.NewPackagePolicyInputStream.vars",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "vars",
|
|
"description": [],
|
|
"signature": [
|
|
"Record<string, ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.PackagePolicyConfigRecordEntry",
|
|
"text": "PackagePolicyConfigRecordEntry"
|
|
},
|
|
"> | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/package_policy.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.NewPackagePolicyInputStream.config",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "config",
|
|
"description": [],
|
|
"signature": [
|
|
"Record<string, ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.PackagePolicyConfigRecordEntry",
|
|
"text": "PackagePolicyConfigRecordEntry"
|
|
},
|
|
"> | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/package_policy.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.PackagePolicy",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "PackagePolicy",
|
|
"description": [],
|
|
"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"
|
|
},
|
|
", \"description\" | \"name\" | \"enabled\" | \"package\" | \"policy_id\" | \"namespace\" | \"output_id\" | \"vars\" | \"elasticsearch\">"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/package_policy.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.PackagePolicy.id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/package_policy.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.PackagePolicy.inputs",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "inputs",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.PackagePolicyInput",
|
|
"text": "PackagePolicyInput"
|
|
},
|
|
"[]"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/package_policy.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.PackagePolicy.version",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "version",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/package_policy.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.PackagePolicy.revision",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "revision",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/package_policy.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.PackagePolicy.updated_at",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "updated_at",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/package_policy.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.PackagePolicy.updated_by",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "updated_by",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/package_policy.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.PackagePolicy.created_at",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "created_at",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/package_policy.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.PackagePolicy.created_by",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "created_by",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/package_policy.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.PackagePolicyConfigRecordEntry",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "PackagePolicyConfigRecordEntry",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/package_policy.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.PackagePolicyConfigRecordEntry.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/package_policy.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.PackagePolicyConfigRecordEntry.value",
|
|
"type": "Any",
|
|
"tags": [],
|
|
"label": "value",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/package_policy.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.PackagePolicyConfigRecordEntry.frozen",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "frozen",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/package_policy.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.PackagePolicyConfigValidationResults",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "PackagePolicyConfigValidationResults",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/services/validate_package_policy.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.PackagePolicyConfigValidationResults.vars",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "vars",
|
|
"description": [],
|
|
"signature": [
|
|
"Record<string, string[] | null> | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/services/validate_package_policy.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.PackagePolicyInput",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "PackagePolicyInput",
|
|
"description": [],
|
|
"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\" | \"policy_template\" | \"keep_enabled\">"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/package_policy.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.PackagePolicyInput.streams",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "streams",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.PackagePolicyInputStream",
|
|
"text": "PackagePolicyInputStream"
|
|
},
|
|
"[]"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/package_policy.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.PackagePolicyInput.compiled_input",
|
|
"type": "Any",
|
|
"tags": [],
|
|
"label": "compiled_input",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/package_policy.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.PackagePolicyInputStream",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "PackagePolicyInputStream",
|
|
"description": [],
|
|
"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"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/package_policy.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.PackagePolicyInputStream.id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/package_policy.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.PackagePolicyInputStream.compiled_stream",
|
|
"type": "Any",
|
|
"tags": [],
|
|
"label": "compiled_stream",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/package_policy.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.PackagePolicyPackage",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "PackagePolicyPackage",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/package_policy.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.PackagePolicyPackage.name",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "name",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/package_policy.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.PackagePolicyPackage.title",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "title",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/package_policy.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.PackagePolicyPackage.version",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "version",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/package_policy.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.PackageSpecIcon",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "PackageSpecIcon",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/package_spec.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.PackageSpecIcon.src",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "src",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/package_spec.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.PackageSpecIcon.title",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "title",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/package_spec.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.PackageSpecIcon.size",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "size",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/package_spec.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.PackageSpecIcon.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/package_spec.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.PackageSpecManifest",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "PackageSpecManifest",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/package_spec.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.PackageSpecManifest.format_version",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "format_version",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/package_spec.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.PackageSpecManifest.name",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "name",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/package_spec.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.PackageSpecManifest.title",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "title",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/package_spec.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.PackageSpecManifest.description",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "description",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/package_spec.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.PackageSpecManifest.version",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "version",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/package_spec.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.PackageSpecManifest.license",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "license",
|
|
"description": [],
|
|
"signature": [
|
|
"\"basic\" | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/package_spec.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.PackageSpecManifest.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
"\"integration\" | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/package_spec.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.PackageSpecManifest.release",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "release",
|
|
"description": [],
|
|
"signature": [
|
|
"\"experimental\" | \"beta\" | \"ga\""
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/package_spec.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.PackageSpecManifest.categories",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "categories",
|
|
"description": [],
|
|
"signature": [
|
|
"(\"custom\" | \"aws\" | \"azure\" | \"cloud\" | \"config_management\" | \"containers\" | \"crm\" | \"datastore\" | \"elastic_stack\" | \"google_cloud\" | \"kubernetes\" | \"languages\" | \"message_queue\" | \"monitoring\" | \"network\" | \"notification\" | \"os_system\" | \"productivity\" | \"security\" | \"support\" | \"ticketing\" | \"version_control\" | \"web\" | undefined)[] | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/package_spec.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.PackageSpecManifest.conditions",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "conditions",
|
|
"description": [],
|
|
"signature": [
|
|
"Record<\"kibana\", { version: string; }> | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/package_spec.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.PackageSpecManifest.icons",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "icons",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.PackageSpecIcon",
|
|
"text": "PackageSpecIcon"
|
|
},
|
|
"[] | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/package_spec.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.PackageSpecManifest.screenshots",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "screenshots",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.PackageSpecScreenshot",
|
|
"text": "PackageSpecScreenshot"
|
|
},
|
|
"[] | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/package_spec.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.PackageSpecManifest.policy_templates",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "policy_templates",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.RegistryPolicyTemplate",
|
|
"text": "RegistryPolicyTemplate"
|
|
},
|
|
"[] | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/package_spec.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.PackageSpecManifest.vars",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "vars",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.RegistryVarsEntry",
|
|
"text": "RegistryVarsEntry"
|
|
},
|
|
"[] | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/package_spec.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.PackageSpecManifest.owner",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "owner",
|
|
"description": [],
|
|
"signature": [
|
|
"{ github: string; }"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/package_spec.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.PackageSpecScreenshot",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "PackageSpecScreenshot",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/package_spec.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.PackageSpecScreenshot.src",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "src",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/package_spec.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.PackageSpecScreenshot.title",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "title",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/package_spec.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.PackageSpecScreenshot.size",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "size",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/package_spec.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.PackageSpecScreenshot.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/package_spec.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.PackageUsageStats",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "PackageUsageStats",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.PackageUsageStats.agent_policy_count",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "agent_policy_count",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.PostAgentUnenrollRequest",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "PostAgentUnenrollRequest",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.PostAgentUnenrollRequest.params",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "params",
|
|
"description": [],
|
|
"signature": [
|
|
"{ agentId: string; }"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.PostAgentUnenrollRequest.body",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "body",
|
|
"description": [],
|
|
"signature": [
|
|
"{ force?: boolean | undefined; revoke?: boolean | undefined; }"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.PostAgentUnenrollResponse",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "PostAgentUnenrollResponse",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.PostAgentUpgradeRequest",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "PostAgentUpgradeRequest",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.PostAgentUpgradeRequest.params",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "params",
|
|
"description": [],
|
|
"signature": [
|
|
"{ agentId: string; }"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.PostAgentUpgradeRequest.body",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "body",
|
|
"description": [],
|
|
"signature": [
|
|
"{ source_uri?: string | undefined; version: string; }"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.PostAgentUpgradeResponse",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "PostAgentUpgradeResponse",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.PostBulkAgentReassignRequest",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "PostBulkAgentReassignRequest",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.PostBulkAgentReassignRequest.body",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "body",
|
|
"description": [],
|
|
"signature": [
|
|
"{ policy_id: string; agents: string | string[]; }"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.PostBulkAgentUnenrollRequest",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "PostBulkAgentUnenrollRequest",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.PostBulkAgentUnenrollRequest.body",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "body",
|
|
"description": [],
|
|
"signature": [
|
|
"{ agents: string | string[]; force?: boolean | undefined; revoke?: boolean | undefined; }"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.PostBulkAgentUpgradeRequest",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "PostBulkAgentUpgradeRequest",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.PostBulkAgentUpgradeRequest.body",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "body",
|
|
"description": [],
|
|
"signature": [
|
|
"{ agents: string | string[]; source_uri?: string | undefined; version: string; }"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.PostEnrollmentAPIKeyRequest",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "PostEnrollmentAPIKeyRequest",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.PostEnrollmentAPIKeyRequest.body",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "body",
|
|
"description": [],
|
|
"signature": [
|
|
"{ name?: string | undefined; policy_id: string; expiration?: string | undefined; }"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.PostEnrollmentAPIKeyResponse",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "PostEnrollmentAPIKeyResponse",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.PostEnrollmentAPIKeyResponse.action",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "action",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.PostEnrollmentAPIKeyResponse.item",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "item",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.EnrollmentAPIKey",
|
|
"text": "EnrollmentAPIKey"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.PostFleetSetupResponse",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "PostFleetSetupResponse",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/fleet_setup.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.PostFleetSetupResponse.isInitialized",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "isInitialized",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/fleet_setup.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.PostFleetSetupResponse.nonFatalErrors",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "nonFatalErrors",
|
|
"description": [],
|
|
"signature": [
|
|
"{ name: string; message: string; }[]"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/fleet_setup.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.PostNewAgentActionRequest",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "PostNewAgentActionRequest",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.PostNewAgentActionRequest.body",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "body",
|
|
"description": [],
|
|
"signature": [
|
|
"{ action: ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.NewAgentAction",
|
|
"text": "NewAgentAction"
|
|
},
|
|
"; }"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.PostNewAgentActionRequest.params",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "params",
|
|
"description": [],
|
|
"signature": [
|
|
"{ agentId: string; }"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.PostNewAgentActionResponse",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "PostNewAgentActionResponse",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.PostNewAgentActionResponse.item",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "item",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.AgentAction",
|
|
"text": "AgentAction"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.PreconfigurationError",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "PreconfigurationError",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/constants/preconfiguration.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.PreconfigurationError.package",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "package",
|
|
"description": [],
|
|
"signature": [
|
|
"{ name: string; version: string; } | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/constants/preconfiguration.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.PreconfigurationError.agentPolicy",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "agentPolicy",
|
|
"description": [],
|
|
"signature": [
|
|
"{ name: string; } | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/constants/preconfiguration.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.PreconfigurationError.error",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "error",
|
|
"description": [],
|
|
"signature": [
|
|
"Error"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/constants/preconfiguration.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.PreconfiguredAgentPolicy",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "PreconfiguredAgentPolicy",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.PreconfiguredAgentPolicy",
|
|
"text": "PreconfiguredAgentPolicy"
|
|
},
|
|
" extends Pick<",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.NewAgentPolicy",
|
|
"text": "NewAgentPolicy"
|
|
},
|
|
", \"description\" | \"name\" | \"is_default\" | \"is_default_fleet_server\" | \"is_managed\" | \"monitoring_enabled\" | \"unenroll_timeout\" | \"is_preconfigured\" | \"data_output_id\" | \"monitoring_output_id\">"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/preconfiguration.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.PreconfiguredAgentPolicy.id",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"signature": [
|
|
"string | number"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/preconfiguration.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.PreconfiguredAgentPolicy.namespace",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "namespace",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/preconfiguration.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.PreconfiguredAgentPolicy.package_policies",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "package_policies",
|
|
"description": [],
|
|
"signature": [
|
|
"(Partial<Pick<",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.NewPackagePolicy",
|
|
"text": "NewPackagePolicy"
|
|
},
|
|
", \"description\" | \"name\" | \"enabled\" | \"policy_id\" | \"namespace\" | \"output_id\" | \"vars\" | \"elasticsearch\">> & { name: string; package: Partial<",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.PackagePolicyPackage",
|
|
"text": "PackagePolicyPackage"
|
|
},
|
|
"> & { name: string; }; inputs?: ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.InputsOverride",
|
|
"text": "InputsOverride"
|
|
},
|
|
"[] | undefined; })[]"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/preconfiguration.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.PreconfiguredOutput",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "PreconfiguredOutput",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.PreconfiguredOutput",
|
|
"text": "PreconfiguredOutput"
|
|
},
|
|
" extends Pick<",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.Output",
|
|
"text": "Output"
|
|
},
|
|
", \"type\" | \"id\" | \"name\" | \"is_default\" | \"is_preconfigured\" | \"hosts\" | \"ca_sha256\" | \"api_key\">"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/preconfiguration.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.PreconfiguredOutput.config",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "config",
|
|
"description": [],
|
|
"signature": [
|
|
"Record<string, unknown> | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/preconfiguration.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.PutAgentReassignRequest",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "PutAgentReassignRequest",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.PutAgentReassignRequest.params",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "params",
|
|
"description": [],
|
|
"signature": [
|
|
"{ agentId: string; }"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.PutAgentReassignRequest.body",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "body",
|
|
"description": [],
|
|
"signature": [
|
|
"{ policy_id: string; }"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.PutAgentReassignResponse",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "PutAgentReassignResponse",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.PutOutputRequest",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "PutOutputRequest",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/output.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.PutOutputRequest.params",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "params",
|
|
"description": [],
|
|
"signature": [
|
|
"{ outputId: string; }"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/output.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.PutOutputRequest.body",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "body",
|
|
"description": [],
|
|
"signature": [
|
|
"{ hosts?: string[] | undefined; ca_sha256?: string | undefined; config?: Record<string, any> | undefined; config_yaml?: string | undefined; }"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/output.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.PutOutputResponse",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "PutOutputResponse",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/output.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.PutOutputResponse.item",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "item",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.NewOutput",
|
|
"text": "NewOutput"
|
|
},
|
|
" & { id: string; }"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/output.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.PutSettingsRequest",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "PutSettingsRequest",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/settings.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.PutSettingsRequest.body",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "body",
|
|
"description": [],
|
|
"signature": [
|
|
"{ has_seen_add_data_notice?: boolean | undefined; has_seen_fleet_migration_notice?: boolean | undefined; fleet_server_hosts?: string[] | undefined; }"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/settings.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.PutSettingsResponse",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "PutSettingsResponse",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/settings.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.PutSettingsResponse.item",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "item",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.Settings",
|
|
"text": "Settings"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/settings.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.RegistryDataStream",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "RegistryDataStream",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.RegistryDataStream.RegistryDataStreamKeys.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "[RegistryDataStreamKeys.type]",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.RegistryDataStream.RegistryDataStreamKeys.ilm_policy",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "[RegistryDataStreamKeys.ilm_policy]",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.RegistryDataStream.RegistryDataStreamKeys.hidden",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "[RegistryDataStreamKeys.hidden]",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.RegistryDataStream.RegistryDataStreamKeys.dataset",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "[RegistryDataStreamKeys.dataset]",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.RegistryDataStream.RegistryDataStreamKeys.title",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "[RegistryDataStreamKeys.title]",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.RegistryDataStream.RegistryDataStreamKeys.release",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "[RegistryDataStreamKeys.release]",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.RegistryDataStream.RegistryDataStreamKeys.streams",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "[RegistryDataStreamKeys.streams]",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.RegistryStream",
|
|
"text": "RegistryStream"
|
|
},
|
|
"[] | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.RegistryDataStream.RegistryDataStreamKeys.package",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "[RegistryDataStreamKeys.package]",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.RegistryDataStream.RegistryDataStreamKeys.path",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "[RegistryDataStreamKeys.path]",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.RegistryDataStream.RegistryDataStreamKeys.ingest_pipeline",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "[RegistryDataStreamKeys.ingest_pipeline]",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.RegistryDataStream.RegistryDataStreamKeys.elasticsearch",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "[RegistryDataStreamKeys.elasticsearch]",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.RegistryElasticsearch",
|
|
"text": "RegistryElasticsearch"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.RegistryDataStream.RegistryDataStreamKeys.dataset_is_prefix",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "[RegistryDataStreamKeys.dataset_is_prefix]",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.RegistryDataStreamPrivileges",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "RegistryDataStreamPrivileges",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.RegistryDataStreamPrivileges.cluster",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "cluster",
|
|
"description": [],
|
|
"signature": [
|
|
"string[] | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.RegistryDataStreamPrivileges.indices",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "indices",
|
|
"description": [],
|
|
"signature": [
|
|
"string[] | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.RegistryElasticsearch",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "RegistryElasticsearch",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.RegistryElasticsearch.privileges",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "privileges",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.RegistryDataStreamPrivileges",
|
|
"text": "RegistryDataStreamPrivileges"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.RegistryElasticsearch.index_template.settings",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "'index_template.settings'",
|
|
"description": [],
|
|
"signature": [
|
|
"IndicesIndexSettings",
|
|
" | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.RegistryElasticsearch.index_template.mappings",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "'index_template.mappings'",
|
|
"description": [],
|
|
"signature": [
|
|
"MappingTypeMapping",
|
|
" | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.RegistryImage",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "RegistryImage",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.RegistryImage",
|
|
"text": "RegistryImage"
|
|
},
|
|
" extends ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.PackageSpecIcon",
|
|
"text": "PackageSpecIcon"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.RegistryImage.path",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "path",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.RegistryInput",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "RegistryInput",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.RegistryInput.RegistryInputKeys.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "[RegistryInputKeys.type]",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.RegistryInput.RegistryInputKeys.title",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "[RegistryInputKeys.title]",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.RegistryInput.RegistryInputKeys.description",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "[RegistryInputKeys.description]",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.RegistryInput.RegistryInputKeys.template_path",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "[RegistryInputKeys.template_path]",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.RegistryInput.RegistryInputKeys.condition",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "[RegistryInputKeys.condition]",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.RegistryInput.RegistryInputKeys.input_group",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "[RegistryInputKeys.input_group]",
|
|
"description": [],
|
|
"signature": [
|
|
"\"metrics\" | \"logs\" | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.RegistryInput.RegistryInputKeys.vars",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "[RegistryInputKeys.vars]",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.RegistryVarsEntry",
|
|
"text": "RegistryVarsEntry"
|
|
},
|
|
"[] | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.RegistryPolicyTemplate",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "RegistryPolicyTemplate",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.RegistryPolicyTemplate.RegistryPolicyTemplateKeys.name",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "[RegistryPolicyTemplateKeys.name]",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.RegistryPolicyTemplate.RegistryPolicyTemplateKeys.title",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "[RegistryPolicyTemplateKeys.title]",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.RegistryPolicyTemplate.RegistryPolicyTemplateKeys.description",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "[RegistryPolicyTemplateKeys.description]",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.RegistryPolicyTemplate.RegistryPolicyTemplateKeys.icons",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "[RegistryPolicyTemplateKeys.icons]",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.RegistryImage",
|
|
"text": "RegistryImage"
|
|
},
|
|
"[] | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.RegistryPolicyTemplate.RegistryPolicyTemplateKeys.screenshots",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "[RegistryPolicyTemplateKeys.screenshots]",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.RegistryImage",
|
|
"text": "RegistryImage"
|
|
},
|
|
"[] | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.RegistryPolicyTemplate.RegistryPolicyTemplateKeys.categories",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "[RegistryPolicyTemplateKeys.categories]",
|
|
"description": [],
|
|
"signature": [
|
|
"(\"custom\" | \"aws\" | \"azure\" | \"cloud\" | \"config_management\" | \"containers\" | \"crm\" | \"datastore\" | \"elastic_stack\" | \"google_cloud\" | \"kubernetes\" | \"languages\" | \"message_queue\" | \"monitoring\" | \"network\" | \"notification\" | \"os_system\" | \"productivity\" | \"security\" | \"support\" | \"ticketing\" | \"version_control\" | \"web\" | undefined)[] | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.RegistryPolicyTemplate.RegistryPolicyTemplateKeys.data_streams",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "[RegistryPolicyTemplateKeys.data_streams]",
|
|
"description": [],
|
|
"signature": [
|
|
"string[] | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.RegistryPolicyTemplate.RegistryPolicyTemplateKeys.inputs",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "[RegistryPolicyTemplateKeys.inputs]",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.RegistryInput",
|
|
"text": "RegistryInput"
|
|
},
|
|
"[] | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.RegistryPolicyTemplate.RegistryPolicyTemplateKeys.readme",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "[RegistryPolicyTemplateKeys.readme]",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.RegistryPolicyTemplate.RegistryPolicyTemplateKeys.multiple",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "[RegistryPolicyTemplateKeys.multiple]",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.RegistryStream",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "RegistryStream",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.RegistryStream.RegistryStreamKeys.input",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "[RegistryStreamKeys.input]",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.RegistryStream.RegistryStreamKeys.title",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "[RegistryStreamKeys.title]",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.RegistryStream.RegistryStreamKeys.description",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "[RegistryStreamKeys.description]",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.RegistryStream.RegistryStreamKeys.enabled",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "[RegistryStreamKeys.enabled]",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.RegistryStream.RegistryStreamKeys.vars",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "[RegistryStreamKeys.vars]",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.RegistryVarsEntry",
|
|
"text": "RegistryVarsEntry"
|
|
},
|
|
"[] | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.RegistryStream.RegistryStreamKeys.template_path",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "[RegistryStreamKeys.template_path]",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.RegistryVarsEntry",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "RegistryVarsEntry",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.RegistryVarsEntry.RegistryVarsEntryKeys.name",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "[RegistryVarsEntryKeys.name]",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.RegistryVarsEntry.RegistryVarsEntryKeys.title",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "[RegistryVarsEntryKeys.title]",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.RegistryVarsEntry.RegistryVarsEntryKeys.description",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "[RegistryVarsEntryKeys.description]",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.RegistryVarsEntry.RegistryVarsEntryKeys.type",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "[RegistryVarsEntryKeys.type]",
|
|
"description": [],
|
|
"signature": [
|
|
"\"string\" | \"text\" | \"yaml\" | \"integer\" | \"bool\" | \"password\""
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.RegistryVarsEntry.RegistryVarsEntryKeys.required",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "[RegistryVarsEntryKeys.required]",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.RegistryVarsEntry.RegistryVarsEntryKeys.show_user",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "[RegistryVarsEntryKeys.show_user]",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.RegistryVarsEntry.RegistryVarsEntryKeys.multi",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "[RegistryVarsEntryKeys.multi]",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.RegistryVarsEntry.RegistryVarsEntryKeys.default",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "[RegistryVarsEntryKeys.default]",
|
|
"description": [],
|
|
"signature": [
|
|
"string | boolean | string[] | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.RegistryVarsEntry.RegistryVarsEntryKeys.os",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "[RegistryVarsEntryKeys.os]",
|
|
"description": [],
|
|
"signature": [
|
|
"{ [key: string]: { default: string | string[]; }; } | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.ServiceRequirements",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "ServiceRequirements",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.ServiceRequirements.versions",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "versions",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.Settings",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "Settings",
|
|
"description": [],
|
|
"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"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/settings.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.Settings.id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/settings.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.SettingsSOAttributes",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "SettingsSOAttributes",
|
|
"description": [],
|
|
"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"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/settings.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.UpdateAgentPolicyResponse",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "UpdateAgentPolicyResponse",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.UpdateAgentPolicyResponse.item",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "item",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.AgentPolicy",
|
|
"text": "AgentPolicy"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.UpdateAgentRequest",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "UpdateAgentRequest",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.UpdateAgentRequest.params",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "params",
|
|
"description": [],
|
|
"signature": [
|
|
"{ agentId: string; }"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.UpdateAgentRequest.body",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "body",
|
|
"description": [],
|
|
"signature": [
|
|
"{ user_provided_metadata: Record<string, any>; }"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.UpdatePackagePolicy",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "UpdatePackagePolicy",
|
|
"description": [],
|
|
"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"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/package_policy.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.UpdatePackagePolicy.version",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "version",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/package_policy.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.UpdatePackageRequest",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "UpdatePackageRequest",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.UpdatePackageRequest.params",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "params",
|
|
"description": [],
|
|
"signature": [
|
|
"{ pkgkey: string; }"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.UpdatePackageRequest.body",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "body",
|
|
"description": [],
|
|
"signature": [
|
|
"{ keepPoliciesUpToDate?: boolean | undefined; }"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.UpdatePackageResponse",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "UpdatePackageResponse",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.UpdatePackageResponse.response",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "response",
|
|
"description": [],
|
|
"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.Installing",
|
|
"text": "Installing"
|
|
},
|
|
"<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"
|
|
},
|
|
", ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.EpmPackageAdditions",
|
|
"text": "EpmPackageAdditions"
|
|
},
|
|
">> | ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.InstallFailed",
|
|
"text": "InstallFailed"
|
|
},
|
|
"<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.Installed",
|
|
"text": "Installed"
|
|
},
|
|
"<Merge<",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.ArchivePackage",
|
|
"text": "ArchivePackage"
|
|
},
|
|
", ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.EpmPackageAdditions",
|
|
"text": "EpmPackageAdditions"
|
|
},
|
|
">> | ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.Installing",
|
|
"text": "Installing"
|
|
},
|
|
"<Merge<",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.ArchivePackage",
|
|
"text": "ArchivePackage"
|
|
},
|
|
", ",
|
|
{
|
|
"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.ArchivePackage",
|
|
"text": "ArchivePackage"
|
|
},
|
|
", ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.EpmPackageAdditions",
|
|
"text": "EpmPackageAdditions"
|
|
},
|
|
">> | ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.InstallFailed",
|
|
"text": "InstallFailed"
|
|
},
|
|
"<Merge<",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.ArchivePackage",
|
|
"text": "ArchivePackage"
|
|
},
|
|
", ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.EpmPackageAdditions",
|
|
"text": "EpmPackageAdditions"
|
|
},
|
|
">>"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.UpgradePackagePolicyBaseResponse",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "UpgradePackagePolicyBaseResponse",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.UpgradePackagePolicyBaseResponse.name",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "name",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.UpgradePackagePolicyDryRunResponseItem",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "UpgradePackagePolicyDryRunResponseItem",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.UpgradePackagePolicyDryRunResponseItem",
|
|
"text": "UpgradePackagePolicyDryRunResponseItem"
|
|
},
|
|
" extends ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.UpgradePackagePolicyBaseResponse",
|
|
"text": "UpgradePackagePolicyBaseResponse"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.UpgradePackagePolicyDryRunResponseItem.hasErrors",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "hasErrors",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.UpgradePackagePolicyDryRunResponseItem.diff",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "diff",
|
|
"description": [],
|
|
"signature": [
|
|
"[",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.PackagePolicy",
|
|
"text": "PackagePolicy"
|
|
},
|
|
", ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.DryRunPackagePolicy",
|
|
"text": "DryRunPackagePolicy"
|
|
},
|
|
"] | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.UpgradePackagePolicyResponseItem",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "UpgradePackagePolicyResponseItem",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.UpgradePackagePolicyResponseItem",
|
|
"text": "UpgradePackagePolicyResponseItem"
|
|
},
|
|
" extends ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.UpgradePackagePolicyBaseResponse",
|
|
"text": "UpgradePackagePolicyBaseResponse"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.UpgradePackagePolicyResponseItem.id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.UpgradePackagePolicyResponseItem.success",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "success",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"enums": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.ElasticsearchAssetType",
|
|
"type": "Enum",
|
|
"tags": [],
|
|
"label": "ElasticsearchAssetType",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.InstallStatus",
|
|
"type": "Enum",
|
|
"tags": [],
|
|
"label": "InstallStatus",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.KibanaAssetType",
|
|
"type": "Enum",
|
|
"tags": [],
|
|
"label": "KibanaAssetType",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.KibanaSavedObjectType",
|
|
"type": "Enum",
|
|
"tags": [],
|
|
"label": "KibanaSavedObjectType",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.RegistryDataStreamKeys",
|
|
"type": "Enum",
|
|
"tags": [],
|
|
"label": "RegistryDataStreamKeys",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.RegistryInputKeys",
|
|
"type": "Enum",
|
|
"tags": [],
|
|
"label": "RegistryInputKeys",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.RegistryPolicyTemplateKeys",
|
|
"type": "Enum",
|
|
"tags": [],
|
|
"label": "RegistryPolicyTemplateKeys",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.RegistryStreamKeys",
|
|
"type": "Enum",
|
|
"tags": [],
|
|
"label": "RegistryStreamKeys",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.RegistryVarsEntryKeys",
|
|
"type": "Enum",
|
|
"tags": [],
|
|
"label": "RegistryVarsEntryKeys",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"misc": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.AGENT_ACTION_SAVED_OBJECT_TYPE",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "AGENT_ACTION_SAVED_OBJECT_TYPE",
|
|
"description": [],
|
|
"signature": [
|
|
"\"fleet-agent-actions\""
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/constants/agent.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.AGENT_ACTIONS_INDEX",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "AGENT_ACTIONS_INDEX",
|
|
"description": [],
|
|
"signature": [
|
|
"\".fleet-actions\""
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/constants/agent.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.AGENT_ACTIONS_RESULTS_INDEX",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "AGENT_ACTIONS_RESULTS_INDEX",
|
|
"description": [],
|
|
"signature": [
|
|
"\".fleet-actions-results\""
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/constants/agent.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.AGENT_POLICY_API_ROOT",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "AGENT_POLICY_API_ROOT",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.AGENT_POLICY_DEFAULT_MONITORING_DATASETS",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "AGENT_POLICY_DEFAULT_MONITORING_DATASETS",
|
|
"description": [],
|
|
"signature": [
|
|
"string[]"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/constants/agent_policy.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.AGENT_POLICY_INDEX",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "AGENT_POLICY_INDEX",
|
|
"description": [],
|
|
"signature": [
|
|
"\".fleet-policies\""
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/constants/agent_policy.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.AGENT_POLICY_ROLLOUT_RATE_LIMIT_INTERVAL_MS",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "AGENT_POLICY_ROLLOUT_RATE_LIMIT_INTERVAL_MS",
|
|
"description": [],
|
|
"signature": [
|
|
"1000"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/constants/agent.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.AGENT_POLICY_ROLLOUT_RATE_LIMIT_REQUEST_PER_INTERVAL",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "AGENT_POLICY_ROLLOUT_RATE_LIMIT_REQUEST_PER_INTERVAL",
|
|
"description": [],
|
|
"signature": [
|
|
"5"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/constants/agent.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.AGENT_POLICY_SAVED_OBJECT_TYPE",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "AGENT_POLICY_SAVED_OBJECT_TYPE",
|
|
"description": [],
|
|
"signature": [
|
|
"\"ingest-agent-policies\""
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/constants/agent_policy.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.AGENT_POLLING_INTERVAL",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "AGENT_POLLING_INTERVAL",
|
|
"description": [],
|
|
"signature": [
|
|
"1000"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/constants/agent.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.AGENT_POLLING_REQUEST_TIMEOUT_MARGIN_MS",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "AGENT_POLLING_REQUEST_TIMEOUT_MARGIN_MS",
|
|
"description": [],
|
|
"signature": [
|
|
"20000"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/constants/agent.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.AGENT_POLLING_REQUEST_TIMEOUT_MS",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "AGENT_POLLING_REQUEST_TIMEOUT_MS",
|
|
"description": [],
|
|
"signature": [
|
|
"300000"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/constants/agent.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.AGENT_POLLING_THRESHOLD_MS",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "AGENT_POLLING_THRESHOLD_MS",
|
|
"description": [],
|
|
"signature": [
|
|
"30000"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/constants/agent.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.AGENT_SAVED_OBJECT_TYPE",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "AGENT_SAVED_OBJECT_TYPE",
|
|
"description": [],
|
|
"signature": [
|
|
"\"fleet-agents\""
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/constants/agent.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.AGENT_TYPE_EPHEMERAL",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "AGENT_TYPE_EPHEMERAL",
|
|
"description": [],
|
|
"signature": [
|
|
"\"EPHEMERAL\""
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/constants/agent.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.AGENT_TYPE_PERMANENT",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "AGENT_TYPE_PERMANENT",
|
|
"description": [],
|
|
"signature": [
|
|
"\"PERMANENT\""
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/constants/agent.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.AGENT_TYPE_TEMPORARY",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "AGENT_TYPE_TEMPORARY",
|
|
"description": [],
|
|
"signature": [
|
|
"\"TEMPORARY\""
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/constants/agent.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.AGENT_UPDATE_ACTIONS_INTERVAL_MS",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "AGENT_UPDATE_ACTIONS_INTERVAL_MS",
|
|
"description": [],
|
|
"signature": [
|
|
"5000"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/constants/agent.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.AGENT_UPDATE_LAST_CHECKIN_INTERVAL_MS",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "AGENT_UPDATE_LAST_CHECKIN_INTERVAL_MS",
|
|
"description": [],
|
|
"signature": [
|
|
"30000"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/constants/agent.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.AgentActionSOAttributes",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "AgentActionSOAttributes",
|
|
"description": [],
|
|
"signature": [
|
|
"CommonAgentActionSOAttributes & { agent_id: string; }"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.AgentActionType",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "AgentActionType",
|
|
"description": [],
|
|
"signature": [
|
|
"\"POLICY_CHANGE\" | \"UNENROLL\" | \"UPGRADE\" | \"SETTINGS\" | \"POLICY_REASSIGN\""
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.AgentAssetType",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "AgentAssetType",
|
|
"description": [],
|
|
"signature": [
|
|
"{ readonly Input: \"input\"; }"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.AgentPolicyActionSOAttributes",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "AgentPolicyActionSOAttributes",
|
|
"description": [],
|
|
"signature": [
|
|
"CommonAgentActionSOAttributes & { policy_id: string; policy_revision: number; }"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.AgentPolicyActionV7_9",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "AgentPolicyActionV7_9",
|
|
"description": [],
|
|
"signature": [
|
|
"Pick<",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.AgentPolicyAction",
|
|
"text": "AgentPolicyAction"
|
|
},
|
|
", \"id\" | \"policy_id\" | \"created_at\" | \"policy_revision\" | \"ack_data\" | \"sent_at\"> & { type: \"CONFIG_CHANGE\"; data: { config: ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.FullAgentPolicy",
|
|
"text": "FullAgentPolicy"
|
|
},
|
|
"; }; }"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.AgentPolicySOAttributes",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "AgentPolicySOAttributes",
|
|
"description": [],
|
|
"signature": [
|
|
"{ status: ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.ValueOf",
|
|
"text": "ValueOf"
|
|
},
|
|
"<{ readonly Active: \"active\"; readonly Inactive: \"inactive\"; }>; description?: string | undefined; name: string; updated_at: string; namespace: string; updated_by: string; is_default?: boolean | undefined; package_policies: string[] | ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.PackagePolicy",
|
|
"text": "PackagePolicy"
|
|
},
|
|
"[]; is_default_fleet_server?: boolean | undefined; is_managed: boolean; monitoring_enabled?: (\"metrics\" | \"logs\")[] | undefined; unenroll_timeout?: number | undefined; is_preconfigured?: boolean | undefined; data_output_id?: string | undefined; monitoring_output_id?: string | undefined; revision: number; }"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.AgentPolicyStatus",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "AgentPolicyStatus",
|
|
"description": [],
|
|
"signature": [
|
|
"{ readonly Active: \"active\"; readonly Inactive: \"inactive\"; }"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.AGENTS_INDEX",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "AGENTS_INDEX",
|
|
"description": [],
|
|
"signature": [
|
|
"\".fleet-agents\""
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/constants/agent.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.AgentStatus",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "AgentStatus",
|
|
"description": [],
|
|
"signature": [
|
|
"\"offline\" | \"online\" | \"error\" | \"warning\" | \"inactive\" | \"enrolling\" | \"unenrolling\" | \"updating\" | \"degraded\""
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.AgentType",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "AgentType",
|
|
"description": [],
|
|
"signature": [
|
|
"\"PERMANENT\" | \"EPHEMERAL\" | \"TEMPORARY\""
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.API_ROOT",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "API_ROOT",
|
|
"description": [],
|
|
"signature": [
|
|
"\"/api/fleet\""
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.ArchivePackage",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "ArchivePackage",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.PackageSpecManifest",
|
|
"text": "PackageSpecManifest"
|
|
},
|
|
" & Pick<",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.RegistryPackage",
|
|
"text": "RegistryPackage"
|
|
},
|
|
", \"internal\" | \"data_streams\" | \"assets\" | \"readme\">"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.AssetReference",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "AssetReference",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.KibanaAssetReference",
|
|
"text": "KibanaAssetReference"
|
|
},
|
|
" | ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.EsAssetReference",
|
|
"text": "EsAssetReference"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.ASSETS_SAVED_OBJECT_TYPE",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "ASSETS_SAVED_OBJECT_TYPE",
|
|
"description": [],
|
|
"signature": [
|
|
"\"epm-packages-assets\""
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/constants/epm.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.AssetsGroupedByServiceByType",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "AssetsGroupedByServiceByType",
|
|
"description": [],
|
|
"signature": [
|
|
"Record<\"kibana\", Record<",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.KibanaAssetType",
|
|
"text": "KibanaAssetType"
|
|
},
|
|
", ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.KibanaAssetParts",
|
|
"text": "KibanaAssetParts"
|
|
},
|
|
"[]>> & Record<\"elasticsearch\", Record<",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.ElasticsearchAssetType",
|
|
"text": "ElasticsearchAssetType"
|
|
},
|
|
", ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.ElasticsearchAssetParts",
|
|
"text": "ElasticsearchAssetParts"
|
|
},
|
|
"[]>>"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.AssetType",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "AssetType",
|
|
"description": [],
|
|
"signature": [
|
|
"\"input\" | \"doc\" | \"notice\" | ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.KibanaAssetType",
|
|
"text": "KibanaAssetType"
|
|
},
|
|
" | ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.ElasticsearchAssetType",
|
|
"text": "ElasticsearchAssetType"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.AssetTypeToParts",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "AssetTypeToParts",
|
|
"description": [],
|
|
"signature": [
|
|
"Record<",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.KibanaAssetType",
|
|
"text": "KibanaAssetType"
|
|
},
|
|
", ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.KibanaAssetParts",
|
|
"text": "KibanaAssetParts"
|
|
},
|
|
"[]> & Record<",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.ElasticsearchAssetType",
|
|
"text": "ElasticsearchAssetType"
|
|
},
|
|
", ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.ElasticsearchAssetParts",
|
|
"text": "ElasticsearchAssetParts"
|
|
},
|
|
"[]>"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.AUTO_UPDATE_PACKAGES",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "AUTO_UPDATE_PACKAGES",
|
|
"description": [],
|
|
"signature": [
|
|
"{ name: string; version: string; }[]"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/constants/preconfiguration.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.autoUpdatePackages",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "autoUpdatePackages",
|
|
"description": [],
|
|
"signature": [
|
|
"string[]"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/constants/epm.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.BaseAgentActionSOAttributes",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "BaseAgentActionSOAttributes",
|
|
"description": [],
|
|
"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"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.CategoryId",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "CategoryId",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.CategorySummaryList",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "CategorySummaryList",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.CategorySummaryItem",
|
|
"text": "CategorySummaryItem"
|
|
},
|
|
"[]"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.DATA_STREAM_API_ROOT",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "DATA_STREAM_API_ROOT",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.DataType",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "DataType",
|
|
"description": [],
|
|
"signature": [
|
|
"{ readonly Logs: \"logs\"; readonly Metrics: \"metrics\"; }"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.DEFAULT_OUTPUT_ID",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "DEFAULT_OUTPUT_ID",
|
|
"description": [],
|
|
"signature": [
|
|
"\"default\""
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/constants/output.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.DEFAULT_PACKAGES",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "DEFAULT_PACKAGES",
|
|
"description": [],
|
|
"signature": [
|
|
"{ name: string; version: string; }[]"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/constants/preconfiguration.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.defaultPackages",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "defaultPackages",
|
|
"description": [],
|
|
"signature": [
|
|
"string[]"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/constants/epm.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.DeletePackagePoliciesResponse",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "DeletePackagePoliciesResponse",
|
|
"description": [],
|
|
"signature": [
|
|
"{ id: string; name?: string | undefined; success: boolean; package?: ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.PackagePolicyPackage",
|
|
"text": "PackagePolicyPackage"
|
|
},
|
|
" | undefined; }[]"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.DetailViewPanelName",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "DetailViewPanelName",
|
|
"description": [],
|
|
"signature": [
|
|
"\"custom\" | \"settings\" | \"overview\" | \"policies\" | \"assets\""
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.DocAssetType",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "DocAssetType",
|
|
"description": [],
|
|
"signature": [
|
|
"\"doc\" | \"notice\""
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.DryRunPackagePolicy",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "DryRunPackagePolicy",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.NewPackagePolicy",
|
|
"text": "NewPackagePolicy"
|
|
},
|
|
" & { errors?: { key: string | undefined; message: string; }[] | undefined; missingVars?: string[] | undefined; }"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/package_policy.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.ElasticsearchAssetParts",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "ElasticsearchAssetParts",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.AssetParts",
|
|
"text": "AssetParts"
|
|
},
|
|
" & { service: \"elasticsearch\"; type: ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.ElasticsearchAssetType",
|
|
"text": "ElasticsearchAssetType"
|
|
},
|
|
"; }"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.ElasticsearchAssetTypeToParts",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "ElasticsearchAssetTypeToParts",
|
|
"description": [],
|
|
"signature": [
|
|
"{ component_template: ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.ElasticsearchAssetParts",
|
|
"text": "ElasticsearchAssetParts"
|
|
},
|
|
"[]; ingest_pipeline: ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.ElasticsearchAssetParts",
|
|
"text": "ElasticsearchAssetParts"
|
|
},
|
|
"[]; index_template: ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.ElasticsearchAssetParts",
|
|
"text": "ElasticsearchAssetParts"
|
|
},
|
|
"[]; ilm_policy: ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.ElasticsearchAssetParts",
|
|
"text": "ElasticsearchAssetParts"
|
|
},
|
|
"[]; transform: ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.ElasticsearchAssetParts",
|
|
"text": "ElasticsearchAssetParts"
|
|
},
|
|
"[]; data_stream_ilm_policy: ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.ElasticsearchAssetParts",
|
|
"text": "ElasticsearchAssetParts"
|
|
},
|
|
"[]; ml_model: ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.ElasticsearchAssetParts",
|
|
"text": "ElasticsearchAssetParts"
|
|
},
|
|
"[]; }"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.ENROLLMENT_API_KEYS_INDEX",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "ENROLLMENT_API_KEYS_INDEX",
|
|
"description": [],
|
|
"signature": [
|
|
"\".fleet-enrollment-api-keys\""
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/constants/enrollment_api_key.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.ENROLLMENT_API_KEYS_SAVED_OBJECT_TYPE",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "ENROLLMENT_API_KEYS_SAVED_OBJECT_TYPE",
|
|
"description": [],
|
|
"signature": [
|
|
"\"fleet-enrollment-api-keys\""
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/constants/enrollment_api_key.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.EnrollmentAPIKeySOAttributes",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "EnrollmentAPIKeySOAttributes",
|
|
"description": [],
|
|
"signature": [
|
|
"{ name?: string | undefined; active: boolean; policy_id?: string | undefined; created_at: string; api_key: string; api_key_id: string; }"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/enrollment_api_key.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.EPM_API_ROOT",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "EPM_API_ROOT",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.EpmPackageInstallStatus",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "EpmPackageInstallStatus",
|
|
"description": [],
|
|
"signature": [
|
|
"\"installed\" | \"installing\" | \"install_failed\""
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.EsAssetReference",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "EsAssetReference",
|
|
"description": [],
|
|
"signature": [
|
|
"Pick<",
|
|
"SavedObjectReference",
|
|
", \"id\"> & { type: ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.ElasticsearchAssetType",
|
|
"text": "ElasticsearchAssetType"
|
|
},
|
|
"; }"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.FLEET_API_ROOT_7_9",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "FLEET_API_ROOT_7_9",
|
|
"description": [],
|
|
"signature": [
|
|
"\"/api/ingest_manager/fleet\""
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.FLEET_APM_PACKAGE",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "FLEET_APM_PACKAGE",
|
|
"description": [],
|
|
"signature": [
|
|
"\"apm\""
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/constants/epm.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.FLEET_ELASTIC_AGENT_PACKAGE",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "FLEET_ELASTIC_AGENT_PACKAGE",
|
|
"description": [],
|
|
"signature": [
|
|
"\"elastic_agent\""
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/constants/epm.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.FLEET_ENDPOINT_PACKAGE",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "FLEET_ENDPOINT_PACKAGE",
|
|
"description": [],
|
|
"signature": [
|
|
"\"endpoint\""
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/constants/epm.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.FLEET_KUBERNETES_PACKAGE",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "FLEET_KUBERNETES_PACKAGE",
|
|
"description": [],
|
|
"signature": [
|
|
"\"kubernetes\""
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/constants/epm.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.FLEET_SERVER_ARTIFACTS_INDEX",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "FLEET_SERVER_ARTIFACTS_INDEX",
|
|
"description": [],
|
|
"signature": [
|
|
"\".fleet-artifacts\""
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/constants/index.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.FLEET_SERVER_INDICES",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "FLEET_SERVER_INDICES",
|
|
"description": [],
|
|
"signature": [
|
|
"string[]"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/constants/index.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.FLEET_SERVER_INDICES_VERSION",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "FLEET_SERVER_INDICES_VERSION",
|
|
"description": [],
|
|
"signature": [
|
|
"1"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/constants/index.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.FLEET_SERVER_PACKAGE",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "FLEET_SERVER_PACKAGE",
|
|
"description": [],
|
|
"signature": [
|
|
"\"fleet_server\""
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/constants/epm.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.FLEET_SERVER_SERVERS_INDEX",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "FLEET_SERVER_SERVERS_INDEX",
|
|
"description": [],
|
|
"signature": [
|
|
"\".fleet-servers\""
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/constants/index.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.FLEET_SYNTHETICS_PACKAGE",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "FLEET_SYNTHETICS_PACKAGE",
|
|
"description": [],
|
|
"signature": [
|
|
"\"synthetics\""
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/constants/epm.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.FLEET_SYSTEM_PACKAGE",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "FLEET_SYSTEM_PACKAGE",
|
|
"description": [],
|
|
"signature": [
|
|
"\"system\""
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/constants/epm.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.FullAgentPolicyOutput",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "FullAgentPolicyOutput",
|
|
"description": [],
|
|
"signature": [
|
|
"Pick<",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.Output",
|
|
"text": "Output"
|
|
},
|
|
", \"type\" | \"hosts\" | \"ca_sha256\" | \"api_key\"> & { [key: string]: any; }"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.GetAgentPoliciesResponseItem",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "GetAgentPoliciesResponseItem",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.AgentPolicy",
|
|
"text": "AgentPolicy"
|
|
},
|
|
" & { agents?: number | undefined; }"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.GLOBAL_SETTINGS_SAVED_OBJECT_TYPE",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "GLOBAL_SETTINGS_SAVED_OBJECT_TYPE",
|
|
"description": [],
|
|
"signature": [
|
|
"\"ingest_manager_settings\""
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/constants/settings.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.InputsOverride",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "InputsOverride",
|
|
"description": [],
|
|
"signature": [
|
|
"Partial<",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.NewPackagePolicyInput",
|
|
"text": "NewPackagePolicyInput"
|
|
},
|
|
"> & { vars?: (Record<string, ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.PackagePolicyConfigRecordEntry",
|
|
"text": "PackagePolicyConfigRecordEntry"
|
|
},
|
|
"> & { name: string; })[] | undefined; }"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/preconfiguration.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.INSTALL_SCRIPT_API_ROUTES",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "INSTALL_SCRIPT_API_ROUTES",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.Installable",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "Installable",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.Installed",
|
|
"text": "Installed"
|
|
},
|
|
"<T> | ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.Installing",
|
|
"text": "Installing"
|
|
},
|
|
"<T> | ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.NotInstalled",
|
|
"text": "NotInstalled"
|
|
},
|
|
"<T> | ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.InstallFailed",
|
|
"text": "InstallFailed"
|
|
},
|
|
"<T>"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.InstallablePackage",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "InstallablePackage",
|
|
"description": [],
|
|
"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"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.InstallationStatus",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "InstallationStatus",
|
|
"description": [],
|
|
"signature": [
|
|
"{ readonly Installed: \"installed\"; readonly Installing: \"installing\"; readonly InstallFailed: \"install_failed\"; readonly NotInstalled: \"not_installed\"; }"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.Installed",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "Installed",
|
|
"description": [],
|
|
"signature": [
|
|
"T & { status: \"installed\"; savedObject: ",
|
|
"SavedObject",
|
|
"<",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.Installation",
|
|
"text": "Installation"
|
|
},
|
|
">; }"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.InstallFailed",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "InstallFailed",
|
|
"description": [],
|
|
"signature": [
|
|
"T & { status: \"install_failed\"; }"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.Installing",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "Installing",
|
|
"description": [],
|
|
"signature": [
|
|
"T & { status: \"installing\"; savedObject: ",
|
|
"SavedObject",
|
|
"<",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.Installation",
|
|
"text": "Installation"
|
|
},
|
|
">; }"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.InstallSource",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "InstallSource",
|
|
"description": [],
|
|
"signature": [
|
|
"\"registry\" | \"upload\""
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.InstallType",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "InstallType",
|
|
"description": [],
|
|
"signature": [
|
|
"\"update\" | \"unknown\" | \"reinstall\" | \"reupdate\" | \"rollback\" | \"install\""
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.INTEGRATIONS_PLUGIN_ID",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "INTEGRATIONS_PLUGIN_ID",
|
|
"description": [],
|
|
"signature": [
|
|
"\"integrations\""
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/constants/plugin.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.KibanaAssetParts",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "KibanaAssetParts",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.AssetParts",
|
|
"text": "AssetParts"
|
|
},
|
|
" & { service: \"kibana\"; type: ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.KibanaAssetType",
|
|
"text": "KibanaAssetType"
|
|
},
|
|
"; }"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.KibanaAssetReference",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "KibanaAssetReference",
|
|
"description": [],
|
|
"signature": [
|
|
"Pick<",
|
|
"SavedObjectReference",
|
|
", \"id\"> & { type: ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.KibanaSavedObjectType",
|
|
"text": "KibanaSavedObjectType"
|
|
},
|
|
"; }"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.KibanaAssetTypeToParts",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "KibanaAssetTypeToParts",
|
|
"description": [],
|
|
"signature": [
|
|
"{ dashboard: ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.KibanaAssetParts",
|
|
"text": "KibanaAssetParts"
|
|
},
|
|
"[]; visualization: ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.KibanaAssetParts",
|
|
"text": "KibanaAssetParts"
|
|
},
|
|
"[]; search: ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.KibanaAssetParts",
|
|
"text": "KibanaAssetParts"
|
|
},
|
|
"[]; index_pattern: ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.KibanaAssetParts",
|
|
"text": "KibanaAssetParts"
|
|
},
|
|
"[]; map: ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.KibanaAssetParts",
|
|
"text": "KibanaAssetParts"
|
|
},
|
|
"[]; lens: ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.KibanaAssetParts",
|
|
"text": "KibanaAssetParts"
|
|
},
|
|
"[]; security_rule: ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.KibanaAssetParts",
|
|
"text": "KibanaAssetParts"
|
|
},
|
|
"[]; ml_module: ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.KibanaAssetParts",
|
|
"text": "KibanaAssetParts"
|
|
},
|
|
"[]; tag: ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.KibanaAssetParts",
|
|
"text": "KibanaAssetParts"
|
|
},
|
|
"[]; }"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.KUBERNETES_RUN_INSTRUCTIONS",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "KUBERNETES_RUN_INSTRUCTIONS",
|
|
"description": [],
|
|
"signature": [
|
|
"\"kubectl apply -f elastic-agent-standalone-kubernetes.yaml\""
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/constants/epm.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.LIMITED_CONCURRENCY_ROUTE_TAG",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "LIMITED_CONCURRENCY_ROUTE_TAG",
|
|
"description": [],
|
|
"signature": [
|
|
"\"ingest:limited-concurrency\""
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.MAX_TIME_COMPLETE_INSTALL",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "MAX_TIME_COMPLETE_INSTALL",
|
|
"description": [],
|
|
"signature": [
|
|
"60000"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/constants/epm.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.MonitoringType",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "MonitoringType",
|
|
"description": [],
|
|
"signature": [
|
|
"(\"metrics\" | \"logs\")[]"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.monitoringTypes",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "monitoringTypes",
|
|
"description": [],
|
|
"signature": [
|
|
"(\"metrics\" | \"logs\")[]"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/constants/epm.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.NotInstalled",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "NotInstalled",
|
|
"description": [],
|
|
"signature": [
|
|
"T & { status: \"not_installed\"; }"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.Output",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "Output",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.NewOutput",
|
|
"text": "NewOutput"
|
|
},
|
|
" & { id: string; }"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/output.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.OUTPUT_SAVED_OBJECT_TYPE",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "OUTPUT_SAVED_OBJECT_TYPE",
|
|
"description": [],
|
|
"signature": [
|
|
"\"ingest-outputs\""
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/constants/output.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.OutputSOAttributes",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "OutputSOAttributes",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.NewOutput",
|
|
"text": "NewOutput"
|
|
},
|
|
" & { output_id?: string | undefined; }"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/output.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.OutputType",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "OutputType",
|
|
"description": [],
|
|
"signature": [
|
|
"{ readonly Elasticsearch: \"elasticsearch\"; }"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/output.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.PACKAGE_POLICY_API_ROOT",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "PACKAGE_POLICY_API_ROOT",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.PACKAGE_POLICY_DEFAULT_INDEX_PRIVILEGES",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "PACKAGE_POLICY_DEFAULT_INDEX_PRIVILEGES",
|
|
"description": [],
|
|
"signature": [
|
|
"string[]"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/constants/package_policy.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.PACKAGE_POLICY_SAVED_OBJECT_TYPE",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "PACKAGE_POLICY_SAVED_OBJECT_TYPE",
|
|
"description": [],
|
|
"signature": [
|
|
"\"ingest-package-policies\""
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/constants/package_policy.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.PackageAssetReference",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "PackageAssetReference",
|
|
"description": [],
|
|
"signature": [
|
|
"Pick<",
|
|
"SavedObjectReference",
|
|
", \"id\"> & { type: \"epm-packages-assets\"; }"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.PackageInfo",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "PackageInfo",
|
|
"description": [],
|
|
"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.Installing",
|
|
"text": "Installing"
|
|
},
|
|
"<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"
|
|
},
|
|
", ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.EpmPackageAdditions",
|
|
"text": "EpmPackageAdditions"
|
|
},
|
|
">> | ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.InstallFailed",
|
|
"text": "InstallFailed"
|
|
},
|
|
"<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.Installed",
|
|
"text": "Installed"
|
|
},
|
|
"<Merge<",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.ArchivePackage",
|
|
"text": "ArchivePackage"
|
|
},
|
|
", ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.EpmPackageAdditions",
|
|
"text": "EpmPackageAdditions"
|
|
},
|
|
">> | ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.Installing",
|
|
"text": "Installing"
|
|
},
|
|
"<Merge<",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.ArchivePackage",
|
|
"text": "ArchivePackage"
|
|
},
|
|
", ",
|
|
{
|
|
"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.ArchivePackage",
|
|
"text": "ArchivePackage"
|
|
},
|
|
", ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.EpmPackageAdditions",
|
|
"text": "EpmPackageAdditions"
|
|
},
|
|
">> | ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.InstallFailed",
|
|
"text": "InstallFailed"
|
|
},
|
|
"<Merge<",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.ArchivePackage",
|
|
"text": "ArchivePackage"
|
|
},
|
|
", ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.EpmPackageAdditions",
|
|
"text": "EpmPackageAdditions"
|
|
},
|
|
">>"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.PackageList",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "PackageList",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.PackageListItem",
|
|
"text": "PackageListItem"
|
|
},
|
|
"[]"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.PackageListItem",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "PackageListItem",
|
|
"description": [],
|
|
"signature": [
|
|
"(Pick<",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.RegistryPackage",
|
|
"text": "RegistryPackage"
|
|
},
|
|
", \"type\" | \"title\" | \"description\" | \"icons\" | \"categories\" | \"name\" | \"version\" | \"path\" | \"download\" | \"internal\" | \"data_streams\" | \"release\" | \"policy_templates\"> & { status: \"installed\"; savedObject: ",
|
|
"SavedObject",
|
|
"<",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.Installation",
|
|
"text": "Installation"
|
|
},
|
|
">; } & { integration?: string | undefined; id: string; }) | (Pick<",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.RegistryPackage",
|
|
"text": "RegistryPackage"
|
|
},
|
|
", \"type\" | \"title\" | \"description\" | \"icons\" | \"categories\" | \"name\" | \"version\" | \"path\" | \"download\" | \"internal\" | \"data_streams\" | \"release\" | \"policy_templates\"> & { status: \"installing\"; savedObject: ",
|
|
"SavedObject",
|
|
"<",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.Installation",
|
|
"text": "Installation"
|
|
},
|
|
">; } & { integration?: string | undefined; id: string; }) | (Pick<",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.RegistryPackage",
|
|
"text": "RegistryPackage"
|
|
},
|
|
", \"type\" | \"title\" | \"description\" | \"icons\" | \"categories\" | \"name\" | \"version\" | \"path\" | \"download\" | \"internal\" | \"data_streams\" | \"release\" | \"policy_templates\"> & { status: \"not_installed\"; } & { integration?: string | undefined; id: string; }) | (Pick<",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.RegistryPackage",
|
|
"text": "RegistryPackage"
|
|
},
|
|
", \"type\" | \"title\" | \"description\" | \"icons\" | \"categories\" | \"name\" | \"version\" | \"path\" | \"download\" | \"internal\" | \"data_streams\" | \"release\" | \"policy_templates\"> & { status: \"install_failed\"; } & { integration?: string | undefined; id: string; })"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.PackagePolicyConfigRecord",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "PackagePolicyConfigRecord",
|
|
"description": [],
|
|
"signature": [
|
|
"{ [x: string]: ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.PackagePolicyConfigRecordEntry",
|
|
"text": "PackagePolicyConfigRecordEntry"
|
|
},
|
|
"; }"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/package_policy.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.PackagePolicyInputValidationResults",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "PackagePolicyInputValidationResults",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.PackagePolicyConfigValidationResults",
|
|
"text": "PackagePolicyConfigValidationResults"
|
|
},
|
|
" & { streams?: Record<string, ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.PackagePolicyConfigValidationResults",
|
|
"text": "PackagePolicyConfigValidationResults"
|
|
},
|
|
"> | undefined; }"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/services/validate_package_policy.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.PackagePolicySOAttributes",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "PackagePolicySOAttributes",
|
|
"description": [],
|
|
"signature": [
|
|
"{ description?: string | undefined; name: string; enabled: boolean; package?: ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.PackagePolicyPackage",
|
|
"text": "PackagePolicyPackage"
|
|
},
|
|
" | undefined; updated_at: string; policy_id: string; inputs: ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.PackagePolicyInput",
|
|
"text": "PackagePolicyInput"
|
|
},
|
|
"[]; namespace: string; output_id: string; vars?: Record<string, ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.PackagePolicyConfigRecordEntry",
|
|
"text": "PackagePolicyConfigRecordEntry"
|
|
},
|
|
"> | undefined; elasticsearch?: { privileges?: { cluster?: string[] | undefined; } | undefined; } | undefined; created_at: string; created_by: string; updated_by: string; revision: number; }"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/package_policy.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.PackagePolicyValidationResults",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "PackagePolicyValidationResults",
|
|
"description": [],
|
|
"signature": [
|
|
"{ name: string[] | null; description: string[] | null; namespace: string[] | null; inputs: Record<string, ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.PackagePolicyInputValidationResults",
|
|
"text": "PackagePolicyInputValidationResults"
|
|
},
|
|
"> | null; } & ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.PackagePolicyConfigValidationResults",
|
|
"text": "PackagePolicyConfigValidationResults"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/services/validate_package_policy.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.PACKAGES_SAVED_OBJECT_TYPE",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "PACKAGES_SAVED_OBJECT_TYPE",
|
|
"description": [],
|
|
"signature": [
|
|
"\"epm-packages\""
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/constants/epm.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.PackagesGroupedByStatus",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "PackagesGroupedByStatus",
|
|
"description": [],
|
|
"signature": [
|
|
"{ installed: ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.PackageList",
|
|
"text": "PackageList"
|
|
},
|
|
"; installing: ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.PackageList",
|
|
"text": "PackageList"
|
|
},
|
|
"; install_failed: ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.PackageList",
|
|
"text": "PackageList"
|
|
},
|
|
"; not_installed: ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.PackageList",
|
|
"text": "PackageList"
|
|
},
|
|
"; }"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.PackageSpecCategory",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "PackageSpecCategory",
|
|
"description": [],
|
|
"signature": [
|
|
"\"custom\" | \"aws\" | \"azure\" | \"cloud\" | \"config_management\" | \"containers\" | \"crm\" | \"datastore\" | \"elastic_stack\" | \"google_cloud\" | \"kubernetes\" | \"languages\" | \"message_queue\" | \"monitoring\" | \"network\" | \"notification\" | \"os_system\" | \"productivity\" | \"security\" | \"support\" | \"ticketing\" | \"version_control\" | \"web\""
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/package_spec.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.PackageSpecConditions",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "PackageSpecConditions",
|
|
"description": [],
|
|
"signature": [
|
|
"{ kibana: { version: string; }; }"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/package_spec.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.PLUGIN_ID",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "PLUGIN_ID",
|
|
"description": [],
|
|
"signature": [
|
|
"\"fleet\""
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/constants/plugin.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.PostBulkAgentReassignResponse",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "PostBulkAgentReassignResponse",
|
|
"description": [],
|
|
"signature": [
|
|
"{ [x: string]: { success: boolean; error?: string | undefined; }; }"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.PostBulkAgentUnenrollResponse",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "PostBulkAgentUnenrollResponse",
|
|
"description": [],
|
|
"signature": [
|
|
"{ [x: string]: { success: boolean; error?: string | undefined; }; }"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.PostBulkAgentUpgradeResponse",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "PostBulkAgentUpgradeResponse",
|
|
"description": [],
|
|
"signature": [
|
|
"{ [x: string]: { success: boolean; error?: string | undefined; }; }"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.PRECONFIGURATION_DELETION_RECORD_SAVED_OBJECT_TYPE",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "PRECONFIGURATION_DELETION_RECORD_SAVED_OBJECT_TYPE",
|
|
"description": [],
|
|
"signature": [
|
|
"\"fleet-preconfiguration-deletion-record\""
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/constants/preconfiguration.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.PRECONFIGURATION_LATEST_KEYWORD",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "PRECONFIGURATION_LATEST_KEYWORD",
|
|
"description": [],
|
|
"signature": [
|
|
"\"latest\""
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/constants/preconfiguration.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.PreconfiguredPackage",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "PreconfiguredPackage",
|
|
"description": [],
|
|
"signature": [
|
|
"{ name: string; version: string; }"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/preconfiguration.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.RegistryInputGroup",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "RegistryInputGroup",
|
|
"description": [],
|
|
"signature": [
|
|
"\"metrics\" | \"logs\""
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.RegistryPackage",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "RegistryPackage",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.PackageSpecManifest",
|
|
"text": "PackageSpecManifest"
|
|
},
|
|
" & Partial<Pick<",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.PackageSpecManifest",
|
|
"text": "PackageSpecManifest"
|
|
},
|
|
", \"title\" | \"release\">> & RegistryAdditionalProperties & RegistryOverridePropertyValue"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.RegistryRelease",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "RegistryRelease",
|
|
"description": [],
|
|
"signature": [
|
|
"\"experimental\" | \"beta\" | \"ga\""
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.RegistrySearchResult",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "RegistrySearchResult",
|
|
"description": [],
|
|
"signature": [
|
|
"{ type?: \"integration\" | undefined; title: string; description: string; icons?: (",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.PackageSpecIcon",
|
|
"text": "PackageSpecIcon"
|
|
},
|
|
"[] & ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.RegistryImage",
|
|
"text": "RegistryImage"
|
|
},
|
|
"[]) | undefined; categories?: (\"custom\" | \"aws\" | \"azure\" | \"cloud\" | \"config_management\" | \"containers\" | \"crm\" | \"datastore\" | \"elastic_stack\" | \"google_cloud\" | \"kubernetes\" | \"languages\" | \"message_queue\" | \"monitoring\" | \"network\" | \"notification\" | \"os_system\" | \"productivity\" | \"security\" | \"support\" | \"ticketing\" | \"version_control\" | \"web\" | undefined)[] | undefined; name: string; version: string; path: string; download: string; internal?: boolean | undefined; data_streams?: ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.RegistryDataStream",
|
|
"text": "RegistryDataStream"
|
|
},
|
|
"[] | undefined; release: \"experimental\" | \"beta\" | \"ga\"; policy_templates?: ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.RegistryPolicyTemplate",
|
|
"text": "RegistryPolicyTemplate"
|
|
},
|
|
"[] | undefined; }"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.RegistrySearchResults",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "RegistrySearchResults",
|
|
"description": [],
|
|
"signature": [
|
|
"Pick<",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.RegistryPackage",
|
|
"text": "RegistryPackage"
|
|
},
|
|
", \"type\" | \"title\" | \"description\" | \"icons\" | \"categories\" | \"name\" | \"version\" | \"path\" | \"download\" | \"internal\" | \"data_streams\" | \"release\" | \"policy_templates\">[]"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.RegistryVarType",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "RegistryVarType",
|
|
"description": [],
|
|
"signature": [
|
|
"\"string\" | \"text\" | \"yaml\" | \"integer\" | \"bool\" | \"password\""
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.RequirementsByServiceName",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "RequirementsByServiceName",
|
|
"description": [],
|
|
"signature": [
|
|
"Record<\"kibana\", { version: string; }> | undefined"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.RequirementVersion",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "RequirementVersion",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.RequirementVersionRange",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "RequirementVersionRange",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.ScreenshotItem",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "ScreenshotItem",
|
|
"description": [],
|
|
"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"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.ServiceName",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "ServiceName",
|
|
"description": [],
|
|
"signature": [
|
|
"\"kibana\" | \"elasticsearch\""
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.SETUP_API_ROUTE",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "SETUP_API_ROUTE",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.SimplifiedAgentStatus",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "SimplifiedAgentStatus",
|
|
"description": [],
|
|
"signature": [
|
|
"\"offline\" | \"inactive\" | \"updating\" | \"healthy\" | \"unhealthy\""
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.SO_SEARCH_LIMIT",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "SO_SEARCH_LIMIT",
|
|
"description": [],
|
|
"signature": [
|
|
"10000"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/constants/index.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.STANDALONE_RUN_INSTRUCTIONS",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "STANDALONE_RUN_INSTRUCTIONS",
|
|
"description": [],
|
|
"signature": [
|
|
"\"./elastic-agent install\""
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/constants/epm.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.unremovablePackages",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "unremovablePackages",
|
|
"description": [],
|
|
"signature": [
|
|
"string[]"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/constants/epm.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.UpdateAgentPolicyRequest",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "UpdateAgentPolicyRequest",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.GetOneAgentPolicyRequest",
|
|
"text": "GetOneAgentPolicyRequest"
|
|
},
|
|
" & { body: ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.NewAgentPolicy",
|
|
"text": "NewAgentPolicy"
|
|
},
|
|
"; }"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.UpdatePackagePolicyRequest",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "UpdatePackagePolicyRequest",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.GetOnePackagePolicyRequest",
|
|
"text": "GetOnePackagePolicyRequest"
|
|
},
|
|
" & { body: ",
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.UpdatePackagePolicy",
|
|
"text": "UpdatePackagePolicy"
|
|
},
|
|
"; }"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.UpdatePackagePolicyResponse",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "UpdatePackagePolicyResponse",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.CreatePackagePolicyResponse",
|
|
"text": "CreatePackagePolicyResponse"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.UpgradePackagePolicyDryRunResponse",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "UpgradePackagePolicyDryRunResponse",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.UpgradePackagePolicyDryRunResponseItem",
|
|
"text": "UpgradePackagePolicyDryRunResponseItem"
|
|
},
|
|
"[]"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.UpgradePackagePolicyResponse",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "UpgradePackagePolicyResponse",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fleet",
|
|
"scope": "common",
|
|
"docId": "kibFleetPluginApi",
|
|
"section": "def-common.UpgradePackagePolicyResponseItem",
|
|
"text": "UpgradePackagePolicyResponseItem"
|
|
},
|
|
"[]"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.ValueOf",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "ValueOf",
|
|
"description": [
|
|
"\nCreates a Union Type for all the values of an object"
|
|
],
|
|
"signature": [
|
|
"T[keyof T]"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/types/index.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"objects": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.AGENT_API_ROUTES",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "AGENT_API_ROUTES",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.AGENT_API_ROUTES.LIST_PATTERN",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "LIST_PATTERN",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.AGENT_API_ROUTES.INFO_PATTERN",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "INFO_PATTERN",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.AGENT_API_ROUTES.UPDATE_PATTERN",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "UPDATE_PATTERN",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.AGENT_API_ROUTES.DELETE_PATTERN",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "DELETE_PATTERN",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.AGENT_API_ROUTES.CHECKIN_PATTERN",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "CHECKIN_PATTERN",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.AGENT_API_ROUTES.ACKS_PATTERN",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "ACKS_PATTERN",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.AGENT_API_ROUTES.ACTIONS_PATTERN",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "ACTIONS_PATTERN",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.AGENT_API_ROUTES.UNENROLL_PATTERN",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "UNENROLL_PATTERN",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.AGENT_API_ROUTES.BULK_UNENROLL_PATTERN",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "BULK_UNENROLL_PATTERN",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.AGENT_API_ROUTES.REASSIGN_PATTERN",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "REASSIGN_PATTERN",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.AGENT_API_ROUTES.BULK_REASSIGN_PATTERN",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "BULK_REASSIGN_PATTERN",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.AGENT_API_ROUTES.STATUS_PATTERN",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "STATUS_PATTERN",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.AGENT_API_ROUTES.UPGRADE_PATTERN",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "UPGRADE_PATTERN",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.AGENT_API_ROUTES.BULK_UPGRADE_PATTERN",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "BULK_UPGRADE_PATTERN",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.AGENT_POLICY_API_ROUTES",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "AGENT_POLICY_API_ROUTES",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.AGENT_POLICY_API_ROUTES.LIST_PATTERN",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "LIST_PATTERN",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.AGENT_POLICY_API_ROUTES.INFO_PATTERN",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "INFO_PATTERN",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.AGENT_POLICY_API_ROUTES.CREATE_PATTERN",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "CREATE_PATTERN",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.AGENT_POLICY_API_ROUTES.UPDATE_PATTERN",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "UPDATE_PATTERN",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.AGENT_POLICY_API_ROUTES.COPY_PATTERN",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "COPY_PATTERN",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.AGENT_POLICY_API_ROUTES.DELETE_PATTERN",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "DELETE_PATTERN",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.AGENT_POLICY_API_ROUTES.FULL_INFO_PATTERN",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "FULL_INFO_PATTERN",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.AGENT_POLICY_API_ROUTES.FULL_INFO_DOWNLOAD_PATTERN",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "FULL_INFO_DOWNLOAD_PATTERN",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.agentAssetTypes",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "agentAssetTypes",
|
|
"description": [],
|
|
"signature": [
|
|
"{ readonly Input: \"input\"; }"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/constants/epm.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.agentPolicyRouteService",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "agentPolicyRouteService",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/services/routes.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.agentPolicyRouteService.getListPath",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getListPath",
|
|
"description": [],
|
|
"signature": [
|
|
"() => string"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/services/routes.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.agentPolicyRouteService.getInfoPath",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getInfoPath",
|
|
"description": [],
|
|
"signature": [
|
|
"(agentPolicyId: string) => string"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/services/routes.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.agentPolicyRouteService.getInfoPath.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "agentPolicyId",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/services/routes.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.agentPolicyRouteService.getCreatePath",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getCreatePath",
|
|
"description": [],
|
|
"signature": [
|
|
"() => string"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/services/routes.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.agentPolicyRouteService.getUpdatePath",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getUpdatePath",
|
|
"description": [],
|
|
"signature": [
|
|
"(agentPolicyId: string) => string"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/services/routes.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.agentPolicyRouteService.getUpdatePath.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "agentPolicyId",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/services/routes.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.agentPolicyRouteService.getCopyPath",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getCopyPath",
|
|
"description": [],
|
|
"signature": [
|
|
"(agentPolicyId: string) => string"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/services/routes.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.agentPolicyRouteService.getCopyPath.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "agentPolicyId",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/services/routes.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.agentPolicyRouteService.getDeletePath",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getDeletePath",
|
|
"description": [],
|
|
"signature": [
|
|
"() => string"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/services/routes.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.agentPolicyRouteService.getInfoFullPath",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getInfoFullPath",
|
|
"description": [],
|
|
"signature": [
|
|
"(agentPolicyId: string) => string"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/services/routes.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.agentPolicyRouteService.getInfoFullPath.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "agentPolicyId",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/services/routes.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.agentPolicyRouteService.getInfoFullDownloadPath",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getInfoFullDownloadPath",
|
|
"description": [],
|
|
"signature": [
|
|
"(agentPolicyId: string) => string"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/services/routes.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.agentPolicyRouteService.getInfoFullDownloadPath.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "agentPolicyId",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/services/routes.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.agentPolicyStatuses",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "agentPolicyStatuses",
|
|
"description": [],
|
|
"signature": [
|
|
"{ readonly Active: \"active\"; readonly Inactive: \"inactive\"; }"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/constants/agent_policy.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.agentRouteService",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "agentRouteService",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/services/routes.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.agentRouteService.getInfoPath",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getInfoPath",
|
|
"description": [],
|
|
"signature": [
|
|
"(agentId: string) => string"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/services/routes.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.agentRouteService.getInfoPath.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "agentId",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/services/routes.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.agentRouteService.getUpdatePath",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getUpdatePath",
|
|
"description": [],
|
|
"signature": [
|
|
"(agentId: string) => string"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/services/routes.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.agentRouteService.getUpdatePath.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "agentId",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/services/routes.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.agentRouteService.getUnenrollPath",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getUnenrollPath",
|
|
"description": [],
|
|
"signature": [
|
|
"(agentId: string) => string"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/services/routes.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.agentRouteService.getUnenrollPath.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "agentId",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/services/routes.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.agentRouteService.getBulkUnenrollPath",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getBulkUnenrollPath",
|
|
"description": [],
|
|
"signature": [
|
|
"() => string"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/services/routes.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.agentRouteService.getReassignPath",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getReassignPath",
|
|
"description": [],
|
|
"signature": [
|
|
"(agentId: string) => string"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/services/routes.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.agentRouteService.getReassignPath.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "agentId",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/services/routes.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.agentRouteService.getBulkReassignPath",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getBulkReassignPath",
|
|
"description": [],
|
|
"signature": [
|
|
"() => string"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/services/routes.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.agentRouteService.getUpgradePath",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getUpgradePath",
|
|
"description": [],
|
|
"signature": [
|
|
"(agentId: string) => string"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/services/routes.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.agentRouteService.getUpgradePath.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "agentId",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/services/routes.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.agentRouteService.getBulkUpgradePath",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getBulkUpgradePath",
|
|
"description": [],
|
|
"signature": [
|
|
"() => string"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/services/routes.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.agentRouteService.getListPath",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getListPath",
|
|
"description": [],
|
|
"signature": [
|
|
"() => string"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/services/routes.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.agentRouteService.getStatusPath",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getStatusPath",
|
|
"description": [],
|
|
"signature": [
|
|
"() => string"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/services/routes.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.agentRouteService.getCreateActionPath",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getCreateActionPath",
|
|
"description": [],
|
|
"signature": [
|
|
"(agentId: string) => string"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/services/routes.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.agentRouteService.getCreateActionPath.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "agentId",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/services/routes.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.AGENTS_SETUP_API_ROUTES",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "AGENTS_SETUP_API_ROUTES",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.AGENTS_SETUP_API_ROUTES.INFO_PATTERN",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "INFO_PATTERN",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.AGENTS_SETUP_API_ROUTES.CREATE_PATTERN",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "CREATE_PATTERN",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.AgentStatusKueryHelper",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "AgentStatusKueryHelper",
|
|
"description": [],
|
|
"signature": [
|
|
"typeof ",
|
|
"x-pack/plugins/fleet/common/services/agent_status"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/services/index.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.APP_API_ROUTES",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "APP_API_ROUTES",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.APP_API_ROUTES.CHECK_PERMISSIONS_PATTERN",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "CHECK_PERMISSIONS_PATTERN",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.APP_API_ROUTES.GENERATE_SERVICE_TOKEN_PATTERN",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "GENERATE_SERVICE_TOKEN_PATTERN",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.appRoutesService",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "appRoutesService",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/services/routes.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.appRoutesService.getCheckPermissionsPath",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getCheckPermissionsPath",
|
|
"description": [],
|
|
"signature": [
|
|
"() => string"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/services/routes.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.appRoutesService.getRegenerateServiceTokenPath",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getRegenerateServiceTokenPath",
|
|
"description": [],
|
|
"signature": [
|
|
"() => string"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/services/routes.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.DATA_STREAM_API_ROUTES",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "DATA_STREAM_API_ROUTES",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.DATA_STREAM_API_ROUTES.LIST_PATTERN",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "LIST_PATTERN",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.dataStreamRouteService",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "dataStreamRouteService",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/services/routes.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.dataStreamRouteService.getListPath",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getListPath",
|
|
"description": [],
|
|
"signature": [
|
|
"() => string"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/services/routes.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.dataTypes",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "dataTypes",
|
|
"description": [],
|
|
"signature": [
|
|
"{ readonly Logs: \"logs\"; readonly Metrics: \"metrics\"; }"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/constants/epm.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.DEFAULT_AGENT_POLICY",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "DEFAULT_AGENT_POLICY",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/constants/preconfiguration.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.DEFAULT_AGENT_POLICY.name",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "name",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/constants/preconfiguration.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.DEFAULT_AGENT_POLICY.namespace",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "namespace",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/constants/preconfiguration.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.DEFAULT_AGENT_POLICY.description",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "description",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/constants/preconfiguration.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.DEFAULT_AGENT_POLICY.package_policies",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "package_policies",
|
|
"description": [],
|
|
"signature": [
|
|
"{ name: string; package: { name: string; }; }[]"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/constants/preconfiguration.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.DEFAULT_AGENT_POLICY.is_default",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "is_default",
|
|
"description": [],
|
|
"signature": [
|
|
"true"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/constants/preconfiguration.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.DEFAULT_AGENT_POLICY.is_managed",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "is_managed",
|
|
"description": [],
|
|
"signature": [
|
|
"false"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/constants/preconfiguration.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.DEFAULT_AGENT_POLICY.monitoring_enabled",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "monitoring_enabled",
|
|
"description": [],
|
|
"signature": [
|
|
"(\"metrics\" | \"logs\")[]"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/constants/preconfiguration.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.DEFAULT_FLEET_SERVER_AGENT_POLICY",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "DEFAULT_FLEET_SERVER_AGENT_POLICY",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/constants/preconfiguration.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.DEFAULT_FLEET_SERVER_AGENT_POLICY.name",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "name",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/constants/preconfiguration.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.DEFAULT_FLEET_SERVER_AGENT_POLICY.namespace",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "namespace",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/constants/preconfiguration.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.DEFAULT_FLEET_SERVER_AGENT_POLICY.description",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "description",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/constants/preconfiguration.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.DEFAULT_FLEET_SERVER_AGENT_POLICY.package_policies",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "package_policies",
|
|
"description": [],
|
|
"signature": [
|
|
"{ name: string; package: { name: string; }; }[]"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/constants/preconfiguration.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.DEFAULT_FLEET_SERVER_AGENT_POLICY.is_default",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "is_default",
|
|
"description": [],
|
|
"signature": [
|
|
"false"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/constants/preconfiguration.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.DEFAULT_FLEET_SERVER_AGENT_POLICY.is_default_fleet_server",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "is_default_fleet_server",
|
|
"description": [],
|
|
"signature": [
|
|
"true"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/constants/preconfiguration.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.DEFAULT_FLEET_SERVER_AGENT_POLICY.is_managed",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "is_managed",
|
|
"description": [],
|
|
"signature": [
|
|
"false"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/constants/preconfiguration.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.DEFAULT_FLEET_SERVER_AGENT_POLICY.monitoring_enabled",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "monitoring_enabled",
|
|
"description": [],
|
|
"signature": [
|
|
"(\"metrics\" | \"logs\")[]"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/constants/preconfiguration.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.DEFAULT_OUTPUT",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "DEFAULT_OUTPUT",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/constants/output.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.DEFAULT_OUTPUT.name",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "name",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/constants/output.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.DEFAULT_OUTPUT.is_default",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "is_default",
|
|
"description": [],
|
|
"signature": [
|
|
"true"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/constants/output.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.DEFAULT_OUTPUT.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
"\"elasticsearch\""
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/constants/output.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.DEFAULT_OUTPUT.hosts",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "hosts",
|
|
"description": [],
|
|
"signature": [
|
|
"string[]"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/constants/output.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.ENROLLMENT_API_KEY_ROUTES",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "ENROLLMENT_API_KEY_ROUTES",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.ENROLLMENT_API_KEY_ROUTES.CREATE_PATTERN",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "CREATE_PATTERN",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.ENROLLMENT_API_KEY_ROUTES.LIST_PATTERN",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "LIST_PATTERN",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.ENROLLMENT_API_KEY_ROUTES.INFO_PATTERN",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "INFO_PATTERN",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.ENROLLMENT_API_KEY_ROUTES.DELETE_PATTERN",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "DELETE_PATTERN",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.enrollmentAPIKeyRouteService",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "enrollmentAPIKeyRouteService",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/services/routes.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.enrollmentAPIKeyRouteService.getListPath",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getListPath",
|
|
"description": [],
|
|
"signature": [
|
|
"() => string"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/services/routes.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.enrollmentAPIKeyRouteService.getCreatePath",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getCreatePath",
|
|
"description": [],
|
|
"signature": [
|
|
"() => string"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/services/routes.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.enrollmentAPIKeyRouteService.getInfoPath",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getInfoPath",
|
|
"description": [],
|
|
"signature": [
|
|
"(keyId: string) => string"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/services/routes.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.enrollmentAPIKeyRouteService.getInfoPath.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "keyId",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/services/routes.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.enrollmentAPIKeyRouteService.getDeletePath",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getDeletePath",
|
|
"description": [],
|
|
"signature": [
|
|
"(keyId: string) => string"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/services/routes.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.enrollmentAPIKeyRouteService.getDeletePath.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "keyId",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/services/routes.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.EPM_API_ROUTES",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "EPM_API_ROUTES",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.EPM_API_ROUTES.BULK_INSTALL_PATTERN",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "BULK_INSTALL_PATTERN",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.EPM_API_ROUTES.LIST_PATTERN",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "LIST_PATTERN",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.EPM_API_ROUTES.LIMITED_LIST_PATTERN",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "LIMITED_LIST_PATTERN",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.EPM_API_ROUTES.INFO_PATTERN",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "INFO_PATTERN",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.EPM_API_ROUTES.INSTALL_FROM_REGISTRY_PATTERN",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "INSTALL_FROM_REGISTRY_PATTERN",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.EPM_API_ROUTES.INSTALL_BY_UPLOAD_PATTERN",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "INSTALL_BY_UPLOAD_PATTERN",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.EPM_API_ROUTES.DELETE_PATTERN",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "DELETE_PATTERN",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.EPM_API_ROUTES.FILEPATH_PATTERN",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "FILEPATH_PATTERN",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.EPM_API_ROUTES.CATEGORIES_PATTERN",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "CATEGORIES_PATTERN",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.EPM_API_ROUTES.STATS_PATTERN",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "STATS_PATTERN",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.epmRouteService",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "epmRouteService",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/services/routes.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.epmRouteService.getCategoriesPath",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getCategoriesPath",
|
|
"description": [],
|
|
"signature": [
|
|
"() => string"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/services/routes.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.epmRouteService.getListPath",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getListPath",
|
|
"description": [],
|
|
"signature": [
|
|
"() => string"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/services/routes.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.epmRouteService.getListLimitedPath",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getListLimitedPath",
|
|
"description": [],
|
|
"signature": [
|
|
"() => string"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/services/routes.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.epmRouteService.getInfoPath",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getInfoPath",
|
|
"description": [],
|
|
"signature": [
|
|
"(pkgkey: string) => string"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/services/routes.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.epmRouteService.getInfoPath.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "pkgkey",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/services/routes.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.epmRouteService.getStatsPath",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getStatsPath",
|
|
"description": [],
|
|
"signature": [
|
|
"(pkgName: string) => string"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/services/routes.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.epmRouteService.getStatsPath.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "pkgName",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/services/routes.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.epmRouteService.getFilePath",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getFilePath",
|
|
"description": [],
|
|
"signature": [
|
|
"(filePath: string) => string"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/services/routes.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.epmRouteService.getFilePath.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "filePath",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/services/routes.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.epmRouteService.getInstallPath",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getInstallPath",
|
|
"description": [],
|
|
"signature": [
|
|
"(pkgkey: string) => string"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/services/routes.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.epmRouteService.getInstallPath.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "pkgkey",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/services/routes.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.epmRouteService.getBulkInstallPath",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getBulkInstallPath",
|
|
"description": [],
|
|
"signature": [
|
|
"() => string"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/services/routes.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.epmRouteService.getRemovePath",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getRemovePath",
|
|
"description": [],
|
|
"signature": [
|
|
"(pkgkey: string) => string"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/services/routes.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.epmRouteService.getRemovePath.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "pkgkey",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/services/routes.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.epmRouteService.getUpdatePath",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getUpdatePath",
|
|
"description": [],
|
|
"signature": [
|
|
"(pkgkey: string) => string"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/services/routes.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.epmRouteService.getUpdatePath.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "pkgkey",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/services/routes.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.fleetSetupRouteService",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "fleetSetupRouteService",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/services/routes.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.fleetSetupRouteService.getFleetSetupPath",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getFleetSetupPath",
|
|
"description": [],
|
|
"signature": [
|
|
"() => string"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/services/routes.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.fleetSetupRouteService.postFleetSetupPath",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "postFleetSetupPath",
|
|
"description": [],
|
|
"signature": [
|
|
"() => string"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/services/routes.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.installationStatuses",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "installationStatuses",
|
|
"description": [],
|
|
"signature": [
|
|
"{ readonly Installed: \"installed\"; readonly Installing: \"installing\"; readonly InstallFailed: \"install_failed\"; readonly NotInstalled: \"not_installed\"; }"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/constants/epm.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.OUTPUT_API_ROUTES",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "OUTPUT_API_ROUTES",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.OUTPUT_API_ROUTES.LIST_PATTERN",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "LIST_PATTERN",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.OUTPUT_API_ROUTES.INFO_PATTERN",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "INFO_PATTERN",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.OUTPUT_API_ROUTES.UPDATE_PATTERN",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "UPDATE_PATTERN",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.outputRoutesService",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "outputRoutesService",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/services/routes.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.outputRoutesService.getInfoPath",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getInfoPath",
|
|
"description": [],
|
|
"signature": [
|
|
"(outputId: string) => string"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/services/routes.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.outputRoutesService.getInfoPath.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "outputId",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/services/routes.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.outputRoutesService.getUpdatePath",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getUpdatePath",
|
|
"description": [],
|
|
"signature": [
|
|
"(outputId: string) => string"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/services/routes.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.outputRoutesService.getUpdatePath.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "outputId",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/services/routes.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.outputRoutesService.getListPath",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getListPath",
|
|
"description": [],
|
|
"signature": [
|
|
"() => string"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/services/routes.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.outputType",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "outputType",
|
|
"description": [],
|
|
"signature": [
|
|
"{ readonly Elasticsearch: \"elasticsearch\"; }"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/constants/output.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.PACKAGE_POLICY_API_ROUTES",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "PACKAGE_POLICY_API_ROUTES",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.PACKAGE_POLICY_API_ROUTES.LIST_PATTERN",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "LIST_PATTERN",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.PACKAGE_POLICY_API_ROUTES.INFO_PATTERN",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "INFO_PATTERN",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.PACKAGE_POLICY_API_ROUTES.CREATE_PATTERN",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "CREATE_PATTERN",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.PACKAGE_POLICY_API_ROUTES.UPDATE_PATTERN",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "UPDATE_PATTERN",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.PACKAGE_POLICY_API_ROUTES.DELETE_PATTERN",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "DELETE_PATTERN",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.PACKAGE_POLICY_API_ROUTES.UPGRADE_PATTERN",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "UPGRADE_PATTERN",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.packagePolicyRouteService",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "packagePolicyRouteService",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/services/routes.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.packagePolicyRouteService.getListPath",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getListPath",
|
|
"description": [],
|
|
"signature": [
|
|
"() => string"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/services/routes.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.packagePolicyRouteService.getInfoPath",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getInfoPath",
|
|
"description": [],
|
|
"signature": [
|
|
"(packagePolicyId: string) => string"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/services/routes.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.packagePolicyRouteService.getInfoPath.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "packagePolicyId",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/services/routes.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.packagePolicyRouteService.getCreatePath",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getCreatePath",
|
|
"description": [],
|
|
"signature": [
|
|
"() => string"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/services/routes.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.packagePolicyRouteService.getUpdatePath",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getUpdatePath",
|
|
"description": [],
|
|
"signature": [
|
|
"(packagePolicyId: string) => string"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/services/routes.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.packagePolicyRouteService.getUpdatePath.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "packagePolicyId",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/services/routes.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.packagePolicyRouteService.getDeletePath",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getDeletePath",
|
|
"description": [],
|
|
"signature": [
|
|
"() => string"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/services/routes.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.packagePolicyRouteService.getUpgradePath",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getUpgradePath",
|
|
"description": [],
|
|
"signature": [
|
|
"() => string"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/services/routes.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.PRECONFIGURATION_API_ROUTES",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "PRECONFIGURATION_API_ROUTES",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.PRECONFIGURATION_API_ROUTES.UPDATE_PATTERN",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "UPDATE_PATTERN",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.SETTINGS_API_ROUTES",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "SETTINGS_API_ROUTES",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.SETTINGS_API_ROUTES.INFO_PATTERN",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "INFO_PATTERN",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.SETTINGS_API_ROUTES.UPDATE_PATTERN",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "UPDATE_PATTERN",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.settingsRoutesService",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "settingsRoutesService",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/services/routes.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.settingsRoutesService.getInfoPath",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getInfoPath",
|
|
"description": [],
|
|
"signature": [
|
|
"() => string"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/services/routes.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.settingsRoutesService.getUpdatePath",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getUpdatePath",
|
|
"description": [],
|
|
"signature": [
|
|
"() => string"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/services/routes.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.setupRouteService",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "setupRouteService",
|
|
"description": [],
|
|
"path": "x-pack/plugins/fleet/common/services/routes.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fleet",
|
|
"id": "def-common.setupRouteService.getSetupPath",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getSetupPath",
|
|
"description": [],
|
|
"signature": [
|
|
"() => string"
|
|
],
|
|
"path": "x-pack/plugins/fleet/common/services/routes.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
]
|
|
}
|
|
}
|