dotCMS

dotCMS License API

License management and validation

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

POST /api/license/applyLicense Apply a license key · Apply license #
Ask an LLM
“How do I activate dotCMS by pasting in license text?”
“Can I apply a license key through the REST API instead of the admin screen?”
Tell an agent
Apply license text {licenseText}.
Activate this server with license {licenseText} using {params}.
DELETE /api/license/delete/{params} Delete a license from the pack · Delete 5 #
Ask an LLM
“Can I remove a license from the uploaded license pack?”
“Which call deletes a specific license entry?”
Tell an agent destructive · confirm first
Delete the license identified by {params}.
Remove license {params} from the license pack.
POST /api/license/free/{params} Free a license from a server · Free license #
Ask an LLM
“How do I release a license from a server so another node can use it?”
“Can I free up a license that's assigned to a decommissioned server?”
Tell an agent destructive · confirm first
Free the license given by {params}.
Release the license held by the server in {params} back to the pool.
GET /api/license/all/{params} List all licenses · Get all 1 #
Ask an LLM
“Which licenses are in the pack and which servers are using them?”
“Can I see every license installed on this cluster?”
Tell an agent
List all licenses using {params}.
Show every license and its assignment for {params}.
POST /api/license/pick/{params} Pick a license for this server · Pick license #
Ask an LLM
“Can I choose a specific license from the pack for this server?”
“How do I assign one of the uploaded licenses to the current node?”
Tell an agent
Pick license {params} for this server.
Assign the license in {params} from the pack to the current node.
POST /api/license/upload/{params} Upload a license pack zip · Put zip file #
Ask an LLM
“How do I upload a zip file of cluster licenses?”
“Can I load a whole license pack at once?”
Tell an agent
Upload license pack {file}.
Load the licenses in zip {file} using {params}.
POST /api/license/requestCode/{params} Generate a license request code · Request license #
Ask an LLM
“How do I get the request code needed to obtain a license for this server?”
“Can I generate a license request code through the API?”
Tell an agent
Generate a license request code using {params}.
Create the request code for {params} so I can get a license issued.
POST /api/license/resetLicense/{params} Reset the server's license · Reset license #
Ask an LLM
“Can I reset this server's license back to an unlicensed state?”
“Which call clears the license currently applied?”
Tell an agent destructive · confirm first
Reset the license using {params}.
Clear the applied license on the server given by {params}.

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-license-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:dotcms-license-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-license-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: dotCMS REST License API
  version: '3'
  description: License management and validation
servers:
- url: /
  description: dotCMS Server
tags:
- name: License
  description: License management and validation
paths:
  /api/license/applyLicense:
    post:
      tags:
      - License
      operationId: applyLicense
      parameters:
      - name: params
        in: path
        required: true
        schema:
          type: string
      - name: licenseText
        in: query
        schema:
          type: string
      responses:
        default:
          description: default response
          content:
            '*/*': {}
      summary: Apply license
      x-summary-source: derived
  /api/license/delete/{params}:
    delete:
      tags:
      - License
      operationId: delete_5
      parameters:
      - name: params
        in: path
        required: true
        schema:
          pattern: .*
          type: string
      responses:
        default:
          description: default response
          content:
            '*/*': {}
      summary: Delete 5
      x-summary-source: derived
  /api/license/free/{params}:
    post:
      tags:
      - License
      operationId: freeLicense
      parameters:
      - name: params
        in: path
        required: true
        schema:
          pattern: .*
          type: string
      responses:
        default:
          description: default response
          content:
            '*/*': {}
      summary: Free license
      x-summary-source: derived
  /api/license/all/{params}:
    get:
      tags:
      - License
      operationId: getAll_1
      parameters:
      - name: params
        in: path
        required: true
        schema:
          pattern: .*
          type: string
      responses:
        default:
          description: default response
          content:
            application/json: {}
      summary: Get all 1
      x-summary-source: derived
  /api/license/pick/{params}:
    post:
      tags:
      - License
      operationId: pickLicense
      parameters:
      - name: params
        in: path
        required: true
        schema:
          pattern: .*
          type: string
      responses:
        default:
          description: default response
          content:
            '*/*': {}
      summary: Pick license
      x-summary-source: derived
  /api/license/upload/{params}:
    post:
      tags:
      - License
      operationId: putZipFile
      parameters:
      - name: params
        in: path
        required: true
        schema:
          pattern: .*
          type: string
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                file:
                  $ref: '#/components/schemas/FormDataContentDisposition'
                return:
                  type: string
      responses:
        default:
          description: default response
          content:
            '*/*': {}
      summary: Put zip file
      x-summary-source: derived
  /api/license/requestCode/{params}:
    post:
      tags:
      - License
      operationId: requestLicense
      parameters:
      - name: params
        in: path
        required: true
        schema:
          pattern: .*
          type: string
      responses:
        default:
          description: default response
          content:
            '*/*': {}
      summary: Request license
      x-summary-source: derived
  /api/license/resetLicense/{params}:
    post:
      tags:
      - License
      operationId: resetLicense
      parameters:
      - name: params
        in: path
        required: true
        schema:
          pattern: .*
          type: string
      responses:
        default:
          description: default response
          content:
            '*/*': {}
      summary: Reset license
      x-summary-source: derived
components:
  schemas:
    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