Kentix SmartAPI (8.2.6)

Kentix GmbH: info@kentix.com URL: https://kentix.com/ License: Kentix GmbH

IMPORT NOTE! This documentation assumes knowledge of ReST concepts.

In order to use the KentixONE ReST API, you need knowledge of the corresponding programming concepts and their methods.
We ask for your understanding that we cannot offer free support for questions regarding program implementation or project integration within the scope of our technical support.
For this purpose, we offer bookable support packages for optimal support in your project and integration questions.

Access-Events

Access-Event List

Get Access-Events

Get a list of Access-Events.

Authorizations:
bearer

Responses

Response Schema: application/json
Array of objects
object
object

Response samples

Content type
application/json
{}

Access-Event Export

Access-Event Export

Export Access-Events

Export all Access-Events.

Authorizations:
bearer

Responses

Response Schema: text/csv
string <binary>

Access-Event Images

Access-Event Images

Get Access-Events

Get a list of Access-Events.

Authorizations:
bearer
path Parameters
access_event
required
string

Access-Event ID

Responses

Response Schema: application/json
Array
data
string <base64>

The data of the image

name
string

The name of the image

Response samples

Content type
application/json
[
  • {
    }
]

Access Settings

Functions to request and update the general access settings.

Get the access settings

Request the access settings.

Authorizations:
bearer

Responses

Response Schema: application/json
external_evaluation
boolean

If true, the manager will not evaluate access permissions. Instead, upon bookings a webhook is sent and DoorLocks can only be remote-opened.

pinlength
string [ 4 .. 10 ]

Sets the length of the user pin. Must be between 4 and 10.

memorydepth
string [ 0 .. 720 ]

Sets the number of days during which all user-related data (bookings, images, etc) is stored. 0 = Unlimited, must be between 0 and 720.

mode
integer

Sets the RFID security mode. 0=Off, 1=Kentix Token, 2=Custom security token.

bus_protocol
string
Enum: "v1" "v2"

Select what version of wallreaders are used with this device. V2 devices are labeled with 'V2' next to their respective devicetype. V1 devices do not have a version label.

Response samples

Content type
application/json
{
  • "external_evaluation": 1,
  • "pinlength": 1,
  • "memorydepth": 1,
  • "mode": 1,
  • "bus_protocol": "v1"
}

Update the access settings.

Updates the access settings. Validation errors are returned in the response body with HTTP 422.

Authorizations:
bearer
Request Body schema: application/json

abcdef...

external_evaluation
boolean

If true, the manager will not evaluate access permissions. Instead, upon bookings a webhook is sent and DoorLocks can only be remote-opened.

pinlength
string [ 4 .. 10 ]

Sets the length of the user pin. Must be between 4 and 10.

memorydepth
string [ 0 .. 720 ]

Sets the number of days during which all user-related data (bookings, images, etc) is stored. 0 = Unlimited, must be between 0 and 720.

mode
integer

Sets the RFID security mode. 0=Off, 1=Kentix Token, 2=Custom security token.

bus_protocol
string
Enum: "v1" "v2"

Select what version of wallreaders are used with this device. V2 devices are labeled with 'V2' next to their respective devicetype. V1 devices do not have a version label.

Responses

Response Schema: application/json
Array
external_evaluation
boolean

If true, the manager will not evaluate access permissions. Instead, upon bookings a webhook is sent and DoorLocks can only be remote-opened.

pinlength
string [ 4 .. 10 ]

Sets the length of the user pin. Must be between 4 and 10.

memorydepth
string [ 0 .. 720 ]

Sets the number of days during which all user-related data (bookings, images, etc) is stored. 0 = Unlimited, must be between 0 and 720.

mode
integer

Sets the RFID security mode. 0=Off, 1=Kentix Token, 2=Custom security token.

bus_protocol
string
Enum: "v1" "v2"

Select what version of wallreaders are used with this device. V2 devices are labeled with 'V2' next to their respective devicetype. V1 devices do not have a version label.

Request samples

Content type
application/json
{
  • "external_evaluation": 1,
  • "pinlength": 1,
  • "memorydepth": 1,
  • "mode": 1,
  • "bus_protocol": "v1"
}

Response samples

Content type
application/json
[
  • {
    }
]

AccessManager List

Functions to manage AccessManagers.

Get Accessmanagers

Get a list of all AccessManagers.

Authorizations:
bearer

Responses

Response Schema: application/json
Array
id
integer

Id of the AccessManager.

name
string

Name of the Accessmanager

type
integer

Devicetype of the AccessManager.

device_type
string

Devicetype name of the AccessManager.

address
string

IP or DNS address of the AccessManager.

Response samples

Content type
application/json
[
  • {
    }
]

AccessManager Names

Function to get a list of all the names of the AccessManagers.

Get names of Accessmanagers

Get the names of all AccessManagers.

Authorizations:
bearer

Responses

Response Schema: application/json
Array
id
integer

Id of the AccessManager.

name
string

Name of the Accessmanager

type
integer

Devicetype of the AccessManager.

Response samples

Content type
application/json
[
  • {
    }
]

AccessManager Details

Functions to get or modify a specific AccessManager via the id.

Get Accessmanager informations

Requests all detail of a specific AccessManager via the id.

Authorizations:
bearer
path Parameters
accessmanager_id
required
string

ID of the Accessmanager to be queried

Responses

Response Schema: application/json
id
integer

ID of the AccessManager.

type
integer

Devicetype of the AccessManager.

is_active
boolean

True if the alarm evaluation and communication for this device is activated

name
string

Name of the AccessManager.

mac_adress
string

MAC address of the AccessManager

address
string

IP or DNS address of the AccessManager.

Array of objects
Array of objects
relais_action_arm
string
Enum: "none" "channel1" "channel2" "backchannel1" "backchannel2" "backchannel_inevitability"

Configures if an external system should be switched on bookings.

ext_arm_doorlocks
Array of integers

List of all DoorLock IDs, which have been configured to switch an external alarmsystem.

object
group_id
integer

Id of the group the AccessManager beolongs to

rack_id
integer

Id of the rack the AccessManager belongs to

webhooks
Array of integers

Integer Array of the webhooks

Response samples

Content type
application/json
{
  • "id": 1,
  • "type": 105,
  • "is_active": true,
  • "name": "AccessManager",
  • "mac_adress": "70:82:0e:10:81:3d",
  • "address": "192.168.100.224",
  • "doorlocks": [
    ],
  • "ios": [
    ],
  • "relais_action_arm": "none",
  • "ext_arm_doorlocks": [
    ],
  • "external": {
    },
  • "group_id": 89,
  • "rack_id": 50,
  • "webhooks": [
    ]
}

Update the configuration of an AccessManager via the ID.

Updates the configuration of a specific AccessManager. Validation errors are returned in the response body with HTTP 422.

Authorizations:
bearer
path Parameters
accessmanager_id
required
string

ID of the Accessmanager to be queried

Request Body schema: application/json

AccessManager configuration to be updated.

id
integer

ID of the AccessManager.

type
integer

Devicetype of the AccessManager.

is_active
boolean

True if the alarm evaluation and communication for this device is activated

name
string

Name of the AccessManager.

mac_adress
string

MAC address of the AccessManager

address
string

IP or DNS address of the AccessManager.

Array of objects
Array of objects
relais_action_arm
string
Enum: "none" "channel1" "channel2" "backchannel1" "backchannel2" "backchannel_inevitability"

Configures if an external system should be switched on bookings.

ext_arm_doorlocks
Array of integers

List of all DoorLock IDs, which have been configured to switch an external alarmsystem.

object
group_id
integer

Id of the group the AccessManager beolongs to

rack_id
integer

Id of the rack the AccessManager belongs to

webhooks
Array of integers

Integer Array of the webhooks

Responses

Response Schema: application/json
Array
id
integer

ID of the AccessManager.

type
integer

Devicetype of the AccessManager.

is_active
boolean

True if the alarm evaluation and communication for this device is activated

name
string

Name of the AccessManager.

mac_adress
string

MAC address of the AccessManager

address
string

IP or DNS address of the AccessManager.

Array of objects
Array of objects
relais_action_arm
string
Enum: "none" "channel1" "channel2" "backchannel1" "backchannel2" "backchannel_inevitability"

Configures if an external system should be switched on bookings.

ext_arm_doorlocks
Array of integers

List of all DoorLock IDs, which have been configured to switch an external alarmsystem.

object
group_id
integer

Id of the group the AccessManager beolongs to

rack_id
integer

Id of the rack the AccessManager belongs to

webhooks
Array of integers

Integer Array of the webhooks

Request samples

