arm.md

August 16, 2020 ยท View on GitHub

Arm the System

Arm the given network - that is, start recording/reporting motion events for enabled cameras.

When this call returns, it does not mean the arm request is complete, the client must gather the command ID from the response and poll for the status of the command.

POST /api/v1/accounts/{AccountID}/networks/{NetworkID}/state/arm

Headers

  • TOKEN-AUTH - session auth token

Response

  • A command object. See example. This call is asynchronous and is monitored by the Command Status API call using the returned Command Id.

Example Request

curl --request POST \
  --url https://rest-prod.immedia-semi.com/api/v1/accounts/1234/networks/1234/state/arm \
  --header 'token-auth: {Auth_Token}'

Example Response

200 OK

{
  "id": 123456789,
  "network_id": 1234,
  "command": "arm",
  "state": "new",
  "commands": [
    {
      "id": 123456780,
      "network_id": 1234,
      "command": "config_lfr",
      "state": "running"
    },
    {
      "id": 123456781,
      "network_id": 1234,
      "command": "config_lfr",
      "state": "running"
    }
  ]
}