dotCMS

dotCMS Search Index API

Elasticsearch index management and operations

GitHub OpenAPI

Operations 19

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 #

Documentation

📖
Documentation
https://dev.dotcms.com/docs/build/apis/api-basics/rest-apis
📖
APIReference
https://dev.dotcms.com/docs/build/apis/rest-apis/api-playground

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/dotcms/refs/heads/main/openapi/dotcms-search-index-api-openapi.yml

Other Resources

🔗
DeveloperPortal
https://dev.dotcms.com/
🔗
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

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/dotcms-search-index-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

dotcms-search-index-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: dotCMS REST Search Index API
  version: '3'
  description: Elasticsearch index management and operations
servers:
- url: /
  description: dotCMS Server
tags:
- name: Search Index
  description: Elasticsearch index management and operations
paths:
  /api/v1/esindex/activate/{params}:
    put:
      tags:
      - Search Index
      operationId: activateIndex
      parameters:
      - name: params
        in: path
        required: true
        schema:
          pattern: .*
          type: string
      responses:
        default:
          description: default response
          content:
            '*/*': {}
      deprecated: true
      summary: Activate index
      x-summary-source: derived
  /api/v1/esindex/clear/{params}:
    put:
      tags:
      - Search Index
      operationId: clearIndex
      parameters:
      - name: params
        in: path
        required: true
        schema:
          pattern: .*
          type: string
      responses:
        default:
          description: default response
          content:
            '*/*': {}
      deprecated: true
      summary: Clear index
      x-summary-source: derived
  /api/v1/esindex/close/{params}:
    put:
      tags:
      - Search Index
      operationId: closeIndex
      parameters:
      - name: params
        in: path
        required: true
        schema:
          pattern: .*
          type: string
      responses:
        default:
          description: default response
          content:
            '*/*': {}
      deprecated: true
      summary: Close index
      x-summary-source: derived
  /api/v1/esindex/create/{params}:
    put:
      tags:
      - Search Index
      operationId: createIndex
      parameters:
      - name: params
        in: path
        required: true
        schema:
          pattern: .*
          type: string
      responses:
        default:
          description: default response
          content:
            text/plain: {}
      deprecated: true
      summary: Create index
      x-summary-source: derived
  /api/v1/esindex/deactivate/{params}:
    put:
      tags:
      - Search Index
      operationId: deactivateIndex
      parameters:
      - name: params
        in: path
        required: true
        schema:
          pattern: .*
          type: string
      responses:
        default:
          description: default response
          content:
            '*/*': {}
      deprecated: true
      summary: Deactivate index
      x-summary-source: derived
  /api/v1/esindex/failed:
    get:
      tags:
      - Search Index
      operationId: downloadRemainingRecordsAsCsv
      responses:
        default:
          description: default response
          content:
            application/json: {}
      summary: Download remaining records as csv
      x-summary-source: derived
    delete:
      tags:
      - Search Index
      operationId: deleteFailedRecords
      responses:
        default:
          description: default response
          content:
            application/json: {}
      summary: Delete failed records
      x-summary-source: derived
  /api/v1/esindex/{indexName}:
    put:
      tags:
      - Search Index
      operationId: modIndex
      parameters:
      - name: indexName
        in: path
        required: true
        schema:
          pattern: .*
          type: string
      - name: action
        in: query
        schema:
          type: string
      responses:
        default:
          description: default response
          content:
            application/json: {}
      summary: Mod index
      x-summary-source: derived
    delete:
      tags:
      - Search Index
      operationId: deleteIndex
      parameters:
      - name: indexName
        in: path
        required: true
        schema:
          pattern: .*
          type: string
      responses:
        default:
          description: default response
          content:
            application/json: {}
      summary: Delete index
      x-summary-source: derived
  /api/v1/esindex/cache:
    delete:
      tags:
      - Search Index
      operationId: flushIndiciesCache
      responses:
        default:
          description: default response
          content:
            application/json: {}
      summary: Flush indicies cache
      x-summary-source: derived
  /api/v1/esindex/active/{params}:
    get:
      tags:
      - Search Index
      operationId: getActive
      parameters:
      - name: params
        in: path
        required: true
        schema:
          pattern: .*
          type: string
      responses:
        default:
          description: default response
          content:
            text/plain: {}
      deprecated: true
      summary: Get active
      x-summary-source: derived
  /api/v1/esindex/cluster:
    get:
      tags:
      - Search Index
      operationId: getClusterStats
      responses:
        default:
          description: default response
          content:
            application/json: {}
      summary: Get cluster stats
      x-summary-source: derived
  /api/v1/esindex:
    get:
      tags:
      - Search Index
      operationId: getIndexStatus
      responses:
        default:
          description: default response
          content:
            application/json: {}
      summary: Get index status
      x-summary-source: derived
  /api/v1/esindex/reindex:
    get:
      tags:
      - Search Index
      operationId: getReindexationProgress
      responses:
        default:
          description: default response
          content:
            application/json: {}
      summary: Get reindexation progress
      x-summary-source: derived
    post:
      tags:
      - Search Index
      operationId: startReindex
      parameters:
      - name: contentType
        in: query
        schema:
          type: string
          default: DOTALL
      responses:
        default:
          description: default response
          content:
            application/json: {}
      summary: Start reindex
      x-summary-source: derived
    delete:
      tags:
      - Search Index
      operationId: stopReindexation
      parameters:
      - name: switch
        in: query
        schema:
          type: boolean
          default: true
      responses:
        default:
          description: default response
          content:
            application/json: {}
      summary: Stop reindexation
      x-summary-source: derived
  /api/v1/esindex/indexlist/{params}:
    get:
      tags:
      - Search Index
      operationId: indexList
      parameters:
      - name: params
        in: path
        required: true
        schema:
          pattern: .*
          type: string
      responses:
        default:
          description: default response
          content:
            application/json: {}
      summary: Index list
      x-summary-source: derived
  /api/v1/esindex/open/{params}:
    put:
      tags:
      - Search Index
      operationId: openIndex
      parameters:
      - name: params
        in: path
        required: true
        schema:
          pattern: .*
          type: string
      responses:
        default:
          description: default response
          content:
            '*/*': {}
      deprecated: true
      summary: Open index
      x-summary-source: derived
  /api/v1/esindex/optimize:
    post:
      tags:
      - Search Index
      operationId: optimizeIndices
      responses:
        default:
          description: default response
          content:
            application/json: {}
      summary: Optimize indices
      x-summary-source: derived