Content type
application/json
{
  • "id": 1,
  • "type": 105,
  • "is_active": true,
  • "name": "AccessManager",
  • "mac_adress": "70:82:0e:10:81:3d",
  • "address": "192.168.100.224",
  • "doorlocks": [
    ],
  • "ios": [
    ],
  • "relais_action_arm": "none",
  • "ext_arm_doorlocks": [
    ],
  • "external": {
    },
  • "group_id": 89,
  • "rack_id": 50,
  • "webhooks": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

Alarm-Events

Alarm-Event List

Get Alarm-Events

Get a list of Alarm-Events.

Authorizations:
bearer

Responses

Response Schema: application/json
Array of objects
object
object

Response samples

Content type
application/json
{}

Alarm-Event Export

Alarm-Event Export

Export Alarm-Events

Export all Alarm-Events.

Authorizations:
bearer

Responses

Response Schema: text/csv
string <binary>

Alarm-Event Images

Alarm-Event Images

Get Alarm-Events

Get a list of Alarm-Events.

Authorizations:
bearer
path Parameters
alarm_event
required
string

Alarm-Event ID

Responses

Response Schema: application/json
Array
data
string <base64>

The data of the image

name
string

The name of the image

Response samples

Content type
application/json
[
  • {
    }
]

Alarmgroups List

Get alarmgroups

Get all alarmgroups.

Authorizations:
bearer

Responses

Response Schema: application/json
Array
id
integer

Id of the alarmgroup.

name
string

Name of the alarmgroup.

sort_index
integer

Describes the sorting order.

group_id
integer or null

Indicates the parent alarm group. Null if the alarmgroup has no parent group

created_at
string <ISO 8601>

ISO 8601 when the alarmgroup was created.

updated_at
string <ISO 8601>

ISO 8601 when the alarmgroup was updated.

Response samples

Content type
application/json
[
  • {
    }
]

Add alarmgroup

Add a new alarmgroup.

Authorizations:
bearer
Request Body schema: application/json
name
string

Describes the name of the alarmgroup.

group_id
integer

Indicates the parent alarm group. Must be an Id of an existing group.

in_stealthmode
boolean

Describes if the internal status LED of all devices in this alarmgroup should be activated.

signaling_group
integer or null

Describes the range in which a signaling is triggered, if an alarm occurs within this alarmgroup. Must be an Id of an parent group.

maintenance
string
Enum: "active" "inactive"

Describes if the alarmgroup is in maintenance mode.

maintenance_start
string or null <ISO 8601>

Describes when the alarmgroup automatically switches to maintenance mode.

maintenance_stop
string or null <ISO 8601>

Describes until when the alarmgroup remains in maintenance mode.

inherit_notification
boolean

Describes if the notification settings should be inherited from the parent group.

is_alarmrepetition_active
boolean

Describes if active alarms should be repeated by it's configured interval. Acknowledgment of the alarm stops the repetition.

alarmrepetition_interval
integer [ 1 .. 999 ]

Describes how alarms are sent to all users configured for alarms, depending on the configured time and repetitions.

alarmrepetition_count
integer [ 0 .. 100 ]

Describes the number of alarm repetitions with the interval of the configured time.

send_quitable_notifications
boolean

Describes if a notification should be sent as soon as an alarm is quitable.

limit_notifications_always
boolean

Limits the always-active notifications per hour. Manual acknowledgement resets the counter, repeated alarms do not count.

notification_count_always_alarm
integer or null [ 0 .. 1000 ]

Describes the limit of always-active alarm notifications. 0 deactivates the notifications. Only required if limit_notifications_always is true.

notification_count_always_warning
boolean or null

Notify in case of always-active warnings. Only required if limit_notifications_always is true.

limit_notifications_armed
boolean

Limits the armed-active notifications per hour. Manual acknowledgement resets the counter, repeated alarms do not count.

notification_count_armed_alarm
integer or null [ 0 .. 1000 ]

Describes the limit of armed-active alarm notifications. 0 deactivates the notifications. Only required if limit_notifications_armed is true.

notification_count_armed_warning
boolean or null

Notify in case of armed-active warnings. Only required if limit_notifications_armed is true.

limit_notifications_fire
boolean

Limits the fire notifications per hour. Manual acknowledgement resets the counter, repeated alarms do not count.

notification_count_fire_alarm
integer or null [ 0 .. 1000 ]

Describes the limit of fire alarm notifications. 0 deactivates the notifications. Only required if limit_notifications_fire is true.

notification_count_fire_warning
boolean or null

Notify in case of fire warnings. Only required if limit_notifications_fire is true.

limit_notifications_sabotage
boolean

Limits the sabotage notifications per hour. Manual acknowledgement resets the counter, repeated alarms do not count.

notification_count_sabotage_alarm
integer or null [ 0 .. 1000 ]

Describes the limit of sabotage alarm notifications. 0 deactivates the notifications. Only required if limit_notifications_sabotage is true.

notification_count_sabotage_warning
boolean or null

Notify in case of sabotage warnings. Only required if limit_notifications_sabotage is true.

limit_notifications_system
boolean

Limits the system notifications per hour. Manual acknowledgement resets the counter, repeated alarms do not count.

notification_count_system_alarm
integer or null [ 0 .. 1000 ]

Describes the limit of system alarm notifications. 0 deactivates the notifications. Only required if limit_notifications_system is true.

notification_count_system_warning
boolean or null

Notify in case of system warnings. Only required if limit_notifications_system is true.

inherit_arm
boolean

Describes if the arm settings should be inherited from the parent group.

arm_delay
integer
Enum: 0 10 30 60 120 180 240 300 600 1200 1800 3600

Describes the arm delay. Only required if inherit_arm is false.

buzzer_arm_duration
integer
Enum: 0 1 3 10 30 60 120 180 300 600 1200 1800 3600

Describes the arm buzzer duration. Only required if inherit_arm is false.

can_alwaysarm
boolean

Describes if the status of external contacts should be ignored during arming. This is useful if e.g. a magnetic door contact must be opened during the arming phase.

inherit_autoquit
boolean

Describes if the autoquit settings should be inherited from the parent group.

can_autoquit_always_alarm
boolean

Describes if always-active alarms should be automatically acknowledged after the given interval. Only required if inherit_autoquit is false.

can_autoquit_armed_alarm
boolean

Describes if armed-active alarms should be automatically acknowledged after the given interval. Only required if inherit_autoquit is false.

can_autoquit_fire_alarm
boolean

Describes if fire alarms should be automatically acknowledged after the given interval. Only required if inherit_autoquit is false.

can_autoquit_sabotage_alarm
boolean

Describes if sabotage alarms should be automatically acknowledged after the given interval. Only required if inherit_autoquit is false.

can_autoquit_system_notification_alarm
boolean

Describes if system alarms should be automatically acknowledged after the given interval. Only required if inherit_autoquit is false.

autoquit_duration
integer
Enum: 0 30 60 180 600 1800

Describes the time after which automatic quitting is executed. Only required if inherit_autoquit is false.

inherit_alarm
boolean

Describes if the alarm settings should be inherited from the parent group.

has_prealarm
boolean

Describes if the Prealarm is en-/disabled.

buzzer_alwaysalarm_duration
integer
Enum: -1 0 1 3 10 30 60 120 180 300 600 1200 1800 3600

Describes the buzzer length for always-active alarms (-1 stands for permanent). Only required if inherit_alarm is false.

buzzer_armedalarm_duration
integer
Enum: -1 0 1 3 10 30 60 120 180 300 600 1200 1800 3600

Describes the buzzer length for armed-active alarms (-1 stands for permanent). Only required if inherit_alarm is false.

buzzer_firealarm_duration
integer
Enum: -1 0 1 3 10 30 60 120 180 300 600 1200 1800 3600

Describes the buzzer length for fire alarms (-1 stands for permanent). Only required if inherit_alarm is false.

buzzer_sabotagealarm_duration
integer
Enum: -1 0 1 3 10 30 60 120 180 300 600 1200 1800 3600

Describes the buzzer length for sabotage alarms (-1 stands for permanent). Only required if inherit_alarm is false.

inherit_sabotagesignal
boolean

Describes if the signaling sabotage settings should be inherited from the parent group.

sabotage_powerdevice_duration
integer
Enum: 300 600 900 1200 1500 1800 2100 2400 2700 3000 3300 3600

Describes how long a plugged device should wait, until it fires a tampering alarm. Only required if inherit_sabotagesignal is false.

sabotage_batterydevice_duration
integer
Enum: 900 1200 1500 1800 2100 2400 2700 3000 3300 3600

Describes how long a battery device should wait, until it fires a tampering alarm. Only required if inherit_sabotagesignal is false.

sabotage_service_duration
integer
Enum: 600 900 1200 1500 1800 2100 2400 2700 3000 3300 3600

Describes how long a service should wait, until it fires a tampering alarm. Only required if inherit_sabotagesignal is false.

event_id
integer or null

Describes the event that should be used. Must be an Id of an existing event.

Array of objects

Describes the webhooks that should be fired when an event happens

Responses

Response Schema: application/json
id
integer

Id of the alarmgroup.

created_at
string <ISO 8601>

Indicates when the alarmgroup was created.

updated_at
string <ISO 8601>

Indicates when the alarmgroup was updated.

name
string

Describes the name of the alarmgroup.

group_id
integer

Indicates the parent alarm group. Must be an Id of an existing group.

sort_index
integer

Describes the sorting order.

in_stealthmode
boolean

Describes if the internal status LED of all devices in this alarmgroup should be activated.

signaling_group
integer or null

Describes the range in which a signaling is triggered, if an alarm occurs within this alarmgroup. Must be an Id of an parent group.

maintenance
string
Enum: "active" "inactive"

Describes if the alarmgroup is in maintenance mode.

maintenance_start
string or null <ISO 8601>

Describes when the alarmgroup automatically switches to maintenance mode.

maintenance_stop
string or null <ISO 8601>

Describes until when the alarmgroup remains in maintenance mode.

inherit_notification
boolean

Describes if the notification settings should be inherited from the parent group.

is_alarmrepetition_active
boolean

Describes if active alarms should be repeated by it's configured interval. Acknowledgment of the alarm stops the repetition.

alarmrepetition_interval
integer [ 1 .. 999 ]

Describes how alarms are sent to all users configured for alarms, depending on the configured time and repetitions.

alarmrepetition_count
integer [ 0 .. 100 ]

Describes the number of alarm repetitions with the interval of the configured time.

send_quitable_notifications
boolean

Describes if a notification should be sent as soon as an alarm is quitable.

limit_notifications_always
boolean

Limits the always-active notifications per hour. Manual acknowledgement resets the counter, repeated alarms do not count.

notification_count_always_alarm
integer or null [ 0 .. 1000 ]

Describes the limit of always-active alarm notifications. 0 deactivates the notifications. Only required if limit_notifications_always is true.

notification_count_always_warning
boolean or null

Notify in case of always-active warnings. Only required if limit_notifications_always is true.

limit_notifications_armed
boolean

Limits the armed-active notifications per hour. Manual acknowledgement resets the counter, repeated alarms do not count.

notification_count_armed_alarm
integer or null [ 0 .. 1000 ]

Describes the limit of armed-active alarm notifications. 0 deactivates the notifications. Only required if limit_notifications_armed is true.

notification_count_armed_warning
boolean or null

Notify in case of armed-active warnings. Only required if limit_notifications_armed is true.

limit_notifications_fire
boolean

Limits the fire notifications per hour. Manual acknowledgement resets the counter, repeated alarms do not count.

notification_count_fire_alarm
integer or null [ 0 .. 1000 ]

Describes the limit of fire alarm notifications. 0 deactivates the notifications. Only required if limit_notifications_fire is true.

notification_count_fire_warning
boolean or null

Notify in case of fire warnings. Only required if limit_notifications_fire is true.

limit_notifications_sabotage
boolean

Limits the sabotage notifications per hour. Manual acknowledgement resets the counter, repeated alarms do not count.

notification_count_sabotage_alarm
integer or null [ 0 .. 1000 ]

Describes the limit of sabotage alarm notifications. 0 deactivates the notifications. Only required if limit_notifications_sabotage is true.

notification_count_sabotage_warning
boolean or null

Notify in case of sabotage warnings. Only required if limit_notifications_sabotage is true.

limit_notifications_system
boolean

Limits the system notifications per hour. Manual acknowledgement resets the counter, repeated alarms do not count.

notification_count_system_alarm
integer or null [ 0 .. 1000 ]

Describes the limit of system alarm notifications. 0 deactivates the notifications. Only required if limit_notifications_system is true.

notification_count_system_warning
boolean or null

Notify in case of system warnings. Only required if limit_notifications_system is true.

inherit_arm
boolean

Describes if the arm settings should be inherited from the parent group.

arm_delay
integer
Enum: 0 10 30 60 120 180 240 300 600 1200 1800 3600

Describes the arm delay. Only required if inherit_arm is false.

buzzer_arm_duration
integer
Enum: 0 1 3 10 30 60 120 180 300 600 1200 1800 3600

Describes the arm buzzer duration. Only required if inherit_arm is false.

can_alwaysarm
boolean

Describes if the status of external contacts should be ignored during arming. This is useful if e.g. a magnetic door contact must be opened during the arming phase.

inherit_autoquit
boolean

Describes if the autoquit settings should be inherited from the parent group.

can_autoquit_always_alarm
boolean

Describes if always-active alarms should be automatically acknowledged after the given interval. Only required if inherit_autoquit is false.

can_autoquit_armed_alarm
boolean

Describes if armed-active alarms should be automatically acknowledged after the given interval. Only required if inherit_autoquit is false.

can_autoquit_fire_alarm
boolean

Describes if fire alarms should be automatically acknowledged after the given interval. Only required if inherit_autoquit is false.

can_autoquit_sabotage_alarm
boolean

Describes if sabotage alarms should be automatically acknowledged after the given interval. Only required if inherit_autoquit is false.

can_autoquit_system_notification_alarm
boolean

Describes if system alarms should be automatically acknowledged after the given interval. Only required if inherit_autoquit is false.

autoquit_duration
integer
Enum: 0 30 60 180 600 1800

Describes the time after which automatic quitting is executed. Only required if inherit_autoquit is false.

inherit_alarm
boolean

Describes if the alarm settings should be inherited from the parent group.

has_prealarm
boolean

Describes if the Prealarm is en-/disabled.

buzzer_alwaysalarm_duration
integer
Enum: -1 0 1 3 10 30 60 120 180 300 600 1200 1800 3600

Describes the buzzer length for always-active alarms (-1 stands for permanent). Only required if inherit_alarm is false.

buzzer_armedalarm_duration
integer
Enum: -1 0 1 3 10 30 60 120 180 300 600 1200 1800 3600

Describes the buzzer length for armed-active alarms (-1 stands for permanent). Only required if inherit_alarm is false.

buzzer_firealarm_duration
integer
Enum: -1 0 1 3 10 30 60 120 180 300 600 1200 1800 3600

Describes the buzzer length for fire alarms (-1 stands for permanent). Only required if inherit_alarm is false.

buzzer_sabotagealarm_duration
integer
Enum: -1 0 1 3 10 30 60 120 180 300 600 1200 1800 3600

Describes the buzzer length for sabotage alarms (-1 stands for permanent). Only required if inherit_alarm is false.

inherit_sabotagesignal
boolean

Describes if the signaling sabotage settings should be inherited from the parent group.

sabotage_powerdevice_duration
integer
Enum: 300 600 900 1200 1500 1800 2100 2400 2700 3000 3300 3600

Describes how long a plugged device should wait, until it fires a tampering alarm. Only required if inherit_sabotagesignal is false.

sabotage_batterydevice_duration
integer
Enum: 900 1200 1500 1800 2100 2400 2700 3000 3300 3600

Describes how long a battery device should wait, until it fires a tampering alarm. Only required if inherit_sabotagesignal is false.

sabotage_service_duration
integer
Enum: 600 900 1200 1500 1800 2100 2400 2700 3000 3300 3600

Describes how long a service should wait, until it fires a tampering alarm. Only required if inherit_sabotagesignal is false.

event_id
integer or null

Describes the event that should be used. Must be an Id of an existing event.

Array of objects

Describes the webhooks that should be fired when an event happens

Request samples

Content type
application/json
{
  • "name": "Kentix HQ",
  • "group_id": 1,
  • "in_stealthmode": false,
  • "signaling_group": 1,
  • "maintenance": "inactive",
  • "maintenance_start": "2023-02-17T01:00:00.000Z",
  • "maintenance_stop": "2023-02-17T23:59:00.000Z",
  • "inherit_notification": false,
  • "is_alarmrepetition_active": false,
  • "alarmrepetition_interval": 1,
  • "alarmrepetition_count": 0,
  • "send_quitable_notifications": false,
  • "limit_notifications_always": true,
  • "notification_count_always_alarm": 1,
  • "notification_count_always_warning": false,
  • "limit_notifications_armed": true,
  • "notification_count_armed_alarm": 1,
  • "notification_count_armed_warning": false,
  • "limit_notifications_fire": false,
  • "notification_count_fire_alarm": 0,
  • "notification_count_fire_warning": false,
  • "limit_notifications_sabotage": false,
  • "notification_count_sabotage_alarm": 0,
  • "notification_count_sabotage_warning": false,
  • "limit_notifications_system": false,
  • "notification_count_system_alarm": 0,
  • "notification_count_system_warning": false,
  • "inherit_arm": false,
  • "arm_delay": 0,
  • "buzzer_arm_duration": 0,
  • "can_alwaysarm": false,
  • "inherit_autoquit": false,
  • "can_autoquit_always_alarm": false,
  • "can_autoquit_armed_alarm": false,
  • "can_autoquit_fire_alarm": false,
  • "can_autoquit_sabotage_alarm": false,
  • "can_autoquit_system_notification_alarm": false,
  • "autoquit_duration": 0,
  • "inherit_alarm": false,
  • "has_prealarm": false,
  • "buzzer_alwaysalarm_duration": 0,
  • "buzzer_armedalarm_duration": 0,
  • "buzzer_firealarm_duration": 0,
  • "buzzer_sabotagealarm_duration": 0,
  • "inherit_sabotagesignal": false,
  • "sabotage_powerdevice_duration": 300,
  • "sabotage_batterydevice_duration": 900,
  • "sabotage_service_duration": 600,
  • "event_id": 0,
  • "webhooks": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 1,
  • "created_at": "2023-01-07T18:08:44.000000Z",
  • "updated_at": "2023-01-07T18:08:44.000000Z",
  • "name": "Kentix HQ",
  • "group_id": 1,
  • "sort_index": 1,
  • "in_stealthmode": false,
  • "signaling_group": 1,
  • "maintenance": "inactive",
  • "maintenance_start": "2023-02-17T01:00:00.000Z",
  • "maintenance_stop": "2023-02-17T23:59:00.000Z",
  • "inherit_notification": false,
  • "is_alarmrepetition_active": false,
  • "alarmrepetition_interval": 1,
  • "alarmrepetition_count": 0,
  • "send_quitable_notifications": false,
  • "limit_notifications_always": true,
  • "notification_count_always_alarm": 1,
  • "notification_count_always_warning": false,
  • "limit_notifications_armed": true,
  • "notification_count_armed_alarm": 1,
  • "notification_count_armed_warning": false,
  • "limit_notifications_fire": false,
  • "notification_count_fire_alarm": 0,
  • "notification_count_fire_warning": false,
  • "limit_notifications_sabotage": false,
  • "notification_count_sabotage_alarm": 0,
  • "notification_count_sabotage_warning": false,
  • "limit_notifications_system": false,
  • "notification_count_system_alarm": 0,
  • "notification_count_system_warning": false,
  • "inherit_arm": false,
  • "arm_delay": 0,
  • "buzzer_arm_duration": 0,
  • "can_alwaysarm": false,
  • "inherit_autoquit": false,
  • "can_autoquit_always_alarm": false,
  • "can_autoquit_armed_alarm": false,
  • "can_autoquit_fire_alarm": false,
  • "can_autoquit_sabotage_alarm": false,
  • "can_autoquit_system_notification_alarm": false,
  • "autoquit_duration": 0,
  • "inherit_alarm": false,
  • "has_prealarm": false,
  • "buzzer_alwaysalarm_duration": 0,
  • "buzzer_armedalarm_duration": 0,
  • "buzzer_firealarm_duration": 0,
  • "buzzer_sabotagealarm_duration": 0,
  • "inherit_sabotagesignal": false,
  • "sabotage_powerdevice_duration": 300,
  • "sabotage_batterydevice_duration": 900,
  • "sabotage_service_duration": 600,
  • "event_id": 0,
  • "webhooks": [
    ]
}

Alarmgroup Details

Get alarmgroup

Get a specific alarmgroup via its ID.

Authorizations:
bearer
path Parameters
alarmgroup
required
string

ID of the alarmgroup to be queried

Responses

Response Schema: application/json
id
integer

Id of the alarmgroup.

created_at
string <ISO 8601>

Indicates when the alarmgroup was created.

updated_at
string <ISO 8601>

Indicates when the alarmgroup was updated.

name
string

Describes the name of the alarmgroup.

group_id
integer

Indicates the parent alarm group. Must be an Id of an existing group.

sort_index
integer

Describes the sorting order.

in_stealthmode
boolean

Describes if the internal status LED of all devices in this alarmgroup should be activated.

signaling_group
integer or null

Describes the range in which a signaling is triggered, if an alarm occurs within this alarmgroup. Must be an Id of an parent group.

maintenance
string
Enum: "active" "inactive"

Describes if the alarmgroup is in maintenance mode.

maintenance_start
string or null <ISO 8601>

Describes when the alarmgroup automatically switches to maintenance mode.

maintenance_stop
string or null <ISO 8601>

Describes until when the alarmgroup remains in maintenance mode.

inherit_notification
boolean

Describes if the notification settings should be inherited from the parent group.

is_alarmrepetition_active
boolean

Describes if active alarms should be repeated by it's configured interval. Acknowledgment of the alarm stops the repetition.

alarmrepetition_interval
integer [ 1 .. 999 ]

Describes how alarms are sent to all users configured for alarms, depending on the configured time and repetitions.

alarmrepetition_count
integer [ 0 .. 100 ]

Describes the number of alarm repetitions with the interval of the configured time.

send_quitable_notifications
boolean

Describes if a notification should be sent as soon as an alarm is quitable.

limit_notifications_always
boolean

Limits the always-active notifications per hour. Manual acknowledgement resets the counter, repeated alarms do not count.

notification_count_always_alarm
integer or null [ 0 .. 1000 ]

Describes the limit of always-active alarm notifications. 0 deactivates the notifications. Only required if limit_notifications_always is true.

notification_count_always_warning
boolean or null

Notify in case of always-active warnings. Only required if limit_notifications_always is true.

limit_notifications_armed
boolean

Limits the armed-active notifications per hour. Manual acknowledgement resets the counter, repeated alarms do not count.

notification_count_armed_alarm
integer or null [ 0 .. 1000 ]

Describes the limit of armed-active alarm notifications. 0 deactivates the notifications. Only required if limit_notifications_armed is true.

notification_count_armed_warning
boolean or null

Notify in case of armed-active warnings. Only required if limit_notifications_armed is true.

limit_notifications_fire
boolean

Limits the fire notifications per hour. Manual acknowledgement resets the counter, repeated alarms do not count.

notification_count_fire_alarm
integer or null [ 0 .. 1000 ]

Describes the limit of fire alarm notifications. 0 deactivates the notifications. Only required if limit_notifications_fire is true.

notification_count_fire_warning
boolean or null

Notify in case of fire warnings. Only required if limit_notifications_fire is true.

limit_notifications_sabotage
boolean

Limits the sabotage notifications per hour. Manual acknowledgement resets the counter, repeated alarms do not count.

notification_count_sabotage_alarm
integer or null [ 0 .. 1000 ]

Describes the limit of sabotage alarm notifications. 0 deactivates the notifications. Only required if limit_notifications_sabotage is true.

notification_count_sabotage_warning
boolean or null

Notify in case of sabotage warnings. Only required if limit_notifications_sabotage is true.

limit_notifications_system
boolean

Limits the system notifications per hour. Manual acknowledgement resets the counter, repeated alarms do not count.

notification_count_system_alarm
integer or null [ 0 .. 1000 ]

Describes the limit of system alarm notifications. 0 deactivates the notifications. Only required if limit_notifications_system is true.

notification_count_system_warning
boolean or null

Notify in case of system warnings. Only required if limit_notifications_system is true.

inherit_arm
boolean

Describes if the arm settings should be inherited from the parent group.

arm_delay
integer
Enum: 0 10 30 60 120 180 240 300 600 1200 1800 3600

Describes the arm delay. Only required if inherit_arm is false.

buzzer_arm_duration
integer
Enum: 0 1 3 10 30 60 120 180 300 600 1200 1800 3600

Describes the arm buzzer duration. Only required if inherit_arm is false.

can_alwaysarm
boolean

Describes if the status of external contacts should be ignored during arming. This is useful if e.g. a magnetic door contact must be opened during the arming phase.

inherit_autoquit
boolean

Describes if the autoquit settings should be inherited from the parent group.

can_autoquit_always_alarm
boolean

Describes if always-active alarms should be automatically acknowledged after the given interval. Only required if inherit_autoquit is false.

can_autoquit_armed_alarm
boolean

Describes if armed-active alarms should be automatically acknowledged after the given interval. Only required if inherit_autoquit is false.

can_autoquit_fire_alarm
boolean

Describes if fire alarms should be automatically acknowledged after the given interval. Only required if inherit_autoquit is false.

can_autoquit_sabotage_alarm
boolean

Describes if sabotage alarms should be automatically acknowledged after the given interval. Only required if inherit_autoquit is false.

can_autoquit_system_notification_alarm
boolean

Describes if system alarms should be automatically acknowledged after the given interval. Only required if inherit_autoquit is false.

autoquit_duration
integer
Enum: 0 30 60 180 600 1800

Describes the time after which automatic quitting is executed. Only required if inherit_autoquit is false.

inherit_alarm
boolean

Describes if the alarm settings should be inherited from the parent group.

has_prealarm
boolean

Describes if the Prealarm is en-/disabled.

buzzer_alwaysalarm_duration
integer
Enum: -1 0 1 3 10 30 60 120 180 300 600 1200 1800 3600

Describes the buzzer length for always-active alarms (-1 stands for permanent). Only required if inherit_alarm is false.

buzzer_armedalarm_duration
integer
Enum: -1 0 1 3 10 30 60 120 180 300 600 1200 1800 3600

Describes the buzzer length for armed-active alarms (-1 stands for permanent). Only required if inherit_alarm is false.

buzzer_firealarm_duration
integer
Enum: -1 0 1 3 10 30 60 120 180 300 600 1200 1800 3600

Describes the buzzer length for fire alarms (-1 stands for permanent). Only required if inherit_alarm is false.

buzzer_sabotagealarm_duration
integer
Enum: -1 0 1 3 10 30 60 120 180 300 600 1200 1800 3600

Describes the buzzer length for sabotage alarms (-1 stands for permanent). Only required if inherit_alarm is false.

inherit_sabotagesignal
boolean

Describes if the signaling sabotage settings should be inherited from the parent group.

sabotage_powerdevice_duration
integer
Enum: 300 600 900 1200 1500 1800 2100 2400 2700 3000 3300 3600

Describes how long a plugged device should wait, until it fires a tampering alarm. Only required if inherit_sabotagesignal is false.

sabotage_batterydevice_duration
integer
Enum: 900 1200 1500 1800 2100 2400 2700 3000 3300 3600

Describes how long a battery device should wait, until it fires a tampering alarm. Only required if inherit_sabotagesignal is false.

sabotage_service_duration
integer
Enum: 600 900 1200 1500 1800 2100 2400 2700 3000 3300 3600

Describes how long a service should wait, until it fires a tampering alarm. Only required if inherit_sabotagesignal is false.

event_id
integer or null

Describes the event that should be used. Must be an Id of an existing event.

Array of objects

Describes the webhooks that should be fired when an event happens

Response samples

Content type
application/json
{
  • "id": 1,
  • "created_at": "2023-01-07T18:08:44.000000Z",
  • "updated_at": "2023-01-07T18:08:44.000000Z",
  • "name": "Kentix HQ",
  • "group_id": 1,
  • "sort_index": 1,
  • "in_stealthmode": false,
  • "signaling_group": 1,
  • "maintenance": "inactive",
  • "maintenance_start": "2023-02-17T01:00:00.000Z",
  • "maintenance_stop": "2023-02-17T23:59:00.000Z",
  • "inherit_notification": false,
  • "is_alarmrepetition_active": false,
  • "alarmrepetition_interval": 1,
  • "alarmrepetition_count": 0,
  • "send_quitable_notifications": false,
  • "limit_notifications_always": true,
  • "notification_count_always_alarm": 1,
  • "notification_count_always_warning": false,
  • "limit_notifications_armed": true,
  • "notification_count_armed_alarm": 1,
  • "notification_count_armed_warning": false,
  • "limit_notifications_fire": false,
  • "notification_count_fire_alarm": 0,
  • "notification_count_fire_warning": false,
  • "limit_notifications_sabotage": false,
  • "notification_count_sabotage_alarm": 0,
  • "notification_count_sabotage_warning": false,
  • "limit_notifications_system": false,
  • "notification_count_system_alarm": 0,
  • "notification_count_system_warning": false,
  • "inherit_arm": false,
  • "arm_delay": 0,
  • "buzzer_arm_duration": 0,
  • "can_alwaysarm": false,
  • "inherit_autoquit": false,
  • "can_autoquit_always_alarm": false,
  • "can_autoquit_armed_alarm": false,
  • "can_autoquit_fire_alarm": false,
  • "can_autoquit_sabotage_alarm": false,
  • "can_autoquit_system_notification_alarm": false,
  • "autoquit_duration": 0,
  • "inherit_alarm": false,
  • "has_prealarm": false,
  • "buzzer_alwaysalarm_duration": 0,
  • "buzzer_armedalarm_duration": 0,
  • "buzzer_firealarm_duration": 0,
  • "buzzer_sabotagealarm_duration": 0,
  • "inherit_sabotagesignal": false,
  • "sabotage_powerdevice_duration": 300,
  • "sabotage_batterydevice_duration": 900,
  • "sabotage_service_duration": 600,
  • "event_id": 0,
  • "webhooks": [
    ]
}

Update alarmgroup

Update a specific alarmgroup via its ID.

Authorizations:
bearer
path Parameters
alarmgroup
required
string

ID of the alarmgroup to be queried

Request Body schema: application/json
One of
sort_index
integer

Describes the sorting order.

in_stealthmode
boolean

Describes if the internal status LED of all devices in this alarmgroup should be activated.

maintenance
string
Enum: "active" "inactive"

Describes if the alarmgroup is in maintenance mode.

maintenance_start
string or null <ISO 8601>

Describes when the alarmgroup automatically switches to maintenance mode.

maintenance_stop
string or null <ISO 8601>

Describes until when the alarmgroup remains in maintenance mode.

is_alarmrepetition_active
boolean

Describes if active alarms should be repeated by it's configured interval. Acknowledgment of the alarm stops the repetition.

alarmrepetition_interval
integer [ 1 .. 999 ]

Describes how alarms are sent to all users configured for alarms, depending on the configured time and repetitions.

alarmrepetition_count
integer [ 0 .. 100 ]

Describes the number of alarm repetitions with the interval of the configured time.

send_quitable_notifications
boolean

Describes if a notification should be sent as soon as an alarm is quitable.

limit_notifications_always
boolean

Limits the always-active notifications per hour. Manual acknowledgement resets the counter, repeated alarms do not count.

notification_count_always_alarm
integer or null [ 0 .. 1000 ]

Describes the limit of always-active alarm notifications. 0 deactivates the notifications. Only required if limit_notifications_always is true.

notification_count_always_warning
boolean or null

Notify in case of always-active warnings. Only required if limit_notifications_always is true.

limit_notifications_armed
boolean

Limits the armed-active notifications per hour. Manual acknowledgement resets the counter, repeated alarms do not count.

notification_count_armed_alarm
integer or null [ 0 .. 1000 ]

Describes the limit of armed-active alarm notifications. 0 deactivates the notifications. Only required if limit_notifications_armed is true.

notification_count_armed_warning
boolean or null

Notify in case of armed-active warnings. Only required if limit_notifications_armed is true.

limit_notifications_fire
boolean

Limits the fire notifications per hour. Manual acknowledgement resets the counter, repeated alarms do not count.

notification_count_fire_alarm
integer or null [ 0 .. 1000 ]

Describes the limit of fire alarm notifications. 0 deactivates the notifications. Only required if limit_notifications_fire is true.

notification_count_fire_warning
boolean or null

Notify in case of fire warnings. Only required if limit_notifications_fire is true.

limit_notifications_sabotage
boolean

Limits the sabotage notifications per hour. Manual acknowledgement resets the counter, repeated alarms do not count.

notification_count_sabotage_alarm
integer or null [ 0 .. 1000 ]

Describes the limit of sabotage alarm notifications. 0 deactivates the notifications. Only required if limit_notifications_sabotage is true.

notification_count_sabotage_warning
boolean or null

Notify in case of sabotage warnings. Only required if limit_notifications_sabotage is true.

limit_notifications_system
boolean

Limits the system notifications per hour. Manual acknowledgement resets the counter, repeated alarms do not count.

notification_count_system_alarm
integer or null [ 0 .. 1000 ]

Describes the limit of system alarm notifications. 0 deactivates the notifications. Only required if limit_notifications_system is true.

notification_count_system_warning
boolean or null

Notify in case of system warnings. Only required if limit_notifications_system is true.

arm_delay
integer
Enum: 0 10 30 60 120 180 240 300 600 1200 1800 3600

Describes the arm delay.

buzzer_arm_duration
integer
Enum: 0 1 3 10 30 60 120 180 300 600 1200 1800 3600

Describes the arm buzzer duration.

can_alwaysarm
boolean

Describes if the status of external contacts should be ignored during arming. This is useful if e.g. a magnetic door contact must be opened during the arming phase.

can_autoquit_always_alarm
boolean

Describes if always-active alarms should be automatically acknowledged after the given interval.

can_autoquit_armed_alarm
boolean

Describes if armed-active alarms should be automatically acknowledged after the given interval.

can_autoquit_fire_alarm
boolean

Describes if fire alarms should be automatically acknowledged after the given interval.

can_autoquit_sabotage_alarm
boolean

Describes if sabotage alarms should be automatically acknowledged after the given interval.

can_autoquit_system_notification_alarm
boolean

Describes if system alarms should be automatically acknowledged after the given interval.

autoquit_duration
integer
Enum: 0 30 60 180 600 1800

Describes the time after which automatic quitting is executed.

has_prealarm
boolean

Describes if the Prealarm is en-/disabled.

buzzer_alwaysalarm_duration
integer
Enum: -1 0 1 3 10 30 60 120 180 300 600 1200 1800 3600

Describes the buzzer length for always-active alarms (-1 stands for permanent).

buzzer_armedalarm_duration
integer
Enum: -1 0 1 3 10 30 60 120 180 300 600 1200 1800 3600

Describes the buzzer length for armed-active alarms (-1 stands for permanent).

buzzer_firealarm_duration
integer
Enum: -1 0 1 3 10 30 60 120 180 300 600 1200 1800 3600

Describes the buzzer length for fire alarms (-1 stands for permanent).

buzzer_sabotagealarm_duration
integer
Enum: -1 0 1 3 10 30 60 120 180 300 600 1200 1800 3600

Describes the buzzer length for sabotage alarms (-1 stands for permanent).

sabotage_powerdevice_duration
integer
Enum: 300 600 900 1200 1500 1800 2100 2400 2700 3000 3300 3600

Describes how long a plugged device should wait, until it fires a tampering alarm.

sabotage_batterydevice_duration
integer
Enum: 900 1200 1500 1800 2100 2400 2700 3000 3300 3600

Describes how long a battery device should wait, until it fires a tampering alarm.

sabotage_service_duration
integer
Enum: 600 900 1200 1500 1800 2100 2400 2700 3000 3300 3600

Describes how long a service should wait, until it fires a tampering alarm.

event_id
integer or null

Describes the event that should be used. Must be an Id of an existing event.

Array of objects

Describes the webhooks that should be fired when an event happens

Responses

Response Schema: application/json
id
integer

Id of the alarmgroup.

created_at
string <ISO 8601>

Indicates when the alarmgroup was created.

updated_at
string <ISO 8601>

Indicates when the alarmgroup was updated.

name
string

Describes the name of the alarmgroup.

group_id
integer

Indicates the parent alarm group. Must be an Id of an existing group.

sort_index
integer

Describes the sorting order.

in_stealthmode
boolean

Describes if the internal status LED of all devices in this alarmgroup should be activated.

signaling_group
integer or null

Describes the range in which a signaling is triggered, if an alarm occurs within this alarmgroup. Must be an Id of an parent group.

maintenance
string
Enum: "active" "inactive"

Describes if the alarmgroup is in maintenance mode.

maintenance_start
string or null <ISO 8601>

Describes when the alarmgroup automatically switches to maintenance mode.

maintenance_stop
string or null <ISO 8601>

Describes until when the alarmgroup remains in maintenance mode.

inherit_notification
boolean

Describes if the notification settings should be inherited from the parent group.

is_alarmrepetition_active
boolean

Describes if active alarms should be repeated by it's configured interval. Acknowledgment of the alarm stops the repetition.

alarmrepetition_interval
integer [ 1 .. 999 ]

Describes how alarms are sent to all users configured for alarms, depending on the configured time and repetitions.

alarmrepetition_count
integer [ 0 .. 100 ]

Describes the number of alarm repetitions with the interval of the configured time.

send_quitable_notifications
boolean

Describes if a notification should be sent as soon as an alarm is quitable.

limit_notifications_always
boolean

Limits the always-active notifications per hour. Manual acknowledgement resets the counter, repeated alarms do not count.

notification_count_always_alarm
integer or null [ 0 .. 1000 ]

Describes the limit of always-active alarm notifications. 0 deactivates the notifications. Only required if limit_notifications_always is true.

notification_count_always_warning
boolean or null

Notify in case of always-active warnings. Only required if limit_notifications_always is true.

limit_notifications_armed
boolean

Limits the armed-active notifications per hour. Manual acknowledgement resets the counter, repeated alarms do not count.

notification_count_armed_alarm
integer or null [ 0 .. 1000 ]

Describes the limit of armed-active alarm notifications. 0 deactivates the notifications. Only required if limit_notifications_armed is true.

notification_count_armed_warning
boolean or null

Notify in case of armed-active warnings. Only required if limit_notifications_armed is true.

limit_notifications_fire
boolean

Limits the fire notifications per hour. Manual acknowledgement resets the counter, repeated alarms do not count.

notification_count_fire_alarm
integer or null [ 0 .. 1000 ]

Describes the limit of fire alarm notifications. 0 deactivates the notifications. Only required if limit_notifications_fire is true.

notification_count_fire_warning
boolean or null

Notify in case of fire warnings. Only required if limit_notifications_fire is true.

limit_notifications_sabotage
boolean

Limits the sabotage notifications per hour. Manual acknowledgement resets the counter, repeated alarms do not count.

notification_count_sabotage_alarm
integer or null [ 0 .. 1000 ]

Describes the limit of sabotage alarm notifications. 0 deactivates the notifications. Only required if limit_notifications_sabotage is true.

notification_count_sabotage_warning
boolean or null

Notify in case of sabotage warnings. Only required if limit_notifications_sabotage is true.

limit_notifications_system
boolean

Limits the system notifications per hour. Manual acknowledgement resets the counter, repeated alarms do not count.

notification_count_system_alarm
integer or null [ 0 .. 1000 ]

Describes the limit of system alarm notifications. 0 deactivates the notifications. Only required if limit_notifications_system is true.

notification_count_system_warning
boolean or null

Notify in case of system warnings. Only required if limit_notifications_system is true.

inherit_arm
boolean

Describes if the arm settings should be inherited from the parent group.

arm_delay
integer
Enum: 0 10 30 60 120 180 240 300 600 1200 1800 3600

Describes the arm delay. Only required if inherit_arm is false.

buzzer_arm_duration
integer
Enum: 0 1 3 10 30 60 120 180 300 600 1200 1800 3600

Describes the arm buzzer duration. Only required if inherit_arm is false.

can_alwaysarm
boolean

Describes if the status of external contacts should be ignored during arming. This is useful if e.g. a magnetic door contact must be opened during the arming phase.

inherit_autoquit
boolean

Describes if the autoquit settings should be inherited from the parent group.

can_autoquit_always_alarm
boolean

Describes if always-active alarms should be automatically acknowledged after the given interval. Only required if inherit_autoquit is false.

can_autoquit_armed_alarm
boolean

Describes if armed-active alarms should be automatically acknowledged after the given interval. Only required if inherit_autoquit is false.

can_autoquit_fire_alarm
boolean

Describes if fire alarms should be automatically acknowledged after the given interval. Only required if inherit_autoquit is false.

can_autoquit_sabotage_alarm
boolean

Describes if sabotage alarms should be automatically acknowledged after the given interval. Only required if inherit_autoquit is false.

can_autoquit_system_notification_alarm
boolean

Describes if system alarms should be automatically acknowledged after the given interval. Only required if inherit_autoquit is false.

autoquit_duration
integer
Enum: 0 30 60 180 600 1800

Describes the time after which automatic quitting is executed. Only required if inherit_autoquit is false.

inherit_alarm
boolean

Describes if the alarm settings should be inherited from the parent group.

has_prealarm
boolean

Describes if the Prealarm is en-/disabled.

buzzer_alwaysalarm_duration
integer
Enum: -1 0 1 3 10 30 60 120 180 300 600 1200 1800 3600

Describes the buzzer length for always-active alarms (-1 stands for permanent). Only required if inherit_alarm is false.

buzzer_armedalarm_duration
integer
Enum: -1 0 1 3 10 30 60 120 180 300 600 1200 1800 3600

Describes the buzzer length for armed-active alarms (-1 stands for permanent). Only required if inherit_alarm is false.

buzzer_firealarm_duration
integer
Enum: -1 0 1 3 10 30 60 120 180 300 600 1200 1800 3600

Describes the buzzer length for fire alarms (-1 stands for permanent). Only required if inherit_alarm is false.

buzzer_sabotagealarm_duration
integer
Enum: -1 0 1 3 10 30 60 120 180 300 600 1200 1800 3600

Describes the buzzer length for sabotage alarms (-1 stands for permanent). Only required if inherit_alarm is false.

inherit_sabotagesignal
boolean

Describes if the signaling sabotage settings should be inherited from the parent group.

sabotage_powerdevice_duration
integer
Enum: 300 600 900 1200 1500 1800 2100 2400 2700 3000 3300 3600

Describes how long a plugged device should wait, until it fires a tampering alarm. Only required if inherit_sabotagesignal is false.

sabotage_batterydevice_duration
integer
Enum: 900 1200 1500 1800 2100 2400 2700 3000 3300 3600

Describes how long a battery device should wait, until it fires a tampering alarm. Only required if inherit_sabotagesignal is false.

sabotage_service_duration
integer
Enum: 600 900 1200 1500 1800 2100 2400 2700 3000 3300 3600

Describes how long a service should wait, until it fires a tampering alarm. Only required if inherit_sabotagesignal is false.

event_id
integer or null

Describes the event that should be used. Must be an Id of an existing event.

Array of objects

Describes the webhooks that should be fired when an event happens

Request samples

Content type
application/json
Example
{
  • "sort_index": 1,
  • "in_stealthmode": false,
  • "maintenance": "inactive",
  • "maintenance_start": "2023-02-17T01:00:00.000Z",
  • "maintenance_stop": "2023-02-17T23:59:00.000Z",
  • "is_alarmrepetition_active": false,
  • "alarmrepetition_interval": 1,
  • "alarmrepetition_count": 0,
  • "send_quitable_notifications": false,
  • "limit_notifications_always": true,
  • "notification_count_always_alarm": 1,
  • "notification_count_always_warning": false,
  • "limit_notifications_armed": true,
  • "notification_count_armed_alarm": 1,
  • "notification_count_armed_warning": false,
  • "limit_notifications_fire": false,
  • "notification_count_fire_alarm": 0,
  • "notification_count_fire_warning": false,
  • "limit_notifications_sabotage": false,
  • "notification_count_sabotage_alarm": 0,
  • "notification_count_sabotage_warning": false,
  • "limit_notifications_system": false,
  • "notification_count_system_alarm": 0,
  • "notification_count_system_warning": false,
  • "arm_delay": 0,
  • "buzzer_arm_duration": 0,
  • "can_alwaysarm": false,
  • "can_autoquit_always_alarm": false,
  • "can_autoquit_armed_alarm": false,
  • "can_autoquit_fire_alarm": false,
  • "can_autoquit_sabotage_alarm": false,
  • "can_autoquit_system_notification_alarm": false,
  • "autoquit_duration": 0,
  • "has_prealarm": false,
  • "buzzer_alwaysalarm_duration": 0,
  • "buzzer_armedalarm_duration": 0,
  • "buzzer_firealarm_duration": 0,
  • "buzzer_sabotagealarm_duration": 0,
  • "sabotage_powerdevice_duration": 300,
  • "sabotage_batterydevice_duration": 900,
  • "sabotage_service_duration": 600,
  • "event_id": 0,
  • "webhooks": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 1,
  • "created_at": "2023-01-07T18:08:44.000000Z",
  • "updated_at": "2023-01-07T18:08:44.000000Z",
  • "name": "Kentix HQ",
  • "group_id": 1,
  • "sort_index": 1,
  • "in_stealthmode": false,
  • "signaling_group": 1,
  • "maintenance": "inactive",
  • "maintenance_start": "2023-02-17T01:00:00.000Z",
  • "maintenance_stop": "2023-02-17T23:59:00.000Z",
  • "inherit_notification": false,
  • "is_alarmrepetition_active": false,
  • "alarmrepetition_interval": 1,
  • "alarmrepetition_count": 0,
  • "send_quitable_notifications": false,
  • "limit_notifications_always": true,
  • "notification_count_always_alarm": 1,
  • "notification_count_always_warning": false,
  • "limit_notifications_armed": true,
  • "notification_count_armed_alarm": 1,
  • "notification_count_armed_warning": false,
  • "limit_notifications_fire": false,
  • "notification_count_fire_alarm": 0,
  • "notification_count_fire_warning": false,
  • "limit_notifications_sabotage": false,
  • "notification_count_sabotage_alarm": 0,
  • "notification_count_sabotage_warning": false,
  • "limit_notifications_system": false,
  • "notification_count_system_alarm": 0,
  • "notification_count_system_warning": false,
  • "inherit_arm": false,
  • "arm_delay": 0,
  • "buzzer_arm_duration": 0,
  • "can_alwaysarm": false,
  • "inherit_autoquit": false,
  • "can_autoquit_always_alarm": false,
  • "can_autoquit_armed_alarm": false,
  • "can_autoquit_fire_alarm": false,
  • "can_autoquit_sabotage_alarm": false,
  • "can_autoquit_system_notification_alarm": false,
  • "autoquit_duration": 0,
  • "inherit_alarm": false,
  • "has_prealarm": false,
  • "buzzer_alwaysalarm_duration": 0,
  • "buzzer_armedalarm_duration": 0,
  • "buzzer_firealarm_duration": 0,
  • "buzzer_sabotagealarm_duration": 0,
  • "inherit_sabotagesignal": false,
  • "sabotage_powerdevice_duration": 300,
  • "sabotage_batterydevice_duration": 900,
  • "sabotage_service_duration": 600,
  • "event_id": 0,
  • "webhooks": [
    ]
}

Delete alarmgroup

Delete specific alarmgroup via its ID.

Authorizations:
bearer
path Parameters
alarmgroup
required
string

ID of the alarmgroup to be queried

Responses

Add Device

Add specified device to alarmgroup.

Authorizations:
bearer
path Parameters
alarmgroup
required
string

ID of the alarmgroup (must be a leaf node) to be queried

device
required
string

ID of the device to be queried

Responses

Response samples

Content type
application/json
{
  • "message": "The username must not be empty.",
  • "errors": {
    }
}

Add IO

Add specified IO to alarmgroup.

Authorizations:
bearer
path Parameters
alarmgroup
required
string

ID of the alarmgroup (must be a leaf node, except for digital output) to be queried

io
required
string

ID of the device to be queried

Responses

Response samples

Content type
application/json
{
  • "message": "The username must not be empty.",
  • "errors": {
    }
}

Get OID-List

Get OID-List for sepcified alarmgroup.

Authorizations:
bearer
path Parameters
alarmgroup
required
string

ID of the alarmgroup to be queried

Responses

Response Schema: application/json
object

Response samples

Content type
application/json
{
  • "group": {
    }
}

Arm Alarmgroup

Arm alarmgroup

Arm a specific alarmgroup via its ID.

Authorizations:
bearer
path Parameters
alarmgroup
required
string

ID of the alarmgoup to be queried

Responses

Disarm Alarmgroup

Disarm alarmgroup

Disarm a specific alarmgroup via its ID.

Authorizations:
bearer
path Parameters
alarmgroup
required
string

ID of the alarmgoup to be queried

Responses

Quit Alarmgroup

Quit alarmgroup

Quit a specific alarmgroup via its ID.

Authorizations:
bearer
path Parameters
alarmgroup
required
string

ID of the alarmgoup to be queried

Responses

Alarmgroup Names

Get alarmgroup names

Requests all alarmgroups which the user has access to.

Authorizations:
bearer

Responses

Response Schema: application/json
Array
id
integer

Id of the alarmgroup.

name
string

Name of the alarmgroup.

Response samples

Content type
application/json
[
  • {
    }
]

Backup Configuration

Backup Configuration

Get backup status

Requests the status of the last backup and the possible storage locations.

Authorizations:
bearer

Responses

Response Schema: application/json
object
object

Response samples

Content type
application/json
{
  • "latest": {
    },
  • "available_destinations": {
    }
}

Create backup

Creates a new backup.

Authorizations:
bearer
Request Body schema: application/json
password
string or null <= 250

Password for encryption of the backup.

destination
string

Destination for the backup.

Responses

Response Schema: application/json
object
object

Request samples

Content type
application/json
{
  • "password": "password",
  • "destination": "download"
}

Response samples

Content type
application/json
{
  • "latest": {
    },
  • "available_destinations": {
    }
}

Download backup

Downloads the latest backup and then deletes the backup.

Authorizations:
bearer

Responses

Response Schema: text/plain
string <base64>

Backup as binary file

Restore backup

Restores a provided backup.

Authorizations:
bearer
Request Body schema: multipart/form-data
backup
required
string <base64>

Backup as binary file

password
string

Password of the encrypted backup.

Responses

Response Schema: application/json
status
string
Enum: "ok" "error"

Status of the backup restore.

address
string

New IP address of the device. Exist only when status is ok.

type
string

Type of the error that occurred. Exist only when status is error.

Response samples

Content type
application/json
{
  • "status": "ok",
  • "address": "192.188.100.224",
  • "type": "The backup file is not compatible with this device."
}

Automatic Backup Configuration

Automatic Backup Configuration

Get automatic backup configuration

Requests the status of the automatic backup configuration.

Authorizations:
bearer

Responses

Response Schema: application/json
is_active
boolean

Describes it automatic backup is en-/disabled.

time
string <HH:mm>

Describes at which time the backup should be created.

type
integer [ 1 .. 2 ]

Describes the selected Storage Drive [1 => SD-Card; 2 => Network Drive (SMB)]

delete_after_days
integer [ 0 .. 7 ]

Describes how long Backups should be stored.

0 (never) is only for type 2 allowed.

address
string or null

Describes the IP-Address of the Network Drive.

Needed when type is 2.

share
string or null

Describes the share name.

Needed when type is 2.

path
string or null

Describes the storage path.

username
string or null

Describes the username for the SMB share.

password
string or null

Describes the password for the SMB share.

Response samples

Content type
application/json
{
  • "is_active": true,
  • "time": "00:00",
  • "type": 2,
  • "delete_after_days": 1,
  • "address": "0.0.0.0",
  • "share": "SMB Rack",
  • "path": "/home/kentix/backup",
  • "username": "root",
  • "password": "password"
}

Update automatic backup configuration

Updates the automatic backup configuration.

Authorizations:
bearer
Request Body schema: application/json
is_active
boolean

Describes it automatic backup is en-/disabled.

time
string <HH:mm>

Describes at which time the backup should be created.

type
integer [ 1 .. 2 ]

Describes the selected Storage Drive [1 => SD-Card; 2 => Network Drive (SMB)]

delete_after_days
integer [ 0 .. 7 ]

Describes how long Backups should be stored.

0 (never) is only for type 2 allowed.

address
string or null

Describes the IP-Address of the Network Drive.

Needed when type is 2.

share
string or null

Describes the share name.

Needed when type is 2.

path
string or null

Describes the storage path.

username
string or null

Describes the username for the SMB share.

password
string or null

Describes the password for the SMB share.

Responses

Response Schema: application/json
is_active
boolean

Describes it automatic backup is en-/disabled.

time
string <HH:mm>

Describes at which time the backup should be created.

type
integer [ 1 .. 2 ]

Describes the selected Storage Drive [1 => SD-Card; 2 => Network Drive (SMB)]

delete_after_days
integer [ 0 .. 7 ]

Describes how long Backups should be stored.

0 (never) is only for type 2 allowed.

address
string or null

Describes the IP-Address of the Network Drive.

Needed when type is 2.

share
string or null

Describes the share name.

Needed when type is 2.

path
string or null

Describes the storage path.

username
string or null

Describes the username for the SMB share.

password
string or null

Describes the password for the SMB share.

Request samples

Content type
application/json
{
  • "is_active": true,
  • "time": "00:00",
  • "type": 2,
  • "delete_after_days": 1,
  • "address": "0.0.0.0",
  • "share": "SMB Rack",
  • "path": "/home/kentix/backup",
  • "username": "root",
  • "password": "password"
}

Response samples

Content type
application/json
{
  • "is_active": true,
  • "time": "00:00",
  • "type": 2,
  • "delete_after_days": 1,
  • "address": "0.0.0.0",
  • "share": "SMB Rack",
  • "path": "/home/kentix/backup",
  • "username": "root",
  • "password": "password"
}

Check SMB configuration

Checks if the current Network Drive (SMB) configuration is correct / works.

Authorizations:
bearer

Responses

Response Schema: application/json
has_response
boolean

Describes whether the check has been handled.

response_code
integer

1 => Network Drive not mounted
2 => Path is invalid
3 => No permissions granted

Response samples

Content type
application/json
{
  • "has_response": true,
  • "response_code": 0
}

Update SMB configuration

Updates the current Network Drive (SMB) configuration.

Authorizations:
bearer
Request Body schema: application/json
address
string

Describes the IP-Address of the Network Drive.

share
string

Describes the share name.

Needed when type is 2.

path
string or null

Describes the storage path.

username
string or null

Describes the username for the SMB share.

password
string or null

Describes the password for the SMB share.

Responses

Response Schema: application/json
has_response
boolean

Describes whether the check has been handled.

response_code
integer

1 => Network Drive not mounted
2 => Path is invalid
3 => No permissions granted

Request samples

Content type
application/json
{
  • "address": "0.0.0.0",
  • "share": "SMB Rack",
  • "path": "/home/kentix/backup",
  • "username": "root",
  • "password": "password"
}

Response samples

Content type
application/json
{
  • "has_response": true,
  • "response_code": 0
}

Camera List

Functions to modify and update network cameras.

Get cameras

Requests a list of all camera names the user has access to.

Authorizations:
bearer

Responses

Response Schema: application/json
Array
id
integer

Id of the camera

is_active
boolean

True if the camera is active

name
string

Name of the camera

address
string

IP Address of the camera

group_id
integer

The group id to which the camera belongs to

Response samples

Content type
application/json
[
  • {
    }
]

Camera Names

Get the names of all cameras.

Get camera names

Requests a list of all camera names the user has access to.

Authorizations:
bearer

Responses

Response Schema: application/json
Array
id
integer

Id of the camera

name
string

Name of the camera

Response samples

Content type
application/json
[
  • {
    }
]

Camera Details

Functions to get and modify a specific camera.

Get camera informations

Requests all detail of a specific camera via the id.

Authorizations:
bearer
path Parameters
camera_id
required
string

ID of the camera to be queried

Responses

Response Schema: application/json
id
integer

Id of the camera.

is_active
boolean

True if the camera is active.

name
string

Name of the camera.

camera_location
string

Mounting area of the camera, can be: indoor, outdoor. Outdoor cameras use a prebuffer to capture persons before the actual booking.

protocol
string

Communication protocol, can be: http, https.

address
string

Network address of the camera.

capture_path
string

Path/URL to get the images of the camera.

stream_path
string

Path/URL to get the livestream of the camera.

username
string

Username for logging in on the camera, if needed.

passsword
string

Password for logging in on the camera, if needed.

append_mail
boolean

If true the system appends an image to the alarm e-mail

alarm_assignments
Array of strings
Items Enum: "off" "always-active" "armed-active" "fire" "sabotage" "display" "system"

Array of all alarm assignments of the specific camera

group_id
integer

Group Id which the camera belongs to.

rack_id
integer

Rack Id which the camera belongs to.

webhooks
Array of integers

Integer Array of the webhooks

Response samples

Content type
application/json
{
  • "id": 1,
  • "is_active": true,
  • "name": "Camera",
  • "camera_location": "outdoor",
  • "protocol": "http",
  • "address": "192.168.100.2",
  • "capture_path": "/image/picture.png",
  • "stream_path": "/video/",
  • "username": "user",
  • "passsword": "password",
  • "append_mail": false,
  • "alarm_assignments": [
    ],
  • "group_id": 1,
  • "rack_id": 1,
  • "webhooks": [
    ]
}

Update a camera via the ID

Updates the configuration of a specific camera. Validation errors are returned in the response body with HTTP 422.

Authorizations:
bearer
path Parameters
camera_id
required
string

ID of the camera to be queried

Request Body schema: application/json

Camera configuration to be updated.

name
string

Name of the camera.

camera_location
string

Mounting area of the camera, can be: indoor, outdoor. Outdoor cameras use a prebuffer to capture persons before the actual booking.

protocol
string

Communication protocol, can be: http, https.

address
string

Network address of the camera.

capture_path
string

Path/URL to get the images of the camera.

username
string

Username for logging in on the camera, if needed.

passsword
string

Password for logging in on the camera, if needed.

append_mail
boolean

If true the system appends an image to the alarm e-mail

image_count
integer

Sets the number of images to be stored for every booking.

prebuffer_count
integer

Sets the number of images BEFORE the actual booking to be stored, outdoor cameras only. Counts to the actual image_count, e.g. if 10 images should be stored and prebuffer is 4, only 6 additional imaged AFTER the booking are stored.

Responses

Response Schema: application/json
Array
id
integer

Id of the camera.

is_active
boolean

True if the camera is active.

name
string

Name of the camera.

camera_location
string

Mounting area of the camera, can be: indoor, outdoor. Outdoor cameras use a prebuffer to capture persons before the actual booking.

protocol
string

Communication protocol, can be: http, https.

address
string

Network address of the camera.

capture_path
string

Path/URL to get the images of the camera.

stream_path
string

Path/URL to get the livestream of the camera.

username
string

Username for logging in on the camera, if needed.

passsword
string

Password for logging in on the camera, if needed.

append_mail
boolean

If true the system appends an image to the alarm e-mail

alarm_assignments
Array of strings
Items Enum: "off" "always-active" "armed-active" "fire" "sabotage" "display" "system"

Array of all alarm assignments of the specific camera

group_id
integer

Group Id which the camera belongs to.

rack_id
integer

Rack Id which the camera belongs to.

webhooks
Array of integers

Integer Array of the webhooks

Request samples

Content type
application/json
{
  • "name": "Camera",
  • "camera_location": "outdoor",
  • "protocol": "http",
  • "address": "192.168.100.2",
  • "capture_path": "/image/picture.png",
  • "username": "user",
  • "passsword": "password",
  • "append_mail": false,
  • "image_count": 10,
  • "prebuffer_count": 4
}

Response samples

Content type
application/json
[
  • {
    }
]

Camera Live Image

Get the live image of a specific camera.

Get camera live image

Requests the live image of a specific camera via the id.

Authorizations:
bearer
path Parameters
camera_id
required
string

ID of the camera to be queried

Responses

Response Schema: application/json
string <base64>

Response samples

Content type
application/json
"string"

Dashboard Data

Data deemed useful for a dashboard

Get dashboard data

Get the dashboard data.

Authorizations:
bearer

Responses

Response Schema: application/json
object

The status of the system displayed in current alarm stats.

Array of objects

The last 10 events logged in the system

Array of objects

The last 5 alarms

Array of objects

Response samples

Content type
application/json
{
  • "status": {
    },
  • "events": [
    ],
  • "active_alarms": [
    ],
  • "key_figures": [
    ]
}

Date & Time Configuration

Date and Time configuration

Get date and time configuration

Requests the date and time configuration of the device.

Authorizations:
bearer

Responses

Response Schema: application/json
Array
auto
boolean

If true, the device will automatically set the date and time using the configured NTP server.

ntp1
string

The first NTP server to use for automatic date and time configuration.

ntp2
string

The second NTP server to use for automatic date and time configuration.

timezone
string

The timezone to use for automatic date and time configuration.

Response samples

Content type
application/json
[
  • {
    }
]

Update date and time configuration

Updates the date and time configuration of the device.

Authorizations:
bearer
Request Body schema: application/json
Array
auto
boolean

If true, the device will automatically set the date and time using the configured NTP server.

ntp1
string

The first NTP server to use for automatic date and time configuration.

ntp2
string

The second NTP server to use for automatic date and time configuration.

timezone
string

The timezone to use for automatic date and time configuration.

Responses

Response Schema: application/json
auto
boolean

If true, the device will automatically set the date and time using the configured NTP server.

ntp1
string

The first NTP server to use for automatic date and time configuration.

ntp2
string

The second NTP server to use for automatic date and time configuration.

timezone
string

The timezone to use for automatic date and time configuration.

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "auto": true,
  • "ntp1": "0.pool.ntp.org",
  • "ntp2": "1.pool.ntp.org",
  • "timezone": "Europe/Berlin"
}

