API Documentation URL - Not able to access

book

Article ID: 143732

calendar_today

Updated On:

Products

Clarity PPM On Premise

Issue/Introduction

Error received when accessing the Administration > General Settings > System Options > API Documentation URL

Depending on the browser used:

  • Page cannot be reached
  • Page cannot be displayed

 

Environment

Release : 15.7.1

Component : CA PPM APPLICATION

Resolution

Here are the possible resolutions:

  1. The CSA > Application > Disable REST API Access is checkmarked. Set it to unchecked.

     2. The URL is associated with the load balancer URL and configuration of the nodes needs to be reviewed by the network team.
A browser trace can be used to find the error message.
As a test, plugging in the hostname of the one node in place of the load balancer URL will allow access to the URL.

Note: The CSA > Application can be used to review the entered configurations such as entry URL and ports.
The API Documentation URL is constructed from this.