opensearch-docs-cn/_ml-commons-plugin/api/agent-apis/delete-agent.md

980 B

layout title parent grand_parent nav_order
default Delete agent Agent APIs ML Commons APIs 50

Delete an agent

Introduced 2.12 {: .label .label-purple }

This is an experimental feature and is not recommended for use in a production environment. For updates on the progress of the feature or if you want to leave feedback, see the associated GitHub issue.
{: .warning}

You can use this API to delete an agent based on the agent_id.

Path and HTTP methods

DELETE /_plugins/_ml/agents/<agent_id>

Example request

DELETE /_plugins/_ml/agents/MzcIJX8BA7mbufL6DOwl

{% include copy-curl.html %}

Example response

{
  "_index" : ".plugins-ml-agent",
  "_id" : "MzcIJX8BA7mbufL6DOwl",
  "_version" : 2,
  "result" : "deleted",
  "_shards" : {
    "total" : 2,
    "successful" : 2,
    "failed" : 0
  },
  "_seq_no" : 27,
  "_primary_term" : 18
}