dotCMS

dotCMS Site API

Site management, lifecycle, and configuration endpoints

GitHub OpenAPI

Operations 20

PUT /api/v1/site/{siteId}/_archive Archive a site #
PUT /api/v1/site/_copy Copy a site #
GET /api/v1/site List sites with pagination #
PUT /api/v1/site Update an existing site #
POST /api/v1/site Create a new site #
GET /api/v1/site/currentSite Get the current site for the logged-in user #
GET /api/v1/site/defaultSite Get the default site #
GET /api/v1/site/{siteId} Get a site by its identifier #
DELETE /api/v1/site/{siteId} Delete a site #
GET /api/v1/site/thumbnails Get thumbnails for all sites #
POST /api/v1/site/_byname Find a site by name #
GET /api/v1/site/{siteId}/setup_progress Get site setup progress #
GET /api/v1/site/variable/{siteId} Retrieve the Site Variables for a site #
PUT /api/v1/site/{siteId}/_makedefault Mark a site as the default #
PUT /api/v1/site/{siteId}/_publish Publish a site #
PUT /api/v1/site/variable Save a Site Variable #
PUT /api/v1/site/switch Switch to the user's default site #
PUT /api/v1/site/switch/{id} Switch to a specific site #
PUT /api/v1/site/{siteId}/_unarchive Unarchive a site #
PUT /api/v1/site/{siteId}/_unpublish Unpublish a site #

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-site-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-site-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-site-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: dotCMS REST Site API
  version: '3'
  description: Site management, lifecycle, and configuration endpoints
servers:
- url: /
  description: dotCMS Server
tags:


# --- truncated at 32 KB (37 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/dotcms/refs/heads/main/openapi/dotcms-site-api-openapi.yml