Link Search Menu Expand Document Documentation Menu

Alias APIs

OpenSearch index alias APIs allow you to create, update, delete, and retrieve information about aliases.

For conceptual information about index aliases, including use cases and examples, see Index aliases.

Available APIs

OpenSearch supports the following index alias APIs.

API Description
Manage aliases Adds or removes aliases.
Create or update alias Creates or updates an alias.
Get index alias Returns information about one or more aliases.
Delete index alias Deletes an existing alias.
Index alias exists Checks if an alias exists.
CAT aliases Lists aliases in a tabular format with routing and filtering information.

For more information about index aliases, see Index aliases.

350 characters left

Have a question? .

Want to contribute? or .