kibana/api_docs/osquery.devdocs.json

{
  "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/plugins/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/plugins/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?: ",
            "AlertEcsData",
            " | undefined; }) => JSX.Element) | undefined"
          ],
          "path": "x-pack/plugins/osquery/public/types.ts",
          "deprecated": false,
          "trackAdoption": false
        },
        {
          "parentPluginId": "osquery",
          "id": "def-public.OsqueryPluginStart.OsqueryResults",
          "type": "Function",
          "tags": [],
          "label": "OsqueryResults",
          "description": [],
          "signature": [
            "(props: ",
            "OsqueryActionResultsProps",
            ") => JSX.Element"
          ],
          "path": "x-pack/plugins/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/plugins/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<string, unknown>; }, any>; }) => JSX.Element) | undefined"
          ],
          "path": "x-pack/plugins/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/plugins/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/plugins/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/plugins/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/plugins/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: LazyOsqueryActionParamsFormProps) => JSX.Element"
          ],
          "path": "x-pack/plugins/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": [
                "LazyOsqueryActionParamsFormProps"
              ],
              "path": "x-pack/plugins/osquery/public/shared_components/lazy_osquery_action_params_form.tsx",
              "deprecated": false,
              "trackAdoption": false
            }
          ]
        }
      ],
      "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/plugins/osquery/server/types.ts",
      "deprecated": false,
      "trackAdoption": false,
      "children": [
        {
          "parentPluginId": "osquery",
          "id": "def-server.OsqueryPluginSetup.osqueryCreateAction",
          "type": "Function",
          "tags": [],
          "label": "osqueryCreateAction",
          "description": [],
          "signature": [
            "(payload: { 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; }[] | { [x: string]: { query: string; id: string; ecs_mapping: { [x: string]: { field?: string | undefined; value?: string | string[] | undefined; }; } | undefined; version: string | undefined; platform: string | undefined; saved_query_id: string | undefined; }; } | undefined; saved_query_id?: string | 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; }) => void"
          ],
          "path": "x-pack/plugins/osquery/server/types.ts",
          "deprecated": false,
          "trackAdoption": false,
          "children": [
            {
              "parentPluginId": "osquery",
              "id": "def-server.OsqueryPluginSetup.osqueryCreateAction.$1",
              "type": "Object",
              "tags": [],
              "label": "payload",
              "description": [],
              "signature": [
                "{ 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; }[] | { [x: string]: { query: string; id: string; ecs_mapping: { [x: string]: { field?: string | undefined; value?: string | string[] | undefined; }; } | undefined; version: string | undefined; platform: string | undefined; saved_query_id: string | undefined; }; } | undefined; saved_query_id?: string | 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; }"
              ],
              "path": "x-pack/plugins/osquery/server/types.ts",
              "deprecated": false,
              "trackAdoption": false,
              "isRequired": true
            }
          ],
          "returnComment": []
        }
      ],
      "lifecycle": "setup",
      "initialIsOpen": true
    },
    "start": {
      "parentPluginId": "osquery",
      "id": "def-server.OsqueryPluginStart",
      "type": "Interface",
      "tags": [],
      "label": "OsqueryPluginStart",
      "description": [],
      "path": "x-pack/plugins/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/plugins/osquery/common/constants.ts",
        "deprecated": false,
        "trackAdoption": false,
        "initialIsOpen": false
      },
      {
        "parentPluginId": "osquery",
        "id": "def-common.DEFAULT_DARK_MODE",
        "type": "string",
        "tags": [],
        "label": "DEFAULT_DARK_MODE",
        "description": [],
        "signature": [
          "\"theme:darkMode\""
        ],
        "path": "x-pack/plugins/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/plugins/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/plugins/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/plugins/osquery/common/index.ts",
        "deprecated": false,
        "trackAdoption": false,
        "initialIsOpen": false
      }
    ],
    "objects": []
  }
}