Skip to content

Cognitive Systems App Cloud API

The AppCloud APIs are used by mobile applications to communicate with the Cognitive Systems Infrastructure.

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

Update General Settings

Request

  • Updates App Cloud network with user-specific information. User must have the role "owner" for the corresponding network.
  • Request body does not require all listed fields, but fields must match type and value validations

To update the timezone, only pass timezone in the request body:

{ "timezone": "Europe/Warsaw" }

Security
Authorization
Path
idintegerrequired
Query
expandArray of strings
Bodyapplication/json
namestring
addressstring
latitudeinteger
longitudeinteger
timezonestring
pet_sizestring
scene_idinteger
building_typestring
building_sizestring
live_enabledboolean
idinteger
curl -i -X PUT \
  'https://docs.cognitivesystems.com/_mock/assets/specs/api/app_cloud/networks/{id}?expand=string' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "address": "string",
    "latitude": 0,
    "longitude": 0,
    "timezone": "string",
    "pet_size": "string",
    "scene_id": 0,
    "building_type": "string",
    "building_size": "string",
    "live_enabled": true,
    "id": 0
  }'

Responses

Bodyapplication/json
idinteger
addressstring
building_sizestring
building_typestring
latitudestring
longitudestring
live_enabledboolean
name(string or null)
(string or null)
pet_sizestring
timezonestring
user_countnumber
created_atstring
updated_atstring
external_idinteger
scene_idinteger
present_countinteger
claimedboolean
network_scene_config(object or null) or (integer or null)
Any of:
object or null
owner_emailstring
subscription_idstring or null
Response
application/json
{ "id": 0, "address": "string", "building_size": "string", "building_type": "string", "latitude": "string", "longitude": "string", "live_enabled": true, "name": "string", "pet_size": "string", "timezone": "string", "user_count": 0, "created_at": "string", "updated_at": "string", "external_id": 0, "scene_id": 0, "present_count": 0, "claimed": true, "network_scene_config": {}, "owner_email": "string", "subscription_id": "string" }

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 Scene Settings

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 }

Sounding v2

Operations

Events, History, and Visualizations

Operations

Household Insights [BETA]

Operations

Zone Priority [BETA]

Operations

Universal Alerting

Operations

Meta

Operations

Administration

Operations