General Device Information

Device-Info

Get Device-Info

Get the Device-Info.

Authorizations:
bearer

Responses

Response Schema: application/json
Array
name
string

The name of the device

type
string

The type code of the device type of the device

version
string

The KentixONE version running on the device

serialnumber
integer

The serialnumber of the device

address
integer

The current address of the device

mac_address
string

The MAC-Address of the device

mode
string
Enum: "Manager" "Satellite"
manager_address
string or null

The address of the managing device this device reports to

mail_active
integer

The active status of the mailing function

Response samples

Content type
application/json
[
  • {
    }
]

DoorLocks List

Get a list of all DoorLocks

Request a list of all DoorLocks the user has access to.

Authorizations:
bearer

Responses

Response Schema: application/json
Array of objects
object
object

Response samples

Content type
application/json
{}

DoorLock Details

Get DoorLock by ID

Requests the complete configuration of a specific DoorLock via its ID.

Authorizations:
bearer
path Parameters
doorlock_id
required
string

ID of the DoorLock to be queried

Responses

Response Schema: application/json
id
number

ID of the DoorLock

device_id
number

ID of the DoorLock's Manager, i.e. the device on which is has been teached-in.

is_active
boolean

Describes if the DoorLock is active or inactive.

is_teachin_default
boolean

