elasticstack.getKibanaAgentbuilderAgent

elasticstack 0.15.0, May 14 26

Viewing docs for elasticstack 0.15.0
published on Thursday, May 14, 2026 by elastic

Schema (JSON)

elastic/terraform-provider-elasticstack

Viewing docs for elasticstack 0.15.0
published on Thursday, May 14, 2026 by elastic

Schema (JSON)

elastic/terraform-provider-elasticstack

Example Usage

Export an agent (with dependencies for cross-cluster import)

import * as pulumi from "@pulumi/pulumi";
import * as elasticstack from "@pulumi/elasticstack";

const exportedTool = new elasticstack.KibanaAgentbuilderTool("exported_tool", {
    toolId: "doc-export-example-tool",
    type: "esql",
    description: "Tool for the export data source example",
    configuration: JSON.stringify({
        query: "FROM logs-* | LIMIT 10",
    }),
});
const source = new elasticstack.KibanaAgentbuilderAgent("source", {
    agentId: "doc-export-source-agent",
    name: "Documentation export agent",
    description: "Agent whose configuration is exported by the data source below",
    instructions: "You are helpful.",
    tools: [exportedTool.toolId],
});
const example = elasticstack.getKibanaAgentbuilderAgentOutput({
    agentId: source.agentId,
    includeDependencies: true,
});
export const agentExport = example;

import pulumi
import json
import pulumi_elasticstack as elasticstack

exported_tool = elasticstack.KibanaAgentbuilderTool("exported_tool",
    tool_id="doc-export-example-tool",
    type="esql",
    description="Tool for the export data source example",
    configuration=json.dumps({
        "query": "FROM logs-* | LIMIT 10",
    }))
source = elasticstack.KibanaAgentbuilderAgent("source",
    agent_id="doc-export-source-agent",
    name="Documentation export agent",
    description="Agent whose configuration is exported by the data source below",
    instructions="You are helpful.",
    tools=[exported_tool.tool_id])
example = elasticstack.get_kibana_agentbuilder_agent_output(agent_id=source.agent_id,
    include_dependencies=True)
pulumi.export("agentExport", example)

package main

