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

Out of Box

Operations

Logging In

Operations

Geofencing

Operations

Account Management

Operations

Network Settings

Operations

Disown Network

Request

  • Disowns a given network, user must be owner.
  • Removes rows from following tables in postgres
    • networks
    • network memberships
    • network scene configs
    • invitations
    • mobile devices
    • users
  • Also propogates delete to MNS
Security
Authorization
Path
idintegerrequired
curl -i -X DELETE \
  'https://docs.cognitivesystems.com/_mock/assets/specs/api/app_cloud/networks/{id}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

204 No Content

Response
No content

Show Motion Settings

Request

Security
Authorization
Query
network_idinteger
curl -i -X GET \
  'https://docs.cognitivesystems.com/_mock/assets/specs/api/app_cloud/network_motion_config?network_id=0' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
cooldowninteger
Example: 200
sensitivity_levelstring
Enum"very-low""low""normal""high"
Example: "low"
Response
application/json
{ "cooldown": 200, "sensitivity_level": "low" }

Update Motion Settings

Request

Security
Authorization
Bodyapplication/json
network_idinteger or numberrequired
Example: 6
Any of:
integer
cooldowninteger or number
Example: 300
Any of:
integer
sensitivity_levelstring
Enum"very-low""low""normal""high"
Example: "normal"
curl -i -X PUT \
  https://docs.cognitivesystems.com/_mock/assets/specs/api/app_cloud/network_motion_config \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "network_id": 6,
    "cooldown": 300,
    "sensitivity_level": "normal"
  }'

Responses

Bodyapplication/json
cooldowninteger
Example: 300
sensitivity_levelstring
Enum"very-low""low""normal""high"
Example: "low"
Response
application/json
{ "cooldown": 300, "sensitivity_level": "low" }

Sounding v2

Operations

Events, History, and Visualizations

Operations

Household Insights

Operations

Zone Priority

Operations

Universal Alerting

Operations

Meta

Operations

Sensor Integration

Operations