Describes if this DoorLock is preselected, when a RFID token will be teached-id.

name
string

Name of the DoorLock

type
number

Numerical devicetype

signal_zonestate
boolean

Set true, if the DoorLock should show the current arm state of the assigned alarmzone.

coupletime
number

Time in seconds after the booking while the door can be opened.

doubleauth_mode
number or null

Mode for double authentication. 0=Off, 1=On, 2=Only when arming/disarming.

log_level
number

Sets the logbook logging mode for this DoorLock. 1=Default, 2=No user-related data (names, pictures), 3=Only unauthorized bookings, 4=No logging.

timeprofile_mode
number
Enum: 0 1 2

Mode for timeprofile usage. 0=Off, 1=On, 2=Open after first booking within the time profile.

group_id
number

ID of the DoorLock's assigned alarmgroup

armlevel
number
Enum: 0 1 2 3 4

Set the arming level of this DoorLock. 0=Off, 1=Assigned Alarmzone, 2=Building containing the assigned Alarmzone, 3=System, 4=External Alarmsystem.

webhooks
Array of integers

IDs of all assigned webhooks.

cameras
Array of integers

IDs of all assigned cameras.

batterylevel
string
Enum: "full" "half" "low" "critical" "wired"

Battery level of the DoorLock

reed_bypass_time
number
Enum: 0 5 10 15 30 45 60 90 120

