Update OSDP device indication settings

Path Parameters

rs485-number integer required
Possible values: >= 1 and <= 2
Number of RS485 port
Example: 1
osdp-device-address integer required
Possible values: <= 126
Address of device

Request Body required

connection object
Device connection extra settings
is_enabled boolean required
Determines if controller poll OSDP device
port_number integer required
Possible values: >= 1 and <= 2
Unique RS485 interface number. Can be in range 1-2
address integer required
Possible values: <= 126
Address of the device on th RS485 bus
channel_type string required
Possible values: [secure, not_secure]
Channel type for device connection
key ([0-9A-Fa-f]{2}[:-]){15}([0-9A-Fa-f]{2}) required
Security key for device connection. Required only if device connection channel type is secure.
name string required
Possible values: <= 100 characters
Name of reader
indication object required
OSDP device indication settings
oneOf
MOD1
MOD2
controlled_by string required
Possible values: [controller, device]
Device control type.

If set to "controller", all led and buzzer manipulation managed by controller via OSDP commands. If set to "device", led and buzzer are working with OSDP device default(built-in) indication settings.

Responses

Bad Request

Schema

error object
Error object, contains error details
code string
Possible values: [invalid_authentication, permission_denied, not_valid, system_error, bad_request, connection_timeout]
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
Contains validation error details

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

{
  "error": {
    "code": "bad_request",
    "message": "Bad request sent"
  }
}

Unauthorized request. Log In

Schema

error object
Error object, contains error details
code string
Possible values: [invalid_authentication, permission_denied, not_valid, system_error, bad_request, connection_timeout]
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
Contains validation error details

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

{
  "error": {
    "code": "invalid_authentication",
    "message": "Invalid authentication"
  }
}

Update OSDP device indication settings​