dotCMS

dotCMS Health API

Health management and monitoring endpoints for administrative dashboards

GitHub OpenAPI

Operations 8

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/v1/health/check/{checkName} Get the result of one health check · Get specific health check result #
Ask an LLM
“Is the database health check passing right now?”
“Can I check just one component's health instead of everything?”
Tell an agent
Show the result of health check {checkName}.
Check whether {checkName} is healthy.
GET /api/v1/health/checks List the registered health checks · Get all health check names #
Ask an LLM
“Which health checks are registered on my dotCMS server?”
“What check names can I query individually?”
Tell an agent
List all health check names.
Show me which health checks exist.
GET /api/v1/health/liveness Get detailed liveness health · Get liveness health status #
Ask an LLM
“Is the dotCMS application alive, with details per critical component?”
“Which endpoint gives liveness details suited for a dashboard?”
Tell an agent
Show the liveness health details.
Check if the app is alive and list the critical component results.
GET /api/v1/health Get the full health report · Get overall health status #
Ask an LLM
“What is the overall health of my dotCMS instance across all checks?”
“Does the detailed health report require authentication?”
Tell an agent
Give me the complete health report with every check.
Show overall system health.
GET /api/v1/health/readiness Get readiness health for traffic · Get readiness health status #
Ask an LLM
“Is this dotCMS node ready to receive traffic yet?”
“Which components are blocking readiness after a restart?”
Tell an agent
Show readiness health details.
Check if the server is ready to take traffic.
GET /api/v1/health/status Get a quick alive and ready summary · Get system status summary #
Ask an LLM
“Can I get a simple yes or no on whether dotCMS is alive and ready?”
“What's the lightest health endpoint for a quick status check?”
Tell an agent
Give me the alive and ready flags.
Show a one-line system status summary.
POST /api/v1/health/refresh/{checkName} Force a refresh of one health check · Force refresh a specific health check #
Ask an LLM
“Can I rerun a single health check right now instead of waiting for the cache?”
“How do I get a fresh result for one component after maintenance?”
Tell an agent
Refresh health check {checkName} now.
Rerun {checkName} bypassing the cache.
POST /api/v1/health/refresh Force a refresh of all health checks · Force refresh all health checks #
Ask an LLM
“How do I rerun every health check after a configuration change?”
“Can I bypass cached health results for all components at once?”
Tell an agent
Refresh all health checks now.
Rerun every registered health check without cache.

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://artifacts.apis.io/dotcms/openapi/dotcms-health-api-openapi.yml

Other Resources

🔗
DeveloperPortal
https://dev.dotcms.com/
🔗
ErrorCatalog
https://artifacts.apis.io/dotcms/errors/dotcms-problem-types.yml
🔗
DataModel
https://artifacts.apis.io/dotcms/data-model/dotcms-data-model.yml
🔗
Conventions
https://artifacts.apis.io/dotcms/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:dotcms-health-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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-health-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: dotCMS REST Health API
  version: '3'
  description: Health management and monitoring endpoints for administrative dashboards
servers:
- url: /
  description: dotCMS Server
tags:
- name: Health
  description: Health management and monitoring endpoints for administrative dashboards