Time in seconds after the booking while the door can be opened without reed contact alarming.

reed_bypass_buzzer_time
number
Enum: 0 5 10 15 30 45 60 90 120

Time in seconds to buzzer after the bypass time and before triggering the door contact alarm.

Response samples

Content type
application/json
{
  • "id": 2,
  • "device_id": 1,
  • "is_active": true,
  • "is_teachin_default": false,
  • "name": "Frontdoor",
  • "type": 21,
  • "signal_zonestate": false,
  • "coupletime": 3,
  • "doubleauth_mode": 0,
  • "log_level": 1,
  • "timeprofile_mode": 0,
  • "group_id": 2,
  • "armlevel": 0,
  • "webhooks": [
    ],
  • "cameras": [
    ],
  • "batterylevel": "full",
  • "reed_bypass_time": 30,
  • "reed_bypass_buzzer_time": 30
}

Update DoorLock by ID

Updates the configuration of a specific DoorLock. Validation errors are returned in the response body with HTTP 422.

Authorizations:
bearer
path Parameters
doorlock_id
required
string

ID of the DoorLock to be queried

Request Body schema: application/json

DoorLock configuration to be updated

id
number

ID of the DoorLock

device_id
number

ID of the DoorLock's Manager, i.e. the device on which is has been teached-in.

