Web services

REST API

The OpenGrok web application provides a REST API under path /api/v1/.

For Indexer and Python scripts to work correctly, the URI of the web application needs to be specified with -U option. (For instance: -U http://localhost:8080/source).

Some of the API endpoints require authorization (which assumes authentication), some of the endpoints need to be accessed either via localhost or with API Bearer token (see authenticationTokens in https://github.com/oracle/opengrok/wiki/Webapp-configuration#configuration-tunables).

For the API documentation go to https://opengrok.docs.apiary.io/