Cognitive Systems WiFi Motion App-Cloud API (v1-5-x)

App Cloud APIs are used by mobile applications.

Download OpenAPI description
Languages
Servers
Mock server

https://docs.cognitivesystems.com/_mock/assets/specs/app-cloud/v1-5-x/

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

Show current zone priority list

Request

curl -i -X GET \
  https://docs.cognitivesystems.com/_mock/assets/specs/app-cloud/v1-5-x/zone_priority

Responses

Bodyapplication/jsonArray [
string
]
Response
application/json
[ "Entrance", "Master Bedroom", "Backyard" ]

Replace zone priority list

Request

Accepts a list or array of strings, these do not have to match or be contained in the list of strings produced by GET /default_locations. Patching is not additive, every request will replace the values.

Making this list empty is the feature switch on whether to use the new zone prioritized leaf blower, or whether to default to legacy leaf blower.

[] tells the network to use legacy leaf blower.

Non empty, for example: ["Kitchen"] disables legacy leaf blower and enables the zone prioritized leaf blower.

Bodyapplication/jsonArray [
string
]
curl -i -X PATCH \
  https://docs.cognitivesystems.com/_mock/assets/specs/app-cloud/v1-5-x/zone_priority \
  -H 'Content-Type: application/json' \
  -d '[
    "Entrance",
    "Master Bedroom",
    "Backyard"
  ]'

Responses

OK

Bodyapplication/jsonArray [
string
]
Response
application/json
[ "Entrance", "Master Bedroom", "Backyard" ]

Batch update leafs and nodes

Request

Receives a list of objects that mutate nodes and/or leafs.

Network nodes (star or mesh) cannot be targeted using a mac_address but only using the node_id. The auto key is also not supported by nodes so the input validation will throw. Mutations to node require node_id and cannot include auto or mac_address.

We expect leafs in the array to not have node_id, and they must have auto and mac_address.

Both mutations to nodes or leafs must always have location and friendly_name keys.

Order does not matter. The payload can include only leafs or only nodes.

Bodyapplication/json
devicesArray of objects
Example: [{"mac_address":"e6:c4:19:c7:2e:f1","auto":"0","location":"Kitchen","friendly_name":"Amazon Alexa"},{"mac_address":"c2:8e:01:69:7f:f2","auto":"","location":"Living Room","friendly_name":"Aura Frame"},{"location":"Basement","friendly_name":"Mesh Node","node_id":4},{"mac_address":"c2:8e:01:69:7f:f2","auto":"","location":"Living Room","friendly_name":"Smart TV"}]
curl -i -X PATCH \
  https://docs.cognitivesystems.com/_mock/assets/specs/app-cloud/v1-5-x/devices \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "devices": [
      {
        "mac_address": "e6:c4:19:c7:2e:f1",
        "auto": "0",
        "location": "Kitchen",
        "friendly_name": "Amazon Alexa"
      },
      {
        "mac_address": "c2:8e:01:69:7f:f2",
        "auto": "",
        "location": "Living Room",
        "friendly_name": "Aura Frame"
      },
      {
        "location": "Basement",
        "friendly_name": "Mesh Node",
        "node_id": 4
      },
      {
        "mac_address": "c2:8e:01:69:7f:f2",
        "auto": "",
        "location": "Living Room",
        "friendly_name": "Smart TV"
      }
    ]
  }'

Responses

Universal Alerting

Operations

Meta

Operations

Administration

Operations