Get current standby screen settings

Standby mode represents splash screen when device is inactive.

Responses

• 200
• 401

---

OK

application/json

• Schema
• Example (from schema)
• Example

---

Schema

• is_enabled boolean

  Default value: false

• current_mode string

  Possible values: [single_camera, cameras_tour]

• duration integer

  Possible values: [0, 60, 120, 300, 600, 1800]

  Time in seconds before turning off the screen backlight 0 - never

• modes object[]

{
  "is_enabled": false,
  "current_mode": "single_camera",
  "duration": 0,
  "modes": [
    {
      "name": "single_camera",
      "params": {
        "camera_id": 1
      }
    },
    {
      "name": "cameras_tour",
      "params": {
        "camera_ids": [
          2
        ],
        "timeout": 10
      }
    }
  ]
}

{
  "is_enabled": false,
  "current_mode": "single_camera",
  "duration": 0,
  "modes": [
    {
      "name": "cameras_tour",
      "params": {
        "camera_id": 1,
        "camera_ids": [
          2
        ],
        "timeout": 10
      }
    }
  ]
}

Please log in

application/json

• Schema
• Example (from schema)
• Example

---

Schema

• error object

  code string

  Possible values: [invalid_authentification, permission_denied, not_valid, system_error]

  Error code

  message string

  Error message

  data object

  Did not pass validation parameters. Can be represented as an object, which can include field names, arrays, query parameters etc.

  param string

{
  "error": {
    "code": "not_valid",
    "message": "Data validation error",
    "data": {
      "param": "must be an string"
    }
  }
}

{
  "error": {
    "code": "invalid_authentification",
    "message": "Log In"
  }
}

Loading...