Bulk remove entities from the index

Remove one or more entities from the global search index. Each item is validated then published to the internal event stream — deletion happens asynchronously. Returns 202 with the count of accepted operations.

POST /search/bulk/delete

Bulk remove entities from the index

cURL

curl --request POST \
  --url https://api.example.com/search/bulk/delete \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
[
  {
    "organization_id": "<string>",
    "entity_type": "<string>",
    "entity_id": "<string>"
  }
]
'

202

{
  "accepted": 123
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

organization_id · string · required

Organisation the entity belongs to

entity_type · string · required

Entity type (e.g. 'table', 'agent')

entity_id · string · required

Stable unique identifier for the entity

Response

202

application/json

Successful Response

Response from POST /search/bulk/index and POST /search/bulk/delete.

accepted · integer · required

Number of operations accepted and queued for processing