# dotCMS Search Index API

**Canonical:** https://apis.io/apis/dotcms/dotcms-search-index-api/  
**Provider:** dotCMS — https://apis.io/providers/dotcms/  
**Base URL:** https://demo.dotcms.com/api  
**Documentation:** https://dev.dotcms.com/docs/build/apis/api-basics/rest-apis

dotCMS Search Index API is one of 73 APIs that [dotCMS](https://apis.io/providers/dotcms/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include Search Index. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

Elasticsearch index management and operations

## Operations (19)

| Method | Path | Summary |
|---|---|---|
| PUT | `/api/v1/esindex/activate/{params}` | Activate index |
| PUT | `/api/v1/esindex/clear/{params}` | Clear index |
| PUT | `/api/v1/esindex/close/{params}` | Close index |
| PUT | `/api/v1/esindex/create/{params}` | Create index |
| PUT | `/api/v1/esindex/deactivate/{params}` | Deactivate index |
| GET | `/api/v1/esindex/failed` | Download remaining records as csv |
| DELETE | `/api/v1/esindex/failed` | Delete failed records |
| PUT | `/api/v1/esindex/{indexName}` | Mod index |
| DELETE | `/api/v1/esindex/{indexName}` | Delete index |
| DELETE | `/api/v1/esindex/cache` | Flush indicies cache |
| GET | `/api/v1/esindex/active/{params}` | Get active |
| GET | `/api/v1/esindex/cluster` | Get cluster stats |
| GET | `/api/v1/esindex` | Get index status |
| GET | `/api/v1/esindex/reindex` | Get reindexation progress |
| POST | `/api/v1/esindex/reindex` | Start reindex |
| DELETE | `/api/v1/esindex/reindex` | Stop reindexation |
| GET | `/api/v1/esindex/indexlist/{params}` | Index list |
| PUT | `/api/v1/esindex/open/{params}` | Open index |
| POST | `/api/v1/esindex/optimize` | Optimize indices |

## Machine-readable artifacts (7)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/dotcms/refs/heads/main/openapi/dotcms-search-index-api-openapi.yml
- **Documentation** — https://dev.dotcms.com/docs/build/apis/api-basics/rest-apis
- **DeveloperPortal** — https://dev.dotcms.com/
- **APIReference** — https://dev.dotcms.com/docs/build/apis/rest-apis/api-playground
- **ErrorCatalog** — https://raw.githubusercontent.com/api-evangelist/dotcms/refs/heads/main/errors/dotcms-problem-types.yml
- **DataModel** — https://raw.githubusercontent.com/api-evangelist/dotcms/refs/heads/main/data-model/dotcms-data-model.yml
- **Conventions** — https://raw.githubusercontent.com/api-evangelist/dotcms/refs/heads/main/conventions/dotcms-conventions.yml

## Other dotCMS APIs (12)

- [dotCMS GraphQL API](https://apis.io/apis/dotcms/graphql/)
- [dotCMS Accessibility Agent API](https://apis.io/apis/dotcms/dotcms-accessibility-agent-api/)
- [dotCMS Accessibility Checker API](https://apis.io/apis/dotcms/dotcms-accessibility-checker-api/)
- [dotCMS Administration API](https://apis.io/apis/dotcms/dotcms-administration-api/)
- [dotCMS AI API](https://apis.io/apis/dotcms/dotcms-ai-api/)
- [dotCMS Announcements API](https://apis.io/apis/dotcms/dotcms-announcements-api/)
- [dotCMS API Token API](https://apis.io/apis/dotcms/dotcms-api-token-api/)
- [dotCMS Apps API](https://apis.io/apis/dotcms/dotcms-apps-api/)
- [dotCMS Authentication API](https://apis.io/apis/dotcms/dotcms-authentication-api/)
- [dotCMS Browser Tree API](https://apis.io/apis/dotcms/dotcms-browser-tree-api/)
- [dotCMS Bundle API](https://apis.io/apis/dotcms/dotcms-bundle-api/)
- [dotCMS Cache Management API](https://apis.io/apis/dotcms/dotcms-cache-management-api/)

## Tags

Search Index

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/dotcms/dotcms-search-index-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/dotcms/.