Komodor API (0.1.0)

Download OpenAPI specification:Download

API Interface to Komodor services

Authentication

ApiKeyAuth

The API Key can be obtained or refreshed by installing a "REST API" integration on the Komodor app UI.

Security Scheme Type API Key
Header parameter name: X-API-KEY

Events

Notify Komodor of the connection between a Docker image and the Git ref it corresponds with

With the source code information for a given Docker image, Komodor will be able to link the relevant Git events to the deployment. Having the deployment connected to the source code changes allows you to gain understanding of what changed and who made the change for a given deployment.

Authorizations:
Request Body schema: application/json
image
required
string

A fully qualified Docker image name, as appears in the K8s deployment spec.

required
object

Git information of the build. This information will be used to connect the subsequent deployment to relevant Git events.

object

Responses

Request samples

Content type
application/json
{
  • "image": "string",
  • "git": {
    },
  • "ci": {
    }
}

Response samples

Content type
application/json
{
  • "success": true
}