dotCMS

dotCMS Java Script API

JavaScript execution and server-side scripting

GitHub OpenAPI

Operations 18

GET /api/js/{folder} Get #
PUT /api/js/{folder} Put multipart #
POST /api/js/{folder} Post multipart #
DELETE /api/js/{folder} Delete 1 #
PATCH /api/js/{folder} Patch multipart #
GET /api/js/{folder}/{pathParam} Get 1 #
PUT /api/js/{folder}/{pathParam} Put multipart 1 #
POST /api/js/{folder}/{pathParam} Post multipart 1 #
DELETE /api/js/{folder}/{pathParam} Delete 2 #
PATCH /api/js/{folder}/{pathParam} Patch multipart 1 #
GET /api/js/dynamic/{pathParam} Dynamic get 1 #
PUT /api/js/dynamic/{pathParam} Dynamic put 1 #
POST /api/js/dynamic/{pathParam} Dynamic post 1 #
DELETE /api/js/dynamic/{pathParam} Dynamic delete #
PATCH /api/js/dynamic/{pathParam} Dynamic patch #
GET /api/js/dynamic Dynamic get #
PUT /api/js/dynamic Dynamic put #
POST /api/js/dynamic Dynamic post #

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-javascript-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-javascript-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-javascript-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: dotCMS REST Java Script API
  version: '3'
  description: JavaScript execution and server-side scripting
servers:
- url: /
  description: dotCMS Server
tags:
- name: JavaScript
  description: JavaScript execution and server-side scripting
