Kosli API

The Kosli API is a REST API that the Kosli CLI, the web app, and the Terraform provider all build on. The endpoint pages in this section are generated from the API’s OpenAPI specification.

Base URLs

Use the base URL of the instance your organization lives on. It’s the address you sign in to Kosli at, followed by /api/v2:

Instance	Base URL
EU (default)	`https://app.kosli.com/api/v2`
US	`https://app.us.kosli.com/api/v2`
Kosli Dedicated	`https://<your-kosli-domain>/api/v2`

Authentication

Send a Kosli API key as a bearer token in the Authorization header:

curl -H "Authorization: Bearer $KOSLI_API_TOKEN" \
  https://app.kosli.com/api/v2/environments/<your-org>

Use a service account API key for automation, or a personal API key for trying things out. For HTTP basic auth and other options, see API authentication methods.

Interactive Swagger docs

Each instance also serves interactive Swagger docs, generated from the same specification:

Instance	Swagger docs
EU (default)	app.kosli.com/api/v2/doc
US	app.us.kosli.com/api/v2/doc
Kosli Dedicated	`https://<your-kosli-domain>/api/v2/doc`

To send requests from Swagger, select Authorize and paste your API key. Requests run against the instance you opened the Swagger docs on, so use the one your organization lives on.

Get started

Actions

Allowlists

Artifacts

Asserts

Attestation

Builds

Controls

Custom Attestation Types

Deployments

EnvDiff

Environments

Evaluations

Flows

Audit Log

Notification Config

Organizations

Policies

Rego Policies

Repos

Schemas

Search

Service Accounts

Snapshots

Tags

Trails

User

Base URLs

Authentication

Interactive Swagger docs

​Base URLs

​Authentication

​Interactive Swagger docs

Base URLs

Authentication

Interactive Swagger docs