/

/dotCMS REST API

Changes Docs Sign in

APIs
Generators
Stacks
Projects

Docs
History
Schema

Checked 14h ago · Updated 14h ago

Filter operations

Accessibility Checker2

API Token6

Authentication2

Bundle15

Content Analytics4

Content Delivery9

Content Import12

Content Report2

Content Type8

Content Type Field1

Experiment18

Navigation1

Page16

TailLog1

Variant1

Web Assets6

Workflow53

get/api/v1/ai/completions/config
post/api/v1/ai/completions/rawPrompt
post/api/v1/ai/completions
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
get/api/v1/dotsaml/login/{idpConfigId}
post/api/v1/dotsaml/login/{idpConfigId}
get/api/v1/dotsaml/logout/{idpConfigId}
post/api/v1/dotsaml/logout/{idpConfigId}
get/api/v1/dotsaml/metadata/{idpConfigId}
get/api/v1/fieldTypes
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
get/api/auditPublishing/get/{bundleId}
get/api/layout/{params}
post/api/bundlePublisher/publish
post/api/config/deleteEndpoint
post/api/config/deleteEnvironment
post/api/config/regenerateKey
post/api/config/saveCompanyAuthTypeInfo
post/api/config/saveCompanyBasicInfo
post/api/config/saveCompanyLocaleInfo
post/api/config/saveCompanyLogo
get/api/cluster/getESConfigProperties/{params}
get/api/cluster/licenseRepoStatus
get/api/cluster/getNodesStatus/{params}
post/api/cluster/remove/{params}
get/api/cluster/test
getReturns the environments
postCreates an environment
putUpdates an environment
deleteDeletes an environment
get/api/environment/loadenvironments/{params}
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}
get/api/portlet/layout/{params}
get/api/portlet/{params}
post/api/portlet/{params}
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}
get/api/osgi/getInstalledBundles/{params}
get/api/osgi/_processExports/{bundle}
post/api/osgi
delete/api/v1/publishqueue
get/api/restexample/layout/{params}
get/api/restexample/test/{params}
get/api/role/loadbyid/{params}
get/api/role/loadbyname/{params}
get/api/role/loadchildren/{params}
get/api/rulesengine/layout/{params}
get/api/structure/{path}
get/api/v1/tags
put/api/v1/tags
post/api/v1/tags
delete/api/v1/tags/{tagId}
get/api/v1/tags/inode/{inode}
delete/api/v1/tags/inode/{inode}
get/api/v1/tags/{nameOrId}

Updates an environment

put/api/environment/{id}

Path parameters

idstring required

Response

If update is success.

i18nMessagesMapobject

permissionsstring[]

Changes