paths:
  /api/js/{folder}:
    get:
      tags:
      - JavaScript
      operationId: get
      parameters:
      - name: folder
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              additionalProperties:
                type: object
      responses:
        default:
          description: default response
          content:
            application/json: {}
            application/xml: {}
            text/plain: {}
      summary: Get
      x-summary-source: derived
    put:
      tags:
      - JavaScript
      operationId: putMultipart
      parameters:
      - name: folder
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/FormDataMultiPart'
      responses:
        default:
          description: default response
          content:
            application/json: {}
            application/xml: {}
            text/plain: {}
      summary: Put multipart
      x-summary-source: derived
    post:
      tags:
      - JavaScript
      operationId: postMultipart
      parameters:
      - name: folder
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/FormDataMultiPart'
      responses:
        default:
          description: default response
          content:
            application/json: {}
            application/xml: {}
            text/plain: {}
      summary: Post multipart
      x-summary-source: derived
    delete:
      tags:
      - JavaScript
      operationId: delete_1
      parameters:
      - name: folder
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              additionalProperties:
                type: object
      responses:
        default:
          description: default response
          content:
            application/json: {}
            application/xml: {}
            text/plain: {}
      summary: Delete 1
      x-summary-source: derived
    patch:
      tags:
      - JavaScript
      operationId: patchMultipart
      parameters:
      - name: folder
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/FormDataMultiPart'
      responses:
        default:
          description: default response
          content:
            application/json: {}
            application/xml: {}
            text/plain: {}
      summary: Patch multipart
      x-summary-source: derived
  /api/js/{folder}/{pathParam}:
    get:
      tags:
      - JavaScript
      operationId: get_1
      parameters:
      - name: folder
        in: path
        required: true
        schema:
          type: string
      - name: pathParam
        in: path
        required: true
        schema:
          pattern: .*
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              additionalProperties:
                type: object
      responses:
        default:
          description: default response
          content:
            application/json: {}
            application/xml: {}
            text/plain: {}
      summary: Get 1
      x-summary-source: derived
    put:
      tags:
      - JavaScript
      operationId: putMultipart_1
      parameters:
      - name: pathParam
        in: path
        required: true
        schema:
          pattern: .*
          type: string
      - name: folder
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/FormDataMultiPart'
      responses:
        default:
          description: default response
          content:
            application/json: {}
            application/xml: {}
            text/plain: {}
      summary: Put multipart 1
      x-summary-source: derived
    post:
      tags:
      - JavaScript
      operationId: postMultipart_1
      parameters:
      - name: pathParam
        in: path
        required: true
        schema:
          pattern: .*
          type: string
      - name: folder
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/FormDataMultiPart'
      responses:
        default:
          description: default response
          content:
            application/json: {}
            application/xml: {}
            text/plain: {}
      summary: Post multipart 1
      x-summary-source: derived
    delete:
      tags:
      - JavaScript
      operationId: delete_2
      parameters:
      - name: folder
        in: path
        required: true
        schema:
          type: string
      - name: pathParam
        in: path
        required: true
        schema:
          pattern: .*
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              additionalProperties:
                type: object
      responses:
        default:
          description: default response
          content:
            application/json: {}
            application/xml: {}
            text/plain: {}
      summary: Delete 2
      x-summary-source: derived
    patch:
      tags:
      - JavaScript
      operationId: patchMultipart_1
      parameters:
      - name: pathParam
        in: path
        required: true
        schema:
          pattern: .*
          type: string
      - name: folder
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/FormDataMultiPart'
      responses:
        default:
          description: default response
          content:
            application/json: {}
            application/xml: {}
            text/plain: {}
      summary: Patch multipart 1
      x-summary-source: derived
  /api/js/dynamic/{pathParam}:
    get:
      tags:
      - JavaScript
      operationId: dynamicGet_1
      parameters:
      - name: pathParam
        in: path
        required: true
        schema:
          pattern: .*
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: string
          text/plain:
            schema:
              type: string
      responses:
        default:
          description: default response
          content:
            application/json: {}
            application/xml: {}
            text/plain: {}
      summary: Dynamic get 1
      x-summary-source: derived
    put:
      tags:
      - JavaScript
      operationId: dynamicPut_1
      parameters:
      - name: pathParam
        in: path
        required: true
        schema:
          pattern: .*
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: string
          text/plain:
            schema:
              type: string
      responses:
        default:
          description: default response
          content:
            application/json: {}
            application/xml: {}
            text/plain: {}
      summary: Dynamic put 1
      x-summary-source: derived
    post:
      tags:
      - JavaScript
      operationId: dynamicPost_1
      parameters:
      - name: pathParam
        in: path
        required: true
        schema:
          pattern: .*
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: string
          text/plain:
            schema:
              type: string
      responses:
        default:
          description: default response
          content:
            application/json: {}
            application/xml: {}
            text/plain: {}
      summary: Dynamic post 1
      x-summary-source: derived
    delete:
      tags:
      - JavaScript
      operationId: dynamicDelete
      parameters:
      - name: pathParam
        in: path
        required: true
        schema:
          pattern: .*
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: string
          text/plain:
            schema:
              type: string
      responses:
        default:
          description: default response
          content:
            application/json: {}
            application/xml: {}
            text/plain: {}
      summary: Dynamic delete
      x-summary-source: derived
    patch:
      tags:
      - JavaScript
      operationId: dynamicPatch
      parameters:
      - name: pathParam
        in: path
        required: true
        schema:
          pattern: .*
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: string
          text/plain:
            schema:
              type: string
      responses:
        default:
          description: default response
          content:
            application/json: {}
            application/xml: {}
            text/plain: {}
      summary: Dynamic patch
      x-summary-source: derived
  /api/js/dynamic:
    get:
      tags:
      - JavaScript
      operationId: dynamicGet
      requestBody:
        content:
          application/json:
            schema:
              type: string
          text/plain:
            schema:
              type: string
      responses:
        default:
          description: default response
          content:
            application/json: {}
            application/xml: {}
            text/plain: {}
      summary: Dynamic get
      x-summary-source: derived
    put:
      tags:
      - JavaScript
      operationId: dynamicPut
      requestBody:
        content:
          application/json:
            schema:
              type: string
          text/plain:
            schema:
              type: string
      responses:
        default:
          description: default response
          content:
            application/json: {}
            application/xml: {}
            text/plain: {}
      summary: Dynamic put
      x-summary-source: derived
    post:
      tags:
      - JavaScript
      operationId: dynamicPost
      requestBody:
        content:
          application/json:
            schema:
              type: string
          text/plain:
            schema:
              type: string
      responses:
        default:
          description: default response
          content:
            application/json: {}
            application/xml: {}
            text/plain: {}
      summary: Dynamic post
      x-summary-source: derived
