Swagger API

Candlepin exposes Swagger file as a documentation of the service. When using deployed candlepin the swagger file can be accessed at:

https://HOST:8443/candlepin/swagger.json

An interactive user interface that allows running Candlepin methods can be accessed at:

https://HOST:8443/candlepin/docs/

If you do not want to serve Swagger, you can turn it off with the following configuration property:

candlepin.swagger.enabled=false

We also host the Swagger file and the UI statically on this site:

Version Swagger file Interactive documentation
2.1.25 swagger.json Swagger UI
2.3.10 swagger.json Swagger UI
2.4.8 swagger.json Swagger UI
2.5.7 swagger.json Swagger UI
2.9.17 swagger.json Swagger UI
3.1.16 swagger.json Swagger UI
Last modified on 9 July 2020