Delete Memory Container API

Introduced 3.3

Use this API to delete a memory container by its ID.

Endpoints

DELETE /_plugins/_ml/memory_containers/{memory_container_id}

Path parameters

The following table lists the available path parameters.

Query parameters

The following table lists the available query parameters.

You can also provide delete_all_memories and delete_memories in the request body. If a parameter is specified in both places, the query parameter takes precedence.

Example request: Basic deletion (preserves memory indexes)

DELETE /_plugins/_ml/memory_containers/SdjmmpgBOh0h20Y9kWuN

Example request: Delete a container and all memory indexes

DELETE /_plugins/_ml/memory_containers/SdjmmpgBOh0h20Y9kWuN?delete_all_memories=true

Example request: Delete a container and specific memory types

DELETE /_plugins/_ml/memory_containers/SdjmmpgBOh0h20Y9kWuN?delete_memories=sessions,working

Example response

{
    "_index": ".plugins-ml-am-memory-container",
    "_id": "SdjmmpgBOh0h20Y9kWuN",
    "_version": 2,
    "result": "deleted",
    "forced_refresh": true,
    "_shards": {
        "total": 1,
        "successful": 1,
        "failed": 0
    },
    "_seq_no": 6,
    "_primary_term": 1
}

Error responses

If you attempt to delete a memory container that doesn’t exist, OpenSearch returns a 404 Not Found error:

{
  "error": {
    "root_cause": [
      {
        "type": "status_exception",
        "reason": "Memory container not found"
      }
    ],
    "type": "status_exception",
    "reason": "Memory container not found"
  },
  "status": 404
}

Memory indexes can be deleted only if no other memory container uses the same index_prefix. If another container shares the prefix, a request that specifies delete_all_memories or delete_memories fails with a 409 Conflict error and the container is not deleted. To delete the container, send the request without these parameters.

Response fields

The following table lists all response body fields.