Cloudera Docs

Ranger REST API documentation

The Ranger Admin Web UI includes REST API documentation which describes the framework used to enable, monitor and manage comprehensive data security across the Hadoop platform. The Ranger REST API is published as html, using the Swagger UI, at a url that has the following format:

Ranger Admin SSL-enabled (Default Port: 6182):

https://<Ranger-host-name>:6182/apidocs/index.html

Ranger Admin not SSL-enabled (Default Port: 6080):

http://<Ranger-host-name>:6080/apidocs/index.html

You can access the Ranger API documentation using the Swagger user interface from Cloudera Manager. From CM, go to Ranger > Ranger Admin Web UI .

To view the Ranger REST API documentation:
  1. Log in to the Ranger Admin Web UI.
  2. Open the Ranger Admin menu.
  3. Select API Documentation.

Ranger Rest API documentation displays as html output in your web browser.