Skip to content

Cognitive Systems App Cloud API

The App Cloud APIs expose the Core API endpoints, but with the addition of adding per user authentication and authorization. For example, you may choose to build with App Cloud APIs when developing for a mobile platform.

Download OpenAPI description
Languages
Servers
Mock server
https://docs.cognitivesystems.com/_mock/assets/specs/api/app_cloud/
https://docs.cognitivesystems.com/api/v1/

Overview

Operations

Build Version

Request

Determine App Cloud version and differentiate from Halo Home (legacy)

curl -i -X GET \
  https://docs.cognitivesystems.com/_mock/assets/specs/api/app_cloud/version

Responses

Bodyapplication/json
servicestring
Example: "appcloud"
versionstring
Example: "v0-9-18"
Response
application/json
{ "service": "appcloud", "version": "v0-9-18" }

Health Probe

Request

Endpoint used by load balancer to determine cloud instance status

curl -i -X GET \
  https://docs.cognitivesystems.com/_mock/assets/specs/api/app_cloud/healthz

Responses

Bodyapplication/json
versionstring
Example: "v1-3-x"
Response
application/json
{ "version": "v1-3-x" }

Out of Box

Operations

Logging In

Operations

Geofencing

Operations

Account Management

Operations

Network Settings

Operations

Sounding v2

Operations

Events, History, and Visualizations

Operations

Household Insights

Operations

Zone Priority

Operations

Universal Alerting

Operations

Meta

Operations

Sensor Integration

Operations