Skip to main content

Endpoint

DELETE /domains/{domain_id}
Soft-deletes a domain by marking it as deleted in the database. The domain will no longer appear in any list or get responses. Cascade behavior: Deleting a domain also soft-deletes every indicator that belongs to that domain. Deleted indicators are removed from all list and get responses and cannot be recovered through the API.

Path parameters

domain_id
string
required
ObjectId string of the domain to delete. Returns 400 if not a valid ObjectId format.

Response

id
string
required
ObjectId string of the deleted domain.
deleted
boolean
required
Always true when the request succeeds.

Errors

StatusCondition
400domain_id is not a valid ObjectId format
404No domain with the given ID exists

Examples

curl --request DELETE \
  --url 'http://localhost:8080/domains/64a1f2b3c4d5e6f7a8b9c0a1'

Sample response

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

Build docs developers (and LLMs) love