Skip to main content
DELETE
DELETE /v1/searchIndexes/{id}

Delete a Search Index

Delete a search index by ID or fully qualified name. Supports soft delete (default), hard delete, and restore operations.

Delete by ID

string
required
UUID of the search index to delete.
boolean
default:"false"
Recursively delete child entities.
boolean
default:"false"
Permanently delete the search index. If false, the search index is soft-deleted and can be restored.

Delete by Name

Use DELETE /v1/searchIndexes/name/{fqn} to delete by fully qualified name.
string
required
Fully qualified name of the search index (e.g., elasticsearch_sample.table_search_index).
boolean
default:"false"
Recursively delete child entities.
boolean
default:"false"
Permanently delete the search index.

Restore a Soft-Deleted Search Index

Use PUT /v1/searchIndexes/restore to restore a soft-deleted search index.
string
required
UUID of the soft-deleted search index to restore.
DELETE /v1/searchIndexes/{id}

Returns

Soft delete returns the search index object with deleted: true. Hard delete returns no content (204). Restore returns the restored search index object.

Error Handling