API Reference

Welcome to the CloudSoda API documentation. Here, you can explore the various options available for integrating with CloudSoda services. CloudSoda provides two client APIs: GraphQL and REST. The GraphQL API allows you to programmatically interact with a broad range of CloudSoda resources and continues to evolve with new product features. The REST API is limited to Quick Transfers and receives regular maintenance updates but is otherwise feature complete.

GraphQL API (Recommended)

The GraphQL API is the recommended way for you to interact with our services. It offers a more efficient, powerful, and flexible approach compared to traditional REST APIs.

Why Choose GraphQL?

• Efficient Data Retrieval: Fetch exactly what you need in a single request. No more over-fetching or under-fetching data.
• Strongly Typed Schema: Know exactly what data is available and how it’s structured, thanks to the strongly typed nature of GraphQL.
• Interactive Documentation: Explore our API in an interactive environment with a self-documented schema.
• Code Generation: While JSON HTTP requests can be used to query data from the API, all major languages provide rich tooling for generating client query code from the schema.

REST API

The traditional RESTful approach is also available through a REST API. This API adheres to standard HTTP methods and REST principles, offering a familiar choice for many developers.

Why Use REST?

• Wide Compatibility: Easily integrate with any system that supports HTTP.
• Stateless Interactions: Each request from you, the client, to our server is independent, ensuring simplicity and reliability.
• Standardized Approach: Leverage standard HTTP methods like GET, POST, PUT, and DELETE for CRUD operations.