import (
	"encoding/json"

	"github.com/pulumi/pulumi-terraform-provider/sdks/go/elasticstack/elasticstack"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		tmpJSON0, err := json.Marshal(map[string]interface{}{
			"query": "FROM logs-* | LIMIT 10",
		})
		if err != nil {
			return err
		}
		json0 := string(tmpJSON0)
		exportedTool, err := elasticstack.NewKibanaAgentbuilderTool(ctx, "exported_tool", &elasticstack.KibanaAgentbuilderToolArgs{
			ToolId:        pulumi.String("doc-export-example-tool"),
			Type:          pulumi.String("esql"),
			Description:   pulumi.String("Tool for the export data source example"),
			Configuration: pulumi.String(json0),
		})
		if err != nil {
			return err
		}
		source, err := elasticstack.NewKibanaAgentbuilderAgent(ctx, "source", &elasticstack.KibanaAgentbuilderAgentArgs{
			AgentId:      pulumi.String("doc-export-source-agent"),
			Name:         pulumi.String("Documentation export agent"),
			Description:  pulumi.String("Agent whose configuration is exported by the data source below"),
			Instructions: pulumi.String("You are helpful."),
			Tools: pulumi.StringArray{
				exportedTool.ToolId,
			},
		})
		if err != nil {
			return err
		}
		example := elasticstack.LookupKibanaAgentbuilderAgentOutput(ctx, elasticstack.GetKibanaAgentbuilderAgentOutputArgs{
			AgentId:             source.AgentId,
			IncludeDependencies: pulumi.Bool(true),
		}, nil)
		ctx.Export("agentExport", example)
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using System.Text.Json;
using Pulumi;
using Elasticstack = Pulumi.Elasticstack;

return await Deployment.RunAsync(() => 
{
    var exportedTool = new Elasticstack.KibanaAgentbuilderTool("exported_tool", new()
    {
        ToolId = "doc-export-example-tool",
        Type = "esql",
        Description = "Tool for the export data source example",
        Configuration = JsonSerializer.Serialize(new Dictionary<string, object?>
        {
            ["query"] = "FROM logs-* | LIMIT 10",
        }),
    });

    var source = new Elasticstack.KibanaAgentbuilderAgent("source", new()
    {
        AgentId = "doc-export-source-agent",
        Name = "Documentation export agent",
        Description = "Agent whose configuration is exported by the data source below",
        Instructions = "You are helpful.",
        Tools = new[]
        {
            exportedTool.ToolId,
        },
    });

    var example = Elasticstack.GetKibanaAgentbuilderAgent.Invoke(new()
    {
        AgentId = source.AgentId,
        IncludeDependencies = true,
    });

    return new Dictionary<string, object?>
    {
        ["agentExport"] = example,
    };
});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.elasticstack.KibanaAgentbuilderTool;
import com.pulumi.elasticstack.KibanaAgentbuilderToolArgs;
import com.pulumi.elasticstack.KibanaAgentbuilderAgent;
import com.pulumi.elasticstack.KibanaAgentbuilderAgentArgs;
import com.pulumi.elasticstack.ElasticstackFunctions;
import com.pulumi.elasticstack.inputs.GetKibanaAgentbuilderAgentArgs;
import static com.pulumi.codegen.internal.Serialization.*;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var exportedTool = new KibanaAgentbuilderTool("exportedTool", KibanaAgentbuilderToolArgs.builder()
            .toolId("doc-export-example-tool")
            .type("esql")
            .description("Tool for the export data source example")
            .configuration(serializeJson(
                jsonObject(
                    jsonProperty("query", "FROM logs-* | LIMIT 10")
                )))
            .build());

        var source = new KibanaAgentbuilderAgent("source", KibanaAgentbuilderAgentArgs.builder()
            .agentId("doc-export-source-agent")
            .name("Documentation export agent")
            .description("Agent whose configuration is exported by the data source below")
            .instructions("You are helpful.")
            .tools(exportedTool.toolId())
            .build());

        final var example = ElasticstackFunctions.getKibanaAgentbuilderAgent(GetKibanaAgentbuilderAgentArgs.builder()
            .agentId(source.agentId())
            .includeDependencies(true)
            .build());

        ctx.export("agentExport", example);
    }
}

resources:
  exportedTool:
    type: elasticstack:KibanaAgentbuilderTool
    name: exported_tool
    properties:
      toolId: doc-export-example-tool
      type: esql
      description: Tool for the export data source example
      configuration:
        fn::toJSON:
          query: FROM logs-* | LIMIT 10
  source:
    type: elasticstack:KibanaAgentbuilderAgent
    properties:
      agentId: doc-export-source-agent
      name: Documentation export agent
      description: Agent whose configuration is exported by the data source below
      instructions: You are helpful.
      tools:
        - ${exportedTool.toolId}
variables:
  example:
    fn::invoke:
      function: elasticstack:getKibanaAgentbuilderAgent
      arguments:
        agentId: ${source.agentId}
        includeDependencies: true
outputs:
  agentExport: ${example}

Example coming soon!

Using getKibanaAgentbuilderAgent

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getKibanaAgentbuilderAgent(args: GetKibanaAgentbuilderAgentArgs, opts?: InvokeOptions): Promise<GetKibanaAgentbuilderAgentResult>
function getKibanaAgentbuilderAgentOutput(args: GetKibanaAgentbuilderAgentOutputArgs, opts?: InvokeOptions): Output<GetKibanaAgentbuilderAgentResult>

