Utility

Soda Cloud API Utility Endpoints

Test connection

get

https://cloud.soda.iohttps://cloud.us.soda.io

/api/v1/test-login

This endpoint enables you to test the API connection to your organization's Soda Cloud account. Use this endpoint to verify that the authentication and authorization details are accurate and the API is ready to accept calls.

Authentication

User authentication required: true

This endpoint accepts authentication via API keys in the Basic authentication header, or a pre-authenticated token in HTTP cookie token. Cookie sessions extend automatically on each request.

Authorization

Any Soda Cloud user in your organization may execute this query.

Tags

Utility

Rate limiting

10 requests/10 seconds

Authorizations

basicAuthApiKeycookieToken

AuthorizationstringRequired

Responses

200

Successful response

application/json

organisationNamestringOptional

400

Bad request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not found

application/json

429

Too many requests

application/json

500

Internal server error

application/json

get/api/v1/test-login

HTTPcURLJavaScriptPython

GET /api/v1/test-login HTTP/1.1
Host: cloud.soda.io
Authorization: Basic username:password
Accept: */*

{
  "organisationName": "text"
}