The Banzai Cloud 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 Banzai CLI or the web interface. There are use cases when other clients or generic HTTP 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.
To help discovering the API, we also have Postman collections.
| Service | OpenAPI | Postman |
|---|---|---|
| pipeline | API reference / pipeline.yaml / Swagger | collection |
| cloudinfo | cloudinfo.yaml / Swagger | |
| telescopes | recommender.yaml / Swagger |
Authentication 🔗︎
API requests to Cloudinfo and Telescopes are unauthenticated, while nearly all endpoints of Pipeline need an access token.
The token should be present in the Authorization header of the request.
For example, you can use the following command to list the available organizations:
curl <your-pipeline-url>/pipeline/api/v1/orgs -H "Authorization: Bearer $PIPELINE_TOKEN"
For details about access tokens, check the authentication section.
Examples 🔗︎
You can check the source code of Banzai CLI for examples about using the API from Go code.