is_active
boolean

Describes if the DoorLock is active or inactive.

is_teachin_default
boolean

Describes if this DoorLock is preselected, when a RFID token will be teached-id.

name
string

Name of the DoorLock

type
number

Numerical devicetype

signal_zonestate
boolean

Set true, if the DoorLock should show the current arm state of the assigned alarmzone.

coupletime
number

Time in seconds after the booking while the door can be opened.

doubleauth_mode
number or null

Mode for double authentication. 0=Off, 1=On, 2=Only when arming/disarming.

log_level
number

Sets the logbook logging mode for this DoorLock. 1=Default, 2=No user-related data (names, pictures), 3=Only unauthorized bookings, 4=No logging.

timeprofile_mode
number
Enum: 0 1 2

Mode for timeprofile usage. 0=Off, 1=On, 2=Open after first booking within the time profile.

group_id
number

ID of the DoorLock's assigned alarmgroup

armlevel
number
Enum: 0 1 2 3 4

Set the arming level of this DoorLock. 0=Off, 1=Assigned Alarmzone, 2=Building containing the assigned Alarmzone, 3=System, 4=External Alarmsystem.

webhooks
Array of integers

IDs of all assigned webhooks.

cameras
Array of integers

IDs of all assigned cameras.

batterylevel
string
Enum: "full" "half" "low" "critical" "wired"

