dotCMS

dotCMS Cluster Management API

Cluster nodes and distributed system management

Documentation GitHub OpenAPI

Operations 5

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /api/cluster/getESConfigProperties/{params} Get the cluster's Elasticsearch config properties · Get ES config properties #

Ask an LLM

“What Elasticsearch configuration properties is the cluster running with?”

“How can I inspect ES settings for a cluster node?”

Tell an agent

Show the Elasticsearch config properties for {params}.

Get the cluster's ES settings using {params}.

GET /api/cluster/licenseRepoStatus Check the license repository status · Get license repo status #

Ask an LLM

“What is the current status of the cluster's license repository?”

“Is the cluster license pool healthy?”

Tell an agent

Check the license repository status with {params}.

Show license pool usage across the cluster for {params}.

GET /api/cluster/getNodesStatus/{params} Get the status of every cluster node · Get nodes info #

Ask an LLM

“Which nodes are in my dotCMS cluster and are they healthy?”

“How do I get a status report for each server node in the cluster?”

Tell an agent

Show the status of all cluster nodes for {params}.

Report node health across the cluster using {params}.

POST /api/cluster/remove/{params} Remove a node from the cluster · Remove from cluster #

Ask an LLM

“How do I take a dead server out of the cluster?”

“Can I remove a node from the cluster remotely?”

Tell an agent destructive · confirm first

Remove the node identified by {params} from the cluster.

Drop server {params} out of cluster membership.

GET /api/cluster/test Test cluster communication · Test cluster #

Ask an LLM

“Are the cluster nodes able to talk to each other?”

“How do I run a quick cluster connectivity test?”

Tell an agent

Run the cluster connectivity test.

Check that cluster messaging works.

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:dotcms-cluster-management-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

openapi: 3.2.0
info:
  title: dotCMS REST Cluster Management API
  version: '3'
  description: Cluster nodes and distributed system management
servers:
- url: /
  description: dotCMS Server
tags:
- name: Cluster Management
  description: Cluster nodes and distributed system management
paths:
  /api/cluster/getESConfigProperties/{params}:
    get:
      tags:
      - Cluster Management
      operationId: getESConfigProperties
      parameters:
      - name: params
        in: path
        required: true
        schema:
          pattern: .*
          type: string
      responses:
        default:
          description: default response
          content:
            application/json: {}
      summary: Get ES config properties
      x-summary-source: derived
  /api/cluster/licenseRepoStatus:
    get:
      tags:
      - Cluster Management
      operationId: getLicenseRepoStatus
      parameters:
      - name: params
        in: path
        required: true
        schema:
          type: string
      responses:
        default:
          description: default response
          content:
            application/json: {}
      summary: Get license repo status
      x-summary-source: derived
  /api/cluster/getNodesStatus/{params}:
    get:
      tags:
      - Cluster Management
      operationId: getNodesInfo
      parameters:
      - name: params
        in: path
        required: true
        schema:
          pattern: .*
          type: string
      responses:
        default:
          description: default response
          content:
            application/json: {}
      summary: Get nodes info
      x-summary-source: derived
  /api/cluster/remove/{params}:
    post:
      tags:
      - Cluster Management
      operationId: removeFromCluster
      parameters:
      - name: params
        in: path
        required: true
        schema:
          pattern: .*
          type: string
      responses:
        default:
          description: default response
          content:
            '*/*': {}
      summary: Remove from cluster
      x-summary-source: derived
  /api/cluster/test:
    get:
      tags:
      - Cluster Management
      operationId: testCluster
      responses:
        default:
          description: default response
          content:
            '*/*': {}
      summary: Test cluster
      x-summary-source: derived

dotCMS Cluster Management API

Operations 5

Documentation

Specifications

Other Resources

Work with this as data

MCP server

Tools for apis

Call it yourself

Get an API key

OpenAPI Specification