The Pipeline Platform consists of different services, which provide a RESTful interface for their users. The services provided on these programmatic interfaces are easily usable with the web interface of the Pipeline Platform. There are however use cases when other clients (like our CI/CD plugin or our planned CLI tool), or more generic clients like curl are the best way to use our services.

All of our interfaces are documented with an OpenAPI description, which allows generating client stubs (bindings) for most programming languages. We do also have pre-generated Go clients that you can import directly to your Go programs.

To help discovering the API, we also have Postman collections.

Service OpenAPI Go Client Postman
pipeline pipeline.yaml Swagger github.com/banzaicloud/pipeline/client collection
cloudinfo cloudinfo.yaml Swagger github.com/banzaicloud/cloudinfo/pkg/cloudinfo-client
telescopes recommender.yaml Swagger