7cfd15c038
* moved legacy actions api to legacy folder * introduced connector create api * added new delete route * added new execute and get_all * introduced all connector APIs * renamed action to connector in Apis * comment on camel case type * fixed va * updated docs * legacy title * corrected APIs * legacy links * added linik to deprecatred APIs * added linik to deprecatred APIs from index * moved legacy apis down one level * Apply suggestions from code review Co-authored-by: ymao1 <ying.mao@elastic.co> * renamed route file for connectorTypesRoute * define legacy route * Update docs/api/actions-and-connectors/legacy/index.asciidoc Co-authored-by: Mike Côté <mikecote@users.noreply.github.com> * api docs Co-authored-by: ymao1 <ying.mao@elastic.co> Co-authored-by: Mike Côté <mikecote@users.noreply.github.com> Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
1769 lines
64 KiB
JSON
1769 lines
64 KiB
JSON
{
|
|
"id": "actions",
|
|
"client": {
|
|
"classes": [],
|
|
"functions": [],
|
|
"interfaces": [],
|
|
"enums": [],
|
|
"misc": [],
|
|
"objects": []
|
|
},
|
|
"server": {
|
|
"classes": [],
|
|
"functions": [
|
|
{
|
|
"id": "def-server.asSavedObjectExecutionSource",
|
|
"type": "Function",
|
|
"label": "asSavedObjectExecutionSource",
|
|
"signature": [
|
|
"(source: Pick<",
|
|
"SavedObjectReference",
|
|
", \"type\" | \"id\">) => ",
|
|
"SavedObjectExecutionSource"
|
|
],
|
|
"description": [],
|
|
"children": [
|
|
{
|
|
"type": "Object",
|
|
"label": "source",
|
|
"isRequired": true,
|
|
"signature": [
|
|
"Pick<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "common",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-common.SavedObjectReference",
|
|
"text": "SavedObjectReference"
|
|
},
|
|
", \"type\" | \"id\">"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/actions/server/lib/action_execution_source.ts",
|
|
"lineNumber": 30,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/lib/action_execution_source.ts#L30"
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/actions/server/lib/action_execution_source.ts",
|
|
"lineNumber": 29,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/lib/action_execution_source.ts#L29"
|
|
},
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-server.asHttpRequestExecutionSource",
|
|
"type": "Function",
|
|
"label": "asHttpRequestExecutionSource",
|
|
"signature": [
|
|
"(source: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreHttpPluginApi",
|
|
"section": "def-server.KibanaRequest",
|
|
"text": "KibanaRequest"
|
|
},
|
|
"<unknown, unknown, unknown, any>) => ",
|
|
"HttpRequestExecutionSource"
|
|
],
|
|
"description": [],
|
|
"children": [
|
|
{
|
|
"type": "Object",
|
|
"label": "source",
|
|
"isRequired": true,
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreHttpPluginApi",
|
|
"section": "def-server.KibanaRequest",
|
|
"text": "KibanaRequest"
|
|
},
|
|
"<unknown, unknown, unknown, any>"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/actions/server/lib/action_execution_source.ts",
|
|
"lineNumber": 22,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/lib/action_execution_source.ts#L22"
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/actions/server/lib/action_execution_source.ts",
|
|
"lineNumber": 22,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/lib/action_execution_source.ts#L22"
|
|
},
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"interfaces": [
|
|
{
|
|
"id": "def-server.ActionsPlugin",
|
|
"type": "Interface",
|
|
"label": "ActionsPlugin",
|
|
"description": [],
|
|
"tags": [],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.ActionsPlugin.setup",
|
|
"type": "Object",
|
|
"label": "setup",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/actions/server/types.ts",
|
|
"lineNumber": 56,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/types.ts#L56"
|
|
},
|
|
"signature": [
|
|
{
|
|
"pluginId": "actions",
|
|
"scope": "server",
|
|
"docId": "kibActionsPluginApi",
|
|
"section": "def-server.PluginSetupContract",
|
|
"text": "PluginSetupContract"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.ActionsPlugin.start",
|
|
"type": "Object",
|
|
"label": "start",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/actions/server/types.ts",
|
|
"lineNumber": 57,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/types.ts#L57"
|
|
},
|
|
"signature": [
|
|
{
|
|
"pluginId": "actions",
|
|
"scope": "server",
|
|
"docId": "kibActionsPluginApi",
|
|
"section": "def-server.PluginStartContract",
|
|
"text": "PluginStartContract"
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/actions/server/types.ts",
|
|
"lineNumber": 55,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/types.ts#L55"
|
|
},
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-server.ActionResult",
|
|
"type": "Interface",
|
|
"label": "ActionResult",
|
|
"signature": [
|
|
{
|
|
"pluginId": "actions",
|
|
"scope": "server",
|
|
"docId": "kibActionsPluginApi",
|
|
"section": "def-server.ActionResult",
|
|
"text": "ActionResult"
|
|
},
|
|
"<Config>"
|
|
],
|
|
"description": [],
|
|
"tags": [],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.ActionResult.id",
|
|
"type": "string",
|
|
"label": "id",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/actions/server/types.ts",
|
|
"lineNumber": 70,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/types.ts#L70"
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.ActionResult.actionTypeId",
|
|
"type": "string",
|
|
"label": "actionTypeId",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/actions/server/types.ts",
|
|
"lineNumber": 71,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/types.ts#L71"
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.ActionResult.name",
|
|
"type": "string",
|
|
"label": "name",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/actions/server/types.ts",
|
|
"lineNumber": 72,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/types.ts#L72"
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.ActionResult.config",
|
|
"type": "Uncategorized",
|
|
"label": "config",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/actions/server/types.ts",
|
|
"lineNumber": 73,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/types.ts#L73"
|
|
},
|
|
"signature": [
|
|
"Config | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.ActionResult.isPreconfigured",
|
|
"type": "boolean",
|
|
"label": "isPreconfigured",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/actions/server/types.ts",
|
|
"lineNumber": 74,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/types.ts#L74"
|
|
}
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/actions/server/types.ts",
|
|
"lineNumber": 69,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/types.ts#L69"
|
|
},
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-server.ActionTypeExecutorOptions",
|
|
"type": "Interface",
|
|
"label": "ActionTypeExecutorOptions",
|
|
"signature": [
|
|
{
|
|
"pluginId": "actions",
|
|
"scope": "server",
|
|
"docId": "kibActionsPluginApi",
|
|
"section": "def-server.ActionTypeExecutorOptions",
|
|
"text": "ActionTypeExecutorOptions"
|
|
},
|
|
"<Config, Secrets, Params>"
|
|
],
|
|
"description": [],
|
|
"tags": [],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.ActionTypeExecutorOptions.actionId",
|
|
"type": "string",
|
|
"label": "actionId",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/actions/server/types.ts",
|
|
"lineNumber": 62,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/types.ts#L62"
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.ActionTypeExecutorOptions.services",
|
|
"type": "Object",
|
|
"label": "services",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/actions/server/types.ts",
|
|
"lineNumber": 63,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/types.ts#L63"
|
|
},
|
|
"signature": [
|
|
{
|
|
"pluginId": "actions",
|
|
"scope": "server",
|
|
"docId": "kibActionsPluginApi",
|
|
"section": "def-server.Services",
|
|
"text": "Services"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.ActionTypeExecutorOptions.config",
|
|
"type": "Uncategorized",
|
|
"label": "config",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/actions/server/types.ts",
|
|
"lineNumber": 64,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/types.ts#L64"
|
|
},
|
|
"signature": [
|
|
"Config"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.ActionTypeExecutorOptions.secrets",
|
|
"type": "Uncategorized",
|
|
"label": "secrets",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/actions/server/types.ts",
|
|
"lineNumber": 65,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/types.ts#L65"
|
|
},
|
|
"signature": [
|
|
"Secrets"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.ActionTypeExecutorOptions.params",
|
|
"type": "Uncategorized",
|
|
"label": "params",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/actions/server/types.ts",
|
|
"lineNumber": 66,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/types.ts#L66"
|
|
},
|
|
"signature": [
|
|
"Params"
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/actions/server/types.ts",
|
|
"lineNumber": 61,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/types.ts#L61"
|
|
},
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-server.ActionType",
|
|
"type": "Interface",
|
|
"label": "ActionType",
|
|
"signature": [
|
|
{
|
|
"pluginId": "actions",
|
|
"scope": "server",
|
|
"docId": "kibActionsPluginApi",
|
|
"section": "def-server.ActionType",
|
|
"text": "ActionType"
|
|
},
|
|
"<Config, Secrets, Params, ExecutorResultData>"
|
|
],
|
|
"description": [],
|
|
"tags": [],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.ActionType.id",
|
|
"type": "string",
|
|
"label": "id",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/actions/server/types.ts",
|
|
"lineNumber": 108,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/types.ts#L108"
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.ActionType.name",
|
|
"type": "string",
|
|
"label": "name",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/actions/server/types.ts",
|
|
"lineNumber": 109,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/types.ts#L109"
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.ActionType.maxAttempts",
|
|
"type": "number",
|
|
"label": "maxAttempts",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/actions/server/types.ts",
|
|
"lineNumber": 110,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/types.ts#L110"
|
|
},
|
|
"signature": [
|
|
"number | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.ActionType.minimumLicenseRequired",
|
|
"type": "CompoundType",
|
|
"label": "minimumLicenseRequired",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/actions/server/types.ts",
|
|
"lineNumber": 111,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/types.ts#L111"
|
|
},
|
|
"signature": [
|
|
"\"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\""
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.ActionType.validate",
|
|
"type": "Object",
|
|
"label": "validate",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/actions/server/types.ts",
|
|
"lineNumber": 112,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/types.ts#L112"
|
|
},
|
|
"signature": [
|
|
"{ params?: ValidatorType<Params> | undefined; config?: ValidatorType<Config> | undefined; secrets?: ValidatorType<Secrets> | undefined; } | undefined"
|
|
]
|
|
},
|
|
{
|
|
"id": "def-server.ActionType.renderParameterTemplates",
|
|
"type": "Function",
|
|
"label": "renderParameterTemplates",
|
|
"signature": [
|
|
"((params: Params, variables: Record<string, unknown>) => Params) | undefined"
|
|
],
|
|
"description": [],
|
|
"children": [
|
|
{
|
|
"type": "Uncategorized",
|
|
"label": "params",
|
|
"isRequired": true,
|
|
"signature": [
|
|
"Params"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/actions/server/types.ts",
|
|
"lineNumber": 117,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/types.ts#L117"
|
|
}
|
|
},
|
|
{
|
|
"type": "Object",
|
|
"label": "variables",
|
|
"isRequired": true,
|
|
"signature": [
|
|
"Record<string, unknown>"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/actions/server/types.ts",
|
|
"lineNumber": 117,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/types.ts#L117"
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/actions/server/types.ts",
|
|
"lineNumber": 117,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/types.ts#L117"
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.ActionType.executor",
|
|
"type": "Function",
|
|
"label": "executor",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/actions/server/types.ts",
|
|
"lineNumber": 118,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/types.ts#L118"
|
|
},
|
|
"signature": [
|
|
{
|
|
"pluginId": "actions",
|
|
"scope": "server",
|
|
"docId": "kibActionsPluginApi",
|
|
"section": "def-server.ExecutorType",
|
|
"text": "ExecutorType"
|
|
},
|
|
"<Config, Secrets, Params, ExecutorResultData>"
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/actions/server/types.ts",
|
|
"lineNumber": 102,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/types.ts#L102"
|
|
},
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-server.PreConfiguredAction",
|
|
"type": "Interface",
|
|
"label": "PreConfiguredAction",
|
|
"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>"
|
|
],
|
|
"description": [],
|
|
"tags": [],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.PreConfiguredAction.secrets",
|
|
"type": "Uncategorized",
|
|
"label": "secrets",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/actions/server/types.ts",
|
|
"lineNumber": 81,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/types.ts#L81"
|
|
},
|
|
"signature": [
|
|
"Secrets"
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/actions/server/types.ts",
|
|
"lineNumber": 77,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/types.ts#L77"
|
|
},
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-server.ActionsApiRequestHandlerContext",
|
|
"type": "Interface",
|
|
"label": "ActionsApiRequestHandlerContext",
|
|
"description": [],
|
|
"tags": [],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.ActionsApiRequestHandlerContext.getActionsClient",
|
|
"type": "Function",
|
|
"label": "getActionsClient",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/actions/server/types.ts",
|
|
"lineNumber": 47,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/types.ts#L47"
|
|
},
|
|
"signature": [
|
|
"() => ",
|
|
{
|
|
"pluginId": "actions",
|
|
"scope": "server",
|
|
"docId": "kibActionsPluginApi",
|
|
"section": "def-server.ActionsClient",
|
|
"text": "ActionsClient"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.ActionsApiRequestHandlerContext.listTypes",
|
|
"type": "Function",
|
|
"label": "listTypes",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/actions/server/types.ts",
|
|
"lineNumber": 48,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/types.ts#L48"
|
|
},
|
|
"signature": [
|
|
"() => ",
|
|
{
|
|
"pluginId": "actions",
|
|
"scope": "common",
|
|
"docId": "kibActionsPluginApi",
|
|
"section": "def-common.ActionType",
|
|
"text": "ActionType"
|
|
},
|
|
"[]"
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/actions/server/types.ts",
|
|
"lineNumber": 46,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/types.ts#L46"
|
|
},
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"enums": [],
|
|
"misc": [
|
|
{
|
|
"id": "def-server.ActionsClient",
|
|
"type": "Type",
|
|
"label": "ActionsClient",
|
|
"tags": [],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/actions/server/index.ts",
|
|
"lineNumber": 15,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/index.ts#L15"
|
|
},
|
|
"signature": [
|
|
"{ get: ({ id }: { id: string; }) => Promise<",
|
|
{
|
|
"pluginId": "actions",
|
|
"scope": "server",
|
|
"docId": "kibActionsPluginApi",
|
|
"section": "def-server.ActionResult",
|
|
"text": "ActionResult"
|
|
},
|
|
"<Record<string, unknown>>>; delete: ({ id }: { id: string; }) => Promise<{}>; create: ({ action: { actionTypeId, name, config, secrets }, }: ",
|
|
"CreateOptions",
|
|
") => 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"
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-server.ActionsAuthorization",
|
|
"type": "Type",
|
|
"label": "ActionsAuthorization",
|
|
"tags": [],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/actions/server/index.ts",
|
|
"lineNumber": 16,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/index.ts#L16"
|
|
},
|
|
"signature": [
|
|
"{ ensureAuthorized: (operation: string, actionTypeId?: string | undefined) => Promise<void>; }"
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.ActionTypeId",
|
|
"type": "string",
|
|
"label": "ActionTypeId",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/actions/server/builtin_action_types/email.ts",
|
|
"lineNumber": 143,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/builtin_action_types/email.ts#L143"
|
|
},
|
|
"signature": [
|
|
"\".email\""
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-server.ActionParamsType",
|
|
"type": "Type",
|
|
"label": "ActionParamsType",
|
|
"tags": [],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/actions/server/builtin_action_types/email.ts",
|
|
"lineNumber": 99,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/builtin_action_types/email.ts#L99"
|
|
},
|
|
"signature": [
|
|
"{ readonly to: string[]; readonly message: string; readonly cc: string[]; readonly bcc: string[]; readonly subject: string; readonly kibanaFooterLink: Readonly<{} & { text: string; path: string; }>; }"
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.ActionTypeId",
|
|
"type": "string",
|
|
"label": "ActionTypeId",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/actions/server/builtin_action_types/es_index.ts",
|
|
"lineNumber": 43,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/builtin_action_types/es_index.ts#L43"
|
|
},
|
|
"signature": [
|
|
"\".index\""
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-server.ActionParamsType",
|
|
"type": "Type",
|
|
"label": "ActionParamsType",
|
|
"tags": [],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/actions/server/builtin_action_types/es_index.ts",
|
|
"lineNumber": 34,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/builtin_action_types/es_index.ts#L34"
|
|
},
|
|
"signature": [
|
|
"{ readonly documents: Record<string, any>[]; }"
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.ActionTypeId",
|
|
"type": "string",
|
|
"label": "ActionTypeId",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/actions/server/builtin_action_types/pagerduty.ts",
|
|
"lineNumber": 121,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/builtin_action_types/pagerduty.ts#L121"
|
|
},
|
|
"signature": [
|
|
"\".pagerduty\""
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-server.ActionParamsType",
|
|
"type": "Type",
|
|
"label": "ActionParamsType",
|
|
"tags": [],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/actions/server/builtin_action_types/pagerduty.ts",
|
|
"lineNumber": 50,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/builtin_action_types/pagerduty.ts#L50"
|
|
},
|
|
"signature": [
|
|
"{ readonly source?: string | undefined; readonly summary?: string | undefined; readonly eventAction?: \"resolve\" | \"trigger\" | \"acknowledge\" | undefined; readonly dedupKey?: string | undefined; readonly severity?: \"warning\" | \"info\" | \"error\" | \"critical\" | undefined; readonly timestamp?: string | undefined; readonly component?: string | undefined; readonly group?: string | undefined; readonly class?: string | undefined; }"
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.ActionTypeId",
|
|
"type": "string",
|
|
"label": "ActionTypeId",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/actions/server/builtin_action_types/server_log.ts",
|
|
"lineNumber": 42,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/builtin_action_types/server_log.ts#L42"
|
|
},
|
|
"signature": [
|
|
"\".server-log\""
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-server.ActionParamsType",
|
|
"type": "Type",
|
|
"label": "ActionParamsType",
|
|
"tags": [],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/actions/server/builtin_action_types/server_log.ts",
|
|
"lineNumber": 25,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/builtin_action_types/server_log.ts#L25"
|
|
},
|
|
"signature": [
|
|
"{ readonly message: string; readonly level: \"info\" | \"error\" | \"debug\" | \"trace\" | \"warn\" | \"fatal\"; }"
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.ActionTypeId",
|
|
"type": "string",
|
|
"label": "ActionTypeId",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/actions/server/builtin_action_types/slack.ts",
|
|
"lineNumber": 54,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/builtin_action_types/slack.ts#L54"
|
|
},
|
|
"signature": [
|
|
"\".slack\""
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-server.ActionParamsType",
|
|
"type": "Type",
|
|
"label": "ActionParamsType",
|
|
"tags": [],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/actions/server/builtin_action_types/slack.ts",
|
|
"lineNumber": 46,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/builtin_action_types/slack.ts#L46"
|
|
},
|
|
"signature": [
|
|
"{ readonly message: string; }"
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.ActionTypeId",
|
|
"type": "string",
|
|
"label": "ActionTypeId",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/actions/server/builtin_action_types/webhook.ts",
|
|
"lineNumber": 76,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/builtin_action_types/webhook.ts#L76"
|
|
},
|
|
"signature": [
|
|
"\".webhook\""
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-server.ActionParamsType",
|
|
"type": "Type",
|
|
"label": "ActionParamsType",
|
|
"tags": [],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/actions/server/builtin_action_types/webhook.ts",
|
|
"lineNumber": 71,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/builtin_action_types/webhook.ts#L71"
|
|
},
|
|
"signature": [
|
|
"{ readonly body?: string | undefined; }"
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.ServiceNowITSMActionTypeId",
|
|
"type": "string",
|
|
"label": "ServiceNowITSMActionTypeId",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/actions/server/builtin_action_types/servicenow/index.ts",
|
|
"lineNumber": 47,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/builtin_action_types/servicenow/index.ts#L47"
|
|
},
|
|
"signature": [
|
|
"\".servicenow\""
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.ServiceNowSIRActionTypeId",
|
|
"type": "string",
|
|
"label": "ServiceNowSIRActionTypeId",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/actions/server/builtin_action_types/servicenow/index.ts",
|
|
"lineNumber": 48,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/builtin_action_types/servicenow/index.ts#L48"
|
|
},
|
|
"signature": [
|
|
"\".servicenow-sir\""
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-server.ActionParamsType",
|
|
"type": "Type",
|
|
"label": "ActionParamsType",
|
|
"tags": [],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/actions/server/builtin_action_types/servicenow/index.ts",
|
|
"lineNumber": 35,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/builtin_action_types/servicenow/index.ts#L35"
|
|
},
|
|
"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; }>; 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; dest_ip: string | null; malware_hash: string | null; malware_url: string | null; source_ip: string | null; priority: string | null; }>; comments: Readonly<{} & { comment: string; commentId: string; }>[] | null; }>; }> | Readonly<{} & { subAction: \"getChoices\"; subActionParams: Readonly<{} & { fields: string[]; }>; }>"
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.ActionTypeId",
|
|
"type": "string",
|
|
"label": "ActionTypeId",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/actions/server/builtin_action_types/jira/index.ts",
|
|
"lineNumber": 52,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/builtin_action_types/jira/index.ts#L52"
|
|
},
|
|
"signature": [
|
|
"\".jira\""
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-server.ActionParamsType",
|
|
"type": "Type",
|
|
"label": "ActionParamsType",
|
|
"tags": [],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/actions/server/builtin_action_types/jira/index.ts",
|
|
"lineNumber": 36,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/builtin_action_types/jira/index.ts#L36"
|
|
},
|
|
"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; }>; }>"
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.ActionTypeId",
|
|
"type": "string",
|
|
"label": "ActionTypeId",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/actions/server/builtin_action_types/resilient/index.ts",
|
|
"lineNumber": 43,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/builtin_action_types/resilient/index.ts#L43"
|
|
},
|
|
"signature": [
|
|
"\".resilient\""
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-server.ActionParamsType",
|
|
"type": "Type",
|
|
"label": "ActionParamsType",
|
|
"tags": [],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/actions/server/builtin_action_types/resilient/index.ts",
|
|
"lineNumber": 34,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/builtin_action_types/resilient/index.ts#L34"
|
|
},
|
|
"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<{} & {}>; }>"
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.ActionTypeId",
|
|
"type": "string",
|
|
"label": "ActionTypeId",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/actions/server/builtin_action_types/teams.ts",
|
|
"lineNumber": 46,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/builtin_action_types/teams.ts#L46"
|
|
},
|
|
"signature": [
|
|
"\".teams\""
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-server.ActionParamsType",
|
|
"type": "Type",
|
|
"label": "ActionParamsType",
|
|
"tags": [],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/actions/server/builtin_action_types/teams.ts",
|
|
"lineNumber": 40,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/builtin_action_types/teams.ts#L40"
|
|
},
|
|
"signature": [
|
|
"{ readonly message: string; }"
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"objects": [],
|
|
"setup": {
|
|
"id": "def-server.PluginSetupContract",
|
|
"type": "Interface",
|
|
"label": "PluginSetupContract",
|
|
"description": [],
|
|
"tags": [],
|
|
"children": [
|
|
{
|
|
"id": "def-server.PluginSetupContract.registerType",
|
|
"type": "Function",
|
|
"label": "registerType",
|
|
"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"
|
|
],
|
|
"description": [],
|
|
"children": [
|
|
{
|
|
"type": "Object",
|
|
"label": "actionType",
|
|
"isRequired": true,
|
|
"signature": [
|
|
{
|
|
"pluginId": "actions",
|
|
"scope": "server",
|
|
"docId": "kibActionsPluginApi",
|
|
"section": "def-server.ActionType",
|
|
"text": "ActionType"
|
|
},
|
|
"<Config, Secrets, Params, ExecutorResultData>"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/actions/server/plugin.ts",
|
|
"lineNumber": 86,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/plugin.ts#L86"
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/actions/server/plugin.ts",
|
|
"lineNumber": 80,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/plugin.ts#L80"
|
|
}
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/actions/server/plugin.ts",
|
|
"lineNumber": 79,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/plugin.ts#L79"
|
|
},
|
|
"lifecycle": "setup",
|
|
"initialIsOpen": true
|
|
},
|
|
"start": {
|
|
"id": "def-server.PluginStartContract",
|
|
"type": "Interface",
|
|
"label": "PluginStartContract",
|
|
"description": [],
|
|
"tags": [],
|
|
"children": [
|
|
{
|
|
"id": "def-server.PluginStartContract.isActionTypeEnabled",
|
|
"type": "Function",
|
|
"label": "isActionTypeEnabled",
|
|
"signature": [
|
|
"(id: string, options?: { notifyUsage: boolean; } | undefined) => boolean"
|
|
],
|
|
"description": [],
|
|
"children": [
|
|
{
|
|
"type": "string",
|
|
"label": "id",
|
|
"isRequired": true,
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/actions/server/plugin.ts",
|
|
"lineNumber": 91,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/plugin.ts#L91"
|
|
}
|
|
},
|
|
{
|
|
"id": "def-server.PluginStartContract.isActionTypeEnabled.options",
|
|
"type": "Object",
|
|
"label": "options",
|
|
"tags": [],
|
|
"description": [],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.PluginStartContract.isActionTypeEnabled.options.notifyUsage",
|
|
"type": "boolean",
|
|
"label": "notifyUsage",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/actions/server/plugin.ts",
|
|
"lineNumber": 91,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/plugin.ts#L91"
|
|
}
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/actions/server/plugin.ts",
|
|
"lineNumber": 91,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/plugin.ts#L91"
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/actions/server/plugin.ts",
|
|
"lineNumber": 91,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/plugin.ts#L91"
|
|
}
|
|
},
|
|
{
|
|
"id": "def-server.PluginStartContract.isActionExecutable",
|
|
"type": "Function",
|
|
"label": "isActionExecutable",
|
|
"signature": [
|
|
"(actionId: string, actionTypeId: string, options?: { notifyUsage: boolean; } | undefined) => boolean"
|
|
],
|
|
"description": [],
|
|
"children": [
|
|
{
|
|
"type": "string",
|
|
"label": "actionId",
|
|
"isRequired": true,
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/actions/server/plugin.ts",
|
|
"lineNumber": 93,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/plugin.ts#L93"
|
|
}
|
|
},
|
|
{
|
|
"type": "string",
|
|
"label": "actionTypeId",
|
|
"isRequired": true,
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/actions/server/plugin.ts",
|
|
"lineNumber": 94,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/plugin.ts#L94"
|
|
}
|
|
},
|
|
{
|
|
"id": "def-server.PluginStartContract.isActionExecutable.options",
|
|
"type": "Object",
|
|
"label": "options",
|
|
"tags": [],
|
|
"description": [],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.PluginStartContract.isActionExecutable.options.notifyUsage",
|
|
"type": "boolean",
|
|
"label": "notifyUsage",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/actions/server/plugin.ts",
|
|
"lineNumber": 95,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/plugin.ts#L95"
|
|
}
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/actions/server/plugin.ts",
|
|
"lineNumber": 95,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/plugin.ts#L95"
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/actions/server/plugin.ts",
|
|
"lineNumber": 92,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/plugin.ts#L92"
|
|
}
|
|
},
|
|
{
|
|
"id": "def-server.PluginStartContract.getActionsClientWithRequest",
|
|
"type": "Function",
|
|
"label": "getActionsClientWithRequest",
|
|
"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"
|
|
},
|
|
", \"get\" | \"delete\" | \"create\" | \"update\" | \"execute\" | \"getAll\" | \"getBulk\" | \"enqueueExecution\" | \"listTypes\" | \"isActionTypeEnabled\">>"
|
|
],
|
|
"description": [],
|
|
"children": [
|
|
{
|
|
"type": "Object",
|
|
"label": "request",
|
|
"isRequired": true,
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreHttpPluginApi",
|
|
"section": "def-server.KibanaRequest",
|
|
"text": "KibanaRequest"
|
|
},
|
|
"<unknown, unknown, unknown, any>"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/actions/server/plugin.ts",
|
|
"lineNumber": 97,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/plugin.ts#L97"
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/actions/server/plugin.ts",
|
|
"lineNumber": 97,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/plugin.ts#L97"
|
|
}
|
|
},
|
|
{
|
|
"id": "def-server.PluginStartContract.getActionsAuthorizationWithRequest",
|
|
"type": "Function",
|
|
"label": "getActionsAuthorizationWithRequest",
|
|
"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\">"
|
|
],
|
|
"description": [],
|
|
"children": [
|
|
{
|
|
"type": "Object",
|
|
"label": "request",
|
|
"isRequired": true,
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreHttpPluginApi",
|
|
"section": "def-server.KibanaRequest",
|
|
"text": "KibanaRequest"
|
|
},
|
|
"<unknown, unknown, unknown, any>"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/actions/server/plugin.ts",
|
|
"lineNumber": 98,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/plugin.ts#L98"
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/actions/server/plugin.ts",
|
|
"lineNumber": 98,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/plugin.ts#L98"
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.PluginStartContract.preconfiguredActions",
|
|
"type": "Array",
|
|
"label": "preconfiguredActions",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/actions/server/plugin.ts",
|
|
"lineNumber": 99,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/plugin.ts#L99"
|
|
},
|
|
"signature": [
|
|
{
|
|
"pluginId": "actions",
|
|
"scope": "server",
|
|
"docId": "kibActionsPluginApi",
|
|
"section": "def-server.PreConfiguredAction",
|
|
"text": "PreConfiguredAction"
|
|
},
|
|
"<Record<string, unknown>, Record<string, unknown>>[]"
|
|
]
|
|
},
|
|
{
|
|
"id": "def-server.PluginStartContract.renderActionParameterTemplates",
|
|
"type": "Function",
|
|
"label": "renderActionParameterTemplates",
|
|
"signature": [
|
|
"<Params extends Record<string, unknown> = Record<string, unknown>>(actionTypeId: string, params: Params, variables: Record<string, unknown>) => Params"
|
|
],
|
|
"description": [],
|
|
"children": [
|
|
{
|
|
"type": "string",
|
|
"label": "actionTypeId",
|
|
"isRequired": true,
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/actions/server/plugin.ts",
|
|
"lineNumber": 101,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/plugin.ts#L101"
|
|
}
|
|
},
|
|
{
|
|
"type": "Uncategorized",
|
|
"label": "params",
|
|
"isRequired": true,
|
|
"signature": [
|
|
"Params"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/actions/server/plugin.ts",
|
|
"lineNumber": 102,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/plugin.ts#L102"
|
|
}
|
|
},
|
|
{
|
|
"type": "Object",
|
|
"label": "variables",
|
|
"isRequired": true,
|
|
"signature": [
|
|
"Record<string, unknown>"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/actions/server/plugin.ts",
|
|
"lineNumber": 103,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/plugin.ts#L103"
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/actions/server/plugin.ts",
|
|
"lineNumber": 100,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/plugin.ts#L100"
|
|
}
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/actions/server/plugin.ts",
|
|
"lineNumber": 90,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/plugin.ts#L90"
|
|
},
|
|
"lifecycle": "start",
|
|
"initialIsOpen": true
|
|
}
|
|
},
|
|
"common": {
|
|
"classes": [],
|
|
"functions": [
|
|
{
|
|
"id": "def-common.isActionTypeExecutorResult",
|
|
"type": "Function",
|
|
"label": "isActionTypeExecutorResult",
|
|
"signature": [
|
|
"(result: unknown) => boolean"
|
|
],
|
|
"description": [],
|
|
"children": [
|
|
{
|
|
"type": "Unknown",
|
|
"label": "result",
|
|
"isRequired": true,
|
|
"signature": [
|
|
"unknown"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/actions/common/types.ts",
|
|
"lineNumber": 43,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/common/types.ts#L43"
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/actions/common/types.ts",
|
|
"lineNumber": 42,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/common/types.ts#L42"
|
|
},
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"interfaces": [
|
|
{
|
|
"id": "def-common.ActionType",
|
|
"type": "Interface",
|
|
"label": "ActionType",
|
|
"description": [],
|
|
"tags": [],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.ActionType.id",
|
|
"type": "string",
|
|
"label": "id",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/actions/common/types.ts",
|
|
"lineNumber": 11,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/common/types.ts#L11"
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.ActionType.name",
|
|
"type": "string",
|
|
"label": "name",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/actions/common/types.ts",
|
|
"lineNumber": 12,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/common/types.ts#L12"
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.ActionType.enabled",
|
|
"type": "boolean",
|
|
"label": "enabled",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/actions/common/types.ts",
|
|
"lineNumber": 13,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/common/types.ts#L13"
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.ActionType.enabledInConfig",
|
|
"type": "boolean",
|
|
"label": "enabledInConfig",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/actions/common/types.ts",
|
|
"lineNumber": 14,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/common/types.ts#L14"
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.ActionType.enabledInLicense",
|
|
"type": "boolean",
|
|
"label": "enabledInLicense",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/actions/common/types.ts",
|
|
"lineNumber": 15,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/common/types.ts#L15"
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.ActionType.minimumLicenseRequired",
|
|
"type": "CompoundType",
|
|
"label": "minimumLicenseRequired",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/actions/common/types.ts",
|
|
"lineNumber": 16,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/common/types.ts#L16"
|
|
},
|
|
"signature": [
|
|
"\"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\""
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/actions/common/types.ts",
|
|
"lineNumber": 10,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/common/types.ts#L10"
|
|
},
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-common.ActionResult",
|
|
"type": "Interface",
|
|
"label": "ActionResult",
|
|
"description": [],
|
|
"tags": [],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.ActionResult.id",
|
|
"type": "string",
|
|
"label": "id",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/actions/common/types.ts",
|
|
"lineNumber": 20,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/common/types.ts#L20"
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.ActionResult.actionTypeId",
|
|
"type": "string",
|
|
"label": "actionTypeId",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/actions/common/types.ts",
|
|
"lineNumber": 21,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/common/types.ts#L21"
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.ActionResult.name",
|
|
"type": "string",
|
|
"label": "name",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/actions/common/types.ts",
|
|
"lineNumber": 22,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/common/types.ts#L22"
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.ActionResult.config",
|
|
"type": "Object",
|
|
"label": "config",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/actions/common/types.ts",
|
|
"lineNumber": 25,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/common/types.ts#L25"
|
|
},
|
|
"signature": [
|
|
"Record<string, any>"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.ActionResult.isPreconfigured",
|
|
"type": "boolean",
|
|
"label": "isPreconfigured",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/actions/common/types.ts",
|
|
"lineNumber": 26,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/common/types.ts#L26"
|
|
}
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/actions/common/types.ts",
|
|
"lineNumber": 19,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/common/types.ts#L19"
|
|
},
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-common.ActionTypeExecutorResult",
|
|
"type": "Interface",
|
|
"label": "ActionTypeExecutorResult",
|
|
"signature": [
|
|
{
|
|
"pluginId": "actions",
|
|
"scope": "common",
|
|
"docId": "kibActionsPluginApi",
|
|
"section": "def-common.ActionTypeExecutorResult",
|
|
"text": "ActionTypeExecutorResult"
|
|
},
|
|
"<Data>"
|
|
],
|
|
"description": [],
|
|
"tags": [],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.ActionTypeExecutorResult.actionId",
|
|
"type": "string",
|
|
"label": "actionId",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/actions/common/types.ts",
|
|
"lineNumber": 34,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/common/types.ts#L34"
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.ActionTypeExecutorResult.status",
|
|
"type": "CompoundType",
|
|
"label": "status",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/actions/common/types.ts",
|
|
"lineNumber": 35,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/common/types.ts#L35"
|
|
},
|
|
"signature": [
|
|
"\"error\" | \"ok\""
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.ActionTypeExecutorResult.message",
|
|
"type": "string",
|
|
"label": "message",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/actions/common/types.ts",
|
|
"lineNumber": 36,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/common/types.ts#L36"
|
|
},
|
|
"signature": [
|
|
"string | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.ActionTypeExecutorResult.serviceMessage",
|
|
"type": "string",
|
|
"label": "serviceMessage",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/actions/common/types.ts",
|
|
"lineNumber": 37,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/common/types.ts#L37"
|
|
},
|
|
"signature": [
|
|
"string | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.ActionTypeExecutorResult.data",
|
|
"type": "Uncategorized",
|
|
"label": "data",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/actions/common/types.ts",
|
|
"lineNumber": 38,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/common/types.ts#L38"
|
|
},
|
|
"signature": [
|
|
"Data | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.ActionTypeExecutorResult.retry",
|
|
"type": "CompoundType",
|
|
"label": "retry",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/actions/common/types.ts",
|
|
"lineNumber": 39,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/common/types.ts#L39"
|
|
},
|
|
"signature": [
|
|
"boolean | Date | null | undefined"
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/actions/common/types.ts",
|
|
"lineNumber": 33,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/common/types.ts#L33"
|
|
},
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"enums": [],
|
|
"misc": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.BASE_ACTION_API_PATH",
|
|
"type": "string",
|
|
"label": "BASE_ACTION_API_PATH",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/actions/common/index.ts",
|
|
"lineNumber": 10,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/common/index.ts#L10"
|
|
},
|
|
"signature": [
|
|
"\"/api/actions\""
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"objects": []
|
|
}
|
|
} |