You're viewing version 3.3 of the OpenSearch documentation. This version is no longer maintained. For the latest version, see the current documentation. For information about OpenSearch version maintenance, see Release Schedule and Maintenance Policy.
Index APIs
Introduced 1.0
The index API operations let you interact with indexes in your cluster. Using these operations, you can create, delete, close, and complete other index-related operations.
Index API operations
The following index API operations are available, organized by category:
- Alias APIs - Create, update, delete, and retrieve information about index aliases
- Core index APIs - Fundamental operations for managing the lifecycle of indexes
- Index operations - Advanced functionality for maintaining and optimizing indexes
- Index settings and mappings - Configure and modify index behavior and structure
- Index templates - Create and manage templates for automatic index configuration
- Index blocks and allocation - Control index access restrictions and shard allocation
- Data stream stats - Returns statistics for data streams
- Dangling index - Manage indexes that exist on disk but are not part of cluster state
If you use the Security plugin, make sure you have the appropriate permissions.