Skip to main content

API

Swagger UI​

Swagger Explorer

If you want to explore all the available endpoints exposed by the API component, you can access the Swagger UI documentation at:

<API_IP_ADDRESS>/api/docs

To enable this, make sure the following Helm value is set to true:

  • apiService.config.apiEnableDocumentation

If this key is not enabled, the /docs endpoint will not be available.