Delete an agent

Auth

Delete an agent by ID. This action cannot be undone. To learn more about agents, refer to the agents 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.
id string required: The unique identifier of the agent to delete.

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/agents/{id}

curl Shell

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

Response

Example response showing that deletion of the agent has been successful

{
  "success": true
}