Language Properties REST API

Last Updated: Dec 13, 2022
documentation for the dotCMS Content Management System

Internationalization Resource Messages

Retrieve one or more I18N resource messages from server-configured properties files.

  • endpoint returns I18N message values configured via the resource bundle stored in /WEB-INF/messages.
  • Does not return values where the key matches a value as well as a parent key. E.g. and Requesting will result in a tree. Appropriate warnings are printed in the logs when such a collision is found.
  • Does not perform any message argument processing. The raw value in the properties file is returned unmodified.
  • DOES follow language failover rules. If a key is not defined for the de locale, the message in the default language will be provided.

GET Method:


Single Result

Curl Command:

curl -v -u -X GET http://localhost:8082/api/v1/i18n/de/message/comment/success -H "Content-Type:application/json"

Sample Result:

{ "Ihr Kommentar wurde gespeichert" }

Parent resource key result

Curl Command:

curl -v -u -X GET http://localhost:8082/api/v1/system/i18n/de/message/comment -H "Content-Type:application/json"

Sample Result:

 "failure": "Ihr Kommentar konnte nicht erstellt werden",  
 "success": "Ihr Kommentar wurde gespeichert",  
 "delete": "Ihr Kommentar wurde gelöscht"  

On this page


We Dig Feedback

Selected excerpt: