dotCMS REST API
The dotCMS REST API exposes the platform's content management capabilities through HTTP endpoints, allowing developers to create, read, update, and delete content, manage workflows, navigate site hierarchy, perform search queries, and administer users, roles, and permissions. The API is organized into resource groups including Content, Workflow, Search, Navigation, Sites, and User management, and supports authentication via JWT tokens, basic auth, and API keys.
dotCMS REST API is one of 2 APIs that dotCMS publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include CMS, Content, and Content Management. The published artifact set on APIs.io includes API documentation, an OpenAPI specification, and an API reference.
This API exposes 754 operations across 592 paths, organized into 71 resource areas, and defines 606 schemas. It is described by OpenAPI 3.0.1, at version 3.
Requests are made against a single base URL, /.
754 operations
592 paths
606 schemas
98 DELETE336 GET1 OPTIONS11 PATCH170 POST138 PUT
Metadata
The identity and technical contract details declared by the specification.
Paths & Operations 754
Across 592 paths, the API surfaces 754 operations — 98 DELETE, 336 GET, 1 OPTIONS, 11 PATCH, 170 POST, 138 PUT. They span 71 resource areas, including AI, dotAuth, SAML Authentication, Content Type Field, JavaScript, Publishing, Operations, Bundle, and 63 more. Each is listed below with its method, path, parameters, and response codes.
AI 23
AI-powered content generation and analysis endpoints
GET
/api/v1/ai/providers
List dotAI provider configuration metadata
POST
/api/v1/ai/providers/test/{capability}
Test a dotAI provider connection
GET
/api/v1/ai/completions/config
Get AI service configuration
PUT
/api/v1/ai/completions/config
Save AI provider configuration
POST
/api/v1/ai/completions/rawPrompt
Generate AI completions from raw prompt
POST
/api/v1/ai/completions
Generate AI completions from content
GET
/api/v1/ai/embeddings/count
POST
/api/v1/ai/embeddings/count
POST
/api/v1/ai/embeddings
DELETE
/api/v1/ai/embeddings
DELETE
/api/v1/ai/embeddings/db
GET
/api/v1/ai/embeddings/indexCount
GET
/api/v1/ai/embeddings/test
GET
/api/v1/ai/image/generate
POST
/api/v1/ai/image/generate
GET
/api/v1/ai/image/test
GET
/api/v1/ai/search/related
POST
/api/v1/ai/search/related
GET
/api/v1/ai/search
POST
/api/v1/ai/search
GET
/api/v1/ai/search/test
GET
/api/v1/ai/text/generate
POST
/api/v1/ai/text/generate
dotAuth 15
OAuth/OIDC and SAML authentication: per-site configuration (SYSTEMHOST is the global default) and headless OIDC token exchange
POST
/api/v1/dotauth/oauth/exchange
Exchange an OIDC idtoken for a dotAuth session-ref
/api/v1/dotauth/oauth/exchange
GET
/api/v1/dotauth/sites/{hostId}
Get the dotAuth configuration for a site
PUT
/api/v1/dotauth/sites/{hostId}
Save (upsert) the dotAuth configuration for a site
DELETE
/api/v1/dotauth/sites/{hostId}
Clear the dotAuth configuration for a site
PUT
/api/v1/dotauth/headless
Save the system-level headless token-exchange configuration
DELETE
/api/v1/dotauth/headless
Clear the system-level headless token-exchange configuration
POST
/api/v1/dotauth/discover/oidc
Fetch and parse an OIDC discovery document
POST
/api/v1/dotauth/export
Export all dotAuth AppSecrets
POST
/api/v1/dotauth/fetch/saml-metadata
Fetch SAML IdP metadata XML from a URL
GET
/api/v1/dotauth/saml/metadata/{hostId}
Download SAML SP metadata XML for a site
POST
/api/v1/dotauth/import
Import dotAuth AppSecrets
GET
/api/v1/dotauth/sites
List all sites with their dotAuth status
POST
/api/v1/dotauth/sessionrefs/revoke
Revoke all dotAuth sessionRefs
DELETE
/api/v1/dotauth/oauth/session
Invalidate the caller's dotAuth session-ref
SAML Authentication 5
SAML SSO authentication and integration
GET
/api/v1/dotsaml/login/{idpConfigId}
Initiate SAML login
POST
/api/v1/dotsaml/login/{idpConfigId}
Process SAML login callback
GET
/api/v1/dotsaml/logout/{idpConfigId}
Process SAML logout (GET)
POST
/api/v1/dotsaml/logout/{idpConfigId}
Process SAML logout (POST)
GET
/api/v1/dotsaml/metadata/{idpConfigId}
Get SAML metadata
Content Type Field 36
Content type field definitions and configuration
GET
/api/v1/fieldTypes
Get field types
GET
/api/v1/contenttype/{typeId}/fieldsdeprecated
Get content type fields (deprecated)
PUT
/api/v1/contenttype/{typeId}/fieldsdeprecated
Update content type fields (deprecated)
POST
/api/v1/contenttype/{typeId}/fieldsdeprecated
Create content type field (deprecated)
DELETE
/api/v1/contenttype/{typeId}/fieldsdeprecated
Delete multiple fields (deprecated)
GET
/api/v1/contenttype/{typeId}/fields/id/{fieldId}deprecated
Get content type field by ID (deprecated)
PUT
/api/v1/contenttype/{typeId}/fields/id/{fieldId}deprecated
Update content type field by ID (deprecated)
DELETE
/api/v1/contenttype/{typeId}/fields/id/{fieldId}deprecated
Delete content type field by ID (deprecated)
GET
/api/v1/contenttype/{typeId}/fields/var/{fieldVar}deprecated
Get content type field by variable name (deprecated)
PUT
/api/v1/contenttype/{typeId}/fields/var/{fieldVar}deprecated
Update content type field by variable name (deprecated)
DELETE
/api/v1/contenttype/{typeId}/fields/var/{fieldVar}deprecated
Delete content type field by variable name (deprecated)
GET
/api/v1/contenttype/{typeId}/fields/id/{fieldId}/variables
Get field variables by field ID
POST
/api/v1/contenttype/{typeId}/fields/id/{fieldId}/variables
Create field variable by field ID
GET
/api/v1/contenttype/{typeId}/fields/var/{fieldVar}/variables
Get field variables by field variable name
POST
/api/v1/contenttype/{typeId}/fields/var/{fieldVar}/variables
Create field variable by field variable name
GET
/api/v1/contenttype/{typeId}/fields/id/{fieldId}/variables/id/{fieldVarId}
Get specific field variable by field ID
PUT
/api/v1/contenttype/{typeId}/fields/id/{fieldId}/variables/id/{fieldVarId}
Update field variable by field ID
DELETE
/api/v1/contenttype/{typeId}/fields/id/{fieldId}/variables/id/{fieldVarId}
Delete field variable by field ID
GET
/api/v1/contenttype/{typeId}/fields/var/{fieldVar}/variables/id/{fieldVarId}
Get specific field variable by field variable name
PUT
/api/v1/contenttype/{typeId}/fields/var/{fieldVar}/variables/id/{fieldVarId}
Update field variable by field variable name
DELETE
/api/v1/contenttype/{typeId}/fields/var/{fieldVar}/variables/id/{fieldVarId}
Delete field variable by field variable name
GET
/api/v2/contenttype/{typeIdOrVarName}/fieldsdeprecated
PUT
/api/v2/contenttype/{typeIdOrVarName}/fieldsdeprecated
POST
/api/v2/contenttype/{typeIdOrVarName}/fields
DELETE
/api/v2/contenttype/{typeIdOrVarName}/fieldsdeprecated
GET
/api/v2/contenttype/{typeIdOrVarName}/fields/id/{fieldId}
PUT
/api/v2/contenttype/{typeIdOrVarName}/fields/id/{fieldId}
DELETE
/api/v2/contenttype/{typeIdOrVarName}/fields/id/{fieldId}
GET
/api/v2/contenttype/{typeIdOrVarName}/fields/var/{fieldVar}
PUT
/api/v2/contenttype/{typeIdOrVarName}/fields/var/{fieldVar}
DELETE
/api/v2/contenttype/{typeIdOrVarName}/fields/var/{fieldVar}
GET
/api/v3/contenttype/{typeIdOrVarName}/fields/allfields
Returns filtered Content Type fields
GET
/api/v3/contenttype/{typeIdOrVarName}/fields
Gets a Content Type's field layout
DELETE
/api/v3/contenttype/{typeIdOrVarName}/fields
Deletes fields from a Content Type
PUT
/api/v3/contenttype/{typeIdOrVarName}/fields/move
Moves or adds a field to a Content Type
PUT
/api/v3/contenttype/{typeIdOrVarName}/fields/{id}
Updates a field in a Content Type
JavaScript 18
JavaScript execution and server-side scripting
GET
/api/js/{folder}
PUT
/api/js/{folder}
POST
/api/js/{folder}
DELETE
/api/js/{folder}
PATCH
/api/js/{folder}
GET
/api/js/{folder}/{pathParam}
PUT
/api/js/{folder}/{pathParam}
POST
/api/js/{folder}/{pathParam}
DELETE
/api/js/{folder}/{pathParam}
PATCH
/api/js/{folder}/{pathParam}
GET
/api/js/dynamic/{pathParam}
PUT
/api/js/dynamic/{pathParam}
POST
/api/js/dynamic/{pathParam}
DELETE
/api/js/dynamic/{pathParam}
PATCH
/api/js/dynamic/{pathParam}
GET
/api/js/dynamic
PUT
/api/js/dynamic
POST
/api/js/dynamic
Publishing 16
Push publishing job management endpoints
GET
/api/auditPublishing/get/{bundleId}
POST
/api/auditPublishing/getAll
DELETE
/api/v1/publishqueue
POST
/api/v1/bundles/assets
Add assets to a bundle
DELETE
/api/v1/bundles/{bundleId}/assets
Remove assets from an unpushed bundle
GET
/api/v1/publishing/{bundleId}
Get publishing job details
DELETE
/api/v1/publishing/{bundleId}
Delete a publishing job
GET
/api/v1/publishing
List publishing jobs
DELETE
/api/v1/publishing/purge
Bulk delete publishing jobs by status
POST
/api/v1/publishing/push/{bundleId}
Push bundle to environments
POST
/api/v1/publishing/retry
Retry failed or successful bundles
GET
/api/v1/pushpublish/filters/{filterKey}
DELETE
/api/v1/pushpublish/filters/{filterKey}
GET
/api/v1/pushpublish/filters
PUT
/api/v1/pushpublish/filters
POST
/api/v1/pushpublish/filters
Operations 6
GET
/api/layout/{params}
GET
/api/testResource/testGet/{params}
POST
/api/testResource/testPost
GET
/api/v1/system/request-draining-test/status
GET
/api/v1/system/request-draining-test/long-request
GET
/api/v1/system/request-draining-test/simulate-active-requests
Bundle 16
Content bundle management and deployment
POST
/api/bundlePublisher/publish
DELETE
/api/bundle/all
DELETE
/api/bundle/all/fail
DELETE
/api/bundle/all/success
DELETE
/api/bundle/ids
DELETE
/api/bundle/olderthan/{olderThan}
GET
/api/bundle/deleteenvironmentpushhistory/{params}
GET
/api/bundle/deletepushhistory/{params}
GET
/api/bundle/_download/{bundleId}
GET
/api/bundle/{bundleId}/manifest
POST
/api/bundle/_generate
GET
/api/bundle/{bundleId}/assets
GET
/api/bundle/getunsendbundles/{params}
GET
/api/bundle/updatebundle/{params}
POST
/api/bundle
POST
/api/bundle/sync
System Configuration 23
System configuration and company settings
POST
/api/config/deleteEndpointdeprecated
POST
/api/config/deleteEnvironment
POST
/api/config/regenerateKey
POST
/api/config/saveCompanyAuthTypeInfo
POST
/api/config/saveCompanyBasicInfo
POST
/api/config/saveCompanyLocaleInfo
POST
/api/config/saveCompanyLogodeprecated
GET
/api/v1/configuration/branding
Get company configuration
PUT
/api/v1/configuration/branding
Save company basic info and branding
POST
/api/v1/configuration/_regenerateKey
Regenerate company security key
PUT
/api/v1/configuration/authentication
Save company authentication type
PUT
/api/v1/configuration/locale
Save company locale info
GET
/api/v1/appconfiguration
GET
/api/v1/configuration/config
Retrieve whitelisted configuration values
GET
/api/v1/configuration
PUT
/api/v1/configuration
POST
/api/v1/configuration/_validateCompanyEmail
GET
/api/v1/system-table/{key}
DELETE
/api/v1/system-table/{key}
DELETE
/api/v1/system-table/_delete
GET
/api/v1/system-table
PUT
/api/v1/system-table
Updates an existing system table entry
POST
/api/v1/system-table
Saves or updates a system table entry
Cluster Management 5
Cluster nodes and distributed system management
GET
/api/cluster/getESConfigProperties/{params}
GET
/api/cluster/licenseRepoStatus
GET
/api/cluster/getNodesStatus/{params}
POST
/api/cluster/remove/{params}
GET
/api/cluster/test
Content Delivery 8
Content retrieval and manipulation endpoints
PUT
/api/content/canLock/{params}deprecated
Check if a contentlet can be locked (deprecated)
GET
/api/content/{params}
Retrieve content by ID, inode, query, or related content
PUT
/api/content/{params}deprecated
Create or update content via PUT (deprecated)
POST
/api/content/{params}deprecated
Create content via POST (deprecated)
GET
/api/content/indexcount/{query}
Count content matching a Lucene query
GET
/api/content/indexsearch/{query}/sortby/{sortby}/limit/{limit}/offset/{offset}
Search content index by Lucene query
PUT
/api/content/lock/{params}deprecated
Lock a contentlet (deprecated)
PUT
/api/content/unlock/{params}deprecated
Unlock a contentlet (deprecated)
Environment 11
Publishing environment management and configuration
GET
/api/v1/environments/endpoints
Returns the endpoints
POST
/api/v1/environments/endpoints
Creates an endpoint
PUT
/api/v1/environments/endpoints/{id}
Updates an endpoint
DELETE
/api/v1/environments/endpoints/{id}
Deletes an endpoint
GET
/api/v1/environments/endpoints/{endpointId}
Returns the endpoint by id
GET
/api/v1/environments/endpoints/environment/{environmentId}
Returns the endpoints
GET
/api/environment
Returns the environments
POST
/api/environment
Creates an environment
PUT
/api/environment/{id}
Updates an environment
DELETE
/api/environment/{id}
Deletes an environment
GET
/api/environment/loadenvironments/{params}
Data Integrity 8
Data integrity checking and conflict resolution
GET
/api/integrity/checkintegrity/{params}
GET
/api/integrity/checkIntegrityProcessStatus/{params}
GET
/api/integrity/discardconflicts/{params}
GET
/api/integrity/fixconflicts/{params}
POST
/api/integrity/_fixconflictsfromremote
POST
/api/integrity/_generateintegritydata
GET
/api/integrity/{requestId}/integrityData
GET
/api/integrity/getIntegrityResult/{params}
Portlets 12
Portlet management and administration
GET
/api/portlet/layout/{params}
GET
/api/portlet/{params}
POST
/api/portlet/{params}
PUT
/api/v1/portlet/custom/{portletId}/_addtolayout/{layoutId}
DELETE
/api/v1/portlet/custom/{portletId}
DELETE
/api/v1/portlet/portletId/{portletId}
DELETE
/api/v1/portlet/portletId/{portletId}/roleId/{roleId}
GET
/api/v1/portlet/{portletId}/_doesuserhaveaccess
GET
/api/v1/portlet/{portletId}
GET
/api/v1/portlet/_actionurl/{contentTypeVariable}
PUT
/api/v1/portlet/custom
POST
/api/v1/portlet/custom
License 8
License management and validation
POST
/api/license/applyLicense
DELETE
/api/license/delete/{params}
POST
/api/license/free/{params}
GET
/api/license/all/{params}
POST
/api/license/pick/{params}
POST
/api/license/upload/{params}
POST
/api/license/requestCode/{params}
POST
/api/license/resetLicense/{params}
OSGi Plugins 15
OSGi plugin management and dynamic deployment
GET
/api/osgi/getInstalledBundles/{params}deprecated
GET
/api/osgi/_processExports/{bundle}deprecated
POST
/api/osgideprecated
PUT
/api/v1/osgi/jar/{jar}/_deploy
deploys bundle
GET
/api/v1/osgi/available-plugins
get available plugins
GET
/api/v1/osgi/extra-packages
get extra packages
PUT
/api/v1/osgi/extra-packages
modify extra packages
GET
/api/v1/osgi
Returns a list of all bundles installed
POST
/api/v1/osgi
Upload bundles to the OSGI framework
GET
/api/v1/osgi/dotsystem
Returns the dot system list of all bundles installed
GET
/api/v1/osgi/_processExports/{bundle}
Process exports
PUT
/api/v1/osgi/_restart
restarts the OSGI framework
PUT
/api/v1/osgi/jar/{jar}/_start
starts bundle
PUT
/api/v1/osgi/jar/{jar}/_stop
stops bundle
DELETE
/api/v1/osgi/jar/{jar}
Undeploys bundle
Administration 10
System administration and management tools
GET
/api/restexample/layout/{params}
GET
/api/restexample/test/{params}
GET
/api/util/encodeQueryParamValue/{params}
GET
/api/ws/v1/system/events
GET
/api/ws/v1/system/syncevents
GET
/api/v1/jvm
PUT
/api/v1/toolgroups/{layoutId}/_addtouser
PUT
/api/v1/toolgroups/{layoutId}/_removefromuser
GET
/api/v1/toolgroups/{layoutId}/_userHasLayout
GET
/api/v1/telemetry/stats
Retrieves dotCMS usage data
Roles 19
User role and permission management
GET
/api/role/loadbyid/{params}deprecated
Load role by ID (deprecated)
GET
/api/role/loadbyname/{params}deprecated
Load roles by name filter (deprecated)
GET
/api/role/loadchildren/{params}deprecated
Load role children (deprecated)
GET
/api/v1/roles
Load root roles
POST
/api/v1/roles
Create new role
POST
/api/v1/roles/{roleid}/users/{userId}
Grant a role to a user
GET
/api/v1/roles/checkuserroles/userid/{userId}/roleids/{roleIds}
Check user roles
GET
/api/v1/roles/{roleid}
Load role by role ID
PUT
/api/v1/roles/{roleid}
Update a role
DELETE
/api/v1/roles/{roleid}
Delete a role
GET
/api/v1/roles/layouts
Get all layouts
POST
/api/v1/roles/layouts
Save role layouts
DELETE
/api/v1/roles/layouts
Delete role layouts
GET
/api/v1/roles/{roleId}/layouts
Find role layouts
GET
/api/v1/roles/users/{userIdOrEmail}
Load user roles
GET
/api/v1/roles/{roleid}/rolehierarchyanduserroles
Load users and roles by role ID
GET
/api/v1/roles/{roleid}/users
Get the users directly granted a role
DELETE
/api/v1/roles/{roleid}/users
Remove users from a role
GET
/api/v1/roles/_search
Search Roles
Rules Engine 26
Business rules and conditional logic management
GET
/api/rulesengine/layout/{params}
GET
/api/v1/sites/{siteId}/ruleengine/rules
POST
/api/v1/sites/{siteId}/ruleengine/rules
GET
/api/v1/sites/{siteId}/ruleengine/rules/{ruleId}
PUT
/api/v1/sites/{siteId}/ruleengine/rules/{ruleId}
DELETE
/api/v1/sites/{siteId}/ruleengine/rules/{ruleId}
POST
/api/v1/sites/{siteId}/ruleengine/actions
GET
/api/v1/sites/{siteId}/ruleengine/actions/{actionId}
PUT
/api/v1/sites/{siteId}/ruleengine/actions/{actionId}
DELETE
/api/v1/sites/{siteId}/ruleengine/actions/{actionId}
GET
/api/v1/sites/{siteId}/ruleengine/rules/{ruleId}/conditionGroups
POST
/api/v1/sites/{siteId}/ruleengine/rules/{ruleId}/conditionGroups
DELETE
/api/v1/sites/{siteId}/ruleengine/rules/{ruleId}/conditionGroups/{conditionGroupId}
GET
/api/v1/sites/{siteId}/ruleengine/rules/{ruleId}/conditionGroups/{groupId}
PUT
/api/v1/sites/{siteId}/ruleengine/rules/{ruleId}/conditionGroups/{groupId}
POST
/api/v1/sites/{siteId}/ruleengine/conditions
GET
/api/v1/sites/{siteId}/ruleengine/conditions/{conditionId}
PUT
/api/v1/sites/{siteId}/ruleengine/conditions/{conditionId}
DELETE
/api/v1/sites/{siteId}/ruleengine/conditions/{conditionId}
GET
/api/v1/sites/{siteId}/ruleengine/conditions/{conditionId}/conditionValues
POST
/api/v1/sites/{siteId}/ruleengine/conditions/{conditionId}/conditionValues
GET
/api/v1/sites/{siteId}/ruleengine/conditions/{conditionId}/conditionValues/{valueId}
PUT
/api/v1/sites/{siteId}/ruleengine/conditions/{conditionId}/conditionValues/{valueId}
DELETE
/api/v1/sites/{siteId}/ruleengine/conditions/{conditionId}/conditionValues/{valueId}
GET
/api/v1/system/ruleengine/actionlets
GET
/api/v1/system/ruleengine/conditionlets
Content Type 11
Content type definitions and schema management
GET
/api/structure/{path}
POST
/api/v1/contenttype/{baseVariableName}/_copy
Copies a content type
GET
/api/v1/contenttype
Retrieves a list of content types
POST
/api/v1/contenttype
Creates one or more content types
GET
/api/v1/contenttype/id/{idOrVar}
Retrieves a single content type
PUT
/api/v1/contenttype/id/{idOrVar}
Updates a content type
DELETE
/api/v1/contenttype/id/{idOrVar}
Deletes a content type
POST
/api/v1/contenttype/_filter
Filters content types
GET
/api/v1/contenttype/basetypes
Retrieves base content types
GET
/api/v1/contenttype/render/id/{idOrVar}
Retrieves a single content type with their rendered custom fields
PATCH
/api/v1/contenttype/id/{idOrVar}/metadata
Updates the metadata of a Content Type
Tag (v1) 10
Legacy tag management endpoints (deprecated - use v2 TagResource instead)
GET
/api/v1/tagsdeprecated
List or search tags (deprecated)
PUT
/api/v1/tagsdeprecated
Update a tag (deprecated)
POST
/api/v1/tagsdeprecated
Create tags (deprecated)
DELETE
/api/v1/tags/{tagId}deprecated
Delete a tag by ID (deprecated)
GET
/api/v1/tags/inode/{inode}deprecated
Get tags by inode (deprecated)
DELETE
/api/v1/tags/inode/{inode}deprecated
Remove all tag-inode links for an inode (deprecated)
GET
/api/v1/tags/{nameOrId}deprecated
Get tags by name or ID (deprecated)
GET
/api/v1/tags/user/{userId}deprecated
Get tags by user ID (deprecated)
POST
/api/v1/tags/importdeprecated
Import tags from file (deprecated)
PUT
/api/v1/tags/tag/{nameOrId}/inode/{inode}deprecated
Link tags to an inode (deprecated)
Users 13
User account management and administration
GET
/api/user/getloggedinuser/{params}deprecated
Get logged in user (deprecated)
PATCH
/api/v1/users/activate/{userId}
Active an existing user.
PUT
/api/v1/users
Update an existing user.
POST
/api/v1/users
Create user
PATCH
/api/v1/users/deactivate/{userId}
Deactivate an existing user.
GET
/api/v1/users/{userId}
Find an user
DELETE
/api/v1/users/{userId}
Deletes an existing user.
GET
/api/v1/users/filter
Filter users
POST
/api/v1/users/loginas
Login as user
GET
/api/v1/users/loginAsData
Get login as data
PUT
/api/v1/users/logoutas
Logout as user
GET
/api/v1/users/current
Get current user
PUT
/api/v1/users/current
Update current user
Widgets 1
Widget development and rendering
GET
/api/widget/{params}
Accessibility Agent 3
Streaming a11y-fix agent proxy
POST
/api/v1/agents/a11y/fix
Run the accessibility fix agent on a page
POST
/api/v1/agents/a11y/fix/stream
Run the accessibility fix agent, streaming progress over SSE
POST
/api/v1/agents/a11y/stop
Stop an in-flight accessibility fix run
Accessibility Checker 4
Endpoints that perform operations related to validating accessibility in content.
GET
/api/v1/achecker/guidelines
Retrieves Accessibility Guidelines
POST
/api/v1/achecker/_validate
Validates content
POST
/api/v1/page-scanner/a11y/check
POST
/api/v1/page-scanner/geo/check
Content Analytics 3
Proxy endpoints that forward analytics requests to the dot-ca-event-manager service.
GET
/api/v1/analytics/content/siteauth/generate/{siteId}
Generate Site Auth
POST
/api/v1/analytics/content/event
Proxy analytics event ingest with site auth validation
GET
/api/v1/analytics/{path}
Proxy any analytics GET request
Announcements 1
System announcements and notifications
GET
/api/v1/announcements
Apps 12
Third-party application integration and configuration
GET
/api/v1/apps
POST
/api/v1/apps
DELETE
/api/v1/apps
GET
/api/v1/apps/{key}/{siteId}
PUT
/api/v1/apps/{key}/{siteId}
POST
/api/v1/apps/{key}/{siteId}
DELETE
/api/v1/apps/{key}/{siteId}
GET
/api/v1/apps/{key}
DELETE
/api/v1/apps/{key}
POST
/api/v1/apps/export
POST
/api/v1/apps/import
GET
/api/v1/ema
Web Assets 8
Web asset management and operations
POST
/api/v1/assets/_archive
Archive asset
PUT
/api/v1/assets/folders
Update existing folder
POST
/api/v1/assets/folders
Create new folder
POST
/api/v1/assets/_delete
Delete asset permanently
POST
/api/v1/assets/folders/_delete
Delete folder permanently
POST
/api/v1/assets/_download
Download asset file
PUT
/api/v1/assets
Upload or update asset file
POST
/api/v1/assets
Get asset information by path
API Token 7
API token management and authentication
DELETE
/api/v1/apitoken/{tokenId}
Deletes an API token
GET
/api/v1/apitoken/{userId}/tokens
Retrieves API tokens based on a user ID
GET
/api/v1/apitoken/expiring
Retrieves API tokens that are about to expire
GET
/api/v1/apitoken/{tokenId}/jwt
Generates a new JWT for an existing token
PUT
/api/v1/apitoken/remote
Generates a remote API token
POST
/api/v1/apitoken
Issues an API token
PUT
/api/v1/apitoken/{tokenId}/revoke
Revokes an API token
Authentication 6
POST
/api/v1/authentication
Verifies user or application authentication
GET
/api/v1/authentication/logInUser
Retrieves user data
POST
/api/v1/forgotpassword
Send password reset email
POST
/api/v1/loginform
Get login form configuration
GET
/api/v1/logout
Logout user
POST
/api/v1/changePassword
Reset user password
Browser Tree 5
File and folder browser tree operations
POST
/api/v1/browser
GET
/api/v1/browser/selectedfolder
PUT
/api/v1/browser/selectedfolder
GET
/api/v1/browsertree/sitename/{sitename}/urideprecated
GET
/api/v1/browsertree/sitename/{sitename}/uri/{uri}deprecated
Categories 10
Content categorization and taxonomy
GET
/api/v1/categories
Get paginated list of categories
PUT
/api/v1/categories
Update an existing category
POST
/api/v1/categories
Create a new category
DELETE
/api/v1/categories
Delete categories by inodes
GET
/api/v1/categories/_export
Export categories as CSV
GET
/api/v1/categories/{idOrKey}
Get a category by ID or key
GET
/api/v1/categories/children
Get children of a category
POST
/api/v1/categories/hierarchy
Get category hierarchy for multiple categories
POST
/api/v1/categories/_import
Import categories from a CSV file
PUT
/api/v1/categories/_sort
Update category sort order
Containers 21
Endpoints for managing Container objects and their content
PUT
/api/v1/containers/_archive
Archives a container
PUT
/api/v1/containers/_bulkarchive
Archives multiple containers
DELETE
/api/v1/containers/_bulkdelete
Deletes multiple containers
PUT
/api/v1/containers/_bulkpublish
Publishes multiple containers
PUT
/api/v1/containers/_bulkunarchive
Unarchives multiple containers
PUT
/api/v1/containers/_bulkunpublish
Unpublishes multiple containers
GET
/api/v1/containers/{containerId}/content/{contentletId}
Renders content HTML within a container
GET
/api/v1/containers/content/{contentletId}
Renders content HTML with container ID as query param
GET
/api/v1/containers/{containerId}/form/{formId}
Renders a form within a container
GET
/api/v1/containers/form/{formId}
Renders a form with container ID as query param
POST
/api/v1/containers/{id}/_copy
Copies a container to the current host
GET
/api/v1/containers
Retrieves a paginated list of Containers
PUT
/api/v1/containers
Updates an existing container
POST
/api/v1/containers
Creates a new container
DELETE
/api/v1/containers
Deletes a container
GET
/api/v1/containers/live
Retrieves a live container by ID
GET
/api/v1/containers/working
Retrieves a working container by ID
PUT
/api/v1/containers/_publish
Publishes a container
DELETE
/api/v1/containers/delete/{containerId}/content/{contentletId}/uid/{uid}
Removes content from a container
PUT
/api/v1/containers/_unarchive
Unarchives a container
PUT
/api/v1/containers/_unpublish
Unpublishes a container
Content 20
Endpoints for managing content and contentlets - the core data objects in dotCMS
GET
/api/v1/contentrelationships/{params}deprecated
Get content with relationships (deprecated)
GET
/api/v1/content/_canlock/{inodeOrIdentifier}
Check if a contentlet can be locked
GET
/api/v1/content/{identifier}/languages
Check content language versions
GET
/api/v1/content/{identifier}/references/count
Get contentlet references count
GET
/api/v1/content/{inodeOrIdentifier}
Retrieves a contentlet by identifier or inode
GET
/api/v1/content/{inodeOrIdentifier}/references
Get contentlet references
GET
/api/v1/content/{identifier}/push/history
Contentlet Push History
PUT
/api/v1/content/_lock/{inodeOrIdentifier}
Lock a given contentlet by the current user
POST
/api/v1/content/related
Pull Related Content
PUT
/api/v1/content/_refresh/{identifierOrInode}
Refresh a contentlet
PUT
/api/v1/content/_draft
Saves a content draft
POST
/api/v1/content/search
Retrieves content from the dotCMS repository
PUT
/api/v1/content/_unlock/{inodeOrIdentifier}
Unlock a given contentlet by the current user
POST
/api/v1/content/_search
Search content with Lucene syntax
GET
/api/v1/content/versions/{inode}
Find content by inode
GET
/api/v1/content/versions
Find content versions
GET
/api/v1/content/versions/id/{identifier}/history
Contentlet History
GET
/api/v1/content/resourcelinks/field/{field}
Get resource link for specific field
GET
/api/v1/content/resourcelinks
Get all resource links for contentlet
POST
/api/v1/content/_bulkrefresh
Reindex a selection of contentlets
Content Report 2
Content reporting and analytics
GET
/api/v1/contentreport/folder/{folder}
Generate folder content report
GET
/api/v1/contentreport/site/{site}
Generate site content report
Content Import 12
GET
/api/v1/content/_import/abandoned
Retrieves abandoned content import jobs
GET
/api/v1/content/_import/active
Retrieves active content import jobs
POST
/api/v1/content/_import/{jobId}/cancel
Cancel a content import job
GET
/api/v1/content/_import/canceled
Retrieves canceled content import jobs
GET
/api/v1/content/_import/completed
Retrieves completed content import jobs
GET
/api/v1/content/_import/failed
Retrieves failed content import jobs
GET
/api/v1/content/_import/{jobId}
Retrieves the status of a content import job
GET
/api/v1/content/_import
Retrieves content import jobs
POST
/api/v1/content/_import
Imports content from a CSV file
GET
/api/v1/content/_import/{jobId}/monitor
Monitor a content import job in real-time
GET
/api/v1/content/_import/successful
Retrieves successful content import jobs
POST
/api/v1/content/_import/_validate
Validates content import from a CSV file
getPagesContentTypes 1
Returns the content types valid for a page based on the container/types on the layout
GET
/api/v1/contenttype/page
Retrieves a list of content types for a page
Experiment 18
POST
/api/v1/experiments/{experimentId}/variants
PUT
/api/v1/experiments/{experimentId}/_archive
POST
/api/v1/experiments/scheduled/{experimentId}/_cancel
GET
/api/v1/experiments
POST
/api/v1/experiments
DELETE
/api/v1/experiments/{experimentId}
PATCH
/api/v1/experiments/{experimentId}
DELETE
/api/v1/experiments/{experimentId}/goals/primary
DELETE
/api/v1/experiments/{experimentId}/targetingConditions/{id}
PUT
/api/v1/experiments/{experimentId}/variants/{name}
DELETE
/api/v1/experiments/{experimentId}/variants/{name}
POST
/api/v1/experiments/{experimentId}/_end
GET
/api/v1/experiments/{id}
GET
/api/v1/experiments/{id}/results
GET
/api/v1/experiments/health
POST
/api/v1/experiments/isUserIncluded
PUT
/api/v1/experiments/{experimentId}/variants/{name}/_promote
POST
/api/v1/experiments/{experimentId}/_start
File Assets 5
File asset management and download operations
GET
/api/v1/content/fileassets/{inode}/resourcelink
GET
/api/v2/assets/{identifier}
Get raw file-asset content by identifier
GET
/api/v2/assets
Get raw file-asset content by path
PUT
/api/v2/assets/publish
Publish file asset (working + live)
PUT
/api/v2/assets/save
Save file asset (working version)
Folders 8
Endpoints for managing folder structure and organization
POST
/api/v1/folder/createfolders/{siteName}
Create folders by paths on a site
DELETE
/api/v1/folder/{siteName}
Delete one or more path for a site
GET
/api/v1/folder/{folderId}
Find a folder by ID
POST
/api/v1/folder/byPathdeprecated
Find subfolders by path (deprecated)
GET
/api/v1/folder/siteId/{siteId}/path/{path}
Load folder and subfolders by path
GET
/api/v1/folder/sitename/{siteName}/uri/{uri}
Load a folder by site name and URI
GET
/api/v1/folder/search
Search folders
PUT
/api/v1/folder/{id}/file-browser-selected
Select folder in file browser
Forms 1
Form management and processing
GET
/api/v1/form/{idOrVar}/successCallback
Health 8
Health management and monitoring endpoints for administrative dashboards
GET
/api/v1/health/check/{checkName}
Get specific health check result
GET
/api/v1/health/checks
Get all health check names
GET
/api/v1/health/liveness
Get liveness health status
GET
/api/v1/health
Get overall health status
GET
/api/v1/health/readiness
Get readiness health status
GET
/api/v1/health/status
Get system status summary
POST
/api/v1/health/refresh/{checkName}
Force refresh a specific health check
POST
/api/v1/health/refresh
Force refresh all health checks
Search Index 19
Elasticsearch index management and operations
PUT
/api/v1/esindex/activate/{params}deprecated
PUT
/api/v1/esindex/clear/{params}deprecated
PUT
/api/v1/esindex/close/{params}deprecated
PUT
/api/v1/esindex/create/{params}deprecated
PUT
/api/v1/esindex/deactivate/{params}deprecated
GET
/api/v1/esindex/failed
DELETE
/api/v1/esindex/failed
PUT
/api/v1/esindex/{indexName}
DELETE
/api/v1/esindex/{indexName}
DELETE
/api/v1/esindex/cache
GET
/api/v1/esindex/active/{params}deprecated
GET
/api/v1/esindex/cluster
GET
/api/v1/esindex
GET
/api/v1/esindex/reindex
POST
/api/v1/esindex/reindex
DELETE
/api/v1/esindex/reindex
GET
/api/v1/esindex/indexlist/{params}
PUT
/api/v1/esindex/open/{params}deprecated
POST
/api/v1/esindex/optimize
Job Queue 14
Endpoints for managing background jobs and job queues
GET
/api/v1/jobs/abandoned
Retrieves abandoned jobs
GET
/api/v1/jobs/active
Retrieves active jobs
GET
/api/v1/jobs/{queueName}/active
Retrieves active jobs in a queue
POST
/api/v1/jobs/{jobId}/cancel
Cancel a job
GET
/api/v1/jobs/canceled
Retrieves canceled jobs
GET
/api/v1/jobs/completed
Retrieves completed jobs
POST
/api/v1/jobs/{queueName}/upload
Creates a new job with form data
POST
/api/v1/jobs/{queueName}
Creates a new job with JSON parameters
GET
/api/v1/jobs/failed
Retrieves failed jobs
GET
/api/v1/jobs/{jobId}/status
Retrieves job status information
GET
/api/v1/jobs/queues
Retrieves available job queues
GET
/api/v1/jobs
Retrieves jobs
GET
/api/v1/jobs/{jobId}/monitor
Monitor a job in real time
GET
/api/v1/jobs/successful
Retrieves successful jobs
Language 2
Language configuration and management
POST
/api/v1/languages/i18n
Get internationalized messages
GET
/api/v1/languages
List all available languages
Maintenance 26
System maintenance and administration operations
DELETE
/api/v1/maintenance/_contentlets
Bulk delete contentlets by identifier
DELETE
/api/v1/maintenance/_pushedAssets
Delete all pushed assets records
DELETE
/api/v1/maintenance/_systemJobs/{group}/{name}
Delete a Quartz scheduler job
GET
/api/v1/maintenance/_downloadAssets
GET
/api/v1/maintenance/_downloadClusterLog/{fileName}
GET
/api/v1/maintenance/_downloadDb
GET
/api/v1/maintenance/_downloadLog/{fileName}
GET
/api/v1/maintenance/_downloadStarter
GET
/api/v1/maintenance/_downloadStarterWithAssets
DELETE
/api/v1/maintenance/_oldVersions
Drop old asset versions
GET
/api/v1/maintenance/assets/_clean
Get latest clean-assets job
POST
/api/v1/maintenance/assets/_clean
Request a clean-assets job
GET
/api/v1/maintenance/assets/_fix
Get latest fix-assets job
POST
/api/v1/maintenance/assets/_fix
Request a fix-assets job
GET
/api/v1/maintenance/_threads
JVM thread dump
GET
/api/v1/maintenance/_threads/info
JVM thread info
GET
/api/v1/maintenance/_pgDumpAvailable
GET
/api/v1/maintenance/_sessions
List active HTTP sessions
DELETE
/api/v1/maintenance/_sessions
Invalidate all sessions except the caller's
DELETE
/api/v1/maintenance/_sessions/{token}
Invalidate a single session
GET
/api/v1/maintenance/_systemJobs
List Quartz scheduler jobs
POST
/api/v1/maintenance/_searchAndReplace
Database-wide search and replace
DELETE
/api/v1/maintenance/_shutdown
DELETE
/api/v1/maintenance/_shutdownCluster
POST
/api/v1/upgradetask
DELETE
/api/v1/caches/menucache
Deletes the menu cache
Navigation 2
Site navigation tree endpoints
GET
/api/v1/menu
GET
/api/v1/nav/{uri}
Get site navigation tree
Notifications 5
User notifications and alerts management
PUT
/api/v1/notification/delete
DELETE
/api/v1/notification/id/{id}
GET
/api/v1/notification/getNewNotificationsCount
GET
/api/v1/notification/getNotifications/{params}
PUT
/api/v1/notification/markAsRead
Page 18
Page rendering, layout management, and content operations
POST
/api/v1/page/{pageId}/content
Replace the content mapping of a page
GET
/api/v1/page/{pageId}/languagesdeprecated
Check page availability by language (deprecated)
POST
/api/v1/page/_check-permission
Check user permission on a page
PUT
/api/v1/page/copyContent
Copy a contentlet on a page
PUT
/api/v1/page/{pageId}/_deepcopy
Deep copy a page and all its content
POST
/api/v1/page/actions
Find available workflow actions for a page
GET
/api/v1/page/{pageId}/content/tree
Get the multi-tree content structure of a page
GET
/api/v1/page/{pageId}/render/versions
Get live and preview render versions of a page
GET
/api/v1/page/types
Get content types associated with pages
GET
/api/v1/page/{pageId}/personas
Get personalized personas for a page
GET
/api/v1/page/_render-sources/{uri}
Get render sources for a page
GET
/api/v1/page/json/{uri}
Get page metadata as JSON by URI
GET
/api/v1/page/render/{uri}
Get rendered page metadata by URI
GET
/api/v1/page/renderHTML/{uri}
Render page as raw HTML
POST
/api/v1/page/layout
Saves a page template
POST
/api/v1/page/{pageId}/layout
Links template and page
GET
/api/v1/page/search
Search pages by path
PUT
/api/v1/page/{pageId}/styles
Update contentlet styles in a page
Personalization 4
Content personalization and persona management
POST
/api/v1/personalization/pagepersonas
Personalize page containers
DELETE
/api/v1/personalization/pagepersonas/page/{pageId}/personalization/{personalization}
Delete page personalization
GET
/api/personas/layout/{params}
GET
/api/personas/sites/{id}
Personas 2
Content persona management and targeting
GET
/api/v1/personas
List personas
GET
/api/v1/personas/{id}
Get persona by ID
Relationships 2
Content relationship management
GET
/api/v1/relationships/cardinalities
GET
/api/v1/relationships
Workflow 57
Endpoints that perform operations related to workflows.
POST
/api/v1/report-issue
Report a dotCMS UI issue
POST
/api/v1/workflow/actions/separator
Creates workflow action separator
POST
/api/v1/workflow/steps
Add a new workflow step
POST
/api/v1/workflow/schemes/{schemeId}/copy
Copy a workflow scheme
GET
/api/v1/workflow/actions/{actionId}
Find action by ID
PUT
/api/v1/workflow/actions/{actionId}
Update an existing workflow action
DELETE
/api/v1/workflow/actions/{actionId}
Delete a workflow action
GET
/api/v1/workflow/steps/{stepId}/actions/{actionId}
Find a workflow action within a step
DELETE
/api/v1/workflow/steps/{stepId}/actions/{actionId}
Remove a workflow action from a step
DELETE
/api/v1/workflow/actionlets/{actionletId}
Remove an actionlet from a workflow action
PUT
/api/v1/workflow/schemes/{schemeId}
Update a workflow scheme
DELETE
/api/v1/workflow/schemes/{schemeId}
Delete a workflow scheme
GET
/api/v1/workflow/steps/{stepId}
Retrieves a workflow step
PUT
/api/v1/workflow/steps/{stepId}
Update an existing workflow step
DELETE
/api/v1/workflow/steps/{stepId}
Delete a workflow step
DELETE
/api/v1/workflow/system/actions/{identifier}
Delete default system action binding by action id
GET
/api/v1/workflow/actions/{actionId}/condition
Find condition by action ID
GET
/api/v1/workflow/schemes/{schemeIdOrVariable}/export
Export a workflow scheme
GET
/api/v1/workflow/actionlets
Find all workflow actionlets
GET
/api/v1/workflow/actions/{actionId}/actionlets
Find workflow actionlets by workflow action
POST
/api/v1/workflow/actions/{actionId}/actionlets
Adds an actionlet to a workflow action
GET
/api/v1/workflow/schemes/{schemeId}/actions
Find all actions in a workflow scheme
POST
/api/v1/workflow/schemes/actions/{systemAction}
Finds workflow actions by schemes and system action
GET
/api/v1/workflow/steps/{stepId}/actions
Find all actions in a workflow step
POST
/api/v1/workflow/steps/{stepId}/actions
Adds a workflow action to a workflow step
GET
/api/v1/workflow/schemes/schemescontenttypes/{contentTypeId}
Find workflow schemes by content type id
GET
/api/v1/workflow/contenttypes/schemes
Find workflow schemes for multiple content types
GET
/api/v1/workflow/contentlet/{inode}/actions
Finds workflow actions by content inode
GET
/api/v1/workflow/defaultactions/contenttype/{contentTypeId}
Find possible default actions by content type
GET
/api/v1/workflow/defaultactions/schemes
Find possible default actions by scheme(s)
GET
/api/v1/workflow/initialactions/contenttype/{contentTypeId}
Find initial actions by content type
GET
/api/v1/workflow/schemes
Find workflow schemes
POST
/api/v1/workflow/schemes
Create a workflow scheme
GET
/api/v1/workflow/schemes/{schemeId}/steps
Find steps by workflow scheme ID
GET
/api/v1/workflow/contenttypes/{contentTypeVarOrId}/system/actions
Find default system actions mapped to a content type
GET
/api/v1/workflow/schemes/{schemeId}/system/actions
Find default system actions mapped to a workflow scheme
PUT
/api/v1/workflow/actions/firemultipart
Fire action by name (multipart form)
PUT
/api/v1/workflow/actions/fire
Fire workflow action by name
PUT
/api/v1/workflow/actions/default/firemultipart/{systemAction}
Fire default action (multipart form)
PUT
/api/v1/workflow/actions/default/fire/{systemAction}
Fire system action by name
POST
/api/v1/workflow/actions/default/fire/{systemAction}
Fire system action by name over multiple contentlets
PATCH
/api/v1/workflow/actions/default/fire/{systemAction}
Modify specific fields on multiple contentlets
PUT
/api/v1/workflow/actions/{actionId}/firemultipart
Fire action by ID (multipart form)
PUT
/api/v1/workflow/actions/{actionId}/fire
Fire action by ID
POST
/api/v1/workflow/contentlet/actions/_bulkfire
Perform workflow actions on bulk content
PUT
/api/v1/workflow/contentlet/actions/bulk/fire
Perform workflow actions on bulk content
POST
/api/v1/workflow/contentlet/actions/bulk
Finds available bulk workflow actions for content
GET
/api/v1/workflow/status/{contentletInode}
Find workflow status of content
GET
/api/v1/workflow/system/actions/{workflowActionId}
Find default system actions by workflow action id
POST
/api/v1/workflow/tasks
Find workflow tasks based on filter parameters
GET
/api/v1/workflow/tasks/history/comments/{contentletIdentifier}
Find workflow tasks history and comments of content
POST
/api/v1/workflow/schemes/import
Import a workflow scheme
PUT
/api/v1/workflow/reorder/steps/{stepId}/actions/{actionId}
Change the order of actions within a workflow step
PUT
/api/v1/workflow/reorder/step/{stepId}/order/{order}
Change the order of steps within a scheme
POST
/api/v1/workflow/actions
Creates/saves a workflow action
POST
/api/v1/workflow/{contentletId}/comments
Create a workflow comment
PUT
/api/v1/workflow/system/actions
Save a default system action mapping
Site 20
Site management, lifecycle, and configuration endpoints
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
Cache Management 11
Cache provider management and operations
DELETE
/api/v1/caches/provider/{provider}/flush
Flush all caches
DELETE
/api/v1/caches/provider/{provider}/flush/{group}
DELETE
/api/v1/caches/provider/{provider}/flush/{group}/{id}
DELETE
/api/v1/caches/region/{regionName}
Flush a cache region
GET
/api/v1/caches/stats
Get cache statistics
GET
/api/v1/caches/provider/{provider}/keys/{group}
GET
/api/v1/caches
List cache region names
GET
/api/v1/caches/provider/{provider}/object/{group}/{id}
GET
/api/v1/caches/provider/{provider}/objects/{group}
GET
/api/v1/caches/providers/{group}
GET
/api/v1/caches/provider/{provider}/{group}
Internationalization 14
Language management and localization
GET
/api/v1/system/i18n/{lang}/{rsrc}
PUT
/api/v2/languages/{languageId}
DELETE
/api/v2/languages/{languageId}
GET
/api/v2/languages/id/{languageid}
GET
/api/v2/languages/{language}/keys
GET
/api/v2/languages/_getdefault
GET
/api/v2/languages/{languageTag}
POST
/api/v2/languages/{languageTag}
GET
/api/v2/languages/iso
POST
/api/v2/languages/i18n
GET
/api/v2/languages/variables
GET
/api/v2/languages
POST
/api/v2/languages
PUT
/api/v2/languages/{language}/_makedefault
System Logging 3
System logging configuration and management
GET
/api/v1/logger
PUT
/api/v1/logger
GET
/api/v1/logger/{loggerName}
System Monitoring 2
System monitoring and health checks
GET
/api/v1/{a}
GET
/api/v1/{a}/{a}
Permissions 11
Permission management and access control
GET
/api/v1/permissions/{assetId}
Get asset permissions
PUT
/api/v1/permissions/{assetId}
Update asset permissions
GET
/api/v1/permissions/_bycontent
Get permission for a Contentlet
GET
/api/v1/permissions/_bycontent/_groupbytype
Get permissions roles group by type for a Contentlet
GET
/api/v1/permissions
Get permission metadata
GET
/api/v1/permissions/_bypermissiontype
Get permissions by permission type
GET
/api/v1/permissions/role/{roleId}
Get role permissions
GET
/api/v1/permissions/user/{userId}
Get user permissions
PUT
/api/v1/permissions/{assetId}/_reset
Reset asset permissions to inherited
PUT
/api/v1/permissions/role/{roleId}/asset/{assetId}
Update role permissions on asset
PUT
/api/v1/permissions/user/{userId}/asset/{assetId}
Update user permissions on asset
System 10
System-level operations and Redis management
GET
/api/v1/redis/{key}
DELETE
/api/v1/redis/{key}
GET
/api/v1/redis/hash/{key}
DELETE
/api/v1/redis/hash/{key}
GET
/api/v1/redis/echo/{message}
GET
/api/v1/redis/incr/{key}
PUT
/api/v1/redis/incr/{key}
GET
/api/v1/redis/ping
PUT
/api/v1/redis
PUT
/api/v1/redis/hash
System Storage 2
Storage providers and data replication management
GET
/api/v1/storages/hello
GET
/api/v1/storages/chain/_replicate/{from}/to/{to}
TailLog 2
Server log file monitoring and real-time viewing
GET
/api/v1/logs/{fileName}/_tail
GET
/api/v1/logs
List available log files
Temporary Files 2
Temporary file upload and management for content creation
POST
/api/v1/temp/byUrl
Create temporary file from a remote URL
POST
/api/v1/temp
Upload temporary files via multipart form
Template 14
Template CRUD, publish, archive, and layout management endpoints
PUT
/api/v1/templates/_archive
Archive templates in bulk
PUT
/api/v1/templates/{templateId}/_copy
Copy a template
GET
/api/v1/templates
List templates
PUT
/api/v1/templates
Update an existing template
POST
/api/v1/templates
Create a new template
DELETE
/api/v1/templates
Delete templates in bulk
POST
/api/v1/templates/image
Get the image associated with a template
GET
/api/v1/templates/{templateId}/live
Get live version of a template
GET
/api/v1/templates/{templateId}/working
Get working version of a template
PUT
/api/v1/templates/_publish
Publish templates in bulk
PUT
/api/v1/templates/_savepublish
Save and publish a template
PUT
/api/v1/templates/draft
Save a template as draft
PUT
/api/v1/templates/_unarchive
Unarchive templates in bulk
PUT
/api/v1/templates/_unpublish
Unpublish templates in bulk
Theme 2
Theme browsing and management
GET
/api/v1/themes/id/{id}
Get theme by ID
GET
/api/v1/themes
List themes with pagination
Usage 1
Provides business intelligence metrics for dashboard usage
GET
/api/v1/usage/summary
Get usage dashboard summary
Variants 5
Endpoints for managing content variants
POST
/api/v1/variants
Creates a new content variant
PUT
/api/v1/variants/{variantName}/_promote
Promotes a variant to become the default
PUT
/api/v1/versionables/{versionableInode}/_bringback
DELETE
/api/v1/versionables/{versionableInode}
GET
/api/v1/versionables/{versionableInodeOrIdentifier}
Templates 18
Template design and management
GET
/api/vtl/{folder}
PUT
/api/vtl/{folder}
POST
/api/vtl/{folder}
DELETE
/api/vtl/{folder}
PATCH
/api/vtl/{folder}
GET
/api/vtl/{folder}/{pathParam}
PUT
/api/vtl/{folder}/{pathParam}
POST
/api/vtl/{folder}/{pathParam}
DELETE
/api/vtl/{folder}/{pathParam}
PATCH
/api/vtl/{folder}/{pathParam}
GET
/api/vtl/dynamic/{pathParam}
Evaluate inline Velocity code (GET)
PUT
/api/vtl/dynamic/{pathParam}
Evaluate inline Velocity code (PUT)
POST
/api/vtl/dynamic/{pathParam}
Evaluate inline Velocity code (POST)
DELETE
/api/vtl/dynamic/{pathParam}
Evaluate inline Velocity code (DELETE)
PATCH
/api/vtl/dynamic/{pathParam}
Evaluate inline Velocity code (PATCH)
GET
/api/vtl/dynamic
Evaluate inline Velocity code (GET)
PUT
/api/vtl/dynamic
Evaluate inline Velocity code (PUT)
POST
/api/vtl/dynamic
Evaluate inline Velocity code (POST)
Tags 13
Content tagging and labeling
GET
/api/v2/tags
List/Search Tags
POST
/api/v2/tags
Create tags
DELETE
/api/v2/tags
Bulk delete tags
DELETE
/api/v2/tags/{tagId}
Delete tag
GET
/api/v2/tags/inode/{inode}
Get tags by inode
DELETE
/api/v2/tags/inode/{inode}
Delete tag-inode associations
GET
/api/v2/tags/export/template
Download tag import template
GET
/api/v2/tags/export
Export tags
GET
/api/v2/tags/{nameOrId}
Get tag by name or ID
GET
/api/v2/tags/user/{userId}
Get tags by user ID
POST
/api/v2/tags/import
Import tags from CSV file
PUT
/api/v2/tags/tag/{nameOrId}/inode/{inode}
Link tags to inode
PUT
/api/v2/tags/{idOrName}
Update tag
Elasticsearch Content Search 3
Backend Elasticsearch search endpoints for portlet context
GET
/api/es/layout/{params}
POST
/api/es/search
Search content using a search query (POST)
POST
/api/es/raw
Execute raw search query (POST)
Schemas 606
The contract defines 606 schemas that model the data the API accepts and returns. The most detailed are User (61 properties), HTMLPageAsset (51 properties), Host (43 properties), WorkflowActionView (42 properties). Each schema is shown below with its type and property counts.
ErrorEntity
object
3 properties
MessageEntity
object
1 property
Pagination
object
3 properties
ProviderField
object
5 properties
ProviderMetadata
object
3 properties
ResponseEntityAiProviderListView
object
6 properties
ResponseEntityAiTestConnectionView
object
6 properties
TestConnectionResult
object
2 properties
CompletionsForm
object
16 properties
Role
object
14 properties
User
object
61 properties
JSONObject
object
2 properties
EmbeddingsForm
object
9 properties
AIImageRequestDTO
object
4 properties
OAuthExchangeView
object
4 properties
ResponseEntityOAuthExchangeView
object
6 properties
UserSummary
object
6 properties
OAuthExchangeForm
object
3 properties
2 required
DotAuthConfigView
object
6 properties
ResponseEntityDotAuthConfigView
object
6 properties
BodyPart
object
8 properties
ContentDisposition
object
7 properties
FormDataBodyPart
object
12 properties
FormDataContentDisposition
object
8 properties
FormDataMultiPart
object
10 properties
MessageBodyWorkers
object
MultiPart
object
9 properties
ParameterizedHeader
object
2 properties
DotAuthSitesView
object
2 properties
ResponseEntityDotAuthSitesView
object
6 properties
SiteRowView
object
4 properties
SystemView
object
3 properties
ResponseEntityStringView
object
6 properties
DotAuthConfigForm
object
2 properties
1 required
ResponseEntityFieldTypeListView
object
6 properties
DeleteBundlesByIdentifierForm
object
1 property
GenerateBundleForm
object
3 properties
PublishingEndPoint
object
11 properties
ResponseEntityEndpointView
object
6 properties
ForbiddenException
object
6 properties
EndpointForm
object
8 properties
5 required
ResponseEntityBooleanView
object
6 properties
DoesNotExistException
object
5 properties
ResponseEntityEndpointsView
object
6 properties
Environment
object
5 properties
ResponseEntityEnvironmentView
object
6 properties
EnvironmentForm
object
3 properties
2 required
ResponseEntityEnvironmentsView
object
6 properties
DeletePPQueueElementsByIdentifierForm
object
1 property
ResponseEntityTagOperationView
object
6 properties
RestTag
object
5 properties
TagForm
object
4 properties
1 required
ResponseEntityTagInodesView
object
6 properties
TagInode
object
4 properties
ResponseEntityTagsView
object
6 properties
ResponseEntityTagInodeOperationView
object
6 properties
UpdateTagForm
object
4 properties
2 required
ResponseEntityView
object
6 properties
A11yAgentFixForm
object
3 properties
1 required
EventOutput
object
2 properties
A11yAgentStopForm
object
1 property
1 required
AccessibilityForm
object
1 property
Announcement
object
11 properties
ResponseEntityViewListAnnouncement
object
6 properties
SecretForm
object
DeleteSecretForm
object
3 properties
3 required
ExportSecretForm
object
4 properties
3 required
AssetArchiveRequestForm
object
1 property
1 required
FolderDetail
object
Folder configuration details
6 properties
1 required
ImmutableListString
array
Ordered list of stat column names reported by this provider
3 properties
NewFolderForm
object
2 properties
2 required
AssetDeletionRequestForm
object
1 property
1 required
FolderDeletionRequestForm
object
1 property
1 required
AssetsRequestForm
object
3 properties
1 required
WebAssetEntityView
object
6 properties
WebAssetView
object
AssetLookupRequestForm
object
1 property
1 required
FileUploadDetail
object
4 properties
UpdateFolderDetail
object
Folder configuration details
7 properties
2 required
UpdateFolderForm
object
2 properties
2 required
ResponseEntityMapView
object
6 properties
ResponseEntityJwtView
object
6 properties
ResponseEntityApiTokenWithJwtView
object
6 properties
RemoteAPITokenForm
object
1 property
ApiTokenForm
object
5 properties
AuthenticationForm
object
6 properties
2 required
ResponseEntityMapMapView
object
6 properties
ResponseEntityForgotPasswordView
object
6 properties
ForgotPasswordForm
object
1 property
1 required
LanguageView
object
3 properties
LoginFormResultView
object
11 properties
ResponseEntityLoginFormView
object
6 properties
I18NForm
object
3 properties
ResponseEntityPasswordResetView
object
6 properties
ResetPasswordForm
object
2 properties
2 required
BrowserQueryForm
object
16 properties
OpenFolderForm
object
1 property
CategoryBulkDeleteResultView
object
4 properties
FailedResultView
object
2 properties
ResponseEntityCategoryBulkDeleteResultView
object
6 properties
CategoryView
object
10 properties
ResponseEntityCategoryView
object
6 properties
CategoryWithChildCountView
object
11 properties
ResponseEntityCategoryWithChildCountView
object
6 properties
HierarchyShortCategoriesResponseView
object
6 properties
HierarchyShortCategory
object
4 properties
ShortCategory
object
3 properties
CategoryKeysForm
object
1 property
CategoryImportFormSchema
object
Category import form data with CSV file and processing parameters
4 properties
BulkResultView
object
3 properties
ResponseEntityBulkResultView
object
6 properties
file
object
CSV file containing categories to import
CategoryEditForm
object
8 properties
CategoryForm
object
10 properties
1 required
CompanyConfigView
object
15 properties
6 required
ResponseEntityCompanyConfigView
object
6 properties
CompanyAuthTypeForm
object
Company authentication type setting
1 property
1 required
CompanyBasicInfoForm
object
Company basic information and branding settings
9 properties
4 required
CompanyLocaleForm
object
Company locale settings (language and timezone)
2 properties
2 required
Container
object
35 properties
ContainerView
object
2 properties
ResponseEntitySingleContainerView
object
6 properties
ResponseEntityContainerObjectMapView
object
6 properties
ResponseEntityContainerView
object
6 properties
PaginatedArrayListMapStringObject
array
5 properties
ResponseEntityPaginatedArrayListMapView
object
6 properties
ContainerForm
object
Form used to create or update a Container in dotCMS
18 properties
1 required
ContainerStructure
object
6 properties
ContentReportView
object
2 properties
ResponseSiteVariablesEntityView
object
6 properties
SiteVariableView
object
8 properties
ResponseEntityViewMapStringObject
object
6 properties
ExistingLanguagesForContentletView
object
1 property
ResponseEntityViewListExistingLanguagesForContentletView
object
6 properties
CountView
object
1 property
ResponseEntityCountView
object
6 properties
ContentReferenceView
object
3 properties
IHTMLPage
object
33 properties
Permissionable
object
4 properties
ResponseEntityContentReferenceListView
object
6 properties
ResponseEntityPaginatedDataView
object
6 properties
ResponseEntityListMapView
object
6 properties
PullRelatedForm
object
6 properties
5 required
ResponseEntityContentletView
object
6 properties
ContentForm
object
1 property
JsonObjectView
object
1 property
SearchView
object
4 properties
ResponseEntityViewSearchView
object
6 properties
ContentSearchForm
object
Form for searching content with support for global search, content type specific fields, and system filters
9 properties
ResponseEntitySearchView
object
6 properties
SearchForm
object
Content search request. query is a Lucene expression; the remaining fields control paging, sorting, language, and how results are rendered.
9 properties
ResponseEntityMapStringObjectView
object
6 properties
BulkRefreshSubmitResponse
object
2 properties
ResponseEntityBulkRefreshSubmitView
object
6 properties
BulkRefreshForm
object
3 properties
1 required
ErrorDetail
object
5 properties
ImmutableListJob
array
3 properties
ImmutableMapStringObject
object
Styles defined for the Contentlet
1 property
Job
object
12 properties
JobPaginatedResult
object
4 properties
JobResult
object
2 properties
ResponseEntityJobPaginatedResultView
object
6 properties
ImmutableListJobView
array
3 properties
JobView
object
12 properties
JobViewPaginatedResult
object
4 properties
ResponseEntityViewJobViewPaginatedResult
object
6 properties
ResponseEntityViewString
object
6 properties
ResponseEntityJobView
object
6 properties
ResponseEntityViewJobView
object
6 properties
JobStatusResponse
object
2 properties
ResponseEntityJobStatusView
object
6 properties
ContentImportParamsSchema
object
Schema for content import parameters.
2 properties
2 required
ContentImportForm
object
6 properties
2 required
ImmutableMapObjectObject
object
1 property
ResponseEntityContentTypeOperationView
object
6 properties
CopyContentTypeForm
object
5 properties
1 required
ContentType
object
2 properties
1 required
ContentTypeForm
object
5 properties
DotAssetContentType
object
FileAssetContentType
object
FormContentType
object
KeyValueContentType
object
PageContentType
object
PersonaContentType
object
SimpleContentType
object
Tuple2SystemActionString
object
2 properties
VanityUrlContentType
object
WidgetContentType
object
WorkflowFormEntry
object
2 properties
ContentTypeFieldView
object
A single field within a content type's 'fields[]' array. The 'clazz' property is the discriminator that selects the concrete field type; the remaining properti…
15 properties
2 required
ContentTypeRequestView
object
A content-type object, posted directly (NOT wrapped in a 'contentType' envelope). The endpoint also accepts an array of these objects to create several types i…
13 properties
2 required
ResponseEntityContentTypeJsonView
object
6 properties
ResponseEntityListContentTypeView
object
6 properties
FilteredContentTypesForm
object
5 properties
BaseContentTypesView
object
4 properties
ContentTypeView
object
5 properties
ResponseEntityBaseContentTypesView
object
6 properties
ResponseEntityContentTypeDetailView
object
6 properties
Condition
object
3 properties
Experiment
object
16 properties
ExperimentVariant
object
5 properties
Goal
object
2 properties
Goals
object
1 property
ImmutableListCondition
array
3 properties
ImmutableMapStringString
object
1 property
Metric
object
4 properties
ResponseEntitySingleExperimentView
object
6 properties
RunningId
object
3 properties
RunningIds
object
1 property
Scheduling
object
2 properties
TargetingCondition
object
4 properties
TrafficProportion
object
2 properties
AddVariantForm
object
1 property
ResponseEntityExperimentView
object
6 properties
ExperimentForm
object
9 properties
BayesianResult
object
6 properties
CredibilityInterval
object
2 properties
DifferenceData
object
4 properties
ExperimentResults
object
3 properties
GoalResults
object
2 properties
ImmutableListVariantResult
array
3 properties
ImmutableMapDoubleQuantilePair
object
1 property
ImmutableMapStringListSampleData
object
1 property
QuantilePair
object
2 properties
ResponseEntityExperimentResults
object
6 properties
ResultResumeItem
object
3 properties
SampleData
object
2 properties
SampleGroup
object
1 property
TotalSession
object
2 properties
UniqueBySessionResume
object
2 properties
VariantResult
object
8 properties
VariantResults
object
5 properties
LookBackWindow
object
2 properties
ResponseEntityExperimentSelectedView
object
6 properties
SelectedExperiment
object
7 properties
SelectedExperiments
object
4 properties
SelectedVariant
object
2 properties
ExcludedExperimentListForm
object
1 property
ExperimentVariantForm
object
1 property
ResponseEntityListView
object
6 properties
BinaryField
object
CategoryField
object
CheckboxField
object
ColumnField
object
ConstantField
object
CustomField
object
DateField
object
DateTimeField
object
EmptyField
object
Field
object
2 properties
1 required
FileField
object
Folder
object
20 properties
HiddenField
object
Host
object
43 properties
HostFolderField
object
ImageField
object
KeyValueField
object
LineDividerField
object
MultiSelectField
object
PermissionTabField
object
RadioField
object
RelationshipField
object
RelationshipsTabField
object
ResponseEntityFolderView
object
6 properties
RowField
object
SelectField
object
StoryBlockField
object
TabDividerField
object
TagField
object
TextAreaField
object
TextField
object
TimeField
object
UserAPI
object
5 properties
WysiwygField
object
FolderSearchResultView
object
5 properties
ResponseEntityFolderSearchResultView
object
6 properties
SearchByPathForm
object
1 property
FolderView
object
14 properties
ResponseEntityFolderWithSubfoldersView
object
6 properties
FolderSearchView
object
13 properties
PaginatedArrayListFolderSearchView
array
5 properties
ResponseEntityFolderSearchView
object
6 properties
ResponseEntityViewJobPaginatedResult
object
6 properties
JobParamsSchema
object
Schema for multipart job queue parameters.
2 properties
ResponseEntityViewJob
object
6 properties
ResponseEntityViewSetString
object
6 properties
ResponseEntityMapStringStringView
object
6 properties
RestLanguage
object
1 property
DeleteContentletsResultView
object
2 properties
2 required
ResponseEntityDeleteContentletsResultView
object
6 properties
DeleteContentletsForm
object
List of contentlet identifiers to permanently destroy
1 property
1 required
ResponseEntitySystemJobDeleteView
object
6 properties
DropOldVersionsResultView
object
2 properties
2 required
ResponseEntityDropOldVersionsResultView
object
6 properties
ImmutableListThreadDescriptorView
array
Per-thread descriptors
3 properties
ResponseEntityThreadDumpView
object
6 properties
ThreadDescriptorView
object
12 properties
9 required
ThreadDumpView
object
7 properties
6 required
ResponseEntityThreadSystemInfoView
object
6 properties
ThreadSystemInfoView
object
7 properties
6 required
KillSessionsResultView
object
1 property
1 required
ResponseEntityKillSessionsResultView
object
6 properties
ResponseEntitySessionListView
object
6 properties
SessionView
object
7 properties
3 required
ResponseEntitySystemJobListView
object
6 properties
ResponseEntitySearchAndReplaceResultView
object
6 properties
SearchAndReplaceResultView
object
2 properties
2 required
SearchAndReplaceForm
object
Database-wide search and replace parameters
2 properties
2 required
DeleteForm
object
1 property
1 required
ResponseEntityListViewString
object
6 properties
BundleMap
object
14 properties
ResponseEntityBundleListView
object
6 properties
ExtraPackagesForm
object
1 property
1 required
ResponseEntitySetStringView
object
6 properties
ContainerEntry
object
5 properties
PageContainerForm
object
2 properties
PageContainerEntryView
object
Single container slot assignment for a page.
4 properties
3 required
ExistingLanguagesForPageView
object
1 property
ResponseEntityLanguagesForPageView
object
6 properties
PageCheckPermissionForm
object
4 properties
CopyContentletForm
object
8 properties
ActionInputView
object
2 properties
PageWorkflowActionsView
object
2 properties
ResponseEntityPageWorkflowActionsView
object
6 properties
WorkflowActionView
object
42 properties
FindAvailableActionsForm
object
4 properties
MulitreeView
object
7 properties
ResponseEntityMulitreeView
object
6 properties
ResponseEntityViewListMulitreeView
object
6 properties
PageLivePreviewVersionBean
object
3 properties
ResponseEntityPageLivePreviewVersionView
object
6 properties
PersonalizationPersonaPageView
object
2 properties
ResponseEntityListPersonalizationPersonaPageView
object
6 properties
ContainerSourceView
object
Containers referenced by the page template, keyed by container identifier (UUID for DB containers, host-qualified path for FILE containers). Only content types…
2 properties
ContentTypeEntryView
object
Content types placed on the page for this container. DB entries contain only contentTypeVar; FILE entries also include path and identifier.
3 properties
FileRefView
object
Every file found anywhere under the theme folder (searched recursively), regardless of type. Each entry carries its extension so consumers can filter.
3 properties
PageRenderSourcesView
object
5 properties
PageSourceRefView
object
Lightweight page reference. When the request URI was a URL-mapped path, identifier is the detail page identifier and uri is the originally requested URI (host-…
3 properties
ResponseEntityPageRenderSourcesView
object
6 properties
ThemeSourceView
object
Theme folder and every file that composes it
4 properties
UrlContentMapView
object
Present only when the requested URI resolved via a URL-map pattern. Identifies the specific mapped contentlet that owns the URL. Absent for regular (literal) H…
4 properties
WidgetSourceView
object
Widget contentlets placed on the page
7 properties
AccruedTag
object
2 properties
Body
object
1 property
CachedVanityUrl
object
11 properties
ContainerRaw
object
3 properties
ContainerUUID
object
3 properties
Contentlet
object
38 properties
EmptyPageView
object
14 properties
Geolocation
object
13 properties
HTMLPageAsset
object
51 properties
IPersona
object
19 properties
JsonNode
object
Language
object
6 properties
Persona
object
41 properties
ResponseEntityEmptyPageView
object
6 properties
Sidebar
object
5 properties
Template
object
41 properties
TemplateLayout
object
Required. The row/column/container structure of the layout: a 'body' of rows, each row holding columns, each column holding containers referenced by identifier…
8 properties
TemplateLayoutColumn
object
8 properties
TemplateLayoutRow
object
3 properties
UserAgent
object
4 properties
Version
object
3 properties
ViewAsPageStatus
object
7 properties
Visitor
object
17 properties
PageView
object
14 properties
ResponseEntityPageView
object
6 properties
VanityURLView
object
5 properties
ResponseEntityTemplateView
object
6 properties
PageForm
object
Layout payload used to create or update the anonymous Template backing a page. Wrap this object under a top-level 'PageForm' property in the request body. 'lay…
5 properties
1 required
ResponseEntityContentletMapsView
object
6 properties
ContentView
object
4 properties
3 required
ResponseEntityContentView
object
6 properties
ContentWithStylesForm
object
Container with contentlet style properties
3 properties
2 required
PageScanCheckForm
object
1 property
ResponseEntityPersonalizationView
object
6 properties
PersonalizationPersonaPageForm
object
2 properties
2 required
MapStringRestPersonaView
object
1 property
RestPersona
object
2 properties
CustomPortletForm
object
5 properties
AddAssetsToBundleView
object
5 properties
4 required
ResponseEntityAddAssetsToBundleView
object
6 properties
AddAssetsToBundleForm
object
Form for adding assets to a bundle
3 properties
1 required
RemoveAssetResultView
object
3 properties
3 required
ResponseEntityRemoveAssetsFromBundleView
object
6 properties
RemoveAssetsFromBundleForm
object
1 property
1 required
EndpointDetailView
object
8 properties
5 required
EnvironmentDetailView
object
3 properties
3 required
ImmutableListEndpointDetailView
array
Endpoints within this environment with their status
3 properties
ImmutableListEnvironmentDetailView
array
Environments with their endpoints and status details
3 properties
PublishingJobDetailView
object
10 properties
6 required
ResponseEntityPublishingJobDetailView
object
6 properties
TimestampsView
object
Publishing job timestamps
6 properties
1 required
AssetPreviewView
object
3 properties
3 required
ImmutableListAssetPreviewView
array
Preview of first 3 assets in the bundle
3 properties
PublishingJobView
object
12 properties
7 required
ResponseEntityPublishingJobsView
object
6 properties
PurgeResultView
object
2 properties
2 required
ResponseEntityPurgeView
object
6 properties
PushBundleResultView
object
6 properties
4 required
ResponseEntityPushBundleResultView
object
6 properties
PushBundleForm
object
Form for pushing a bundle to environments
5 properties
3 required
ResponseEntityRetryBundlesView
object
6 properties
RetryBundleResultView
object
7 properties
4 required
RetryBundlesForm
object
3 properties
1 required
FilterDescriptorForm
object
6 properties
ResponseEntitySiteView
object
6 properties
CopySiteForm
object
10 properties
SimpleSiteVariableForm
object
Optional list of site variables (key/value pairs) to create alongside the site.
4 properties
SiteForm
object
Form used to create a Site (Host) in dotCMS. 'siteName' (the hostname) is the only required field; the new site is created unpublished and must be published se…
18 properties
1 required
ResponseEntityHostView
object
6 properties
SearchSiteByNameForm
object
1 property
ResponseEntitySiteSetupProgressView
object
6 properties
HostVariable
object
7 properties
ResponseHostVariableEntityView
object
6 properties
SiteVariableForm
object
5 properties
ResponseEntitySiteSwitchView
object
6 properties
RestConditionGroup
object
3 properties
1 required
RestRule
object
7 properties
ParameterModel
object
5 properties
RestRuleAction
object
4 properties
1 required
RestCondition
object
5 properties
3 required
RestConditionValue
object
3 properties
1 required
CompanyEmailForm
object
1 property
ResponseEntityViewMapStringString
object
6 properties
KeyValueForm
object
2 properties
2 required
UpgradeTaskForm
object
1 property
1 required
CacheProviderStatsView
object
3 properties
3 required
CacheStatsView
object
5 properties
5 required
ImmutableListCacheProviderStatsView
array
Per-provider cache statistics
3 properties
ImmutableListMapStringString
array
Per-region statistics, each row keyed by column name
3 properties
JvmMemoryView
object
JVM memory statistics
4 properties
4 required
ResponseEntityCacheStatsView
object
6 properties
ResponseEntityListStringView
object
6 properties
ChangeLoggerForm
object
2 properties
PermissionView
object
6 properties
ResponseEntityPermissionView
object
6 properties
ImmutableSetScope
array
Available permission scopes (asset types) that support permissions
1 property
ImmutableSetType
array
Individual permission levels assigned directly to this role on the asset
1 property
PermissionMetadataView
object
2 properties
2 required
ResponseEntityPermissionMetadataView
object
6 properties
ResponseEntityPermissionsByTypeView
object
6 properties
ImmutableListUserPermissionAssetView
array
List of permission assets (hosts and folders) with their permission assignments
3 properties
ImmutableMapStringSetString
object
Map of permission types (INDIVIDUAL, HOST, FOLDER, etc.) to sets of permission level names (READ, WRITE, PUBLISH, EDITPERMISSIONS, CANADDCHILDREN)
1 property
ResponseEntityRolePermissionsView
object
6 properties
RolePermissionsView
object
3 properties
3 required
UserPermissionAssetView
object
The updated asset with new permission assignments
8 properties
8 required
ResetAssetPermissionsView
object
3 properties
3 required
ResponseEntityResetPermissionsView
object
6 properties
AssetPermissionsView
object
The updated asset with its new permission assignments
9 properties
8 required
ImmutableListRolePermissionView
array
Paginated list of role permissions assigned to this asset
3 properties
ImmutableMapScopeSetType
object
Inheritable permissions by scope (only for parent permissionables). Keys are permission scopes (HOST, FOLDER, CONTENT, etc.), values are permission types
1 property
ResponseEntityUpdatePermissionsView
object
6 properties
RolePermissionView
object
5 properties
4 required
UpdateAssetPermissionsView
object
5 properties
4 required
RolePermissionForm
object
Permission assignment for a single role on an asset
3 properties
1 required
UpdateAssetPermissionsForm
object
1 property
1 required
ImmutableMapStringListString
object
Map of permission scopes (INDIVIDUAL, CONTENT, FOLDER, HOST, etc.) to lists of permission level names (READ, WRITE, PUBLISH, EDITPERMISSIONS, CANADDCHILDREN)
1 property
ResponseEntityUpdateRolePermissionsView
object
6 properties
RolePermissionAssetView
object
The updated asset with new permission assignments for this role
8 properties
8 required
UpdateRolePermissionsView
object
3 properties
3 required
UpdateRolePermissionsForm
object
1 property
1 required
ResponseEntitySaveUserPermissionsView
object
6 properties
SaveUserPermissionsView
object
4 properties
4 required
SaveUserPermissionsForm
object
2 properties
1 required
SetForm
object
2 properties
2 required
SetHashForm
object
2 properties
2 required
RoleResponseEntityView
object
6 properties
RoleForm
object
7 properties
1 required
ResponseEntityRoleUserGrantView
object
6 properties
RoleMemberUserView
object
The user the role was granted to
3 properties
3 required
RoleUserGrantView
object
3 properties
3 required
ResponseEntityRoleOperationView
object
6 properties
ResponseEntityRoleDeletionView
object
6 properties
RoleDeletionView
object
3 properties
3 required
RoleLayoutForm
object
2 properties
Layout
object
5 properties
ResponseEntityLayoutList
object
6 properties
LayoutMapResponseEntityView
object
6 properties
ResponseEntityRoleDetailView
object
6 properties
RoleView
object
15 properties
2 required
ResponseEntityRoleViewListView
object
6 properties
ResponseEntityRoleListView
object
6 properties
ResponseEntityRoleUsersRemovalView
object
6 properties
RoleUsersRemovalView
object
2 properties
2 required
SkippedUserView
object
Users that could not be removed, each with a reason
2 properties
2 required
RoleUsersForm
object
1 property
1 required
ResponseEntitySmallRoleView
object
6 properties
SmallRoleView
object
4 properties
DotTempFile
object
9 properties
TempFilesView
object
Response body for /api/v1/temp and /api/v1/temp/byUrl uploads. Contains the tempFiles array; use tempFiles[0].id (e.g. "temp5311313004") as the field value whe…
1 property
RemoteUrlForm
object
5 properties
BodyView
object
1 property
SidebarView
object
3 properties
TemplateLayoutColumnView
object
5 properties
TemplateLayoutRowView
object
3 properties
TemplateLayoutView
object
Layout produced by the visual builder: a 'body' of rows, each row holding columns, and each column holding containers (referenced by identifier + uuid), plus o…
6 properties
TemplateView
object
40 properties
ThemeView
object
13 properties
TemplateImageForm
object
1 property
ResponseEntityListTemplateView
object
6 properties
TemplateForm
object
Form used to create or update a Template in dotCMS. A Template can be either drawn with the layout builder (set 'drawed:true' and provide 'layout') or authored…
23 properties
1 required
ResponseEntityUsageSummaryView
object
6 properties
UsageSummary
object
2 properties
ResponseUserMapEntityView
object
6 properties
ResponseEntityUserUpdateView
object
6 properties
UserForm
object
14 properties
3 required
ResponseUserDeletedEntityView
object
6 properties
UserDeletedView
object
3 properties
ResponseEntityListUserView
object
6 properties
ResponseEntityLoginAsView
object
6 properties
LoginAsForm
object
2 properties
2 required
RestUser
object
7 properties
UpdateCurrentUserForm
object
6 properties
ResponseEntityVariantView
object
6 properties
Variant
object
3 properties
VariantForm
object
2 properties
VelocityErrorResponseView
object
2 properties
VelocityErrorView
object
A single Velocity evaluation error, structured so an automated caller can locate and fix the offending code without parsing a stack trace.
6 properties
VelocityWarningView
object
A non-fatal Velocity warning, such as an undefined reference or a method call that returned null. The script still evaluated; warnings flag likely typos in non…
5 properties
WorkflowAction
object
41 properties
WorkflowActionSeparatorForm
object
2 properties
ResponseEntityWorkflowStepView
object
6 properties
WorkflowStep
object
9 properties
WorkflowStepAddForm
object
6 properties
6 required
ResponseEntityWorkflowSchemeView
object
6 properties
WorkflowScheme
object
11 properties
WorkflowCopyForm
object
1 property
ResponseEntitySystemActionWorkflowActionMapping
object
6 properties
SystemActionWorkflowActionMapping
object
6 properties
ResponseEntityWorkflowActionView
object
6 properties
ResponseEntityWorkflowActionletsView
object
6 properties
WorkFlowActionlet
object
6 properties
WorkflowActionletParameter
object
4 properties
ResponseEntityWorkflowActionClassesView
object
6 properties
WorkflowActionClass
object
6 properties
ResponseEntityWorkflowActionsView
object
6 properties
WorkflowSchemesForm
object
1 property
1 required
SchemesAndSchemesContentTypeView
object
2 properties
ContentTypeWorkflowSchemesView
object
3 properties
3 required
ImmutableListWorkflowScheme
array
Workflow schemes associated with the content type
3 properties
ResponseEntityContentTypeWorkflowSchemesView
object
6 properties
ResponseEntityDefaultWorkflowActionsView
object
6 properties
WorkflowDefaultActionView
object
3 properties
ResponseEntityWorkflowSchemesView
object
6 properties
ResponseEntityWorkflowStepsView
object
6 properties
ResponseEntitySystemActionWorkflowActionMappings
object
6 properties
WorkflowActionMultipartSchema
object
Multipart form for workflow actions. Include a JSON 'contentlet' and one or more 'file' parts that map to binary field variables.
3 properties
FireActionByNameForm
object
16 properties
FireActionForm
object
Form used to fire a workflow action. The content being acted on is supplied in the 'contentlet' map; the remaining fields are workflow/publishing options appli…
15 properties
AdditionalParamsBean
object
Action-specific parameters for bulk fire. Wraps push-publish settings, assign-and-comment metadata, and a free-form map for actionlet-specific keys.
5 properties
AssignCommentBean
object
Assignee and comment to attach to the workflow task created when an action is fired.
2 properties
FireBulkActionsForm
object
Request body for PUT /api/v1/workflow/contentlet/actions/bulk/fire. Either 'query' OR 'contentletIds' must be supplied (not both). 'workflowActionId' is requir…
5 properties
1 required
PushPublishBean
object
Push-publish settings applied when the resolved workflow action wires the Push Publish actionlet.
10 properties
ActionFail
object
3 properties
BulkActionsResultView
object
4 properties
ResponseEntityBulkActionsResultView
object
6 properties
FireMultipleActionForm
object
12 properties
BulkActionView
object
1 property
BulkWorkflowSchemeView
object
2 properties
BulkWorkflowStepView
object
2 properties
CountWorkflowAction
object
5 properties
CountWorkflowStep
object
2 properties
ResponseEntityBulkActionView
object
6 properties
BulkActionForm
object
2 properties
ContentletWorkflowStatusView
object
3 properties
ResponseContentletWorkflowStatusView
object
6 properties
WorkflowTask
object
14 properties
ResponseEntityWorkflowTasksView
object
6 properties
WorkflowSearchResultsView
object
2 properties
WorkflowTaskView
object
12 properties
WorkflowSearcherForm
object
12 properties
ResponseEntityWorkflowHistoryCommentsView
object
6 properties
WorkflowTimelineItemView
object
8 properties
Permission
object
7 properties
WorkflowActionClassParameter
object
4 properties
WorkflowSchemeImportExportObjectView
object
8 properties
WorkflowSchemeImportObjectForm
object
2 properties
WorkflowReorderWorkflowActionStepForm
object
1 property
1 required
WorkflowActionForm
object
14 properties
7 required
WorkflowActionStepForm
object
1 property
1 required
WorkflowActionletActionForm
object
3 properties
1 required
ResponseEntityWorkflowCommentView
object
6 properties
WorkflowCommentForm
object
1 property
WorkflowSchemeForm
object
3 properties
1 required
WorkflowSystemActionForm
object
4 properties
2 required
WorkflowStepUpdateForm
object
6 properties
5 required
FileAssetView
object
File asset view returned after a save or publish operation
8 properties
ResponseEntityFileAssetView
object
Response entity wrapping a FileAssetView after a save or publish operation
6 properties
ResponseEntityViewLanguage
object
6 properties
MakeDefaultLangForm
object
1 property
LanguageForm
object
5 properties
ResponseEntityTagCreateView
object
6 properties
ResponseEntityTagInodesMapView
object
6 properties
ResponseEntityRestTagView
object
6 properties
ResponseEntityTagMapView
object
6 properties
FieldResponseView
object
6 properties
DeleteFieldsForm
object
1 property
MoveFieldsForm
object
UpdateFieldRequestView
object
Request body for updating one content-type field. The field object must be wrapped in the top-level field property.
1 property
1 required
UpdateFieldForm
object
1 property
MetricCalculationError
object
6 properties
MetricTiming
object
6 properties
MetricValue
object
5 properties
MetricsSnapshot
object
4 properties
ResponseEntityMetricsSnapshotView
object
6 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from dotCMS 1
Other APIs dotCMS publishes across the network.
dotCMS GraphQL API
#CMS#Content#Content Management
Where this information came from
This is an independent, third-party profile of dotCMS REST API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.