ADT · Schema

ArmRequest

Request to arm a security system.

Access ControlAutomationHome SecurityIoTMonitoringSecuritySmart HomeFortune 1000

Properties

Name Type Description
mode string Arming mode.
accessCode string Valid access code to authorize arming.
View JSON Schema on GitHub

JSON Schema

platform-api-arm-request-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/adt/refs/heads/main/json-schema/platform-api-arm-request-schema.json",
  "title": "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"
    }
  }
}