Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Configuration keyDescription
webservices.rest.maxResultsDefaultThis setting determines the maximum number of resources that can be accessed on any webservice call.  The default is *50*.
webservices.rest.maxResultsAbsoluteThis setting determines the absolute maximum number of resources that can be accessed on any web service call. If the client requests more than this limit, then receives an error. The default is 1000.
webservices.rest.uriPrefix

This should point at the root of your exposed web application.  This is typically http://localhost:8080/openmrs during testing, but after being deployed will be something like http://192.168.1.100/openmrs or http://yourdomainname.org/openmrs.

If this is empty or not filled in, the user will see NEEDSTOBECONFIGURED/ws/rest/ as the "self" urls on all objects.

webservices.rest.allowedips

By default this is an empty string: "", which means anyone can access the rest URLs. If you put any IP addresses into this list, only calls from those are allowed. IPs should be separated by a whitespace or a comma.

IPs can be declared with bit masks to denote whole subdomains e.g. 10.0.0.0/30 matches 10.0.0.0 - 10.0.0.3 and 10.0.0.0/24 matches 10.0.0.0 - 10.0.0.255. Non matching IP addresses will receive a 403 HTTP error. Both IPv4 and IPv6 addresses are supported.

...