paths:
  /api/v1/health/check/{checkName}:
    get:
      tags:
      - Health
      summary: Get specific health check result
      description: Returns the result of a specific health check identified by name. Useful for monitoring individual components or debugging specific health issues.
      operationId: getHealthCheck
      parameters:
      - name: checkName
        in: path
        description: Name of the health check to retrieve
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved health check result
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseEntityView'
        '403':
          description: Forbidden - Authentication required
        '404':
          description: Health check not found
        '500':
          description: Internal Server Error
  /api/v1/health/checks:
    get:
      tags:
      - Health
      summary: Get all health check names
      description: Returns a list of all registered health check names. Useful for discovering available health checks and building monitoring interfaces.
      operationId: getHealthCheckNames
      responses:
        '200':
          description: Successfully retrieved health check names
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseEntityView'
        '403':
          description: Forbidden - Authentication required
        '500':
          description: Internal Server Error
  /api/v1/health/liveness:
    get:
      tags:
      - Health
      summary: Get liveness health status
      description: Returns liveness health checks suitable for application dashboards. This endpoint provides detailed JSON information about critical system components required for the application to be considered alive.
      operationId: getLivenessHealth
      responses:
        '200':
          description: Successfully retrieved liveness health status
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseEntityView'
        '403':
          description: Forbidden - Authentication required
        '500':
          description: Internal Server Error
  /api/v1/health:
    get:
      tags:
      - Health
      summary: Get overall health status
      description: Returns comprehensive health status including all registered health checks. Authentication requirements are controlled by the health.detailed.authentication.required configuration property.
      operationId: getOverallHealth
      responses:
        '200':
          description: Successfully retrieved overall health status
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseEntityView'
        '403':
          description: Forbidden - Authentication required
        '500':
          description: Internal Server Error
  /api/v1/health/readiness:
    get:
      tags:
      - Health
      summary: Get readiness health status
      description: Returns readiness health checks to determine if the application is ready to receive traffic. This endpoint provides detailed JSON information about system components required for the application to be considered ready to serve requests.
      operationId: getReadinessHealth
      responses:
        '200':
          description: Successfully retrieved readiness health status
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseEntityView'
        '500':
          description: Internal Server Error
  /api/v1/health/status:
    get:
      tags:
      - Health
      summary: Get system status summary
      description: Returns a simple boolean summary of system health status with alive and ready flags. Provides a quick overview of system health without detailed check information.
      operationId: getSystemStatus
      responses:
        '200':
          description: Successfully retrieved system status summary
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseEntityView'
        '403':
          description: Forbidden - Authentication required
        '500':
          description: Internal Server Error
  /api/v1/health/refresh/{checkName}:
    post:
      tags:
      - Health
      summary: Force refresh a specific health check
      description: Triggers an immediate refresh of a specific health check identified by name, bypassing any caching mechanisms. Useful for testing individual components or getting up-to-date status after targeted maintenance.
      operationId: refreshHealthCheck
      parameters:
      - name: checkName
        in: path
        description: Name of the health check to refresh
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successfully refreshed the health check
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseEntityView'
        '403':
          description: Forbidden - Authentication required
        '404':
          description: Health check not found
        '500':
          description: Internal Server Error
  /api/v1/health/refresh:
    post:
      tags:
      - Health
      summary: Force refresh all health checks
      description: Triggers an immediate refresh of all registered health checks, bypassing any caching mechanisms. Useful for getting up-to-date health status after configuration changes or system maintenance.
      operationId: refreshHealthChecks
      responses:
        '200':
          description: Successfully triggered health checks refresh
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseEntityView'
        '403':
          description: Forbidden - Authentication required
        '500':
          description: Internal Server Error
components:
  schemas:
    Pagination:
      type: object
      properties:
        currentPage:
          type: integer
          format: int32
        perPage:
          type: integer
          format: int32
        totalEntries:
          type: integer
          format: int64
    MessageEntity:
      type: object
      properties:
        message:
          type: string
    ResponseEntityView:
      type: object
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/ErrorEntity'
        entity:
          type: object
        messages:
          type: array
          items:
            $ref: '#/components/schemas/MessageEntity'
        i18nMessagesMap:
          type: object
          additionalProperties:
            type: string
        permissions:
          type: array
          items:
            type: string
        pagination:
          $ref: '#/components/schemas/Pagination'
    ErrorEntity:
      type: object
      properties:
        errorCode:
          type: string
        message:
          type: string
        fieldName:
          type: string
x-provenance:
  method: harvested
  publisher: dotCMS
  source: https://demo.dotcms.com/api/openapi.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)