---
title: "Clear Overlays"
method: POST
path: "/api/v1/ontology/entities/{entity_id}/clear-overlays"
tags: ["ontology-promotion"]
---

# Clear Overlays

`POST /api/v1/ontology/entities/{entity_id}/clear-overlays`

## Request

- Base URL: `https://api.netter.ai` (the document declares no server; this is the origin it was published from)
- URL: `https://api.netter.ai/api/v1/ontology/entities/{entity_id}/clear-overlays`
- Auth: none declared

Type-to-confirm wipe of every overlay row for an entity.

## Path parameters

- `entity_id` string, uuid, required

## Request body

- ClearBody
  - `confirm` string, required: Must be the literal phrase 'clear all overlays'

## Response `200`

Successful Response

- ClearResponse
  - `deleted` integer, required

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/netter/apis/dmi-backend.md) - [All operations](https://skmtc.dev/netter/apis/dmi-backend/llms.txt) - [OpenAPI document](https://skmtc.dev/netter/apis/dmi-backend/revisions/29c68bd8ba7b?raw)