11. API Reference

Each service publishes its own interactive reference (Swagger UI) and OpenAPI schema, generated from the release you run, through the platform gateway:

Service

Interactive reference

OpenAPI schema

Platform gateway

https://<koios host>/api/gateway/v1/docs/

https://<koios host>/api/gateway/v1/docs/schema/

Automation controller

https://<koios host>/api/controller/v2/docs/

https://<koios host>/api/controller/v2/docs/schema/

Event-Driven Ansible

https://<koios host>/api/eda/v1/docs/

https://<koios host>/api/eda/v1/openapi.json

The browsable API of each service (for example /api/controller/v2/) also describes every endpoint; see Browsable API. Authentication is described in Authentication Methods Using the API.