{ "id": "osquery", "client": { "classes": [], "functions": [], "interfaces": [], "enums": [], "misc": [], "objects": [], "setup": { "parentPluginId": "osquery", "id": "def-public.OsqueryPluginSetup", "type": "Interface", "tags": [], "label": "OsqueryPluginSetup", "description": [], "path": "x-pack/platform/plugins/shared/osquery/public/types.ts", "deprecated": false, "trackAdoption": false, "children": [], "lifecycle": "setup", "initialIsOpen": true }, "start": { "parentPluginId": "osquery", "id": "def-public.OsqueryPluginStart", "type": "Interface", "tags": [], "label": "OsqueryPluginStart", "description": [], "path": "x-pack/platform/plugins/shared/osquery/public/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "osquery", "id": "def-public.OsqueryPluginStart.OsqueryAction", "type": "Function", "tags": [], "label": "OsqueryAction", "description": [], "signature": [ "((props: ", "OsqueryActionProps", " & { ecsData?: ", { "pluginId": "cases", "scope": "common", "docId": "kibCasesPluginApi", "section": "def-common.Ecs", "text": "Ecs" }, " | undefined; }) => React.JSX.Element) | undefined" ], "path": "x-pack/platform/plugins/shared/osquery/public/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "osquery", "id": "def-public.OsqueryPluginStart.OsqueryResult", "type": "Function", "tags": [], "label": "OsqueryResult", "description": [], "signature": [ "(props: ", "OsqueryActionResultProps", ") => React.JSX.Element" ], "path": "x-pack/platform/plugins/shared/osquery/public/types.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "osquery", "id": "def-public.OsqueryPluginStart.OsqueryResult.$1", "type": "Object", "tags": [], "label": "props", "description": [], "signature": [ "OsqueryActionResultProps" ], "path": "x-pack/platform/plugins/shared/osquery/public/shared_components/lazy_osquery_result.tsx", "deprecated": false, "trackAdoption": false } ] }, { "parentPluginId": "osquery", "id": "def-public.OsqueryPluginStart.OsqueryResults", "type": "Function", "tags": [], "label": "OsqueryResults", "description": [], "signature": [ "(props: ", "OsqueryActionResultsProps", ") => React.JSX.Element" ], "path": "x-pack/platform/plugins/shared/osquery/public/types.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "osquery", "id": "def-public.OsqueryPluginStart.OsqueryResults.$1", "type": "Object", "tags": [], "label": "props", "description": [], "signature": [ "OsqueryActionResultsProps" ], "path": "x-pack/platform/plugins/shared/osquery/public/shared_components/lazy_osquery_results.tsx", "deprecated": false, "trackAdoption": false } ] }, { "parentPluginId": "osquery", "id": "def-public.OsqueryPluginStart.LiveQueryField", "type": "Function", "tags": [], "label": "LiveQueryField", "description": [], "signature": [ "(({ formMethods, ...props }: ", "LiveQueryQueryFieldProps", " & { formMethods: ", "UseFormReturn", "<{ label: string; query: string; ecs_mapping: Record; }, any, undefined>; }) => React.JSX.Element) | undefined" ], "path": "x-pack/platform/plugins/shared/osquery/public/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "osquery", "id": "def-public.OsqueryPluginStart.isOsqueryAvailable", "type": "Function", "tags": [], "label": "isOsqueryAvailable", "description": [], "signature": [ "(props: { agentId: string; }) => boolean" ], "path": "x-pack/platform/plugins/shared/osquery/public/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "osquery", "id": "def-public.OsqueryPluginStart.isOsqueryAvailable.$1", "type": "Object", "tags": [], "label": "props", "description": [], "path": "x-pack/platform/plugins/shared/osquery/public/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "osquery", "id": "def-public.OsqueryPluginStart.isOsqueryAvailable.$1.agentId", "type": "string", "tags": [], "label": "agentId", "description": [], "path": "x-pack/platform/plugins/shared/osquery/public/types.ts", "deprecated": false, "trackAdoption": false } ] } ], "returnComment": [] }, { "parentPluginId": "osquery", "id": "def-public.OsqueryPluginStart.fetchInstallationStatus", "type": "Function", "tags": [], "label": "fetchInstallationStatus", "description": [], "signature": [ "() => { loading: boolean; disabled: boolean; permissionDenied: boolean; }" ], "path": "x-pack/platform/plugins/shared/osquery/public/types.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "osquery", "id": "def-public.OsqueryPluginStart.OsqueryResponseActionTypeForm", "type": "Function", "tags": [], "label": "OsqueryResponseActionTypeForm", "description": [], "signature": [ "(props: ", "OsqueryResponseActionsParamsFormProps", ") => React.JSX.Element" ], "path": "x-pack/platform/plugins/shared/osquery/public/types.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "osquery", "id": "def-public.OsqueryPluginStart.OsqueryResponseActionTypeForm.$1", "type": "Object", "tags": [], "label": "props", "description": [], "signature": [ "OsqueryResponseActionsParamsFormProps" ], "path": "x-pack/platform/plugins/shared/osquery/public/shared_components/lazy_osquery_action_params_form.tsx", "deprecated": false, "trackAdoption": false } ] }, { "parentPluginId": "osquery", "id": "def-public.OsqueryPluginStart.fetchAllLiveQueries", "type": "Function", "tags": [], "label": "fetchAllLiveQueries", "description": [], "signature": [ "(config: ", "UseAllLiveQueriesConfig", ") => ", "UseQueryResult", "<{ data: Omit<", "ActionsStrategyResponse", ", \"edges\"> & { items: ", "SearchHit", "[]; }; }, Error>" ], "path": "x-pack/platform/plugins/shared/osquery/public/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "osquery", "id": "def-public.OsqueryPluginStart.fetchAllLiveQueries.$1", "type": "Object", "tags": [], "label": "config", "description": [], "signature": [ "UseAllLiveQueriesConfig" ], "path": "x-pack/platform/plugins/shared/osquery/public/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] } ], "lifecycle": "start", "initialIsOpen": true } }, "server": { "classes": [], "functions": [], "interfaces": [], "enums": [], "misc": [], "objects": [], "setup": { "parentPluginId": "osquery", "id": "def-server.OsqueryPluginSetup", "type": "Interface", "tags": [], "label": "OsqueryPluginSetup", "description": [], "path": "x-pack/platform/plugins/shared/osquery/server/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "osquery", "id": "def-server.OsqueryPluginSetup.createActionService", "type": "Object", "tags": [], "label": "createActionService", "description": [], "signature": [ "{ create: (params: { agent_ids?: string[] | undefined; agent_all?: boolean | undefined; agent_platforms?: string[] | undefined; agent_policy_ids?: string[] | undefined; query?: string | undefined; queries?: { id: string; query: string; ecs_mapping: { [x: string]: { field?: string | undefined; value?: string | string[] | undefined; }; } | undefined; version: string | undefined; platform: string | undefined; removed: boolean | undefined; snapshot: boolean | undefined; }[] | undefined; saved_query_id?: string | undefined; timeout?: number | undefined; ecs_mapping?: { [x: string]: { field?: string | undefined; value?: string | string[] | undefined; }; } | undefined; pack_id?: string | undefined; alert_ids?: string[] | undefined; case_ids?: string[] | undefined; event_ids?: string[] | undefined; metadata?: object | undefined; }, alertData?: (OutputOf> & { _index: string; }) | undefined) => Promise<{ response: { action_id: string; '@timestamp': string; expiration: string; type: string; input_type: string; alert_ids: string[] | undefined; event_ids: string[] | undefined; case_ids: string[] | undefined; agent_ids: string[] | undefined; agent_all: boolean | undefined; agent_platforms: string[] | undefined; agent_policy_ids: string[] | undefined; agents: string[]; user_id: string | undefined; metadata: object | undefined; pack_id: string | undefined; pack_name: string | undefined; pack_prebuilt: boolean | undefined; queries: _.Dictionary[]; }; fleetActionsCount: number; }>; stop: () => void; }" ], "path": "x-pack/platform/plugins/shared/osquery/server/types.ts", "deprecated": false, "trackAdoption": false } ], "lifecycle": "setup", "initialIsOpen": true }, "start": { "parentPluginId": "osquery", "id": "def-server.OsqueryPluginStart", "type": "Interface", "tags": [], "label": "OsqueryPluginStart", "description": [], "path": "x-pack/platform/plugins/shared/osquery/server/types.ts", "deprecated": false, "trackAdoption": false, "children": [], "lifecycle": "start", "initialIsOpen": true } }, "common": { "classes": [], "functions": [], "interfaces": [], "enums": [], "misc": [ { "parentPluginId": "osquery", "id": "def-common.BASE_PATH", "type": "string", "tags": [], "label": "BASE_PATH", "description": [], "signature": [ "\"/app/osquery\"" ], "path": "x-pack/platform/plugins/shared/osquery/common/constants.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "osquery", "id": "def-common.OSQUERY_INTEGRATION_NAME", "type": "string", "tags": [], "label": "OSQUERY_INTEGRATION_NAME", "description": [], "signature": [ "\"osquery_manager\"" ], "path": "x-pack/platform/plugins/shared/osquery/common/constants.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "osquery", "id": "def-common.PLUGIN_ID", "type": "string", "tags": [], "label": "PLUGIN_ID", "description": [], "signature": [ "\"osquery\"" ], "path": "x-pack/platform/plugins/shared/osquery/common/index.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "osquery", "id": "def-common.PLUGIN_NAME", "type": "string", "tags": [], "label": "PLUGIN_NAME", "description": [], "signature": [ "\"Osquery\"" ], "path": "x-pack/platform/plugins/shared/osquery/common/index.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false } ], "objects": [] } }