API URL

The CloudSoda API is accessible via the api.<deployment>.cloudsoda.io subdomain for both REST and GraphQL endpoints. For example, if your URL is https://acme-us-1.cloudsoda.io, your API can be reached at https://api.acme-us-1.cloudsoda.io.

Endpoints

Both REST and GraphQL endpoints are available on a unified HTTP server for streamlined API access.

GraphQL Endpoint

In accordance with common practices across GraphQL implementations, the standard GraphQL query endpoint is located at the /graphql path which is accessible to both GET and POST HTTP queries. For example, the URL could look like https://acme-us-1.api.cloudsoda.io/graphql.

Server Information Endpoint

The GET / endpoint provides basic metadata about the CloudSoda API server in a JSON format response. This endpoint serves as the primary entry point for accessing and navigating within the REST API. For GraphQL clients, it can confirm connectivity to the API server.

Authentication Endpoint

The POST /oauth/token endpoint is used to obtain an authentication token necessary for authenticating subsequent requests on behalf of the client. For more detailed information about obtaining and using authentication tokens, refer to the Authentication section.