In this section, the functionality and commands of the Keptn REST API are described.
The Keptn API is documented in terms of a Swagger API documentation.
Use the Keptn CLI to retrieve the endpoint of your Keptn API via the command
Starting to authenticate Successfully authenticated CLI is authenticated against the Keptn cluster https://api.keptn.XX.XXX.XX.XXX.io
Access the Keptn Swagger API documentation in your browser at https://api.keptn.XX.XXX.XX.XXX.io/swagger-ui/. You should see something similar to the screenshot:
Clicking on an endpoint reveals more details how to use it, including definitions and examples of the payload.
The following descriptions are only valid for a full Keptn installation (i.e., a Keptn installation which was not installed for the quality-gates use case).
Details of the Gateway
This Gateway accepts HTTP and HTTPS traffic. For the HTTPS traffic, Keptn generates a self-signed certificate during the installation.
If you already have a valid certificate for your domain and want to use this, please first configure your domain and, afterwards, manually update the used certificate in the Gateway. For adding a custom certificate, the Knative Documentation provides useful instructions.