1992 lines
68 KiB
JSON
1992 lines
68 KiB
JSON
{
|
|
"id": "actions",
|
|
"client": {
|
|
"classes": [],
|
|
"functions": [],
|
|
"interfaces": [],
|
|
"enums": [],
|
|
"misc": [],
|
|
"objects": []
|
|
},
|
|
"server": {
|
|
"classes": [],
|
|
"functions": [
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.asHttpRequestExecutionSource",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "asHttpRequestExecutionSource",
|
|
"description": [],
|
|
"signature": [
|
|
"(source: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreHttpPluginApi",
|
|
"section": "def-server.KibanaRequest",
|
|
"text": "KibanaRequest"
|
|
},
|
|
"<unknown, unknown, unknown, any>) => ",
|
|
"HttpRequestExecutionSource"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/lib/action_execution_source.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.asHttpRequestExecutionSource.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "source",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreHttpPluginApi",
|
|
"section": "def-server.KibanaRequest",
|
|
"text": "KibanaRequest"
|
|
},
|
|
"<unknown, unknown, unknown, any>"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/lib/action_execution_source.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.asSavedObjectExecutionSource",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "asSavedObjectExecutionSource",
|
|
"description": [],
|
|
"signature": [
|
|
"(source: Pick<",
|
|
"SavedObjectReference",
|
|
", \"type\" | \"id\">) => ",
|
|
"SavedObjectExecutionSource"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/lib/action_execution_source.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.asSavedObjectExecutionSource.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "source",
|
|
"description": [],
|
|
"signature": [
|
|
"Pick<",
|
|
"SavedObjectReference",
|
|
", \"type\" | \"id\">"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/lib/action_execution_source.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"interfaces": [
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.ActionResult",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "ActionResult",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "actions",
|
|
"scope": "server",
|
|
"docId": "kibActionsPluginApi",
|
|
"section": "def-server.ActionResult",
|
|
"text": "ActionResult"
|
|
},
|
|
"<Config>"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.ActionResult.id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"path": "x-pack/plugins/actions/server/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.ActionResult.actionTypeId",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "actionTypeId",
|
|
"description": [],
|
|
"path": "x-pack/plugins/actions/server/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.ActionResult.name",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "name",
|
|
"description": [],
|
|
"path": "x-pack/plugins/actions/server/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.ActionResult.isMissingSecrets",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "isMissingSecrets",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.ActionResult.config",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "config",
|
|
"description": [],
|
|
"signature": [
|
|
"Config | undefined"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.ActionResult.isPreconfigured",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "isPreconfigured",
|
|
"description": [],
|
|
"path": "x-pack/plugins/actions/server/types.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.ActionsApiRequestHandlerContext",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "ActionsApiRequestHandlerContext",
|
|
"description": [],
|
|
"path": "x-pack/plugins/actions/server/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.ActionsApiRequestHandlerContext.getActionsClient",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getActionsClient",
|
|
"description": [],
|
|
"signature": [
|
|
"() => ",
|
|
{
|
|
"pluginId": "actions",
|
|
"scope": "server",
|
|
"docId": "kibActionsPluginApi",
|
|
"section": "def-server.ActionsClient",
|
|
"text": "ActionsClient"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/actions/server/types.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.ActionsApiRequestHandlerContext.listTypes",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "listTypes",
|
|
"description": [],
|
|
"signature": [
|
|
"() => ",
|
|
{
|
|
"pluginId": "actions",
|
|
"scope": "common",
|
|
"docId": "kibActionsPluginApi",
|
|
"section": "def-common.ActionType",
|
|
"text": "ActionType"
|
|
},
|
|
"[]"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/types.ts",
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.ActionsPlugin",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "ActionsPlugin",
|
|
"description": [],
|
|
"path": "x-pack/plugins/actions/server/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.ActionsPlugin.setup",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "setup",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "actions",
|
|
"scope": "server",
|
|
"docId": "kibActionsPluginApi",
|
|
"section": "def-server.PluginSetupContract",
|
|
"text": "PluginSetupContract"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/actions/server/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.ActionsPlugin.start",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "start",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "actions",
|
|
"scope": "server",
|
|
"docId": "kibActionsPluginApi",
|
|
"section": "def-server.PluginStartContract",
|
|
"text": "PluginStartContract"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/actions/server/types.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.ActionType",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "ActionType",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "actions",
|
|
"scope": "server",
|
|
"docId": "kibActionsPluginApi",
|
|
"section": "def-server.ActionType",
|
|
"text": "ActionType"
|
|
},
|
|
"<Config, Secrets, Params, ExecutorResultData>"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.ActionType.id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"path": "x-pack/plugins/actions/server/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.ActionType.name",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "name",
|
|
"description": [],
|
|
"path": "x-pack/plugins/actions/server/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.ActionType.maxAttempts",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "maxAttempts",
|
|
"description": [],
|
|
"signature": [
|
|
"number | undefined"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.ActionType.minimumLicenseRequired",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "minimumLicenseRequired",
|
|
"description": [],
|
|
"signature": [
|
|
"\"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\""
|
|
],
|
|
"path": "x-pack/plugins/actions/server/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.ActionType.validate",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "validate",
|
|
"description": [],
|
|
"signature": [
|
|
"{ params?: ValidatorType<Params> | undefined; config?: ValidatorType<Config> | undefined; secrets?: ValidatorType<Secrets> | undefined; } | undefined"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.ActionType.renderParameterTemplates",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "renderParameterTemplates",
|
|
"description": [],
|
|
"signature": [
|
|
"((params: Params, variables: Record<string, unknown>, actionId?: string | undefined) => Params) | undefined"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.ActionType.renderParameterTemplates.$1",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "params",
|
|
"description": [],
|
|
"signature": [
|
|
"Params"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/types.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.ActionType.renderParameterTemplates.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "variables",
|
|
"description": [],
|
|
"signature": [
|
|
"Record<string, unknown>"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/types.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.ActionType.renderParameterTemplates.$3",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "actionId",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/types.ts",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.ActionType.executor",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "executor",
|
|
"description": [],
|
|
"signature": [
|
|
"(options: ",
|
|
{
|
|
"pluginId": "actions",
|
|
"scope": "server",
|
|
"docId": "kibActionsPluginApi",
|
|
"section": "def-server.ActionTypeExecutorOptions",
|
|
"text": "ActionTypeExecutorOptions"
|
|
},
|
|
"<Config, Secrets, Params>) => Promise<",
|
|
{
|
|
"pluginId": "actions",
|
|
"scope": "common",
|
|
"docId": "kibActionsPluginApi",
|
|
"section": "def-common.ActionTypeExecutorResult",
|
|
"text": "ActionTypeExecutorResult"
|
|
},
|
|
"<ExecutorResultData>>"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/types.ts",
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.ActionType.executor.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "options",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "actions",
|
|
"scope": "server",
|
|
"docId": "kibActionsPluginApi",
|
|
"section": "def-server.ActionTypeExecutorOptions",
|
|
"text": "ActionTypeExecutorOptions"
|
|
},
|
|
"<Config, Secrets, Params>"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/types.ts",
|
|
"deprecated": false
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.ActionTypeExecutorOptions",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "ActionTypeExecutorOptions",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "actions",
|
|
"scope": "server",
|
|
"docId": "kibActionsPluginApi",
|
|
"section": "def-server.ActionTypeExecutorOptions",
|
|
"text": "ActionTypeExecutorOptions"
|
|
},
|
|
"<Config, Secrets, Params>"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.ActionTypeExecutorOptions.actionId",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "actionId",
|
|
"description": [],
|
|
"path": "x-pack/plugins/actions/server/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.ActionTypeExecutorOptions.services",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "services",
|
|
"description": [],
|
|
"signature": [
|
|
"Services"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.ActionTypeExecutorOptions.config",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "config",
|
|
"description": [],
|
|
"signature": [
|
|
"Config"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.ActionTypeExecutorOptions.secrets",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "secrets",
|
|
"description": [],
|
|
"signature": [
|
|
"Secrets"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.ActionTypeExecutorOptions.params",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "params",
|
|
"description": [],
|
|
"signature": [
|
|
"Params"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.ActionTypeExecutorOptions.isEphemeral",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "isEphemeral",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.ActionTypeExecutorOptions.taskInfo",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "taskInfo",
|
|
"description": [],
|
|
"signature": [
|
|
"TaskInfo",
|
|
" | undefined"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/types.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.PreConfiguredAction",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "PreConfiguredAction",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "actions",
|
|
"scope": "server",
|
|
"docId": "kibActionsPluginApi",
|
|
"section": "def-server.PreConfiguredAction",
|
|
"text": "PreConfiguredAction"
|
|
},
|
|
"<Config, Secrets> extends ",
|
|
{
|
|
"pluginId": "actions",
|
|
"scope": "server",
|
|
"docId": "kibActionsPluginApi",
|
|
"section": "def-server.ActionResult",
|
|
"text": "ActionResult"
|
|
},
|
|
"<Config>"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.PreConfiguredAction.secrets",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "secrets",
|
|
"description": [],
|
|
"signature": [
|
|
"Secrets"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/types.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"enums": [],
|
|
"misc": [
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.ACTION_SAVED_OBJECT_TYPE",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "ACTION_SAVED_OBJECT_TYPE",
|
|
"description": [],
|
|
"signature": [
|
|
"\"action\""
|
|
],
|
|
"path": "x-pack/plugins/actions/server/constants/saved_objects.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.ActionParamsType",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "ActionParamsType",
|
|
"description": [],
|
|
"signature": [
|
|
"{ readonly to: string[]; readonly message: string; readonly subject: string; readonly cc: string[]; readonly bcc: string[]; readonly kibanaFooterLink: Readonly<{} & { path: string; text: string; }>; }"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/builtin_action_types/email.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.ActionParamsType",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "ActionParamsType",
|
|
"description": [],
|
|
"signature": [
|
|
"{ readonly documents: Record<string, any>[]; readonly indexOverride: string | null; }"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/builtin_action_types/es_index.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.ActionParamsType",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "ActionParamsType",
|
|
"description": [],
|
|
"signature": [
|
|
"{ readonly source?: string | undefined; readonly summary?: string | undefined; readonly timestamp?: string | undefined; readonly eventAction?: \"resolve\" | \"trigger\" | \"acknowledge\" | undefined; readonly dedupKey?: string | undefined; readonly severity?: \"error\" | \"info\" | \"warning\" | \"critical\" | undefined; readonly component?: string | undefined; readonly group?: string | undefined; readonly class?: string | undefined; }"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/builtin_action_types/pagerduty.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.ActionParamsType",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "ActionParamsType",
|
|
"description": [],
|
|
"signature": [
|
|
"{ readonly message: string; readonly level: \"error\" | \"info\" | \"debug\" | \"trace\" | \"warn\" | \"fatal\"; }"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/builtin_action_types/server_log.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.ActionParamsType",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "ActionParamsType",
|
|
"description": [],
|
|
"signature": [
|
|
"{ readonly message: string; }"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/builtin_action_types/slack.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.ActionParamsType",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "ActionParamsType",
|
|
"description": [],
|
|
"signature": [
|
|
"{ readonly body?: string | undefined; }"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/builtin_action_types/webhook.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.ActionParamsType",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "ActionParamsType",
|
|
"description": [],
|
|
"signature": [
|
|
"Readonly<{} & { subAction: \"getFields\"; subActionParams: Readonly<{} & {}>; }> | Readonly<{} & { subAction: \"getIncident\"; subActionParams: Readonly<{} & { externalId: string; }>; }> | Readonly<{} & { subAction: \"handshake\"; subActionParams: Readonly<{} & {}>; }> | Readonly<{} & { subAction: \"pushToService\"; subActionParams: Readonly<{} & { incident: Readonly<{} & { description: string | null; category: string | null; severity: string | null; externalId: string | null; urgency: string | null; impact: string | null; short_description: string; subcategory: string | null; correlation_id: string | null; correlation_display: string | null; }>; comments: Readonly<{} & { comment: string; commentId: string; }>[] | null; }>; }> | Readonly<{} & { subAction: \"getChoices\"; subActionParams: Readonly<{} & { fields: string[]; }>; }> | Readonly<{} & { subAction: \"getFields\"; subActionParams: Readonly<{} & {}>; }> | Readonly<{} & { subAction: \"getIncident\"; subActionParams: Readonly<{} & { externalId: string; }>; }> | Readonly<{} & { subAction: \"handshake\"; subActionParams: Readonly<{} & {}>; }> | Readonly<{} & { subAction: \"pushToService\"; subActionParams: Readonly<{} & { incident: Readonly<{} & { description: string | null; category: string | null; externalId: string | null; short_description: string; subcategory: string | null; correlation_id: string | null; correlation_display: string | null; dest_ip: string | string[] | null; malware_hash: string | string[] | null; malware_url: string | string[] | null; source_ip: string | string[] | null; priority: string | null; }>; comments: Readonly<{} & { comment: string; commentId: string; }>[] | null; }>; }> | Readonly<{} & { subAction: \"getChoices\"; subActionParams: Readonly<{} & { fields: string[]; }>; }>"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/builtin_action_types/servicenow/index.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.ActionParamsType",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "ActionParamsType",
|
|
"description": [],
|
|
"signature": [
|
|
"Readonly<{} & { subAction: \"getFields\"; subActionParams: Readonly<{} & {}>; }> | Readonly<{} & { subAction: \"getIncident\"; subActionParams: Readonly<{} & { externalId: string; }>; }> | Readonly<{} & { subAction: \"handshake\"; subActionParams: Readonly<{} & {}>; }> | Readonly<{} & { subAction: \"pushToService\"; subActionParams: Readonly<{} & { incident: Readonly<{} & { description: string | null; parent: string | null; summary: string; externalId: string | null; priority: string | null; issueType: string | null; labels: string[] | null; }>; comments: Readonly<{} & { comment: string; commentId: string; }>[] | null; }>; }> | Readonly<{} & { subAction: \"issueTypes\"; subActionParams: Readonly<{} & {}>; }> | Readonly<{} & { subAction: \"fieldsByIssueType\"; subActionParams: Readonly<{} & { id: string; }>; }> | Readonly<{} & { subAction: \"issues\"; subActionParams: Readonly<{} & { title: string; }>; }> | Readonly<{} & { subAction: \"issue\"; subActionParams: Readonly<{} & { id: string; }>; }>"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/builtin_action_types/jira/index.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.ActionParamsType",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "ActionParamsType",
|
|
"description": [],
|
|
"signature": [
|
|
"Readonly<{} & { subAction: \"getFields\"; subActionParams: Readonly<{} & {}>; }> | Readonly<{} & { subAction: \"getIncident\"; subActionParams: Readonly<{} & { externalId: string; }>; }> | Readonly<{} & { subAction: \"handshake\"; subActionParams: Readonly<{} & {}>; }> | Readonly<{} & { subAction: \"pushToService\"; subActionParams: Readonly<{} & { incident: Readonly<{} & { description: string | null; name: string; externalId: string | null; incidentTypes: number[] | null; severityCode: number | null; }>; comments: Readonly<{} & { comment: string; commentId: string; }>[] | null; }>; }> | Readonly<{} & { subAction: \"incidentTypes\"; subActionParams: Readonly<{} & {}>; }> | Readonly<{} & { subAction: \"severity\"; subActionParams: Readonly<{} & {}>; }>"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/builtin_action_types/resilient/index.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.ActionParamsType",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "ActionParamsType",
|
|
"description": [],
|
|
"signature": [
|
|
"{ readonly message: string; }"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/builtin_action_types/teams.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.ActionsAuthorization",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "ActionsAuthorization",
|
|
"description": [],
|
|
"signature": [
|
|
"{ ensureAuthorized: (operation: string, actionTypeId?: string | undefined) => Promise<void>; }"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/index.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.ActionsClient",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "ActionsClient",
|
|
"description": [],
|
|
"signature": [
|
|
"{ create: ({ action: { actionTypeId, name, config, secrets }, }: ",
|
|
"CreateOptions",
|
|
") => Promise<",
|
|
{
|
|
"pluginId": "actions",
|
|
"scope": "server",
|
|
"docId": "kibActionsPluginApi",
|
|
"section": "def-server.ActionResult",
|
|
"text": "ActionResult"
|
|
},
|
|
"<Record<string, unknown>>>; delete: ({ id }: { id: string; }) => Promise<{}>; get: ({ id }: { id: string; }) => Promise<",
|
|
{
|
|
"pluginId": "actions",
|
|
"scope": "server",
|
|
"docId": "kibActionsPluginApi",
|
|
"section": "def-server.ActionResult",
|
|
"text": "ActionResult"
|
|
},
|
|
"<Record<string, unknown>>>; update: ({ id, action }: ",
|
|
"UpdateOptions",
|
|
") => Promise<",
|
|
{
|
|
"pluginId": "actions",
|
|
"scope": "server",
|
|
"docId": "kibActionsPluginApi",
|
|
"section": "def-server.ActionResult",
|
|
"text": "ActionResult"
|
|
},
|
|
"<Record<string, unknown>>>; execute: ({ actionId, params, source, relatedSavedObjects, }: Pick<",
|
|
"ExecuteOptions",
|
|
"<unknown>, \"source\" | \"params\" | \"actionId\" | \"isEphemeral\" | \"taskInfo\" | \"relatedSavedObjects\">) => Promise<",
|
|
{
|
|
"pluginId": "actions",
|
|
"scope": "common",
|
|
"docId": "kibActionsPluginApi",
|
|
"section": "def-common.ActionTypeExecutorResult",
|
|
"text": "ActionTypeExecutorResult"
|
|
},
|
|
"<unknown>>; getAll: () => Promise<",
|
|
"FindActionResult",
|
|
"[]>; getBulk: (ids: string[]) => Promise<",
|
|
{
|
|
"pluginId": "actions",
|
|
"scope": "server",
|
|
"docId": "kibActionsPluginApi",
|
|
"section": "def-server.ActionResult",
|
|
"text": "ActionResult"
|
|
},
|
|
"<Record<string, unknown>>[]>; enqueueExecution: (options: ",
|
|
"ExecuteOptions",
|
|
") => Promise<void>; ephemeralEnqueuedExecution: (options: ",
|
|
"ExecuteOptions",
|
|
") => Promise<",
|
|
{
|
|
"pluginId": "taskManager",
|
|
"scope": "server",
|
|
"docId": "kibTaskManagerPluginApi",
|
|
"section": "def-server.RunNowResult",
|
|
"text": "RunNowResult"
|
|
},
|
|
">; listTypes: () => Promise<",
|
|
{
|
|
"pluginId": "actions",
|
|
"scope": "common",
|
|
"docId": "kibActionsPluginApi",
|
|
"section": "def-common.ActionType",
|
|
"text": "ActionType"
|
|
},
|
|
"[]>; isActionTypeEnabled: (actionTypeId: string, options?: { notifyUsage: boolean; }) => boolean; isPreconfigured: (connectorId: string) => boolean; }"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/index.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.ActionTypeId",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "ActionTypeId",
|
|
"description": [],
|
|
"signature": [
|
|
"\".email\""
|
|
],
|
|
"path": "x-pack/plugins/actions/server/builtin_action_types/email.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.ActionTypeId",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "ActionTypeId",
|
|
"description": [],
|
|
"signature": [
|
|
"\".index\""
|
|
],
|
|
"path": "x-pack/plugins/actions/server/builtin_action_types/es_index.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.ActionTypeId",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "ActionTypeId",
|
|
"description": [],
|
|
"signature": [
|
|
"\".pagerduty\""
|
|
],
|
|
"path": "x-pack/plugins/actions/server/builtin_action_types/pagerduty.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.ActionTypeId",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "ActionTypeId",
|
|
"description": [],
|
|
"signature": [
|
|
"\".server-log\""
|
|
],
|
|
"path": "x-pack/plugins/actions/server/builtin_action_types/server_log.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.ActionTypeId",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "ActionTypeId",
|
|
"description": [],
|
|
"signature": [
|
|
"\".slack\""
|
|
],
|
|
"path": "x-pack/plugins/actions/server/builtin_action_types/slack.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.ActionTypeId",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "ActionTypeId",
|
|
"description": [],
|
|
"signature": [
|
|
"\".webhook\""
|
|
],
|
|
"path": "x-pack/plugins/actions/server/builtin_action_types/webhook.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.ActionTypeId",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "ActionTypeId",
|
|
"description": [],
|
|
"signature": [
|
|
"\".jira\""
|
|
],
|
|
"path": "x-pack/plugins/actions/server/builtin_action_types/jira/index.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.ActionTypeId",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "ActionTypeId",
|
|
"description": [],
|
|
"signature": [
|
|
"\".resilient\""
|
|
],
|
|
"path": "x-pack/plugins/actions/server/builtin_action_types/resilient/index.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.ActionTypeId",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "ActionTypeId",
|
|
"description": [],
|
|
"signature": [
|
|
"\".teams\""
|
|
],
|
|
"path": "x-pack/plugins/actions/server/builtin_action_types/teams.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.ServiceNowITSMActionTypeId",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "ServiceNowITSMActionTypeId",
|
|
"description": [],
|
|
"signature": [
|
|
"\".servicenow\""
|
|
],
|
|
"path": "x-pack/plugins/actions/server/builtin_action_types/servicenow/config.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.ServiceNowSIRActionTypeId",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "ServiceNowSIRActionTypeId",
|
|
"description": [],
|
|
"signature": [
|
|
"\".servicenow-sir\""
|
|
],
|
|
"path": "x-pack/plugins/actions/server/builtin_action_types/servicenow/config.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"objects": [],
|
|
"setup": {
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.PluginSetupContract",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "PluginSetupContract",
|
|
"description": [],
|
|
"path": "x-pack/plugins/actions/server/plugin.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.PluginSetupContract.registerType",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "registerType",
|
|
"description": [],
|
|
"signature": [
|
|
"<Config extends Record<string, unknown> = Record<string, unknown>, Secrets extends Record<string, unknown> = Record<string, unknown>, Params extends Record<string, unknown> = Record<string, unknown>, ExecutorResultData = void>(actionType: ",
|
|
{
|
|
"pluginId": "actions",
|
|
"scope": "server",
|
|
"docId": "kibActionsPluginApi",
|
|
"section": "def-server.ActionType",
|
|
"text": "ActionType"
|
|
},
|
|
"<Config, Secrets, Params, ExecutorResultData>) => void"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/plugin.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.PluginSetupContract.registerType.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "actionType",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "actions",
|
|
"scope": "server",
|
|
"docId": "kibActionsPluginApi",
|
|
"section": "def-server.ActionType",
|
|
"text": "ActionType"
|
|
},
|
|
"<Config, Secrets, Params, ExecutorResultData>"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/plugin.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.PluginSetupContract.isPreconfiguredConnector",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "isPreconfiguredConnector",
|
|
"description": [],
|
|
"signature": [
|
|
"(connectorId: string) => boolean"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/plugin.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.PluginSetupContract.isPreconfiguredConnector.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "connectorId",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/plugin.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"lifecycle": "setup",
|
|
"initialIsOpen": true
|
|
},
|
|
"start": {
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.PluginStartContract",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "PluginStartContract",
|
|
"description": [],
|
|
"path": "x-pack/plugins/actions/server/plugin.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.PluginStartContract.isActionTypeEnabled",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "isActionTypeEnabled",
|
|
"description": [],
|
|
"signature": [
|
|
"(id: string, options?: { notifyUsage: boolean; } | undefined) => boolean"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/plugin.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.PluginStartContract.isActionTypeEnabled.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/plugin.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.PluginStartContract.isActionTypeEnabled.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "options",
|
|
"description": [],
|
|
"path": "x-pack/plugins/actions/server/plugin.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.PluginStartContract.isActionTypeEnabled.$2.notifyUsage",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "notifyUsage",
|
|
"description": [],
|
|
"path": "x-pack/plugins/actions/server/plugin.ts",
|
|
"deprecated": false
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.PluginStartContract.isActionExecutable",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "isActionExecutable",
|
|
"description": [],
|
|
"signature": [
|
|
"(actionId: string, actionTypeId: string, options?: { notifyUsage: boolean; } | undefined) => boolean"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/plugin.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.PluginStartContract.isActionExecutable.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "actionId",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/plugin.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.PluginStartContract.isActionExecutable.$2",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "actionTypeId",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/plugin.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.PluginStartContract.isActionExecutable.$3",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "options",
|
|
"description": [],
|
|
"path": "x-pack/plugins/actions/server/plugin.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.PluginStartContract.isActionExecutable.$3.notifyUsage",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "notifyUsage",
|
|
"description": [],
|
|
"path": "x-pack/plugins/actions/server/plugin.ts",
|
|
"deprecated": false
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.PluginStartContract.getActionsClientWithRequest",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getActionsClientWithRequest",
|
|
"description": [],
|
|
"signature": [
|
|
"(request: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreHttpPluginApi",
|
|
"section": "def-server.KibanaRequest",
|
|
"text": "KibanaRequest"
|
|
},
|
|
"<unknown, unknown, unknown, any>) => Promise<Pick<",
|
|
{
|
|
"pluginId": "actions",
|
|
"scope": "server",
|
|
"docId": "kibActionsPluginApi",
|
|
"section": "def-server.ActionsClient",
|
|
"text": "ActionsClient"
|
|
},
|
|
", \"create\" | \"delete\" | \"get\" | \"update\" | \"execute\" | \"getAll\" | \"getBulk\" | \"enqueueExecution\" | \"ephemeralEnqueuedExecution\" | \"listTypes\" | \"isActionTypeEnabled\" | \"isPreconfigured\">>"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/plugin.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.PluginStartContract.getActionsClientWithRequest.$1",
|
|
"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/actions/server/plugin.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.PluginStartContract.getActionsAuthorizationWithRequest",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getActionsAuthorizationWithRequest",
|
|
"description": [],
|
|
"signature": [
|
|
"(request: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreHttpPluginApi",
|
|
"section": "def-server.KibanaRequest",
|
|
"text": "KibanaRequest"
|
|
},
|
|
"<unknown, unknown, unknown, any>) => Pick<",
|
|
{
|
|
"pluginId": "actions",
|
|
"scope": "server",
|
|
"docId": "kibActionsPluginApi",
|
|
"section": "def-server.ActionsAuthorization",
|
|
"text": "ActionsAuthorization"
|
|
},
|
|
", \"ensureAuthorized\">"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/plugin.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.PluginStartContract.getActionsAuthorizationWithRequest.$1",
|
|
"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/actions/server/plugin.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.PluginStartContract.preconfiguredActions",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "preconfiguredActions",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "actions",
|
|
"scope": "server",
|
|
"docId": "kibActionsPluginApi",
|
|
"section": "def-server.PreConfiguredAction",
|
|
"text": "PreConfiguredAction"
|
|
},
|
|
"<Record<string, unknown>, Record<string, unknown>>[]"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/plugin.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.PluginStartContract.renderActionParameterTemplates",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "renderActionParameterTemplates",
|
|
"description": [],
|
|
"signature": [
|
|
"<Params extends Record<string, unknown> = Record<string, unknown>>(actionTypeId: string, actionId: string, params: Params, variables: Record<string, unknown>) => Params"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/plugin.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.PluginStartContract.renderActionParameterTemplates.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "actionTypeId",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/plugin.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.PluginStartContract.renderActionParameterTemplates.$2",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "actionId",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/plugin.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.PluginStartContract.renderActionParameterTemplates.$3",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "params",
|
|
"description": [],
|
|
"signature": [
|
|
"Params"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/plugin.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-server.PluginStartContract.renderActionParameterTemplates.$4",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "variables",
|
|
"description": [],
|
|
"signature": [
|
|
"Record<string, unknown>"
|
|
],
|
|
"path": "x-pack/plugins/actions/server/plugin.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"lifecycle": "start",
|
|
"initialIsOpen": true
|
|
}
|
|
},
|
|
"common": {
|
|
"classes": [],
|
|
"functions": [
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-common.buildAlertHistoryDocument",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "buildAlertHistoryDocument",
|
|
"description": [],
|
|
"signature": [
|
|
"(variables: Record<string, unknown>) => { event: { kind: string; }; kibana?: { alert: { actionGroupName?: string; actionGroup?: string; context?: { [x: string]: Record<string, unknown>; }; id?: string; }; }; rule?: { type?: string; space?: string; params?: { [x: string]: Record<string, unknown>; }; name?: string; id?: string; }; message?: unknown; tags?: string[]; '@timestamp': string; } | null"
|
|
],
|
|
"path": "x-pack/plugins/actions/common/alert_history_schema.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-common.buildAlertHistoryDocument.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "variables",
|
|
"description": [],
|
|
"signature": [
|
|
"Record<string, unknown>"
|
|
],
|
|
"path": "x-pack/plugins/actions/common/alert_history_schema.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-common.isActionTypeExecutorResult",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "isActionTypeExecutorResult",
|
|
"description": [],
|
|
"signature": [
|
|
"(result: unknown) => boolean"
|
|
],
|
|
"path": "x-pack/plugins/actions/common/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-common.isActionTypeExecutorResult.$1",
|
|
"type": "Unknown",
|
|
"tags": [],
|
|
"label": "result",
|
|
"description": [],
|
|
"signature": [
|
|
"unknown"
|
|
],
|
|
"path": "x-pack/plugins/actions/common/types.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"interfaces": [
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-common.ActionResult",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "ActionResult",
|
|
"description": [],
|
|
"path": "x-pack/plugins/actions/common/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-common.ActionResult.id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"path": "x-pack/plugins/actions/common/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-common.ActionResult.actionTypeId",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "actionTypeId",
|
|
"description": [],
|
|
"path": "x-pack/plugins/actions/common/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-common.ActionResult.name",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "name",
|
|
"description": [],
|
|
"path": "x-pack/plugins/actions/common/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-common.ActionResult.config",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "config",
|
|
"description": [],
|
|
"signature": [
|
|
"{ [x: string]: any; }"
|
|
],
|
|
"path": "x-pack/plugins/actions/common/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-common.ActionResult.isPreconfigured",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "isPreconfigured",
|
|
"description": [],
|
|
"path": "x-pack/plugins/actions/common/types.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-common.ActionType",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "ActionType",
|
|
"description": [],
|
|
"path": "x-pack/plugins/actions/common/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-common.ActionType.id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"path": "x-pack/plugins/actions/common/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-common.ActionType.name",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "name",
|
|
"description": [],
|
|
"path": "x-pack/plugins/actions/common/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-common.ActionType.enabled",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "enabled",
|
|
"description": [],
|
|
"path": "x-pack/plugins/actions/common/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-common.ActionType.enabledInConfig",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "enabledInConfig",
|
|
"description": [],
|
|
"path": "x-pack/plugins/actions/common/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-common.ActionType.enabledInLicense",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "enabledInLicense",
|
|
"description": [],
|
|
"path": "x-pack/plugins/actions/common/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-common.ActionType.minimumLicenseRequired",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "minimumLicenseRequired",
|
|
"description": [],
|
|
"signature": [
|
|
"\"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\""
|
|
],
|
|
"path": "x-pack/plugins/actions/common/types.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-common.ActionTypeExecutorResult",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "ActionTypeExecutorResult",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "actions",
|
|
"scope": "common",
|
|
"docId": "kibActionsPluginApi",
|
|
"section": "def-common.ActionTypeExecutorResult",
|
|
"text": "ActionTypeExecutorResult"
|
|
},
|
|
"<Data>"
|
|
],
|
|
"path": "x-pack/plugins/actions/common/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-common.ActionTypeExecutorResult.actionId",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "actionId",
|
|
"description": [],
|
|
"path": "x-pack/plugins/actions/common/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-common.ActionTypeExecutorResult.status",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "status",
|
|
"description": [],
|
|
"signature": [
|
|
"\"error\" | \"ok\""
|
|
],
|
|
"path": "x-pack/plugins/actions/common/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-common.ActionTypeExecutorResult.message",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "message",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/plugins/actions/common/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-common.ActionTypeExecutorResult.serviceMessage",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "serviceMessage",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/plugins/actions/common/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-common.ActionTypeExecutorResult.data",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "data",
|
|
"description": [],
|
|
"signature": [
|
|
"Data | undefined"
|
|
],
|
|
"path": "x-pack/plugins/actions/common/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-common.ActionTypeExecutorResult.retry",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "retry",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean | Date | null | undefined"
|
|
],
|
|
"path": "x-pack/plugins/actions/common/types.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"enums": [
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-common.AdditionalEmailServices",
|
|
"type": "Enum",
|
|
"tags": [],
|
|
"label": "AdditionalEmailServices",
|
|
"description": [],
|
|
"path": "x-pack/plugins/actions/common/index.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"misc": [
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-common.ACTIONS_FEATURE_ID",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "ACTIONS_FEATURE_ID",
|
|
"description": [],
|
|
"signature": [
|
|
"\"actions\""
|
|
],
|
|
"path": "x-pack/plugins/actions/common/index.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-common.ALERT_HISTORY_PREFIX",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "ALERT_HISTORY_PREFIX",
|
|
"description": [],
|
|
"signature": [
|
|
"\"kibana-alert-history-\""
|
|
],
|
|
"path": "x-pack/plugins/actions/common/alert_history_schema.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-common.AlertHistoryDefaultIndexName",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "AlertHistoryDefaultIndexName",
|
|
"description": [],
|
|
"path": "x-pack/plugins/actions/common/alert_history_schema.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-common.AlertHistoryDocumentTemplate",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "AlertHistoryDocumentTemplate",
|
|
"description": [],
|
|
"signature": [
|
|
"Readonly<{ event: { kind: string; }; kibana?: { alert: { actionGroupName?: string; actionGroup?: string; context?: { [x: string]: Record<string, unknown>; }; id?: string; }; }; rule?: { type?: string; space?: string; params?: { [x: string]: Record<string, unknown>; }; name?: string; id?: string; }; message?: unknown; tags?: string[]; '@timestamp': string; }> | null"
|
|
],
|
|
"path": "x-pack/plugins/actions/common/alert_history_schema.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-common.AlertHistoryEsIndexConnectorId",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "AlertHistoryEsIndexConnectorId",
|
|
"description": [],
|
|
"signature": [
|
|
"\"preconfigured-alert-history-es-index\""
|
|
],
|
|
"path": "x-pack/plugins/actions/common/alert_history_schema.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-common.AsApiContract",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "AsApiContract",
|
|
"description": [],
|
|
"signature": [
|
|
"{ [K in keyof T as CamelToSnake<RenameActionToConnector<Extract<K, string>>>]: T[K]; }"
|
|
],
|
|
"path": "x-pack/plugins/actions/common/rewrite_request_case.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-common.BASE_ACTION_API_PATH",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "BASE_ACTION_API_PATH",
|
|
"description": [],
|
|
"signature": [
|
|
"\"/api/actions\""
|
|
],
|
|
"path": "x-pack/plugins/actions/common/index.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-common.INTERNAL_BASE_ACTION_API_PATH",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "INTERNAL_BASE_ACTION_API_PATH",
|
|
"description": [],
|
|
"signature": [
|
|
"\"/internal/actions\""
|
|
],
|
|
"path": "x-pack/plugins/actions/common/index.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-common.RewriteRequestCase",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "RewriteRequestCase",
|
|
"description": [],
|
|
"signature": [
|
|
"(requested: ",
|
|
{
|
|
"pluginId": "actions",
|
|
"scope": "common",
|
|
"docId": "kibActionsPluginApi",
|
|
"section": "def-common.AsApiContract",
|
|
"text": "AsApiContract"
|
|
},
|
|
"<T>) => T"
|
|
],
|
|
"path": "x-pack/plugins/actions/common/rewrite_request_case.ts",
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-common.RewriteRequestCase.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "requested",
|
|
"description": [],
|
|
"signature": [
|
|
"{ [K in keyof T as CamelToSnake<RenameActionToConnector<Extract<K, string>>>]: T[K]; }"
|
|
],
|
|
"path": "x-pack/plugins/actions/common/rewrite_request_case.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-common.RewriteResponseCase",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "RewriteResponseCase",
|
|
"description": [],
|
|
"signature": [
|
|
"(responded: T) => T extends (infer Item)[] ? ",
|
|
{
|
|
"pluginId": "actions",
|
|
"scope": "common",
|
|
"docId": "kibActionsPluginApi",
|
|
"section": "def-common.AsApiContract",
|
|
"text": "AsApiContract"
|
|
},
|
|
"<Item>[] : ",
|
|
{
|
|
"pluginId": "actions",
|
|
"scope": "common",
|
|
"docId": "kibActionsPluginApi",
|
|
"section": "def-common.AsApiContract",
|
|
"text": "AsApiContract"
|
|
},
|
|
"<T>"
|
|
],
|
|
"path": "x-pack/plugins/actions/common/rewrite_request_case.ts",
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "actions",
|
|
"id": "def-common.RewriteResponseCase.$1",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "responded",
|
|
"description": [],
|
|
"signature": [
|
|
"T"
|
|
],
|
|
"path": "x-pack/plugins/actions/common/rewrite_request_case.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"objects": []
|
|
}
|
|
} |