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

Show Scene SettingsDeprecated

Request

Security
Authorization
Path
idintegerrequired

network scene id

curl -i -X GET \
  'https://docs.cognitivesystems.com/_mock/assets/specs/api/app_cloud/network_scene_configs/{id}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
idinteger
excessive_motion_enabledboolean
excessive_motion_secondsinteger
network_idinteger
created_atstring
updated_atstring
auto_switching_enabledboolean
guardian_enabledboolean
guardian_weekday_start_time_hoursnumber
guardian_weekday_start_time_minutesnumber
guardian_weekday_end_time_hoursnumber
guardian_weekday_end_time_minutesnumber
guardian_weekend_start_time_hoursnumber
guardian_weekend_start_time_minutesnumber
guardian_weekend_end_time_hoursnumber
guardian_weekend_end_time_minutesnumber
Response
application/json
{ "id": 0, "excessive_motion_enabled": true, "excessive_motion_seconds": 0, "network_id": 0, "created_at": "string", "updated_at": "string", "auto_switching_enabled": true, "guardian_enabled": true, "guardian_weekday_start_time_hours": 0, "guardian_weekday_start_time_minutes": 0, "guardian_weekday_end_time_hours": 0, "guardian_weekday_end_time_minutes": 0, "guardian_weekend_start_time_hours": 0, "guardian_weekend_start_time_minutes": 0, "guardian_weekend_end_time_hours": 0, "guardian_weekend_end_time_minutes": 0 }

Update Scene SettingsDeprecated

Request

Security
Authorization
Path
idintegerrequired

network scene id

Bodyapplication/json
idinteger
excessive_motion_secondsinteger
excessive_motion_enabledboolean
auto_switching_enabledboolean
guardian_enabledboolean
guardian_weekday_start_time_hoursnumber
guardian_weekday_start_time_minutesnumber
guardian_weekday_end_time_hoursnumber
guardian_weekday_end_time_minutesnumber
guardian_weekend_start_time_hoursnumber
guardian_weekend_start_time_minutesnumber
guardian_weekend_end_time_hoursnumber
guardian_weekend_end_time_minutesnumber
curl -i -X PUT \
  'https://docs.cognitivesystems.com/_mock/assets/specs/api/app_cloud/network_scene_configs/{id}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": 0,
    "excessive_motion_seconds": 0,
    "excessive_motion_enabled": true,
    "auto_switching_enabled": true,
    "guardian_enabled": true,
    "guardian_weekday_start_time_hours": 0,
    "guardian_weekday_start_time_minutes": 0,
    "guardian_weekday_end_time_hours": 0,
    "guardian_weekday_end_time_minutes": 0,
    "guardian_weekend_start_time_hours": 0,
    "guardian_weekend_start_time_minutes": 0,
    "guardian_weekend_end_time_hours": 0,
    "guardian_weekend_end_time_minutes": 0
  }'

Responses

Bodyapplication/json
idinteger
excessive_motion_enabledboolean
excessive_motion_secondsinteger
network_idinteger
created_atstring
updated_atstring
auto_switching_enabledboolean
guardian_enabledboolean
guardian_weekday_start_time_hoursnumber
guardian_weekday_start_time_minutesnumber
guardian_weekday_end_time_hoursnumber
guardian_weekday_end_time_minutesnumber
guardian_weekend_start_time_hoursnumber
guardian_weekend_start_time_minutesnumber
guardian_weekend_end_time_hoursnumber
guardian_weekend_end_time_minutesnumber
Response
application/json
{ "id": 0, "excessive_motion_enabled": true, "excessive_motion_seconds": 0, "network_id": 0, "created_at": "string", "updated_at": "string", "auto_switching_enabled": true, "guardian_enabled": true, "guardian_weekday_start_time_hours": 0, "guardian_weekday_start_time_minutes": 0, "guardian_weekday_end_time_hours": 0, "guardian_weekday_end_time_minutes": 0, "guardian_weekend_start_time_hours": 0, "guardian_weekend_start_time_minutes": 0, "guardian_weekend_end_time_hours": 0, "guardian_weekend_end_time_minutes": 0 }

Sounding v2

Operations

Events, History, and Visualizations

Operations

Household Insights

Operations

Zone Priority

Operations

Universal Alerting

Operations

Meta

Operations

Sensor Integration

Operations