components:
  schemas:
    FormDataMultiPart:
      type: object
      properties:
        contentDisposition:
          $ref: '#/components/schemas/ContentDisposition'
        entity:
          type: object
        headers:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
        mediaType:
          type: object
          properties:
            type:
              type: string
            subtype:
              type: string
            parameters:
              type: object
              additionalProperties:
                type: string
            wildcardType:
              type: boolean
            wildcardSubtype:
              type: boolean
        messageBodyWorkers:
          $ref: '#/components/schemas/MessageBodyWorkers'
        parent:
          $ref: '#/components/schemas/MultiPart'
        providers:
          type: object
        bodyParts:
          type: array
          items:
            $ref: '#/components/schemas/BodyPart'
        fields:
          type: object
          additionalProperties:
            type: array
            items:
              $ref: '#/components/schemas/FormDataBodyPart'
        parameterizedHeaders:
          type: object
          additionalProperties:
            type: array
            items:
              $ref: '#/components/schemas/ParameterizedHeader'
    BodyPart:
      type: object
      properties:
        contentDisposition:
          $ref: '#/components/schemas/ContentDisposition'
        entity:
          type: object
        headers:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
        mediaType:
          type: object
          properties:
            type:
              type: string
            subtype:
              type: string
            parameters:
              type: object
              additionalProperties:
                type: string
            wildcardType:
              type: boolean
            wildcardSubtype:
              type: boolean
        messageBodyWorkers:
          $ref: '#/components/schemas/MessageBodyWorkers'
        parent:
          $ref: '#/components/schemas/MultiPart'
        providers:
          type: object
        parameterizedHeaders:
          type: object
          additionalProperties:
            type: array
            items:
              $ref: '#/components/schemas/ParameterizedHeader'
    ParameterizedHeader:
      type: object
      properties:
        value:
          type: string
        parameters:
          type: object
          additionalProperties:
            type: string
    ContentDisposition:
      type: object
      properties:
        type:
          type: string
        parameters:
          type: object
          additionalProperties:
            type: string
        fileName:
          type: string
        creationDate:
          type: string
          format: date-time
        modificationDate:
          type: string
          format: date-time
        readDate:
          type: string
          format: date-time
        size:
          type: integer
          format: int64
    FormDataBodyPart:
      type: object
      properties:
        contentDisposition:
          $ref: '#/components/schemas/ContentDisposition'
        entity:
          type: object
        headers:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
        mediaType:
          type: object
          properties:
            type:
              type: string
            subtype:
              type: string
            parameters:
              type: object
              additionalProperties:
                type: string
            wildcardType:
              type: boolean
            wildcardSubtype:
              type: boolean
        messageBodyWorkers:
          $ref: '#/components/schemas/MessageBodyWorkers'
        parent:
          $ref: '#/components/schemas/MultiPart'
        providers:
          type: object
        formDataContentDisposition:
          $ref: '#/components/schemas/FormDataContentDisposition'
        simple:
          type: boolean
        name:
          type: string
        value:
          type: string
        parameterizedHeaders:
          type: object
          additionalProperties:
            type: array
            items:
              $ref: '#/components/schemas/ParameterizedHeader'
    MessageBodyWorkers:
      type: object
    FormDataContentDisposition:
      type: object
      properties:
        type:
          type: string
        parameters:
          type: object
          additionalProperties:
            type: string
        fileName:
          type: string
        creationDate:
          type: string
          format: date-time
        modificationDate:
          type: string
          format: date-time
        readDate:
          type: string
          format: date-time
        size:
          type: integer
          format: int64
        name:
          type: string
    MultiPart:
      type: object
      properties:
        contentDisposition:
          $ref: '#/components/schemas/ContentDisposition'
        entity:
          type: object
        headers:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
        mediaType:
          type: object
          properties:
            type:
              type: string
            subtype:
              type: string
            parameters:
              type: object
              additionalProperties:
                type: string
            wildcardType:
              type: boolean
            wildcardSubtype:
              type: boolean
        messageBodyWorkers:
          $ref: '#/components/schemas/MessageBodyWorkers'
        parent:
          $ref: '#/components/schemas/MultiPart'
        providers:
          type: object
        bodyParts:
          type: array
          items:
            $ref: '#/components/schemas/BodyPart'
        parameterizedHeaders:
          type: object
          additionalProperties:
            type: array
            items:
              $ref: '#/components/schemas/ParameterizedHeader'