REST API Path Description Notes
API Token apitoken Issue, revoke, and manage API Tokens
Apps appconfiguration Access and manage Apps and secrets
Authentication authentication
Authentication (Login) authenticationlogInUser
Authentication (Logout) logout
Bundle bundle (Legacy) Build and manage Push Publishing Bundles
Category categories Create, modify, and view Categories
Cluster cluster
Configuration configuration
Configuration (Legacy) config
Container containers Create, modify, and view Containers (but not Container contents)
Container Delete containersdelete Delete Containers
Content content Search for content
Important
The Content API is deprecated for creating and updating content.
To create and edit content, please use the Workflow API instead.
Content Type contenttype Create, modify, and view Content Types
Content Types (Legacy) structure (Legacy) Manage Content Types
Elasticsearch es Elasticsearch functions
Environment environment
ES Index esindex Manage Elasticsearch indexes
ES Raw esraw
ES Search essearch Perform content searches using Elasticsearch JSON format
Field Type fieldTypes
Folder folder Manage folders
Javascript POST (Legacy) javascriptPOST (Legacy) ?????
Language languages
License license
License (Ext) ext
Login Form loginform Present a login form to a user
Menu menu
Navigation nav Generate navigation (trees, breadcrumbs, etc.) from folders, files, and Menu Links
Notification notification Send and receive Notifications for the back-end UI
OSGI osgi
Page (Layout as a Service) page
Page Search pagesearch
Password (Change) changePassword Provide Change Password functionality
Password (Forgot) forgotpassword Provide password reset (Forgot Password) functionality
Persona personas Create, modify, and view Personas
Personalization personalization
Portlet portlet
Push Publishing (Legacy) bundlePublisher (Legacy) Manage Push Publishing Bundles
Push Publishing Audit auditPublishing
Push Publishing Integrity integrity Perform Push Publishing integrity checks
Relationship contentrelationships
Relationship Cardinalities relationshipscardinalities
Relationships relationships
REST Example restexample (Example Only) Example REST API for testing and development purposes only
Role roles
Role (Legacy) role
Rule Actions rulesengine/actions Create and edit Rules for Sites and Pages
Rules rulesengine Create and edit Rules for Sites and Pages
Site site
Site Browser browsertree
Sites sites
System system
System Status system-status
Tag tags Create, edit, and manage Tags
Temporary File temp
Theme themes Create, update, and manage Themes
Upgrade Task upgradetask Initiate upgrade tasks when upgrading an existing installation to a new version
User user
Users users
VTL vtl
Websocket ws
Widget widget
Workflow workflow Create and configure Workflows, and execute Workflow Actions

API Token (apitoken)

Endpoint Path Version HTTP
Method		 Parameters Example Payload Auth
Required

Apps (appconfiguration)

Endpoint Path Version HTTP
Method		 Parameters Example Payload Auth
Required

Authentication (authentication)

Endpoint Path Version HTTP
Method		 Parameters Example Payload Auth
Required

Authentication (Login) (authenticationlogInUser)

Endpoint Path Version HTTP
Method		 Parameters Example Payload Auth
Required

Authentication (Logout) (logout)

Endpoint Path Version HTTP
Method		 Parameters Example Payload Auth
Required

Bundle (bundle)

Endpoint Path Version HTTP
Method		 Parameters Example Payload Auth
Required

Category (categories)

Endpoint Path Version HTTP
Method		 Parameters Example Payload Auth
Required

Cluster (cluster)

Endpoint Path Version HTTP
Method		 Parameters Example Payload Auth
Required

Configuration (configuration)

Endpoint Path Version HTTP
Method		 Parameters Example Payload Auth
Required

Configuration (Legacy) (config)

Endpoint Path Version HTTP
Method		 Parameters Example Payload Auth
Required

Container (containers)

Endpoint Path Version HTTP
Method		 Parameters Example Payload Auth
Required

Container Delete (containersdelete)

Endpoint Path Version HTTP
Method		 Parameters Example Payload Auth
Required

Content (content)

Endpoint Path Version HTTP
Method		 Parameters Example Payload Auth
Required
Can Lock /canLock legacy PUT No parameters Unknown Yes
Count /indexcount legacy GET No parameters N/A No
Index Search /indexSearch legacy GET No parameters N/A No
Lock Content /lockContent legacy PUT No parameters Unknown Yes
Save (Single PUT)
Deprecated 		/save legacy PUT No parameters 
                {
    contentType:"webPageContent",
    languageId:1,
    title:"Test Content",
    contentHost:"demo.dotcms.com",
    body:"test body"
}
Yes

Content Type (contenttype)

Endpoint Path Version HTTP
Method		 Parameters Example Payload Auth
Required

Content Types (Legacy) (structure)

Endpoint Path Version HTTP
Method		 Parameters Example Payload Auth
Required

Elasticsearch (es)

Endpoint Path Version HTTP
Method		 Parameters Example Payload Auth
Required

Environment (environment)

Endpoint Path Version HTTP
Method		 Parameters Example Payload Auth
Required

ES Index (esindex)

Endpoint Path Version HTTP
Method		 Parameters Example Payload Auth
Required

ES Raw (esraw)

