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
app_cloud.json
app_cloud.yaml
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

Sounding v2

Operations

Events, History, and Visualizations

Operations

Household Insights [BETA]

Operations

Zone Priority [BETA]

Operations

Universal Alerting

Operations

Meta

Operations

Administration

Operations

Display network and related config

Request

Retrieve all network related data from postgres and MNS for a single network. This includes network, members, scenes, login, and events information.

Security
Authorization
Path
network_idstringrequired
curl -i -X GET \
  'https://docs.cognitivesystems.com/_mock/assets/specs/api/app_cloud/internal/network/{network_id}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
network_idinteger
external_idinteger
usersArray of objects
networkobject
network_scene_configobject
mobile_devicesArray of objects
invitationsArray of objects
leafsArray of objects
nodesArray of objects
systemobject
Response
application/json
{
  "network_id": 0,
  "external_id": 0,
  "users": [
    { … }
  ],
  "network": {
    "id": 0,
    "name": "string",
    "created_at": "string",
    "updated_at": "string",
    "external_id": 0,
    "user_count": 0,
    "latitude": "string",
    "longitude": "string",
    "address": "string",
    "timezone": "string",
    "pet_size": "string",
    "building_type": "string",
    "building_size": "string",
    "live_enabled": true,
    "scene_id": 0
  },
  "network_scene_config": {
    "id": 0,
    "network_id": 0,
    "excessive_motion_seconds": 0,
    "excessive_motion_enabled": true,
    "created_at": "string",
    "updated_at": "string",
    "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_job_id": 0,
    "auto_switching_enabled": true,
    "guardian_weekend_start_time_hours": 0,
    "guardian_weekend_start_time_minutes": 0,
    "guardian_weekend_end_time_hours": 0,
    "guardian_weekend_end_time_minutes": 0
  },
  "mobile_devices": [
    { … }
  ],
  "invitations": [
    { … }
  ],
  "leafs": [
    { … }
  ],
  "nodes": [
    { … }
  ],
  "system": {
    "pet_filter": 0,
    "sensitivity": "string",
    "notification_cooldown": 0,
    "online": true,
    "last_motion": 0
  }
}

List Network Owners

Request

Retrieve paginated array of all users that are network owners

Security
Authorization
Path
page_numberstringrequired

current page number

count_numberstringrequired

Number of items per page

Default 25
curl -i -X GET \
  'https://docs.cognitivesystems.com/_mock/assets/specs/api/app_cloud/internal/users/{page_number}/{count_number}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/jsonArray [
user_idinteger
emailstring
first_namestring
last_namestring
external_idinteger
network_idinteger
]
Response
application/json
[
  {
    "user_id": 0,
    "email": "string",
    "first_name": "string",
    "last_name": "string",
    "external_id": 0,
    "network_id": 0
  }
]

Password Reset

Request

Security
Authorization
Bodyapplication/json
emailstring(email)required
passwordstring>= 6 charactersrequired
curl -i -X PATCH \
  https://docs.cognitivesystems.com/_mock/assets/specs/api/app_cloud/internal/users/reset \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "email": "user@example.com",
    "password": "string"
  }'

Responses

Bodyapplication/json
idinteger
Example: 3
usernamestring
Example: "jsmith"
emailstring
Example: "john.smith@cognitivesystems.com"
first_namestring
Example: "John"
last_namestring
Example: "Smith"
created_atstring
Example: "2020-08-27T20:44:38.793Z"
updated_atstring
Example: "2020-11-10T20:08:40.754Z"
confirmed_atstring or null
Example: "2020-08-27T20:44:38.793Z"
Response
application/json
{
  "id": 3,
  "username": "jsmith",
  "email": "john.smith@cognitivesystems.com",
  "first_name": "John",
  "last_name": "Smith",
  "created_at": "2020-08-27T20:44:38.793Z",
  "updated_at": "2020-11-10T20:08:40.754Z",
  "confirmed_at": "2020-08-27T20:44:38.793Z"
}