dotCMS

dotCMS System API

System-level operations and Redis management

GitHub OpenAPI

Operations 13

GET /api/v1/system/request-draining-test/status Get shutdown status #
GET /api/v1/system/request-draining-test/long-request Long running request #
GET /api/v1/system/request-draining-test/simulate-active-requests Simulate active requests #
GET /api/v1/redis/{key} Get 5 #
DELETE /api/v1/redis/{key} Delete 10 #
GET /api/v1/redis/hash/{key} Get hash #
DELETE /api/v1/redis/hash/{key} Delete hash #
GET /api/v1/redis/echo/{message} Echo #
GET /api/v1/redis/incr/{key} Get increment #
PUT /api/v1/redis/incr/{key} Increment async #
GET /api/v1/redis/ping Ping #
PUT /api/v1/redis Set 1 #
PUT /api/v1/redis/hash Set hash #

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-system-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-system-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-system-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: dotCMS REST System API
  version: '3'
  description: System-level operations and Redis management
servers:
- url: /
  description: dotCMS Server
tags:
- name: System
  description: System-level operations and Redis management
paths:
  /api/v1/system/request-draining-test/status:
    get:
      operationId: getShutdownStatus
      responses:
        default:
          description: default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseEntityViewMapStringObject'
      tags:
      - System
      summary: Get shutdown status
      x-summary-source: derived
  /api/v1/system/request-draining-test/long-request:
    get:
      operationId: longRunningRequest
      parameters:
      - name: duration
        in: query
        schema:
          type: integer
          format: int64
          default: 5000
      responses:
        default:
          description: default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseEntityViewMapStringObject'
      tags:
      - System
      summary: Long running request
      x-summary-source: derived
  /api/v1/system/request-draining-test/simulate-active-requests:
    get:
      operationId: simulateActiveRequests
      parameters:
      - name: count
        in: query
        schema:
          type: integer
          format: int32
          default: 1
      responses:
        default:
          description: default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseEntityViewMapStringObject'
      tags:
      - System
      summary: Simulate active requests
      x-summary-source: derived
  /api/v1/redis/{key}:
    get:
      tags:
      - System
      operationId: get_5
      parameters:
      - name: key
        in: path
        required: true
        schema:
          type: string
      responses:
        default:
          description: default response
          content:
            application/json: {}
            application/javascript: {}
      summary: Get 5
      x-summary-source: derived
    delete:
      tags:
      - System
      operationId: delete_10
      parameters:
      - name: key
        in: path
        required: true
        schema:
          type: string
      responses:
        default:
          description: default response
          content:
            application/json: {}
            application/javascript: {}
      summary: Delete 10
      x-summary-source: derived
  /api/v1/redis/hash/{key}:
    get:
      tags:
      - System
      operationId: getHash
      parameters:
      - name: key
        in: path
        required: true
        schema:
          type: string
      responses:
        default:
          description: default response
          content:
            application/json: {}
            application/javascript: {}
      summary: Get hash
      x-summary-source: derived
    delete:
      tags:
      - System
      operationId: deleteHash
      parameters:
      - name: key
        in: path
        required: true
        schema:
          type: string
      responses:
        default:
          description: default response
          content:
            application/json: {}
            application/javascript: {}
      summary: Delete hash
      x-summary-source: derived
  /api/v1/redis/echo/{message}:
    get:
      tags:
      - System
      operationId: echo
      parameters:
      - name: message
        in: path
        required: true
        schema:
          type: string
      responses:
        default:
          description: default response
          content:
            application/json: {}
            application/javascript: {}
      summary: Echo
      x-summary-source: derived
  /api/v1/redis/incr/{key}:
    get:
      tags:
      - System
      operationId: getIncrement
      parameters:
      - name: key
        in: path
        required: true
        schema:
          type: string
      responses:
        default:
          description: default response
          content:
            application/json: {}
            application/javascript: {}
      summary: Get increment
      x-summary-source: derived
    put:
      tags:
      - System
      operationId: incrementAsync
      parameters:
      - name: key
        in: path
        required: true
        schema:
          type: string
      responses:
        default:
          description: default response
          content:
            application/json: {}
            application/javascript: {}
      summary: Increment async
      x-summary-source: derived
  /api/v1/redis/ping:
    get:
      tags:
      - System
      operationId: ping
      responses:
        default:
          description: default response
          content:
            application/json: {}
            application/javascript: {}
      summary: Ping
      x-summary-source: derived
  /api/v1/redis:
    put:
      tags:
      - System
      operationId: set_1
      requestBody:
        content:
          '*/*':
            schema:
              $ref: '#/components/schemas/SetForm'
      responses:
        default:
          description: default response
          content:
            application/json: {}
            application/javascript: {}
      summary: Set 1
      x-summary-source: derived
  /api/v1/redis/hash:
    put:
      tags:
      - System
      operationId: setHash
      requestBody:
        content:
          '*/*':
            schema:
              $ref: '#/components/schemas/SetHashForm'
      responses:
        default:
          description: default response
          content:
            application/json: {}
            application/javascript: {}
      summary: Set hash
      x-summary-source: derived
components:
  schemas:
    ResponseEntityViewMapStringObject:
      type: object
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/ErrorEntity'
        entity:
          type: object
          additionalProperties:
            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'
    SetHashForm:
      required:
      - fields
      - key
      type: object
      properties:
        key:
          type: string
        fields:
          type: object
          additionalProperties:
            type: object
    ErrorEntity:
      type: object
      properties:
        errorCode:
          type: string
        message:
          type: string
        fieldName:
          type: string
    Pagination:
      type: object
      properties:
        currentPage:
          type: integer
          format: int32
        perPage:
          type: integer
          format: int32
        totalEntries:
          type: integer
          format: int64
    SetForm:
      required:
      - key
      - value
      type: object
      properties:
        key:
          type: string
        value:
          type: object
    MessageEntity:
      type: object
      properties:
        message:
          type: string