Skip to content

WiFi Motion Core APIs (v3-x-x)

The WiFi Motion Core Cloud APIs facilitate the creation, configuration, and management of WiFi Motion networks via RESTful APIs. Additionally, it offers interfaces for accessing topologies, events, and motion data. The only difference is that the Core APIs do not specifically reference a user, and instead provide you with the ability to query the data from any network that is available in the environment.

Download OpenAPI description
v3-x-x.json
v3-x-x.yaml
Languages
Servers
Mock server

https://docs.cognitivesystems.com/_mock/assets/specs/mns/v3-x-x/

Network Settings

Operations

Motion History

Operations

Live Motion

Operations

Events

Operations

Insights v2

Operations

Universal Alerting

Operations

Network Status

Operations

Network Meta

Operations

Obtain Network Metadata

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/mns/v3-x-x/network/{network_id}/meta?key=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Network meta config

Bodyapplication/json
dwmobject

value mapping used for fleet's organization

homeobject

mobile client state

locationobject

location indicator leafs, key is leaf mac and value is location string

neuron_envstring or null

neuron environment to be used with this network (only current dev is supported)

motion_pausedinteger

Identifies if the network is in a paused state. Only applicable for Access Points and wireless extenders.

  • 0 The network is not paused.

  • 1 The network is paused.

mqSecureRadarPortnumber or null

Advanced - Network level overwrite of gatekeeper's mqSecurePort response.

auto_segmentinteger

(internal) value for internal Vision project

guardian_envstring

value env to indicate where fusion happens (only local is currently supported)

friendly_nameobject

friendly name for leafs, key is leaf mac and value is friendly name string

new_network_idinteger

(internal) used to indicate if there is older network id assigned to this network

old_network_idinteger

(internal) used to indicate if the old network id assigned to this network

new_guardian_idstring

(internal) used to indicate if there is older guardian id assigned to this network

gatekeeper_redirectstring

Full URL of target gatekeeper (move this network to another instance)

property name*stringadditional property
Response
application/json
{
  "dwm": {
    "groupId": 1,
    "systemName": "A0B1234C-DE56-7FAB-C89D-E012F3456789",
    "systemOwner": ""
  },
  "location": {
    "01:2a:b3:45:c6:78": "Basement",
    "01:2a:b3:45:c6:7d": "Living Room",
    "01:a2:3b:4c:d5:67": "Basement",
    "01:a2:3b:4c:de:fa": "Basement",
    "a0:12:3b:4c:56:de": "Upstairs Main Bathroom"
  },
  "neuron_env": "",
  "motion_paused": 0,
  "guardian_env": "local",
  "friendly_name": {
    "01:2a:b3:45:c6:78": "Basement Landing",
    "01:2a:b3:45:c6:7d": "Stereo",
    "01:a2:3b:4c:d5:67": "TV - Backroom",
    "01:a2:3b:4c:de:fa": "TV - Fireplace",
    "a0:12:3b:4c:56:de": "Upstairs Hallway"
  }
}

Set Network metadata

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.

updateboolean

When true the new configuration is immediately propagated to the network.

Default false
Bodyapplication/json
dwmobject

value mapping used for fleet's organization

homeobject

mobile client state

locationobject

location indicator leafs, key is leaf mac and value is location string

neuron_envstring or null

neuron environment to be used with this network (only current dev is supported)

motion_pausedinteger

Identifies if the network is in a paused state. Only applicable for Access Points and wireless extenders.

  • 0 The network is not paused.

  • 1 The network is paused.

mqSecureRadarPortnumber or null

Advanced - Network level overwrite of gatekeeper's mqSecurePort response.

auto_segmentinteger

(internal) value for internal Vision project

guardian_envstring

value env to indicate where fusion happens (only local is currently supported)

friendly_nameobject

friendly name for leafs, key is leaf mac and value is friendly name string

new_network_idinteger

(internal) used to indicate if there is older network id assigned to this network

old_network_idinteger

(internal) used to indicate if the old network id assigned to this network

new_guardian_idstring

(internal) used to indicate if there is older guardian id assigned to this network

gatekeeper_redirectstring

Full URL of target gatekeeper (move this network to another instance)

property name*stringadditional property
curl -i -X POST \
  'https://docs.cognitivesystems.com/_mock/assets/specs/mns/v3-x-x/network/{network_id}/meta?key=string&update=false' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "dwm": {
      "groupId": "string",
      "systemName": "string",
      "systemType": "string",
      "systemOwner": "string",
      "configurationType": "string"
    },
    "home": {
      "sens": 0,
      "cooldown": 0,
      "sensitivity_level": "string"
    },
    "location": {
      "property1": "string",
      "property2": "string"
    },
    "neuron_env": "string",
    "motion_paused": 0,
    "mqSecureRadarPort": 0,
    "auto_segment": 0,
    "guardian_env": "string",
    "friendly_name": {
      "property1": "string",
      "property2": "string"
    },
    "new_network_id": 0,
    "old_network_id": 0,
    "new_guardian_id": "string",
    "gatekeeper_redirect": "string",
    "property1": "string",
    "property2": "string"
  }'

Responses

Network meta config

Bodyapplication/json
dwmobject

value mapping used for fleet's organization

homeobject

mobile client state

locationobject

location indicator leafs, key is leaf mac and value is location string

neuron_envstring or null

neuron environment to be used with this network (only current dev is supported)

motion_pausedinteger

Identifies if the network is in a paused state. Only applicable for Access Points and wireless extenders.

  • 0 The network is not paused.

  • 1 The network is paused.

mqSecureRadarPortnumber or null

