In order to enable ease of development and ease of use of the CPBM BSS APIs, CPBM provides a utility known as CPBM BSS API DOCS which has the following:

• Contains generated documentation for BSS API
• Exposed with a clear user html interface
• Test API methods with the provided playground

This utility provides users or developers a live playground on which they can:

1. Select top level API. For example, Users.
2. Select/choose one API call available in the top level API. For example, "/users".
3. Provide inputs as required by the API .
4. Execute the API.
5. See/Observe/Validate the response from the server.

The CPBM BSS API DOC is disabled, by default, during the installation. To enable this feature, perform the following steps:

1. Stop the cloud-portal service on all active nodes using the command:

   service cloud-portal stop

2. Go to VIRGO_HOME/pickup directory.
3. Open com.citrix.cpbm.plan.
4. Uncomment the below configuration:

   <artifact type="bundle" name="citrix.cpbm.api.doc" version="[2.0.0, 3.0.0)">        <property name="header:Web-ContextPath" value="/portal/api/doc" />    </artifact>  

5. Repeat Step 2 through Step 4 on all active nodes.
6. Start the cloud-portal service on all active nodes using the command:

   service cloud-portal start

CPBM BSS API DOC will be accessible using this URL:

http[s]://<ip of cpbm host>:<port>/portal/api/doc