Skip to content

Cognitive Systems App Core API

The Core APIs facilitate the creation, configuration, and management of WiFi Motion networks via RESTful APIs. It offers interfaces for accessing topologies, events, motion data, and more.

Download OpenAPI description
core.json
core.yaml
Languages
Servers
Mock server
https://docs.cognitivesystems.com/_mock/assets/specs/api/core/

Network Settings

Operations

Motion History

Operations

Live Motion

Operations

Events

Operations

Insights v2

Operations

Universal Alerting

Operations

Network Status

Operations

Network Meta

Operations

Location Data

Operations

Find

Operations

Application Settings

Operations

Create a new application configuration

Request

Creates a new application configuration entry for a specific network with schedule settings and timezone.

Security
ApiKey
Path
network_idintegerrequired

Unique identifier of the network whose configuration should be managed

Bodyapplication/jsonrequired

Application configuration object that needs to be created

network_idinteger(network_id)

The network identifier of the WiFi Motion network.

timezonestring(timezone)

Timezone configuration

enabledboolean(enabled)

The sleep settings enabled or disabled.

true Sleep settings are enabled

false Sleep settings are not enabled

sleep_hourinteger(sleep_hour)[ 0 .. 23 ]

Provides rough guidance to the WiFi Motion network as to the hour of day when the household initiates their sleeping pattern.

sleep_minuteinteger(sleep_minute)[ 0 .. 59 ]

Provides rough guidance to the WiFi Motion network as to the minute within the hour when the household initiates their sleeping pattern.

wake_hourinteger(wake_hour)[ 0 .. 23 ]

Provides rough guidance to the WiFi Motion network as to the hour of day when the household ends their sleeping pattern.

wake_minuteinteger(wake_minute)[ 0 .. 59 ]

Provides rough guidance to the WiFi Motion network as to the minute within the hour when the household ends their sleeping pattern.

curl -i -X POST \
  'https://docs.cognitivesystems.com/_mock/assets/specs/api/core/network/{network_id}/application/settings' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "network_id": 0,
    "timezone": "string",
    "enabled": true,
    "sleep_hour": 23,
    "sleep_minute": 59,
    "wake_hour": 23,
    "wake_minute": 59
  }'

Responses

Configuration created successfully

Bodyapplication/json
Response
application/json
{
  "message": "Configuration created successfully",
  "data": {
    "network_id": 123,
    "timezone": "America/New_York",
    "enabled": true,
    "sleep_hour": 22,
    "sleep_minute": 30,
    "wake_hour": 6,
    "wake_minute": 30,
    "created_at": "2025-06-17T18:44:01.674Z",
    "updated_at": "2025-06-17T18:44:01.674Z",
    "enabled_at": "2025-06-17T18:44:01.674Z"
  }
}

Update an application configuration

Request

Updates an existing application configuration with provided fields. Only supplied fields will be updated.

Security
ApiKey
Path
network_idintegerrequired

Unique identifier of the network whose configuration should be managed

Bodyapplication/jsonrequired

Application configuration fields to update

network_idinteger(network_id)

The network identifier of the WiFi Motion network.

timezonestring(timezone)

Timezone configuration

enabledboolean(enabled)

The sleep settings enabled or disabled.

true Sleep settings are enabled

false Sleep settings are not enabled

sleep_hourinteger(sleep_hour)[ 0 .. 23 ]

Provides rough guidance to the WiFi Motion network as to the hour of day when the household initiates their sleeping pattern.

sleep_minuteinteger(sleep_minute)[ 0 .. 59 ]

Provides rough guidance to the WiFi Motion network as to the minute within the hour when the household initiates their sleeping pattern.

wake_hourinteger(wake_hour)[ 0 .. 23 ]

Provides rough guidance to the WiFi Motion network as to the hour of day when the household ends their sleeping pattern.

wake_minuteinteger(wake_minute)[ 0 .. 59 ]

Provides rough guidance to the WiFi Motion network as to the minute within the hour when the household ends their sleeping pattern.

curl -i -X PATCH \
  'https://docs.cognitivesystems.com/_mock/assets/specs/api/core/network/{network_id}/application/settings' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "network_id": 0,
    "timezone": "string",
    "enabled": true,
    "sleep_hour": 23,
    "sleep_minute": 59,
    "wake_hour": 23,
    "wake_minute": 59
  }'

Responses

Configuration updated successfully

Bodyapplication/json
Response
application/json
{
  "message": "Configuration updated successfully",
  "data": {
    "network_id": 369,
    "timezone": "America/New_York",
    "enabled": true,
    "sleep_hour": 22,
    "sleep_minute": 30,
    "wake_hour": 6,
    "wake_minute": 30,
    "created_at": "2025-06-17T18:51:22.140Z",
    "updated_at": "2025-06-17T19:02:23.869Z",
    "enabled_at": "2025-06-17T19:02:23.869Z"
  }
}

Delete application configuration by network ID

Request

Deletes the application configuration settings for a specified network.

Security
ApiKey
Path
network_idintegerrequired

Unique identifier of the network whose configuration should be managed

curl -i -X DELETE \
  'https://docs.cognitivesystems.com/_mock/assets/specs/api/core/network/{network_id}/application/settings' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Application configuration deleted successfully

Bodyapplication/json
Response
application/json
{
  "message": "Configuration deleted successfully"
}

Config

Operations

Node

Operations

Management

Operations