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

Operations

Zone Priority

Operations

Universal Alerting

Operations

Meta

Operations

Sensor Integration

Operations

Obtain detections for a single Sensor

Request

Generic API to query sensor detections by thingName without any filters or selected time ranges.

Path
THING_NAMEstringrequired

Sensor thingName.

curl -i -X GET \
  'https://docs.cognitivesystems.com/_mock/assets/specs/api/app_cloud/sensors/history/{THING_NAME}'

Responses

200 OK

Bodyapplication/json
Response
application/json
{
  "network_id": "1",
  "sensor_detections": [
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … }
  ]
}

Obtain Recommended Software Version

Request

Provides you with the recommended software version for your hub.

curl -i -X GET \
  https://docs.cognitivesystems.com/_mock/assets/specs/api/app_cloud/sensors/ota/hub/recommended

Responses

200 OK

Bodyapplication/json
versionstring

The recommended software version for the hub.

Response
application/json
{
  "version": "03.00.88.00"
}

Perform Sensor OTA Upgrade

Request

Allows you to update your sensors via an Over the Air (OTA) push.

Path
thingNamestringrequired

The ID of the sensor.

Bodyapplication/json
otaVersionstring

The software version to use to upgrade the hub.

curl -i -X POST \
  'https://docs.cognitivesystems.com/_mock/assets/specs/api/app_cloud/sensors/{thingName}' \
  -H 'Content-Type: application/json' \
  -d '{
    "otaVersion": "03.00.88.00"
  }'

Responses

201 Created

Bodyapplication/json
thingNamestring

The hub thingName that is the target of the Over the Air (OTA) upgrade.

fromVersionstring

The software version that the hub is being upgraded from.

toVersionstring

The software version that the hub is being upgraded to.

Response
application/json
{
  "thingName": "HUB_A1B2CDEF345A",
  "fromVersion": "03.00.62.00",
  "toVersion": "03.00.88.00"
}