Battery level of the DoorLock

reed_bypass_time
number
Enum: 0 5 10 15 30 45 60 90 120

Time in seconds after the booking while the door can be opened without reed contact alarming.

reed_bypass_buzzer_time
number
Enum: 0 5 10 15 30 45 60 90 120

Time in seconds to buzzer after the bypass time and before triggering the door contact alarm.

Responses

Response Schema: application/json
id
number

ID of the DoorLock

device_id
number

ID of the DoorLock's Manager, i.e. the device on which is has been teached-in.

is_active
boolean

Describes if the DoorLock is active or inactive.

is_teachin_default
boolean

Describes if this DoorLock is preselected, when a RFID token will be teached-id.

name
string

Name of the DoorLock

type
number

Numerical devicetype

signal_zonestate
boolean

Set true, if the DoorLock should show the current arm state of the assigned alarmzone.

coupletime
number

Time in seconds after the booking while the door can be opened.

doubleauth_mode
number or null

Mode for double authentication. 0=Off, 1=On, 2=Only when arming/disarming.

log_level
number

Sets the logbook logging mode for this DoorLock. 1=Default, 2=No user-related data (names, pictures), 3=Only unauthorized bookings, 4=No logging.

timeprofile_mode
number
Enum: 0 1 2

Mode for timeprofile usage. 0=Off, 1=On, 2=Open after first booking within the time profile.