def get_kibana_agentbuilder_agent(agent_id: Optional[str] = None,
                                  include_dependencies: Optional[bool] = None,
                                  kibana_connections: Optional[Sequence[GetKibanaAgentbuilderAgentKibanaConnection]] = None,
                                  space_id: Optional[str] = None,
                                  opts: Optional[InvokeOptions] = None) -> GetKibanaAgentbuilderAgentResult
def get_kibana_agentbuilder_agent_output(agent_id: pulumi.Input[Optional[str]] = None,
                                  include_dependencies: pulumi.Input[Optional[bool]] = None,
                                  kibana_connections: pulumi.Input[Optional[Sequence[pulumi.Input[GetKibanaAgentbuilderAgentKibanaConnectionArgs]]]] = None,
                                  space_id: pulumi.Input[Optional[str]] = None,
                                  opts: Optional[InvokeOptions] = None) -> Output[GetKibanaAgentbuilderAgentResult]

func LookupKibanaAgentbuilderAgent(ctx *Context, args *LookupKibanaAgentbuilderAgentArgs, opts ...InvokeOption) (*LookupKibanaAgentbuilderAgentResult, error)
func LookupKibanaAgentbuilderAgentOutput(ctx *Context, args *LookupKibanaAgentbuilderAgentOutputArgs, opts ...InvokeOption) LookupKibanaAgentbuilderAgentResultOutput

> Note: This function is named LookupKibanaAgentbuilderAgent in the Go SDK.

