In this section, the functionality and commands of the Keptn REST API are described.
To access the Keptn API, a running Keptn installation is needed. If you have not set up Keptn yet, please start here.
To get the API token for authenticating API calls, please see here.
The Keptn API is documented in terms of a Swagger API documentation.
Starting to authenticate Successfully authenticated CLI is authenticated against the Keptn cluster https://api.keptn.YOUR.DOMAIN
Access the Keptn Swagger API documentation in your browser at: https://api.keptn.YOUR.DOMAIN/swagger-ui/
The index page of the Swagger API documentation looks as follows:
Select one of the two API collections:
api-service contains endpoints to create/delete a project, to create service, and to send/get events.
configuration-service provides GET endpoints for project/stage/service and endpoints for resource management.
/authendpoint of the
api-servicenow does not implement endpoints of the
configuration-serviceis exposed to the public. Endpoints that are not intended to be used from the public (e.g., deleting a project) are marked and the description is accordingly adapted.
Architecture for the full installation:
Architecture for the quality gates installation:
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.