Legacy Knowledge Base
Published Sep. 10, 2025

How to restrict the JSON web services API page

Written By

Sivakumar Perumal

How To articles are not official guidelines or officially supported documentation. They are community-contributed content and may not always reflect the latest updates to Liferay DXP. We welcome your feedback to improve How To articles!

While we make every effort to ensure this Knowledge Base is accurate, it may not always reflect the most recent updates or official guidelines.We appreciate your understanding and encourage you to reach out with any feedback or concerns.

Legacy Article

You are viewing an article from our legacy "FastTrack" publication program, made available for informational purposes. Articles in this program were published without a requirement for independent editing or verification and are provided"as is" without guarantee.

Before using any information from this article, independently verify its suitability for your situation and project.

Issue

Environment

  • Liferay Portal 6.2

Resolution

  • Liferay Portal 6.2 doesn't have any out of the box option to restrict the JSON web services API page.

Additional Information

  • Liferay Portal 6.2
    • Setting the below property as false in portal-ext.properties will block the portlets which are consuming JSON web services whereas it will not affect the accessibility of the JSON web services API page.
      #
          # Set this property to true to enable JSON web services. Note that setting
          # this to false will cause portlets that make JSON web service calls from
          # working.
          #
          json.web.service.enabled=true 
  • Liferay DXP 7.0
    • This has been improved by adding one property to disable the JSON web services API page. Setting the below property to false will help to restrict.
      #
      # Set this property to true if JSON web services are discoverable through
      # the API page.
      #
      jsonws.web.service.api.discoverable=true
Did this article resolve your issue ?

Legacy Knowledge Base