Set security sensor settings

Configures the security sensor (zone) settings.

• No — zone number.
• Type — sensor trigger type:
  • Normal mode — activates only when the system is armed and the zone is included in the active scene. Typically used for door and window sensors.
  • Emergency / 24 hours — always active regardless of arming state. Used for flood, gas, smoke, and heat sensors.
• Mode — wiring mode of the sensor (no, nc, 3c, bell).
• Delay — delay in seconds before the zone triggers an alarm. Applies only to normal type zones; other types always have a delay of 0.
• Sensor — sensor icon type shown when the zone is triggered.

application/json

Request Body

• zones object[] required

  List of zone settings

  zone_id integer

  Possible values: <= 15

  Zone number

  type string

  Sensor type

  mode string

  Sensor mode

  delay integer

  Sensor activation delay in seconds

  sensor string

  Sensor name

Responses

• 200
• 400
• 401

---

OK

Validation error. Required fields are not provided.

• Wrong type value
• Wrong mode value
• Wrong delay value
• Wrong sensor value
• Wrong zone_id
• Missed json body or wrong param. Response sample:

  "error": "Wrong JSON body"

• Required field is not provided. Response sample:

  "error": "Wrong JSON body: no value for `param`"

where param - is a required field that was not provided

• Field was of the wrong type. Response sample:

  "error": "Wrong JSON body: value `param` was of the wrong type"

where param - is a field of the wrong type

application/json

• Schema
• Example (from schema)
• Wrong type value
• Base
• No value
• Wrong param type

---

Schema

• error string

  Error information

{
  "error": true
}

{
  "error": "Wrong type value"
}

{
  "error": "Wrong JSON body"
}

{
  "error": "Wrong JSON body: no value for `param`"
}

{
  "error": "Wrong JSON body: value `param` was of the wrong type"
}

Unauthorized request. Log In

application/json

• Schema
• Example (from schema)
• Log In

---

Schema

• error string

  Error information

{
  "error": "Log In"
}

{
  "error": "Log In"
}

Loading...