> ## Documentation Index
> Fetch the complete documentation index at: https://docs.getcollate.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Search Indexes

> Create, retrieve, update, list, and delete search index entities with fields, mappings, owners, and tags within a search service using the Collate REST API.

# Search Indexes

A **Search Index** is a data structure within a Search Service that enables efficient full-text and structured search over metadata entities.

<Info>
  Entity schema follows the [OpenMetadata Standard](https://openmetadatastandards.org/data-assets/search/search-index/).
</Info>

## Entity Hierarchy

Search Indexes belong to a Search Service:

<CodeGroup>
  ```txt Search Index theme={null}
  SearchService
  └── SearchIndex (this page)
  ```
</CodeGroup>

## Fully Qualified Name

The FQN format for a search index is:

```
service.indexName
```

For example: `elasticsearch_sample.table_search_index`

***

## API Endpoints

| Method   | Endpoint                                    | Description                                                                              |
| -------- | ------------------------------------------- | ---------------------------------------------------------------------------------------- |
| `PUT`    | `/v1/searchIndexes`                         | [Create or update a search index](/api-reference/data-assets/search-indexes/create)      |
| `POST`   | `/v1/searchIndexes`                         | [Create a search index (POST variant)](/api-reference/data-assets/search-indexes/create) |
| `GET`    | `/v1/searchIndexes`                         | [List search indexes](/api-reference/data-assets/search-indexes/list)                    |
| `GET`    | `/v1/searchIndexes/{id}`                    | [Get by ID](/api-reference/data-assets/search-indexes/retrieve)                          |
| `GET`    | `/v1/searchIndexes/name/{fqn}`              | [Get by FQN](/api-reference/data-assets/search-indexes/retrieve)                         |
| `PATCH`  | `/v1/searchIndexes/{id}`                    | [Update by ID](/api-reference/data-assets/search-indexes/update)                         |
| `PATCH`  | `/v1/searchIndexes/name/{fqn}`              | [Update by name](/api-reference/data-assets/search-indexes/update)                       |
| `DELETE` | `/v1/searchIndexes/{id}`                    | [Delete by ID](/api-reference/data-assets/search-indexes/delete)                         |
| `DELETE` | `/v1/searchIndexes/name/{fqn}`              | [Delete by name](/api-reference/data-assets/search-indexes/delete)                       |
| `PUT`    | `/v1/searchIndexes/restore`                 | [Restore soft-deleted search index](/api-reference/data-assets/search-indexes/delete)    |
| `GET`    | `/v1/searchIndexes/{id}/versions`           | [List versions](/api-reference/data-assets/search-indexes/versions)                      |
| `GET`    | `/v1/searchIndexes/{id}/versions/{version}` | [Get specific version](/api-reference/data-assets/search-indexes/versions)               |
| `PUT`    | `/v1/searchIndexes/{id}/followers`          | [Add follower](/api-reference/data-assets/search-indexes/followers-votes)                |
| `DELETE` | `/v1/searchIndexes/{id}/followers/{userId}` | [Remove follower](/api-reference/data-assets/search-indexes/followers-votes)             |
| `PUT`    | `/v1/searchIndexes/{id}/vote`               | [Add/update vote](/api-reference/data-assets/search-indexes/followers-votes)             |