Delete a tool

Auth

Delete a tool by ID. This action cannot be undone. To learn more about Agent Builder tools, refer to the tools documentation.

Required privileges

space_id string optional: An identifier for the space. If space_id is not provided in the URL, the default space is used. Refer to Spaces for more information.
toolId string required: The unique identifier of the tool to delete.

force boolean · default: false: If true, removes the tool from agents that use it and then deletes it. If false and any agent uses the tool, the request returns 409 Conflict with the list of agents.

kbn-xsrf string required: A required header to protect against CSRF attacks

200

Indicates a successful response

application/json

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

DELETE kbn:/api/agent_builder/tools/{toolId}

curl Shell

curl \
  -X DELETE "https://${KIBANA_URL}/api/agent_builder/tools/{toolId}" \
  -H "Authorization: ApiKey ${API_KEY}" \
  -H "kbn-xsrf: true"

Response

Example response showing that the deletion operation was successful

{
  "success": true
}