public static class GetKibanaAgentbuilderAgent 
{
    public static Task<GetKibanaAgentbuilderAgentResult> InvokeAsync(GetKibanaAgentbuilderAgentArgs args, InvokeOptions? opts = null)
    public static Output<GetKibanaAgentbuilderAgentResult> Invoke(GetKibanaAgentbuilderAgentInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetKibanaAgentbuilderAgentResult> getKibanaAgentbuilderAgent(GetKibanaAgentbuilderAgentArgs args, InvokeOptions options)
public static Output<GetKibanaAgentbuilderAgentResult> getKibanaAgentbuilderAgent(GetKibanaAgentbuilderAgentArgs args, InvokeOptions options)

fn::invoke:
  function: elasticstack:index/getKibanaAgentbuilderAgent:getKibanaAgentbuilderAgent
  arguments:
    # arguments dictionary

data "elasticstack_getkibanaagentbuilderagent" "name" {
    # arguments
}

The following arguments are supported:

AgentId string: The agent ID.
IncludeDependencies bool: If true, exports the agent along with its tools and workflows. If omitted, false is used (tool rows only list id, space_id, and tool_id unless this is true).
KibanaConnections List<GetKibanaAgentbuilderAgentKibanaConnection>: Kibana connection configuration block.
SpaceId string: An identifier for the space. If space_id is not provided, the default space is used.

AgentId string: The agent ID.
IncludeDependencies bool: If true, exports the agent along with its tools and workflows. If omitted, false is used (tool rows only list id, space_id, and tool_id unless this is true).
KibanaConnections []GetKibanaAgentbuilderAgentKibanaConnection: Kibana connection configuration block.
SpaceId string: An identifier for the space. If space_id is not provided, the default space is used.

agent_id string: The agent ID.
include_dependencies bool: If true, exports the agent along with its tools and workflows. If omitted, false is used (tool rows only list id, space_id, and tool_id unless this is true).
kibana_connections list(object): Kibana connection configuration block.
space_id string: An identifier for the space. If space_id is not provided, the default space is used.

agentId String: The agent ID.
includeDependencies Boolean: If true, exports the agent along with its tools and workflows. If omitted, false is used (tool rows only list id, space_id, and tool_id unless this is true).
kibanaConnections List<GetKibanaAgentbuilderAgentKibanaConnection>: Kibana connection configuration block.
spaceId String: An identifier for the space. If space_id is not provided, the default space is used.

agentId string: The agent ID.
includeDependencies boolean: If true, exports the agent along with its tools and workflows. If omitted, false is used (tool rows only list id, space_id, and tool_id unless this is true).
kibanaConnections GetKibanaAgentbuilderAgentKibanaConnection[]: Kibana connection configuration block.
spaceId string: An identifier for the space. If space_id is not provided, the default space is used.

agent_id str: The agent ID.
include_dependencies bool: If true, exports the agent along with its tools and workflows. If omitted, false is used (tool rows only list id, space_id, and tool_id unless this is true).
kibana_connections Sequence[GetKibanaAgentbuilderAgentKibanaConnection]: Kibana connection configuration block.
space_id str: An identifier for the space. If space_id is not provided, the default space is used.

agentId String: The agent ID.
includeDependencies Boolean: If true, exports the agent along with its tools and workflows. If omitted, false is used (tool rows only list id, space_id, and tool_id unless this is true).
kibanaConnections List<Property Map>: Kibana connection configuration block.
spaceId String: An identifier for the space. If space_id is not provided, the default space is used.

getKibanaAgentbuilderAgent Result

The following output properties are available:

AgentId string: The agent ID.
AvatarColor string: Hex color code for the agent avatar (e.g., #BFDBFF).
AvatarSymbol string: Symbol or initials for the agent avatar (e.g., SI).
Description string: The agent description.
Id string: The composite ID of the agent: <space_id>/<agent_id>.
Instructions string: Optional system instructions that define the agent behavior.
Labels List<string>: List of labels for the agent.
Name string: The agent name.
Tools List<GetKibanaAgentbuilderAgentTool>: Tools attached to the agent. When includedependencies is true, each entry includes full tool data and workflow YAML for workflow-type tools. When false, only id (composite space/tool), spaceid, and tool_id are set.
IncludeDependencies bool: If true, exports the agent along with its tools and workflows. If omitted, false is used (tool rows only list id, space_id, and tool_id unless this is true).
KibanaConnections List<GetKibanaAgentbuilderAgentKibanaConnection>: Kibana connection configuration block.
SpaceId string: An identifier for the space. If space_id is not provided, the default space is used.

AgentId string: The agent ID.
AvatarColor string: Hex color code for the agent avatar (e.g., #BFDBFF).
AvatarSymbol string: Symbol or initials for the agent avatar (e.g., SI).
Description string: The agent description.
Id string: The composite ID of the agent: <space_id>/<agent_id>.
Instructions string: Optional system instructions that define the agent behavior.
Labels []string: List of labels for the agent.
Name string: The agent name.
Tools []GetKibanaAgentbuilderAgentTool: Tools attached to the agent. When includedependencies is true, each entry includes full tool data and workflow YAML for workflow-type tools. When false, only id (composite space/tool), spaceid, and tool_id are set.
IncludeDependencies bool: If true, exports the agent along with its tools and workflows. If omitted, false is used (tool rows only list id, space_id, and tool_id unless this is true).
KibanaConnections []GetKibanaAgentbuilderAgentKibanaConnection: Kibana connection configuration block.
SpaceId string: An identifier for the space. If space_id is not provided, the default space is used.

agent_id string: The agent ID.
avatar_color string: Hex color code for the agent avatar (e.g., #BFDBFF).
avatar_symbol string: Symbol or initials for the agent avatar (e.g., SI).
description string: The agent description.
id string: The composite ID of the agent: <space_id>/<agent_id>.
instructions string: Optional system instructions that define the agent behavior.
labels list(string): List of labels for the agent.
name string: The agent name.
tools list(object): Tools attached to the agent. When includedependencies is true, each entry includes full tool data and workflow YAML for workflow-type tools. When false, only id (composite space/tool), spaceid, and tool_id are set.
include_dependencies bool: If true, exports the agent along with its tools and workflows. If omitted, false is used (tool rows only list id, space_id, and tool_id unless this is true).
kibana_connections list(object): Kibana connection configuration block.
space_id string: An identifier for the space. If space_id is not provided, the default space is used.

agentId String: The agent ID.
avatarColor String: Hex color code for the agent avatar (e.g., #BFDBFF).
avatarSymbol String: Symbol or initials for the agent avatar (e.g., SI).
description String: The agent description.
id String: The composite ID of the agent: <space_id>/<agent_id>.
instructions String: Optional system instructions that define the agent behavior.
labels List<String>: List of labels for the agent.
name String: The agent name.
tools List<GetKibanaAgentbuilderAgentTool>: Tools attached to the agent. When includedependencies is true, each entry includes full tool data and workflow YAML for workflow-type tools. When false, only id (composite space/tool), spaceid, and tool_id are set.
includeDependencies Boolean: If true, exports the agent along with its tools and workflows. If omitted, false is used (tool rows only list id, space_id, and tool_id unless this is true).
kibanaConnections List<GetKibanaAgentbuilderAgentKibanaConnection>: Kibana connection configuration block.
spaceId String: An identifier for the space. If space_id is not provided, the default space is used.

agentId string: The agent ID.
avatarColor string: Hex color code for the agent avatar (e.g., #BFDBFF).
avatarSymbol string: Symbol or initials for the agent avatar (e.g., SI).
description string: The agent description.
id string: The composite ID of the agent: <space_id>/<agent_id>.
instructions string: Optional system instructions that define the agent behavior.
labels string[]: List of labels for the agent.
name string: The agent name.
tools GetKibanaAgentbuilderAgentTool[]: Tools attached to the agent. When includedependencies is true, each entry includes full tool data and workflow YAML for workflow-type tools. When false, only id (composite space/tool), spaceid, and tool_id are set.
includeDependencies boolean: If true, exports the agent along with its tools and workflows. If omitted, false is used (tool rows only list id, space_id, and tool_id unless this is true).
kibanaConnections GetKibanaAgentbuilderAgentKibanaConnection[]: Kibana connection configuration block.
spaceId string: An identifier for the space. If space_id is not provided, the default space is used.

agent_id str: The agent ID.
avatar_color str: Hex color code for the agent avatar (e.g., #BFDBFF).
avatar_symbol str: Symbol or initials for the agent avatar (e.g., SI).
description str: The agent description.
id str: The composite ID of the agent: <space_id>/<agent_id>.
instructions str: Optional system instructions that define the agent behavior.
labels Sequence[str]: List of labels for the agent.
name str: The agent name.
tools Sequence[GetKibanaAgentbuilderAgentTool]: Tools attached to the agent. When includedependencies is true, each entry includes full tool data and workflow YAML for workflow-type tools. When false, only id (composite space/tool), spaceid, and tool_id are set.
include_dependencies bool: If true, exports the agent along with its tools and workflows. If omitted, false is used (tool rows only list id, space_id, and tool_id unless this is true).
kibana_connections Sequence[GetKibanaAgentbuilderAgentKibanaConnection]: Kibana connection configuration block.
space_id str: An identifier for the space. If space_id is not provided, the default space is used.

agentId String: The agent ID.
avatarColor String: Hex color code for the agent avatar (e.g., #BFDBFF).
avatarSymbol String: Symbol or initials for the agent avatar (e.g., SI).
description String: The agent description.
id String: The composite ID of the agent: <space_id>/<agent_id>.
instructions String: Optional system instructions that define the agent behavior.
labels List<String>: List of labels for the agent.
name String: The agent name.
tools List<Property Map>: Tools attached to the agent. When includedependencies is true, each entry includes full tool data and workflow YAML for workflow-type tools. When false, only id (composite space/tool), spaceid, and tool_id are set.
includeDependencies Boolean: If true, exports the agent along with its tools and workflows. If omitted, false is used (tool rows only list id, space_id, and tool_id unless this is true).
kibanaConnections List<Property Map>: Kibana connection configuration block.
spaceId String: An identifier for the space. If space_id is not provided, the default space is used.

Supporting Types

GetKibanaAgentbuilderAgentKibanaConnection

ApiKey string: API Key to use for authentication to Kibana
BearerToken string: Bearer Token to use for authentication to Kibana
CaCerts List<string>: A list of paths to CA certificates to validate the certificate presented by the Kibana server.
Endpoints List<string>
Insecure bool: Disable TLS certificate validation
Password string: Password to use for API authentication to Kibana.
Username string: Username to use for API authentication to Kibana.

ApiKey string: API Key to use for authentication to Kibana
BearerToken string: Bearer Token to use for authentication to Kibana
CaCerts []string: A list of paths to CA certificates to validate the certificate presented by the Kibana server.
Endpoints []string
Insecure bool: Disable TLS certificate validation
Password string: Password to use for API authentication to Kibana.
Username string: Username to use for API authentication to Kibana.

api_key string: API Key to use for authentication to Kibana
bearer_token string: Bearer Token to use for authentication to Kibana
ca_certs list(string): A list of paths to CA certificates to validate the certificate presented by the Kibana server.
endpoints list(string)
insecure bool: Disable TLS certificate validation
password string: Password to use for API authentication to Kibana.
username string: Username to use for API authentication to Kibana.

apiKey String: API Key to use for authentication to Kibana
bearerToken String: Bearer Token to use for authentication to Kibana
caCerts List<String>: A list of paths to CA certificates to validate the certificate presented by the Kibana server.
endpoints List<String>
insecure Boolean: Disable TLS certificate validation
password String: Password to use for API authentication to Kibana.
username String: Username to use for API authentication to Kibana.

apiKey string: API Key to use for authentication to Kibana
bearerToken string: Bearer Token to use for authentication to Kibana
caCerts string[]: A list of paths to CA certificates to validate the certificate presented by the Kibana server.
endpoints string[]
insecure boolean: Disable TLS certificate validation
password string: Password to use for API authentication to Kibana.
username string: Username to use for API authentication to Kibana.

api_key str: API Key to use for authentication to Kibana
bearer_token str: Bearer Token to use for authentication to Kibana
ca_certs Sequence[str]: A list of paths to CA certificates to validate the certificate presented by the Kibana server.
endpoints Sequence[str]
insecure bool: Disable TLS certificate validation
password str: Password to use for API authentication to Kibana.
username str: Username to use for API authentication to Kibana.

apiKey String: API Key to use for authentication to Kibana
bearerToken String: Bearer Token to use for authentication to Kibana
caCerts List<String>: A list of paths to CA certificates to validate the certificate presented by the Kibana server.
endpoints List<String>
insecure Boolean: Disable TLS certificate validation
password String: Password to use for API authentication to Kibana.
username String: Username to use for API authentication to Kibana.

GetKibanaAgentbuilderAgentTool

Configuration string: The tool configuration in JSON format.
Description string: Description of what the tool does.
Id string: The tool ID to look up.
Readonly bool: Whether the tool is read-only.
SpaceId string: An identifier for the space. If space_id is not provided, the default space is used.
Tags List<string>: Tags for categorizing and organizing tools.
ToolId string: The ID of the tool.
Type string: The type of the tool (esql, index_search, workflow, mcp).
WorkflowConfigurationYaml string: The YAML configuration of the referenced workflow. Only populated for workflow-type tools. Requires Elastic Stack v9.4.0 or later.
WorkflowId string: The ID of the referenced workflow. Only populated for workflow-type tools. Requires Elastic Stack v9.4.0 or later.

Configuration string: The tool configuration in JSON format.
Description string: Description of what the tool does.
Id string: The tool ID to look up.
Readonly bool: Whether the tool is read-only.
SpaceId string: An identifier for the space. If space_id is not provided, the default space is used.
Tags []string: Tags for categorizing and organizing tools.
ToolId string: The ID of the tool.
Type string: The type of the tool (esql, index_search, workflow, mcp).
WorkflowConfigurationYaml string: The YAML configuration of the referenced workflow. Only populated for workflow-type tools. Requires Elastic Stack v9.4.0 or later.
WorkflowId string: The ID of the referenced workflow. Only populated for workflow-type tools. Requires Elastic Stack v9.4.0 or later.

configuration string: The tool configuration in JSON format.
description string: Description of what the tool does.
id string: The tool ID to look up.
readonly bool: Whether the tool is read-only.
space_id string: An identifier for the space. If space_id is not provided, the default space is used.
tags list(string): Tags for categorizing and organizing tools.
tool_id string: The ID of the tool.
type string: The type of the tool (esql, index_search, workflow, mcp).
workflow_configuration_yaml string: The YAML configuration of the referenced workflow. Only populated for workflow-type tools. Requires Elastic Stack v9.4.0 or later.
workflow_id string: The ID of the referenced workflow. Only populated for workflow-type tools. Requires Elastic Stack v9.4.0 or later.

configuration String: The tool configuration in JSON format.
description String: Description of what the tool does.
id String: The tool ID to look up.
readonly Boolean: Whether the tool is read-only.
spaceId String: An identifier for the space. If space_id is not provided, the default space is used.
tags List<String>: Tags for categorizing and organizing tools.
toolId String: The ID of the tool.
type String: The type of the tool (esql, index_search, workflow, mcp).
workflowConfigurationYaml String: The YAML configuration of the referenced workflow. Only populated for workflow-type tools. Requires Elastic Stack v9.4.0 or later.
workflowId String: The ID of the referenced workflow. Only populated for workflow-type tools. Requires Elastic Stack v9.4.0 or later.

configuration string: The tool configuration in JSON format.
description string: Description of what the tool does.
id string: The tool ID to look up.
readonly boolean: Whether the tool is read-only.
spaceId string: An identifier for the space. If space_id is not provided, the default space is used.
tags string[]: Tags for categorizing and organizing tools.
toolId string: The ID of the tool.
type string: The type of the tool (esql, index_search, workflow, mcp).
workflowConfigurationYaml string: The YAML configuration of the referenced workflow. Only populated for workflow-type tools. Requires Elastic Stack v9.4.0 or later.
workflowId string: The ID of the referenced workflow. Only populated for workflow-type tools. Requires Elastic Stack v9.4.0 or later.

configuration str: The tool configuration in JSON format.
description str: Description of what the tool does.
id str: The tool ID to look up.
readonly bool: Whether the tool is read-only.
space_id str: An identifier for the space. If space_id is not provided, the default space is used.
tags Sequence[str]: Tags for categorizing and organizing tools.
tool_id str: The ID of the tool.
type str: The type of the tool (esql, index_search, workflow, mcp).
workflow_configuration_yaml str: The YAML configuration of the referenced workflow. Only populated for workflow-type tools. Requires Elastic Stack v9.4.0 or later.
workflow_id str: The ID of the referenced workflow. Only populated for workflow-type tools. Requires Elastic Stack v9.4.0 or later.

configuration String: The tool configuration in JSON format.
description String: Description of what the tool does.
id String: The tool ID to look up.
readonly Boolean: Whether the tool is read-only.
spaceId String: An identifier for the space. If space_id is not provided, the default space is used.
tags List<String>: Tags for categorizing and organizing tools.
toolId String: The ID of the tool.
type String: The type of the tool (esql, index_search, workflow, mcp).
workflowConfigurationYaml String: The YAML configuration of the referenced workflow. Only populated for workflow-type tools. Requires Elastic Stack v9.4.0 or later.
workflowId String: The ID of the referenced workflow. Only populated for workflow-type tools. Requires Elastic Stack v9.4.0 or later.