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 |
ImportantThe 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 |
apitoken
)Endpoint | Path | Version | HTTP Method |
Parameters | Example Payload | Auth Required |
---|
appconfiguration
)Endpoint | Path | Version | HTTP Method |
Parameters | Example Payload | Auth Required |
---|
authentication
)Endpoint | Path | Version | HTTP Method |
Parameters | Example Payload | Auth Required |
---|
authenticationlogInUser
)Endpoint | Path | Version | HTTP Method |
Parameters | Example Payload | Auth Required |
---|
logout
)Endpoint | Path | Version | HTTP Method |
Parameters | Example Payload | Auth Required |
---|
bundle
)Endpoint | Path | Version | HTTP Method |
Parameters | Example Payload | Auth Required |
---|
categories
)Endpoint | Path | Version | HTTP Method |
Parameters | Example Payload | Auth Required |
---|
cluster
)Endpoint | Path | Version | HTTP Method |
Parameters | Example Payload | Auth Required |
---|
configuration
)Endpoint | Path | Version | HTTP Method |
Parameters | Example Payload | Auth Required |
---|
config
)Endpoint | Path | Version | HTTP Method |
Parameters | Example Payload | Auth Required |
---|
containers
)Endpoint | Path | Version | HTTP Method |
Parameters | Example Payload | Auth Required |
---|
containersdelete
)Endpoint | Path | Version | HTTP Method |
Parameters | Example Payload | Auth Required |
---|
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 |
contenttype
)Endpoint | Path | Version | HTTP Method |
Parameters | Example Payload | Auth Required |
---|
structure
)Endpoint | Path | Version | HTTP Method |
Parameters | Example Payload | Auth Required |
---|
es
)Endpoint | Path | Version | HTTP Method |
Parameters | Example Payload | Auth Required |
---|
environment
)Endpoint | Path | Version | HTTP Method |
Parameters | Example Payload | Auth Required |
---|
esindex
)Endpoint | Path | Version | HTTP Method |
Parameters | Example Payload | Auth Required |
---|
esraw
)Endpoint | Path | Version | HTTP Method |
Parameters | Example Payload | Auth Required |
---|
essearch
)Endpoint | Path | Version | HTTP Method |
Parameters | Example Payload | Auth Required |
---|
fieldTypes
)Endpoint | Path | Version | HTTP Method |
Parameters | Example Payload | Auth Required |
---|
folder
)Endpoint | Path | Version | HTTP Method |
Parameters | Example Payload | Auth Required |
---|
javascriptPOST
)Endpoint | Path | Version | HTTP Method |
Parameters | Example Payload | Auth Required |
---|
languages
)Endpoint | Path | Version | HTTP Method |
Parameters | Example Payload | Auth Required |
---|
license
)Endpoint | Path | Version | HTTP Method |
Parameters | Example Payload | Auth Required |
---|
ext
)Endpoint | Path | Version | HTTP Method |
Parameters | Example Payload | Auth Required |
---|
loginform
)Endpoint | Path | Version | HTTP Method |
Parameters | Example Payload | Auth Required |
---|
menu
)Endpoint | Path | Version | HTTP Method |
Parameters | Example Payload | Auth Required |
---|
nav
)Endpoint | Path | Version | HTTP Method |
Parameters | Example Payload | Auth Required |
---|
notification
)Endpoint | Path | Version | HTTP Method |
Parameters | Example Payload | Auth Required |
---|
osgi
)Endpoint | Path | Version | HTTP Method |
Parameters | Example Payload | Auth Required |
---|
page
)Endpoint | Path | Version | HTTP Method |
Parameters | Example Payload | Auth Required |
---|
pagesearch
)Endpoint | Path | Version | HTTP Method |
Parameters | Example Payload | Auth Required |
---|
changePassword
)Endpoint | Path | Version | HTTP Method |
Parameters | Example Payload | Auth Required |
---|
forgotpassword
)Endpoint | Path | Version | HTTP Method |
Parameters | Example Payload | Auth Required |
---|
personas
)Endpoint | Path | Version | HTTP Method |
Parameters | Example Payload | Auth Required |
---|
personalization
)Endpoint | Path | Version | HTTP Method |
Parameters | Example Payload | Auth Required |
---|
portlet
)Endpoint | Path | Version | HTTP Method |
Parameters | Example Payload | Auth Required |
---|
bundlePublisher
)Endpoint | Path | Version | HTTP Method |
Parameters | Example Payload | Auth Required |
---|
auditPublishing
)Endpoint | Path | Version | HTTP Method |
Parameters | Example Payload | Auth Required |
---|
integrity
)Endpoint | Path | Version | HTTP Method |
Parameters | Example Payload | Auth Required |
---|
contentrelationships
)Endpoint | Path | Version | HTTP Method |
Parameters | Example Payload | Auth Required |
---|
relationshipscardinalities
)Endpoint | Path | Version | HTTP Method |
Parameters | Example Payload | Auth Required |
---|
relationships
)Endpoint | Path | Version | HTTP Method |
Parameters | Example Payload | Auth Required |
---|
restexample
)Endpoint | Path | Version | HTTP Method |
Parameters | Example Payload | Auth Required |
---|
roles
)Endpoint | Path | Version | HTTP Method |
Parameters | Example Payload | Auth Required |
---|
role
)Endpoint | Path | Version | HTTP Method |
Parameters | Example Payload | Auth Required |
---|
rulesengine/actions
)Endpoint | Path | Version | HTTP Method |
Parameters | Example Payload | Auth Required |
---|
rulesengine
)Endpoint | Path | Version | HTTP Method |
Parameters | Example Payload | Auth Required |
---|
site
)Endpoint | Path | Version | HTTP Method |
Parameters | Example Payload | Auth Required |
---|
browsertree
)Endpoint | Path | Version | HTTP Method |
Parameters | Example Payload | Auth Required |
---|
sites
)Endpoint | Path | Version | HTTP Method |
Parameters | Example Payload | Auth Required |
---|
system
)Endpoint | Path | Version | HTTP Method |
Parameters | Example Payload | Auth Required |
---|
system-status
)Endpoint | Path | Version | HTTP Method |
Parameters | Example Payload | Auth Required |
---|
tags
)Endpoint | Path | Version | HTTP Method |
Parameters | Example Payload | Auth Required |
---|
temp
)Endpoint | Path | Version | HTTP Method |
Parameters | Example Payload | Auth Required |
---|
themes
)Endpoint | Path | Version | HTTP Method |
Parameters | Example Payload | Auth Required |
---|
upgradetask
)Endpoint | Path | Version | HTTP Method |
Parameters | Example Payload | Auth Required |
---|
user
)Endpoint | Path | Version | HTTP Method |
Parameters | Example Payload | Auth Required |
---|
users
)Endpoint | Path | Version | HTTP Method |
Parameters | Example Payload | Auth Required |
---|
vtl
)Endpoint | Path | Version | HTTP Method |
Parameters | Example Payload | Auth Required |
---|
ws
)Endpoint | Path | Version | HTTP Method |
Parameters | Example Payload | Auth Required |
---|
widget
)Endpoint | Path | Version | HTTP Method |
Parameters | Example Payload | Auth Required |
---|
workflow
)Endpoint | Path | Version | HTTP Method |
Parameters | Example Payload | Auth Required |
---|---|---|---|---|---|---|
Fire Action | /fireAction |
v1 |
PUT | No parameters | Unknown | No |