Skip to main content

​
Endpoint

DELETE /indicators/{indicator_id}
Soft-deletes the indicator by setting its deleted flag to true in MongoDB. The record is no longer returned by any list, get, or search endpoints.
Deleting an indicator also removes all data segments associated with it from MongoDB. This action cannot be undone through the API.

​
Path parameters

​
indicator_id
string
required
ObjectId string of the indicator to delete. Returns 400 if not a valid ObjectId.

​
Response

​
id
string
required
The ObjectId string of the deleted indicator.
​
deleted
boolean
required
Always true on a successful delete.

​
Errors

StatusCondition
400indicator_id is not a valid ObjectId format
404No indicator with the given ID exists

​
Examples

curl --request DELETE \
  --url 'http://localhost:8080/indicators/64a1f2b3c4d5e6f7a8b9c0d1'

​
Sample response

200
{
  "id": "64a1f2b3c4d5e6f7a8b9c0d1",
  "deleted": true
}

Build docs developers (and LLMs) love

Get started for freeTalk to us