These docs are for v1.0. Click to read the latest docs for v3.0.

Device Provisioning

A Konnected Alarm Panel or Alarm Panel Pro needs to be provisioned via this endpoint to specify the device inputs, outputs, and the endpoint for the hub or controller. After this provisioning step, the Alarm Panel will communicate state changes to the endpoint specified, and will respond to state change commands authenticated with the valid token.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

All Konnected Alarm Panel devices must be provisioned with a HTTP request from your controller, computer or mobile device on the same network.

Provisioning a HTTP API Endpoint

When provisioning a HTTP API Endpoint, set the endpoint and token fields are required. Example provisioning payload:

{
  "endpoint_type":"rest",
  "endpoint":"http://192.168.1.123:8800/api/konnected",
  "token":"my-service-shared-secret",
  "sensors":[
    {"zone":1},{"zone":2},{"zone":3},{"zone":4},{"zone":6}
   ], 
  "actuators":[
    {"zone":"out", "trigger": 1}
  ],
  "dht_sensors":[
    {"zone":5, "poll_interval":2}
  ]
}

Provisioning an AWS IoT Endpoint

When provisioning an AWS IoT endpoint, the aws object is required. The aws object specifies connection credentials and the MQTT topics that the device will publish and subscribe.

Example provisioning payload for Alarm Panel / ESP8266:

{
  "endpoint_type":"aws_iot",
  "endpoint":"wss://a35zoibxxxxxxx-ats.iot.us-east-1.amazonaws.com/mqtt",
  "aws":{ 
    "token":"TOKEN", 
    "token_signature":"TOKEN_SIGNATURE", 
    "authorizer":"us-east-1",
    "topics":{
      "sensor":"konnected/8840f5209948/sensor",
      "switch":"konnected/8840f5209948/switch",
      "heartbeat":"konnected/8840f5209948/hb"
    }
   },
  "sensors":[
    {"zone":1},{"zone":2},{"zone":3},{"zone":4},{"zone":6}
   ], 
  "actuators":[
    {"zone":"out", "trigger": 1}
  ],
  "dht_sensors":[
    {"zone":5, "poll_interval":2}
  ]
}

Example provisioning payload for the Alarm Panel Pro / ESP32:

{
  "endpoint_type":"aws_iot",
  "endpoint":"a35zoibxxxxxxx-ats.iot.us-east-1.amazonaws.com",
  "aws":{ 
    "certs": {
      "client_cert": "CLIENT_CERT",
      "client_key": "CLIENT_KEY"
    },
    "topics":{
      "sensor":"konnected/8840f5209948/sensor",
      "switch":"konnected/8840f5209948/switch",
      "heartbeat":"konnected/8840f5209948/hb"
    }
   },
  "sensors":[
    {"zone":1},{"zone":2},{"zone":3},{"zone":4},{"zone":6}
   ], 
  "actuators":[
    {"zone":"alarm1", "trigger": 1}
  ],
  "dht_sensors":[
    {"zone":5, "poll_interval":2}
  ]
}
Body Params
string
required

The http(s) endpoint of the smart home hub or controller that Konnected will post state updates to. Include http or https and the full hostname or IP address and path.

string
required

A shared secret token set by the controller. Subsequent reqeusts to actuate inputs will require this token in the Authorization header.

string
enum
Defaults to rest

The endpoint type. Use rest for local REST-based controllers.

Allowed:
aws
object

A set of AWS credentials and settings for connecting and communicating with AWS IoT. This is only required if endpoint_type is aws_iot.

sensors
array of objects

Binary sensor zones to monitor. Use for contact sensors, motion sensors, water leak sensors, and any open/close or on/off sensor type. Valid zones on the Alarm Panel (ESP8266) are 1 thru 6. On the Alarm Panel Pro (ESP32) valid zones are 1 thru 12.

sensors
actuators
array of objects

Actuator zones to control. Use for sirens, switches, strobes, buzzers and any device which is turned on and off by Konnected. Valid zones on the Alarm Panel (ESP8266) are 1 thru 5 and out. On the Alarm Panel Pro (ESP32) valid zones are 1 thru 8 and alarm1, out1, and alarm2_out2.

actuators
dht_sensors
array of objects

Digital temperature and humidity sensor zones. Use a DHT22 type sensor connected to zones 1 thru 5 on the Alarm Panel or 1 thru 8 on the Alarm Panel Pro.

dht_sensors
ds18b20_sensors
array of objects

Digital temperature sensor zones. Use a DS18B20 type sensor connected to zones 1 thru 5 on the Alarm Panel or 1 thru 8 on the Alarm Panel Pro.

ds18b20_sensors
boolean
boolean

Should the Konnected device respond to SSDP discovery requests (true if not set).

string

A custom time server implementing the NTP protocol.

Response
200

Settings set successfully

Language
URL
LoadingLoading…