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

Config

Operations

Get Motion-Radar configuration

Request

Security
ApiKey
Path
network_idintegerrequired

Motion Network ID (returned as 'id' by Find API calls)

Query
keystring

If provided, all operations will be relative to this top-level key.

curl -i -X GET \
  'https://docs.cognitivesystems.com/_mock/assets/specs/api/core/network/{network_id}/config/radar?key=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

OK.

Bodyapplication/json
dynamic_sensitivitystring

Dynamic sensitivity enable (for development only)

bridgeobject
motion80211object
Response
application/json
{
  "dynamic_sensitivity": "string",
  "bridge": {
    "statusInterval": 60,
    "zmqPort": 6969,
    "loglevel": "debug",
    "zmqHost": "127.0.0.1",
    "linkExpiry": 120,
    "debug": 1,
    "debug_status": 0,
    "vault": 0
  },
  "motion80211": {
    "txEnable": { … },
    "linkSens": { … },
    "hyperSensOverride": [ … ],
    "noise_ctrl": 0,
    "cfrMode": "o",
    "dmEnable": 0,
    "period": 0,
    "meshAutoDisable": 0,
    "meshSoundingDisabled": [ … ],
    "sens": 1,
    "forceTxEnable": 0,
    "pingerEnable": { … },
    "ping_rate": 100,
    "optmode": { … },
    "mpdf_threshold": { … }
  }
}

Set Motion-Radar configuration

Request

Security
ApiKey
Path
network_idintegerrequired

Motion Network ID (returned as 'id' by Find API calls)

Query
updateboolean

Propagate configuration change to device.

Default false
keystring

If provided, all operations will be relative to this top-level key.

Bodyapplication/json
dynamic_sensitivitystring

Dynamic sensitivity enable (for development only)

bridgeobject
motion80211object
curl -i -X POST \
  'https://docs.cognitivesystems.com/_mock/assets/specs/api/core/network/{network_id}/config/radar?update=false&key=string' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "dynamic_sensitivity": "string",
    "bridge": {
      "statusInterval": 60,
      "zmqPort": 6969,
      "loglevel": "debug",
      "zmqHost": "127.0.0.1",
      "linkExpiry": 120,
      "debug": 1,
      "debug_status": 0,
      "vault": 0
    },
    "motion80211": {
      "txEnable": {
        "property1": 0,
        "property2": 0
      },
      "linkSens": {
        "property1": 0,
        "property2": 0
      },
      "hyperSensOverride": [
        "string"
      ],
      "noise_ctrl": 0,
      "cfrMode": "o",
      "dmEnable": 0,
      "period": 0,
      "meshAutoDisable": 0,
      "meshSoundingDisabled": [
        "string"
      ],
      "sens": 1,
      "forceTxEnable": 0,
      "pingerEnable": {
        "property1": 0,
        "property2": 0
      },
      "ping_rate": 100,
      "optmode": {
        "property1": 0,
        "property2": 0
      },
      "mpdf_threshold": {
        "property1": 0,
        "property2": 0
      }
    }
  }'

Responses

OK.

Bodyapplication/json
dynamic_sensitivitystring

Dynamic sensitivity enable (for development only)

bridgeobject
motion80211object
Response
application/json
{
  "dynamic_sensitivity": "string",
  "bridge": {
    "statusInterval": 60,
    "zmqPort": 6969,
    "loglevel": "debug",
    "zmqHost": "127.0.0.1",
    "linkExpiry": 120,
    "debug": 1,
    "debug_status": 0,
    "vault": 0
  },
  "motion80211": {
    "txEnable": { … },
    "linkSens": { … },
    "hyperSensOverride": [ … ],
    "noise_ctrl": 0,
    "cfrMode": "o",
    "dmEnable": 0,
    "period": 0,
    "meshAutoDisable": 0,
    "meshSoundingDisabled": [ … ],
    "sens": 1,
    "forceTxEnable": 0,
    "pingerEnable": { … },
    "ping_rate": 100,
    "optmode": { … },
    "mpdf_threshold": { … }
  }
}

Update Motion-Radar configuration

Request

Security
ApiKey
Path
network_idintegerrequired

Motion Network ID (returned as 'id' by Find API calls)

Query
updateboolean

Propagate configuration change to device.

keystring

If provided, all operations will be relative to this top-level key.

Bodyapplication/json
dynamic_sensitivitystring

Dynamic sensitivity enable (for development only)

bridgeobject
motion80211object
curl -i -X PATCH \
  'https://docs.cognitivesystems.com/_mock/assets/specs/api/core/network/{network_id}/config/radar?update=true&key=string' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "dynamic_sensitivity": "string",
    "bridge": {
      "statusInterval": 60,
      "zmqPort": 6969,
      "loglevel": "debug",
      "zmqHost": "127.0.0.1",
      "linkExpiry": 120,
      "debug": 1,
      "debug_status": 0,
      "vault": 0
    },
    "motion80211": {
      "txEnable": {
        "property1": 0,
        "property2": 0
      },
      "linkSens": {
        "property1": 0,
        "property2": 0
      },
      "hyperSensOverride": [
        "string"
      ],
      "noise_ctrl": 0,
      "cfrMode": "o",
      "dmEnable": 0,
      "period": 0,
      "meshAutoDisable": 0,
      "meshSoundingDisabled": [
        "string"
      ],
      "sens": 1,
      "forceTxEnable": 0,
      "pingerEnable": {
        "property1": 0,
        "property2": 0
      },
      "ping_rate": 100,
      "optmode": {
        "property1": 0,
        "property2": 0
      },
      "mpdf_threshold": {
        "property1": 0,
        "property2": 0
      }
    }
  }'

Responses

OK.

Bodyapplication/json
dynamic_sensitivitystring

Dynamic sensitivity enable (for development only)

bridgeobject
motion80211object
Response
application/json
{
  "dynamic_sensitivity": "string",
  "bridge": {
    "statusInterval": 60,
    "zmqPort": 6969,
    "loglevel": "debug",
    "zmqHost": "127.0.0.1",
    "linkExpiry": 120,
    "debug": 1,
    "debug_status": 0,
    "vault": 0
  },
  "motion80211": {
    "txEnable": { … },
    "linkSens": { … },
    "hyperSensOverride": [ … ],
    "noise_ctrl": 0,
    "cfrMode": "o",
    "dmEnable": 0,
    "period": 0,
    "meshAutoDisable": 0,
    "meshSoundingDisabled": [ … ],
    "sens": 1,
    "forceTxEnable": 0,
    "pingerEnable": { … },
    "ping_rate": 100,
    "optmode": { … },
    "mpdf_threshold": { … }
  }
}

Node

Operations

Management

Operations