ADT · JSON Structure

Platform Api Arm Request Structure

Request to arm a security system.

Type: object Properties: 2 Required: 2
Access ControlAutomationHome SecurityIoTMonitoringSecuritySmart HomeFortune 1000

ArmRequest is a JSON Structure definition published by ADT, describing 2 properties, of which 2 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

mode accessCode

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/adt/refs/heads/main/json-structure/platform-api-arm-request-structure.json",
  "name": "ArmRequest",
  "description": "Request to arm a security system.",
  "type": "object",
  "required": [
    "mode",
    "accessCode"
  ],
  "properties": {
    "mode": {
      "type": "string",
      "description": "Arming mode.",
      "enum": [
        "away",
        "stay"
      ],
      "example": "away"
    },
    "accessCode": {
      "type": "string",
      "description": "Valid access code to authorize arming.",
      "example": "1234"
    }
  }
}