Delete an agent

Server: https://{kibana_url}

DELETE /api/agent_builder/agents/{id}

Delete an agent by ID. This action cannot be undone. To learn more about agents, refer to the agents documentation.

[Required authorization] Route required privileges: agentBuilder:manageAgents.

Path Parameters

id string required: The unique identifier of the agent to delete.

Response

200

Indicates a successful response

application/json

Examples

Example response showing that deletion of the agent has been successful

Request Console 1 / 2 languages

Console Kibana Dev Tools

DELETE kbn://api/agent_builder/agents/{id}

curl Shell

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

Response

{
  "success": true
}