Overview
API Reference
Blue API allows you to programmatically access our services such as Ripple, WavePro, and Octo. It uses protocol buffers for service and message definitions, and gRPC for implementation and server/client stub generation. It also uses grpc-gateway for proxying JSON/REST requests to gRPC, and generating OpenAPI documentation. This way, you have the option to use our APIs using either gRPC or JSON/REST, or both.
Apart from Octo, some of the APIs currently supported in Ripple, and WavePro are still not available in Blue. In the meantime, you can still use our JSON/REST APIs here. We plan to upgrade as many of our JSON/REST APIs as possible over to gRPC as it is significantly more efficient in terms of throughput and CPU usage compared to JSON/REST API. However, we don't intend to deprecate our JSON/REST APIs once the transition is completed. You should be able to use both.
List of supported APIs
| API | Link | Additional info |
|---|---|---|
| Organization API | https://labs.alphaus.cloud/blueapidocs/#/Organization | - |
| IAM API | https://labs.alphaus.cloud/blueapidocs/#/Iam | Link |
| Admin API | https://labs.alphaus.cloud/blueapidocs/#/Admin | - |
| Cost API | https://labs.alphaus.cloud/blueapidocs/#/Cost | - |
| Billing API | https://labs.alphaus.cloud/blueapidocs/#/Billing | Link |
| Operations API | https://labs.alphaus.cloud/blueapidocs/#/Operations | - |
| Octo API | https://labs.alphaus.cloud/blueapidocs/#/Cover | - |
| Pricing API | https://labs.alphaus.cloud/blueapidocs/#/Pricing | - |
| Flow API | https://labs.alphaus.cloud/blueapidocs/#/Flow | - |
| Prism API | https://labs.alphaus.cloud/blueapidocs/#/Prism | - |
| Vortex API | https://labs.alphaus.cloud/blueapidocs/#/Vortex | - |
| Preferences API | https://labs.alphaus.cloud/blueapidocs/#/Preferences | - |