Endpoint Path Version HTTP
Method		 Parameters Example Payload Auth
Required

ES Search (essearch)

Endpoint Path Version HTTP
Method		 Parameters Example Payload Auth
Required

Field Type (fieldTypes)

Endpoint Path Version HTTP
Method		 Parameters Example Payload Auth
Required

Folder (folder)

Endpoint Path Version HTTP
Method		 Parameters Example Payload Auth
Required

Javascript POST (Legacy) (javascriptPOST)

Endpoint Path Version HTTP
Method		 Parameters Example Payload Auth
Required

Language (languages)

Endpoint Path Version HTTP
Method		 Parameters Example Payload Auth
Required

License (license)

Endpoint Path Version HTTP
Method		 Parameters Example Payload Auth
Required

License (Ext) (ext)

Endpoint Path Version HTTP
Method		 Parameters Example Payload Auth
Required

Login Form (loginform)

Endpoint Path Version HTTP
Method		 Parameters Example Payload Auth
Required

Menu (menu)

Endpoint Path Version HTTP
Method		 Parameters Example Payload Auth
Required

Navigation (nav)

Endpoint Path Version HTTP
Method		 Parameters Example Payload Auth
Required

Notification (notification)

Endpoint Path Version HTTP
Method		 Parameters Example Payload Auth
Required

OSGI (osgi)

Endpoint Path Version HTTP
Method		 Parameters Example Payload Auth
Required

Page (Layout as a Service) (page)

Endpoint Path Version HTTP
Method		 Parameters Example Payload Auth
Required

Page Search (pagesearch)

Endpoint Path Version HTTP
Method		 Parameters Example Payload Auth
Required

Password (Change) (changePassword)

Endpoint Path Version HTTP
Method		 Parameters Example Payload Auth
Required

Password (Forgot) (forgotpassword)

Endpoint Path Version HTTP
Method		 Parameters Example Payload Auth
Required

Persona (personas)

Endpoint Path Version HTTP
Method		 Parameters Example Payload Auth
Required

Personalization (personalization)

Endpoint Path Version HTTP
Method		 Parameters Example Payload Auth
Required

Portlet (portlet)

Endpoint Path Version HTTP
Method		 Parameters Example Payload Auth
Required

Push Publishing (Legacy) (bundlePublisher)

Endpoint Path Version HTTP
Method		 Parameters Example Payload Auth
Required

Push Publishing Audit (auditPublishing)

Endpoint Path Version HTTP
Method		 Parameters Example Payload Auth
Required

Push Publishing Integrity (integrity)

Endpoint Path Version HTTP
Method		 Parameters Example Payload Auth
Required

Relationship (contentrelationships)

Endpoint Path Version HTTP
Method		 Parameters Example Payload Auth
Required

Relationship Cardinalities (relationshipscardinalities)

Endpoint Path Version HTTP
Method		 Parameters Example Payload Auth
Required

Relationships (relationships)

Endpoint Path Version HTTP
Method		 Parameters Example Payload Auth
Required

REST Example (restexample)

Endpoint Path Version HTTP
Method		 Parameters Example Payload Auth
Required

Role (roles)

Endpoint Path Version HTTP
Method		 Parameters Example Payload Auth
Required

Role (Legacy) (role)

Endpoint Path Version HTTP
Method		 Parameters Example Payload Auth
Required

Rule Actions (rulesengine/actions)

Endpoint Path Version HTTP
Method		 Parameters Example Payload Auth
Required

Rules (rulesengine)

Endpoint Path Version HTTP
Method		 Parameters Example Payload Auth
Required

Site (site)

Endpoint Path Version HTTP
Method		 Parameters Example Payload Auth
Required

Site Browser (browsertree)

Endpoint Path Version HTTP
Method		 Parameters Example Payload Auth
Required

Sites (sites)

Endpoint Path Version HTTP
Method		 Parameters Example Payload Auth
Required

System (system)

Endpoint Path Version HTTP
Method		 Parameters Example Payload Auth
Required

System Status (system-status)

Endpoint Path Version HTTP
Method		 Parameters Example Payload Auth
Required

Tag (tags)

Endpoint Path Version HTTP
Method		 Parameters Example Payload Auth
Required

Temporary File (temp)

Endpoint Path Version HTTP
Method		 Parameters Example Payload Auth
Required

Theme (themes)

Endpoint Path Version HTTP
Method		 Parameters Example Payload Auth
Required

Upgrade Task (upgradetask)

Endpoint Path Version HTTP
Method		 Parameters Example Payload Auth
Required

User (user)

Endpoint Path Version HTTP
Method		 Parameters Example Payload Auth
Required

Users (users)

Endpoint Path Version HTTP
Method		 Parameters Example Payload Auth
Required

VTL (vtl)

Endpoint Path Version HTTP
Method		 Parameters Example Payload Auth
Required

Websocket (ws)

Endpoint Path Version HTTP
Method		 Parameters Example Payload Auth
Required

Widget (widget)

Endpoint Path Version HTTP
Method		 Parameters Example Payload Auth
Required

Workflow (workflow)

Endpoint Path Version HTTP
Method		 Parameters Example Payload Auth
Required
Fire Action /fireAction v1 PUT No parameters Unknown No