Advanced - Network level overwrite of gatekeeper's mqSecurePort response.

auto_segmentinteger

(internal) value for internal Vision project

guardian_envstring

value env to indicate where fusion happens (only local is currently supported)

friendly_nameobject

friendly name for leafs, key is leaf mac and value is friendly name string

new_network_idinteger

(internal) used to indicate if there is older network id assigned to this network

old_network_idinteger

(internal) used to indicate if the old network id assigned to this network

new_guardian_idstring

(internal) used to indicate if there is older guardian id assigned to this network

gatekeeper_redirectstring

Full URL of target gatekeeper (move this network to another instance)

property name*stringadditional property
Response
application/json
{
  "dwm": {
    "groupId": "string",
    "systemName": "string",
    "systemType": "string",
    "systemOwner": "string",
    "configurationType": "string"
  },
  "home": {
    "sens": 0,
    "cooldown": 0,
    "sensitivity_level": "string"
  },
  "location": {
    "property1": "string",
    "property2": "string"
  },
  "neuron_env": "string",
  "motion_paused": 0,
  "mqSecureRadarPort": 0,
  "auto_segment": 0,
  "guardian_env": "string",
  "friendly_name": {
    "property1": "string",
    "property2": "string"
  },
  "new_network_id": 0,
  "old_network_id": 0,
  "new_guardian_id": "string",
  "gatekeeper_redirect": "string",
  "property1": "string",
  "property2": "string"
}

Update Network Metadata

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.

updateboolean

When true the new configuration is immediately propagated to the network.

Default false
Bodyapplication/json
dwmobject

value mapping used for fleet's organization

homeobject

mobile client state

locationobject

location indicator leafs, key is leaf mac and value is location string

neuron_envstring or null

neuron environment to be used with this network (only current dev is supported)

motion_pausedinteger

Identifies if the network is in a paused state. Only applicable for Access Points and wireless extenders.

  • 0 The network is not paused.

  • 1 The network is paused.

mqSecureRadarPortnumber or null

Advanced - Network level overwrite of gatekeeper's mqSecurePort response.

auto_segmentinteger

(internal) value for internal Vision project

guardian_envstring

value env to indicate where fusion happens (only local is currently supported)

friendly_nameobject

friendly name for leafs, key is leaf mac and value is friendly name string

new_network_idinteger

(internal) used to indicate if there is older network id assigned to this network

old_network_idinteger

(internal) used to indicate if the old network id assigned to this network

new_guardian_idstring

(internal) used to indicate if there is older guardian id assigned to this network

gatekeeper_redirectstring

Full URL of target gatekeeper (move this network to another instance)

property name*stringadditional property
curl -i -X PATCH \
  'https://docs.cognitivesystems.com/_mock/assets/specs/mns/v3-x-x/network/{network_id}/meta?key=string&update=false' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "dwm": {
      "groupId": "string",
      "systemName": "string",
      "systemType": "string",
      "systemOwner": "string",
      "configurationType": "string"
    },
    "home": {
      "sens": 0,
      "cooldown": 0,
      "sensitivity_level": "string"
    },
    "location": {
      "property1": "string",
      "property2": "string"
    },
    "neuron_env": "string",
    "motion_paused": 0,
    "mqSecureRadarPort": 0,
    "auto_segment": 0,
    "guardian_env": "string",
    "friendly_name": {
      "property1": "string",
      "property2": "string"
    },
    "new_network_id": 0,
    "old_network_id": 0,
    "new_guardian_id": "string",
    "gatekeeper_redirect": "string",
    "property1": "string",
    "property2": "string"
  }'

Responses

Network meta config

Bodyapplication/json
dwmobject

value mapping used for fleet's organization

homeobject

mobile client state

locationobject

location indicator leafs, key is leaf mac and value is location string

neuron_envstring or null

neuron environment to be used with this network (only current dev is supported)

motion_pausedinteger

Identifies if the network is in a paused state. Only applicable for Access Points and wireless extenders.

  • 0 The network is not paused.

  • 1 The network is paused.

mqSecureRadarPortnumber or null

Advanced - Network level overwrite of gatekeeper's mqSecurePort response.

auto_segmentinteger

(internal) value for internal Vision project

guardian_envstring

value env to indicate where fusion happens (only local is currently supported)

friendly_nameobject

friendly name for leafs, key is leaf mac and value is friendly name string

new_network_idinteger

(internal) used to indicate if there is older network id assigned to this network

old_network_idinteger

(internal) used to indicate if the old network id assigned to this network

new_guardian_idstring

(internal) used to indicate if there is older guardian id assigned to this network

gatekeeper_redirectstring

Full URL of target gatekeeper (move this network to another instance)

property name*stringadditional property
Response
application/json
{
  "dwm": {
    "groupId": "string",
    "systemName": "string",
    "systemType": "string",
    "systemOwner": "string",
    "configurationType": "string"
  },
  "home": {
    "sens": 0,
    "cooldown": 0,
    "sensitivity_level": "string"
  },
  "location": {
    "property1": "string",
    "property2": "string"
  },
  "neuron_env": "string",
  "motion_paused": 0,
  "mqSecureRadarPort": 0,
  "auto_segment": 0,
  "guardian_env": "string",
  "friendly_name": {
    "property1": "string",
    "property2": "string"
  },
  "new_network_id": 0,
  "old_network_id": 0,
  "new_guardian_id": "string",
  "gatekeeper_redirect": "string",
  "property1": "string",
  "property2": "string"
}

Location Data

Operations

Find

Operations

Application Settings

Operations

Config

Operations

Node

Operations

Management

Operations