group_id
number

ID of the DoorLock's assigned alarmgroup

armlevel
number
Enum: 0 1 2 3 4

Set the arming level of this DoorLock. 0=Off, 1=Assigned Alarmzone, 2=Building containing the assigned Alarmzone, 3=System, 4=External Alarmsystem.

webhooks
Array of integers

IDs of all assigned webhooks.

cameras
Array of integers

IDs of all assigned cameras.

batterylevel
string
Enum: "full" "half" "low" "critical" "wired"

Battery level of the DoorLock

reed_bypass_time
number
Enum: 0 5 10 15 30 45 60 90 120

Time in seconds after the booking while the door can be opened without reed contact alarming.

reed_bypass_buzzer_time
number
Enum: 0 5 10 15 30 45 60 90 120

Time in seconds to buzzer after the bypass time and before triggering the door contact alarm.

Request samples

Content type
application/json
{
  • "id": 2,
  • "device_id": 1,
  • "is_active": true,
  • "is_teachin_default": false,
  • "name": "Frontdoor",
  • "type": 21,
  • "signal_zonestate": false,
  • "coupletime": 3,
  • "doubleauth_mode": 0,
  • "log_level": 1,
  • "timeprofile_mode": 0,
  • "group_id": 2,
  • "armlevel": 0,
  • "webhooks": [
    ],
  • "cameras": [
    ],
  • "batterylevel": "full",
  • "reed_bypass_time": 30,
  • "reed_bypass_buzzer_time": 30
}

Response samples

Content type
application/json
{
  • "id": 2,
  • "device_id": 1,
  • "is_active": true,
  • "is_teachin_default": false,
  • "name": "Frontdoor",
  • "type": 21,
  • "signal_zonestate": false,
  • "coupletime": 3,
  • "doubleauth_mode": 0,
  • "log_level": 1,
  • "timeprofile_mode": 0,
  • "group_id": 2,
  • "armlevel": 0,
  • "webhooks": [
    ],
  • "cameras": [
    ],
  • "batterylevel": "full",
  • "reed_bypass_time": 30,
  • "reed_bypass_buzzer_time": 30
}

Remote open DoorLock

Open DoorLock Deprecated

Remotely open a specific DoorLock. Only allowed if the user has permission to open the DoorLock or was assigned a matching access profile.

Authorizations:
bearer
path Parameters
doorlock_id
required
string

ID of the DoorLock to be queried

Responses

Open DoorLock

Remotely open a specific DoorLock. Only allowed if the user has permission to open the DoorLock or was assigned a matching access profile.

Authorizations:
bearer
path Parameters
doorlock_id
required
string

ID of the DoorLock to be queried

Responses

DoorLock Information

DoorLock general information

Requests general information regarding a specific DoorLock.

Authorizations:
bearer
path Parameters
doorlock_id
required
string

ID of the DoorLock to be queried

Responses

Response Schema: application/json
Array
name
string

Name of the DoorLock

type
string

Devicetype of the DoorLock.

device_type
string

Devicetype name of the DoorLock.

serial
string

Serial number of the DoorLock.

version
string

Firmware Version of the DoorLock.

device_id
number

AccessManager, to which the DoorLock was teached-in.

batterylevel
string
Enum: "full" "half" "low" "critical" "wired"

Current batterylevel of the DoorLock.

switches_ext_system
boolean

Describes if the DoorLock is configured to switch an external alarmsystem.

armlevel
string
Default: 0
Enum: "0" "1" "2" "3" "4"

Set the arming level of this DoorLock. 0=Off, 1=Assigned Alarmzone, 2=Building containing the assigned Alarmzone, 3=System, 4=External Alarmsystem.

group_id
number

ID of the alarmgroup, to which this DoorLock was assigned.

log_level
number
Enum: 1 2 3 4

Sets the logbook logging mode for this DoorLock. 1=Default, 2=No user-related data (names, pictures), 3=Only unauthorized bookings, 4=No logging.

latch_logic
boolean or null

DoorLock RA4 Only. Configures if the latch logic should be inverted.

reed_logic
boolean or null

DoorLock RA4 Only. Configures if the reed logic should be inverted.

Response samples

Content type
application/json
[
  • {
    }
]

DoorLock Names

Get all DoorLock names

Requests a list of all DoorLocks the user has access to.

Authorizations:
bearer

Responses

Response Schema: application/json
Array
id
number

ID of the DoorLock

name
string

Name of the DoorLock

device_id
number

ID of the DoorLock's Manager, i.e. the device on which is has been teached-in.

is_teachin_default
boolean

Describes if this DoorLock is preselected, when a RFID token will be teached-id.

Response samples

Content type
application/json
[
  • {
    }
]

Disable multiple DoorLocks

Disable DoorLocks

Disable multiple DoorLocks and prevent any bookings on them.

Authorizations:
bearer

Responses

Response Schema: application/json
Array
integer

ID of the DoorLock

Response samples

Content type
application/json
[
  • 0
]

Enable multiple DoorLocks

Enable DoorLocks

(Re-)Enable multiple DoorLocks and re-enable any bookings on them.

Authorizations:
bearer

Responses

Response Schema: application/json
Array
integer

ID of the DoorLock

Response samples

Content type
application/json
[
  • 0
]

Exceptionday Profile List

Exceptionday Profiles

Get Exceptionday-Profiles

Get a list of Exceptionday-Profiles.

Authorizations:
bearer

Responses

Response Schema: application/json
Array of objects

The list of Exceptionday-profiles

object
object

Response samples

Content type
application/json
{}

Add Exceptionday-Profile

Add new Exceptionday-Profile.

Authorizations:
bearer
Request Body schema: application/json

Exceptionday-Profile Data

id
integer

The ID of the profile (if not included a new profile with the given data will be created)

name
string

The name of the profile

Array of objects

The days, on which the exception occures

Responses

Response Schema: application/json
Array
id
integer

The ID of the profile (if not included a new profile with the given data will be created)

name
string

The name of the profile

Array of objects

The days, on which the exception occures

Request samples

Content type
application/json
{
  • "id": 1,
  • "name": "Holidays",
  • "days": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

Mass-delete Exceptionday-Profiles

Delete all given Exceptionday-Profiles.

Authorizations:
bearer
Request Body schema: application/json

Successful operation

Array
arrays

Responses

Request samples

Content type
application/json
[
  • [
    ]
]

Exceptionday Profile Details

Exceptionday Profile configuration

Get Details

Get the configuration of given Exceptionday-Profile.

Authorizations:
bearer
path Parameters
profile
required
string

Exceptionday-Profile ID

Responses

Response Schema: application/json
Array
id
integer

The ID of the profile (if not included a new profile with the given data will be created)

name
string

The name of the profile

Array of objects

The days, on which the exception occures

Response samples

Content type
application/json
[
  • {
    }
]

Update configuration

Update the configuration of given Exceptionday-Profile.

Authorizations:
bearer
path Parameters
profile
required
string

Exceptionday-Profile ID

Request Body schema: application/json

Exceptionday-Profile Data

id
integer

The ID of the profile (if not included a new profile with the given data will be created)

name
string

The name of the profile

Array of objects

The days, on which the exception occures

Responses

Response Schema: application/json
Array
id
integer

The ID of the profile (if not included a new profile with the given data will be created)

name
string

The name of the profile

Array of objects

The days, on which the exception occures

Request samples

Content type
application/json
{
  • "id": 1,
  • "name": "Holidays",
  • "days": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

Delete Exceptionday-Profile

Delete given Exceptionday-Profile.

Authorizations:
bearer
path Parameters
profile
required
string

Exceptionday-Profile ID

Responses

Exceptionday Import - Export

Exceptionday Import - Export

Import from ICS

Import Exceptiondays from ICS-File.

Authorizations:
bearer
Request Body schema: text/calendar

ICS File

string <binary>

Responses

Export as ICS

Export all Exceptiondays as ICS.

Authorizations:
bearer
path Parameters
profile
required
string

Exceptionday-Profile ID

Responses

Response Schema: text/calendar
string <binary>

Export as CSV

Export all Exceptiondays as CSV

Authorizations:
bearer
path Parameters
profile
required
string

Exceptionday-Profile ID

Responses

Response Schema: text/csv
string <binary>

Filterprofile List

Filterprofile List

Get the filterprofiles

Get Filterprofiles.

Authorizations:
bearer

Responses

Response Schema: application/json
Array
id
integer

The ID of the Filterprofile (If not included, a new Filterprofile with the given data will be created)

user_id
integer

The ID of the creating User

name
string

The name of the filterprofile

object
is_global
boolean

If true the filterprofile will be shown to all users

is_default
boolean

If true the filterprofile will be set as default

Response samples

Content type
application/json
[
  • {
    }
]

Add a new filterprofile

Add filterprofile.

Authorizations:
bearer
Request Body schema: application/json

Successful operation

id
integer

The ID of the Filterprofile (If not included, a new Filterprofile with the given data will be created)

user_id
integer

The ID of the creating User

name
string

The name of the filterprofile

object
is_global
boolean

If true the filterprofile will be shown to all users

is_default
boolean

If true the filterprofile will be set as default

Responses

Response Schema: application/json
Array
id
integer

The ID of the Filterprofile (If not included, a new Filterprofile with the given data will be created)

user_id
integer

The ID of the creating User

name
string

The name of the filterprofile

object
is_global
boolean

If true the filterprofile will be shown to all users

is_default
boolean

If true the filterprofile will be set as default

Request samples

Content type
application/json
{
  • "id": 1,
  • "user_id": 1,
  • "name": "Alarm",
  • "filters": {
    },
  • "is_global": true,
  • "is_default": true
}

Response samples

Content type
application/json
[
  • {
    }
]

Filterprofile

Filterprofile Details

Get the details of given filterprofile

Get Filterprofile Details.

Authorizations:
bearer
path Parameters
filterprofile
required
string

Filterprofile ID

Responses

Response Schema: application/json
id
integer

The ID of the Filterprofile (If not included, a new Filterprofile with the given data will be created)

user_id
integer

The ID of the creating User

name
string

The name of the filterprofile

object
is_global
boolean

If true the filterprofile will be shown to all users

is_default
boolean

If true the filterprofile will be set as default

Response samples

Content type
application/json
{
  • "id": 1,
  • "user_id": 1,
  • "name": "Alarm",
  • "filters": {
    },
  • "is_global": true,
  • "is_default": true
}