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

Request

Security
Authorization
Bodyapplication/json
friendly_namestring
locationstring

Set as empty string to specify mobile device. Can also use 'mobile' boolean field to do this.

mac_addressstring^((([0-9A-F]{2}:){5})|(([0-9A-F]{2}-){5})|([0...required
network_idintegerrequired
autostring
Enum"1""""0"
mobileboolean
curl -i -X PUT \
  https://docs.cognitivesystems.com/_mock/assets/specs/api/app_cloud/leaf \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "friendly_name": "string",
    "location": "string",
    "mac_address": "string",
    "network_id": 0,
    "auto": "1",
    "mobile": true
  }'

Responses

OK

Show Network Info

Request

Returns the following internal network identifiers:

  • guardian_id
  • external_id
  • network_id
  • nodes
Security
Authorization
curl -i -X GET \
  https://docs.cognitivesystems.com/_mock/assets/specs/api/app_cloud/networks/info \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
guardian_idstring

The Guardian ID is a unique identifier for a WiFi Motion network.

Example: "add5cfe79g12797e253e3623"
external_idinteger(int32)

The unique identifier that the Motion Network System (MNS) uses to identify a network.

Example: 1
network_idinteger(int32)

A unique identifier that the App-Cloud uses to identify a network.

Example: 2
nodesobject

A node is a network device that contains Cognitive System's proprietary WiFi Motion software. Examples can include Access Points (APs) and IoT devices.

Example: {"esp_1A2B345C6D7E":{"hw_version":"Ven-diag","fw_version":"v2.01.0"},"esp_2A2B345C6D7E":{"hw_version":"Ven-diag","fw_version":"v2.01.0"},"esp_3A2B345C6D7E":{"hw_version":"Ven-diag","fw_version":"v2.01.0"},"esp_4A2B345C6D7E":{"hw_version":"Ven-diag","fw_version":"v2.01.0"}}
Response
application/json
{ "guardian_id": "add5cfe79g12797e253e3623", "external_id": 1, "network_id": 2, "nodes": { "esp_1A2B345C6D7E": {}, "esp_2A2B345C6D7E": {}, "esp_3A2B345C6D7E": {}, "esp_4A2B345C6D7E": {} } }

Sounding v2

Operations

Events, History, and Visualizations

Operations

Household Insights [BETA]

Operations

Zone Priority [BETA]

Operations

Universal Alerting

Operations

Meta

Operations

Administration

Operations