v50

latestOpenAPI 3.0.0raw.githubusercontent.com2026-05-142013116.2 KB
Indices

Delete index by name

Deletes an index.

Permissions

Any user or API key must have at least one of the appropriate License Manager resources to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint:

ProductCategoryResource
Dynamic StorageIndexRemove index
Dynamic StorageDynamic storage generic resourcesMaster Data administrator

There are no applicable predefined roles for this resource list. You must create a custom role and add at least one of the resources above in order to use this endpoint.To learn more about machine authentication at VTEX, see Authentication overview.

❗ To prevent integrations from having excessive permissions, consider the best practices for managing API keys when assigning License Manager roles to integrations.

delete/api/dataentities/{dataEntityName}/indices/{index_name}

Path parameters

dataEntityNamestring required
Example:Newsletter

Name of the data entity.

index_namestring required
Example:{{index_name}}

Name of the index.

Headers

Content-Typestring required
Example:application/json

Type of the content being sent.

Response

No Content