Kentix GmbH
API docs by Redocly

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
}

Update a new filterprofile

Update filterprofile.

Authorizations:
bearer
path Parameters
filterprofile
required
string

Filterprofile ID

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
[
  • {
    }
]

Delete filterprofile

Delete filterprofile.

Authorizations:
bearer
path Parameters
filterprofile
required
string

Filterprofile ID

Responses

Response samples

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

KPIs

KPI configuration

Get configuration

Get the KPI configuration for the given user.

Authorizations:
bearer
path Parameters
user
required
string

User ID

Responses

Response Schema: application/json
Array
user_id
integer

The ID of the user related to the configuration

object

Response samples

Content type
application/json
[
  • {
    }
]

Update configuration

Update the KPI configuration for the given user.

Authorizations:
bearer
path Parameters
user
required
string

User ID

Request Body schema: application/json

KPIs Data

user_id
integer

The ID of the user related to the configuration

object

Responses

Response Schema: application/json
Array
user_id
integer

The ID of the user related to the configuration

object

Request samples

Content type
application/json
{
  • "user_id": 1,
  • "config": {
    }
}

Response samples

Content type
application/json
[
  • {
    }
]

LDAP Settings

LDAP

Get LDAP settings

Get the LDAP settings

Authorizations:
bearer

Responses

Response Schema: application/json
is_active
boolean

Is LDAP active

soft_deletes
boolean

Describes, if deleted users should be disabled or deleted. If true, the user will be disabled.

security
integer
Enum: 0 1

Describes the security level of the LDAP connection. 0 = None 1 = SSL (LDAPS)

address
string

LDAP server address

port
integer

LDAP server port

basedn
string

LDAP base DN

binddn
string

LDAP bind DN

binddn_password
string

LDAP bind DN password

usergroup_1
integer

ID of the Kentix system usergroup, which should be used for LDAP usergroup 1

usergroup_1_path
string

LDAP usergroup 1 path

usergroup_2
integer

ID of the Kentix system usergroup, which should be used for LDAP usergroup 2

usergroup_2_path
string

LDAP usergroup 2 path

admin_group
string

LDAP admin group

user_active
string

LDAP user active attribute

username
string

LDAP username attribute

fullname
string

LDAP fullname attribute

email
string

LDAP email attribute

phone
string

LDAP phone attribute, only required for AlarmManagers

pin
string

LDAP pin attribute

rfid
string

LDAP rfid attribute

description
string

LDAP description attribute

emergency_access
string

LDAP emergency access attribute

notifications
string

LDAP attribute to describe if a user may receive notifications

levelprofiles
string

LDAP attribute to describe the accessprofiles of a user

sync_interval
integer
Enum: 3600 10800 21600 43200 86400

LDAP sync interval in seconds

Response samples

Content type
application/json
{
  • "is_active": true,
  • "soft_deletes": false,
  • "security": 1,
  • "address": "ldap.example.com",
  • "port": 389,
  • "basedn": "dc=example,dc=com",
  • "binddn": "cn=admin,dc=example,dc=com",
  • "binddn_password": "password",
  • "usergroup_1": 1,
  • "usergroup_1_path": "cn=users,ou=groups,dc=example,dc=com",
  • "usergroup_2": 2,
  • "usergroup_2_path": "cn=admins,ou=groups,dc=example,dc=com",
  • "admin_group": "cn=admins,ou=groups,dc=example,dc=com",
  • "user_active": "active",
  • "username": "sAMAccountName",
  • "fullname": "name",
  • "email": "mail",
  • "phone": "telephoneNumber",
  • "pin": "pin",
  • "rfid": "rfid",
  • "description": "description",
  • "emergency_access": "emergency",
  • "notifications": "receives_notifications",
  • "levelprofiles": "accessprofiles",
  • "sync_interval": 3600
}

Update LDAP settings

Update the LDAP settings

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

Is LDAP active

soft_deletes
boolean

Describes, if deleted users should be disabled or deleted. If true, the user will be disabled.

security
integer
Enum: 0 1

Describes the security level of the LDAP connection. 0 = None 1 = SSL (LDAPS)

address
string

LDAP server address

port
integer

LDAP server port

basedn
string

LDAP base DN

binddn
string

LDAP bind DN

binddn_password
string

LDAP bind DN password

usergroup_1
integer

ID of the Kentix system usergroup, which should be used for LDAP usergroup 1

usergroup_1_path
string

LDAP usergroup 1 path

usergroup_2
integer

ID of the Kentix system usergroup, which should be used for LDAP usergroup 2

usergroup_2_path
string

LDAP usergroup 2 path

admin_group
string

LDAP admin group

user_active
string

LDAP user active attribute

username
string

LDAP username attribute

fullname
string

LDAP fullname attribute

email
string

LDAP email attribute

phone
string

LDAP phone attribute, only required for AlarmManagers

pin
string

LDAP pin attribute

rfid
string

LDAP rfid attribute

description
string

LDAP description attribute

emergency_access
string

LDAP emergency access attribute

notifications
string

LDAP attribute to describe if a user may receive notifications

levelprofiles
string

LDAP attribute to describe the accessprofiles of a user

sync_interval
integer
Enum: 3600 10800 21600 43200 86400

LDAP sync interval in seconds

Responses

Response Schema: application/json
is_active
boolean

Is LDAP active

soft_deletes
boolean

Describes, if deleted users should be disabled or deleted. If true, the user will be disabled.

security
integer
Enum: 0 1

Describes the security level of the LDAP connection. 0 = None 1 = SSL (LDAPS)

address
string

LDAP server address

port
integer

LDAP server port

basedn
string

LDAP base DN

binddn
string

LDAP bind DN

binddn_password
string

LDAP bind DN password

usergroup_1
integer

ID of the Kentix system usergroup, which should be used for LDAP usergroup 1

usergroup_1_path
string

LDAP usergroup 1 path

usergroup_2
integer

ID of the Kentix system usergroup, which should be used for LDAP usergroup 2

usergroup_2_path
string

LDAP usergroup 2 path

admin_group
string

LDAP admin group

user_active
string

LDAP user active attribute

username
string

LDAP username attribute

fullname
string

LDAP fullname attribute

email
string

LDAP email attribute

phone
string

LDAP phone attribute, only required for AlarmManagers

pin
string

LDAP pin attribute

rfid
string

LDAP rfid attribute

description
string

LDAP description attribute

emergency_access
string

LDAP emergency access attribute

notifications
string

LDAP attribute to describe if a user may receive notifications

levelprofiles
string

LDAP attribute to describe the accessprofiles of a user

sync_interval
integer
Enum: 3600 10800 21600 43200 86400

LDAP sync interval in seconds

Request samples

Content type
application/json
{
  • "is_active": true,
  • "soft_deletes": false,
  • "security": 1,
  • "address": "ldap.example.com",
  • "port": 389,
  • "basedn": "dc=example,dc=com",
  • "binddn": "cn=admin,dc=example,dc=com",
  • "binddn_password": "password",
  • "usergroup_1": 1,
  • "usergroup_1_path": "cn=users,ou=groups,dc=example,dc=com",
  • "usergroup_2": 2,
  • "usergroup_2_path": "cn=admins,ou=groups,dc=example,dc=com",
  • "admin_group": "cn=admins,ou=groups,dc=example,dc=com",
  • "user_active": "active",
  • "username": "sAMAccountName",
  • "fullname": "name",
  • "email": "mail",
  • "phone": "telephoneNumber",
  • "pin": "pin",
  • "rfid": "rfid",
  • "description": "description",
  • "emergency_access": "emergency",
  • "notifications": "receives_notifications",
  • "levelprofiles": "accessprofiles",
  • "sync_interval": 3600
}

Response samples

Content type
application/json
{
  • "is_active": true,
  • "soft_deletes": false,
  • "security": 1,
  • "address": "ldap.example.com",
  • "port": 389,
  • "basedn": "dc=example,dc=com",
  • "binddn": "cn=admin,dc=example,dc=com",
  • "binddn_password": "password",
  • "usergroup_1": 1,
  • "usergroup_1_path": "cn=users,ou=groups,dc=example,dc=com",
  • "usergroup_2": 2,
  • "usergroup_2_path": "cn=admins,ou=groups,dc=example,dc=com",
  • "admin_group": "cn=admins,ou=groups,dc=example,dc=com",
  • "user_active": "active",
  • "username": "sAMAccountName",
  • "fullname": "name",
  • "email": "mail",
  • "phone": "telephoneNumber",
  • "pin": "pin",
  • "rfid": "rfid",
  • "description": "description",
  • "emergency_access": "emergency",
  • "notifications": "receives_notifications",
  • "levelprofiles": "accessprofiles",
  • "sync_interval": 3600
}

LDAP Sync

LDAP Sync

Synchronize LDAP users

Start an LDAP sync

Authorizations:
bearer

Responses

Response samples

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

Levelprofile List

Get levelprofiles

Get all levelprofiles

Requests all levelprofiles which the user has access to.

Authorizations:
bearer

Responses

Response Schema: application/json
Array
id
required
integer

Id of the levelprofile

name
required
string

Name of the levelprofile

timeprofile
string

Name of the timeprofile

Response samples

Content type
application/json
[
  • {
    }
]

Create levelprofile

Creates a new levelprofile.

Authorizations:
bearer
Request Body schema: application/json

Levelprofile configuration to be added

name
string

Name of the levelprofile

timeprofile_id
integer

Id of the assigned timeprofile

doorlocks
Array of integers

Ids of the doorlocks

Responses

Response Schema: application/json
Array
id
integer

Id of levelprofile

name
string

Name of the levelprofile

timeprofile_id
integer

Id of the assigned timeprofile

doorlocks
Array of integers

Id of the doorlocks

Request samples

Content type
application/json
{
  • "name": "Levelprofile",
  • "timeprofile_id": 1,
  • "doorlocks": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

Levelprofile Details

Get a specific levelprofile by an Id

Get levelprofile by ID

Requests the levelprofile via its ID.

Authorizations:
bearer
path Parameters
levelprofile_id
required
string

ID of the levelprofile to be queried

Responses

Response Schema: application/json
Array
id
integer

Id of levelprofile

name
string

Name of the levelprofile

timeprofile_id
integer

Id of the assigned timeprofile

doorlocks
Array of integers

Id of the doorlocks

Response samples

Content type
application/json
[
  • {
    }
]

Update levelprofile by ID

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

Authorizations:
bearer
path Parameters
levelprofile_id
required
string

ID of the levelprofile to be queried

Request Body schema: application/json

Levelprofile configuration to be updated

name
string

Name of the timeprofile

timeprofile_id
integer

Id of the timeprofile connected to the levelprofile

doorlocks
Array of integers

Id of the doorlocks

Responses

Response Schema: application/json
Array
id
integer

Id of levelprofile

name
string

Name of the levelprofile

timeprofile_id
integer

Id of the assigned timeprofile

doorlocks
Array of integers

Id of the doorlocks

Request samples

Content type
application/json
{
  • "name": "Levelprofile",
  • "timeprofile_id": 1,
  • "doorlocks": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

Delete a single levelprofile

Delete the levelprofile with a specific id.

Authorizations:
bearer
path Parameters
levelprofile_id
required
string

ID of the levelprofile to be deleted

Responses

Levelprofile Names

Get the names of the levelprofiles

Levelprofiles names

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

Authorizations:
bearer

Responses

Response Schema: application/json
Array
id
integer

Id of levelprofile name

name
string

Name of the levelprofile

Response samples

Content type
application/json
[
  • {
    }
]

Email Configuration

Email configuration

Get email configuration

Requests the email configuration of the device.

Authorizations:
bearer

Responses

Response Schema: application/json
Array
is_active
boolean

Describes if mailing is active or not.

sender
string

Sender email address

address
string

SMTP server address

port
integer

SMTP server port

security
string
Enum: "off" "starttls" "ssl"

SMTP server security

username
string

SMTP server username

password
string

SMTP server password

signature
string

Email signature

Response samples

Content type
application/json
[
  • {
    }
]

Update email configuration

Updates the email configuration of the device.

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

Describes if mailing is active or not.

sender
string

Sender email address

address
string

SMTP server address

port
integer

SMTP server port

security
string
Enum: "off" "starttls" "ssl"

SMTP server security

username
string

SMTP server username

password
string

SMTP server password

signature
string

Email signature

Responses

Response Schema: application/json
Array
is_active
boolean

Describes if mailing is active or not.

sender
string

Sender email address

address
string

SMTP server address

port
integer

SMTP server port

security
string
Enum: "off" "starttls" "ssl"

SMTP server security

username
string

SMTP server username

password
string

SMTP server password

signature
string

Email signature

Request samples

Content type
application/json
{
  • "is_active": true,
  • "sender": "sender@mail.test",
  • "address": "smtp.mail.test",
  • "port": 587,
  • "security": "starttls",
  • "username": "myusername",
  • "password": "mypassword",
  • "signature": "My signature"
}

Response samples

Content type
application/json
[
  • {
    }
]

Test Email Configuration

Test Email configuration

Send test email

Send a test email. This will send a test email to the configured email address.

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

Sender email address

address
string

SMTP server address

port
integer

SMTP server port

security
string
Enum: "off" "starttls" "ssl"

SMTP server security

username
string

SMTP server username

password
string

SMTP server password

signature
string

Email signature

Responses

Request samples

Content type
application/json
{
  • "sender": "sender@mail.test",
  • "address": "smtp.mail.test",
  • "port": 587,
  • "security": "starttls",
  • "username": "myusername",
  • "password": "mypassword",
  • "signature": "My signature"
}

Massedit

Massedit

Massedit

Send a massedit request.

Authorizations:
bearer
Request Body schema: application/json

Massedit Data

object

An Object that contains all ids of the devices to be edited

fields
object

An Object that contains all the fields and their values to be edited (Remember to properly layer the fields e.g. temerature and dewpoint have to be inside of monitoring)

Responses

Request samples

Content type
application/json
{
  • "ids": {
    },
  • "fields": {
    }
}

Measurements

Measurements of the devices

Get Systemvalues

Requests the Systemvalues of the device. The Systemvalues contain all sensor data and devices list informations.

Authorizations:
bearer

Responses

Response Schema: application/json
Array
object

A array for a the measurement units used in the response.

Array of objects

A full device list of all registered devices and their mesurements.

Array of objects

A full device list of all registered ios and their mesurements.

Array of objects

A list of all alarmgroups of the device.

Array of objects

A full device list of all registered racks and their mesurements.

Response samples

Content type
application/json
[
  • {
    }
]

Get Systemvalues of a specific device

Requests the Systemvalues of a specific device, which contains the sensor data.

Authorizations:
bearer
path Parameters
id
required
string

Device ID

Responses

Response Schema: application/json
Array
object

A array for a the measurement units used in the response.

Array of objects

A full device list of all registered devices and their mesurements.

Response samples

Content type
application/json
[
  • {
    }
]

Network Configuration

Network configuration

Get network configuration

Requests the network configuration of the device.

Authorizations:
bearer

Responses

Response Schema: application/json
Array
dhcp_active
boolean

Describes if DHCP is active or not.

dhcp_address
string

DHCP IP address of the device.

dhcp_netmask
string

DHCP netmask of the device.

static_active
boolean

Describes if static IP is active or not.

static_address
string or null

Static IP address of the device.

static_netmask
string

Static netmask of the device.

gateway
string

Network gateway of the device.

dns1
string

Primary DNS server of the device.

dns2
string

Secondary DNS server of the device.

dyndns_address
string

Dynymic DNS address of the device.

object

IEEE 802.1X port authentication settings.

Response samples

Content type
application/json
[
  • {
    }
]

Update network configuration

Updates the network configuration of the device.

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

Describes if DHCP is active or not.

dhcp_address
string

DHCP IP address of the device.

dhcp_netmask
string

DHCP netmask of the device.

static_active
boolean

Describes if static IP is active or not.

static_address
string or null

Static IP address of the device.

static_netmask
string

Static netmask of the device.

gateway
string

Network gateway of the device.

dns1
string

Primary DNS server of the device.

dns2
string

Secondary DNS server of the device.

dyndns_address
string

Dynymic DNS address of the device.

object

IEEE 802.1X port authentication settings.

Responses

Response Schema: application/json
Array
dhcp_active
boolean

Describes if DHCP is active or not.

dhcp_address
string

DHCP IP address of the device.

dhcp_netmask
string

DHCP netmask of the device.

static_active
boolean

Describes if static IP is active or not.

static_address
string or null

Static IP address of the device.

static_netmask
string

Static netmask of the device.

gateway
string

Network gateway of the device.

dns1
string

Primary DNS server of the device.

dns2
string

Secondary DNS server of the device.

dyndns_address
string

Dynymic DNS address of the device.

object

IEEE 802.1X port authentication settings.

Request samples

Content type
application/json
{
  • "dhcp_active": true,
  • "dhcp_address": "192.168.100.224",
  • "dhcp_netmask": "255.255.255.0",
  • "static_active": false,
  • "static_address": "192.168.100.224",
  • "static_netmask": "255.255.255.0",
  • "gateway": "192.168.100.1",
  • "dns1": "192.168.100.1",
  • "dns2": "192.168.100.2",
  • "dyndns_address": "my-alarmmanager.internal.mycompany.com",
  • "port_auth": {
    }
}

Response samples

Content type
application/json
[
  • {
    }
]

SSL Certificate Configuration

SSL Certificate configuration

Get SSL certificate

Requests the SSL certificate of the device.

Authorizations:
bearer

Responses

Response Schema: application/json
Array
data
string

The SSL certificate of the device.

upload
string

The date and time the certificate was uploaded.

begin
string

The date and time the certificate is valid from.

end
string

The date and time the certificate is valid until.

Response samples

Content type
application/json
[
  • {
    }
]

Upload SSL certificate

Uploads a new SSL certificate to the device.

Authorizations:
bearer
Request Body schema: application/octet-stream

The SSL certificate to upload.

string <binary>

Responses

Response Schema: application/json
Array
data
string

The SSL certificate of the device.

upload
string

The date and time the certificate was uploaded.

begin
string

The date and time the certificate is valid from.

end
string

The date and time the certificate is valid until.

Response samples

Content type
application/json
[
  • {
    }
]

Delete SSL certificate

Deletes the SSL certificate of the device.

Authorizations:
bearer

Responses

Personalizations

Get Personalizations

Get the start default-view

Requests the start default-view.

Authorizations:
bearer

Responses

Response Schema: application/json
defaultview_start
string

Name of the selected topology

Response samples

Content type
application/json
{
  • "defaultview_start": "topology"
}

Update the start default-view

Updates the start default-view. Validation errors are returned in the response body with HTTP 422.

Authorizations:
bearer
Request Body schema: application/json

Default-view configuration to be updated

detailview_start
string
Enum: "topology" "grid" "list"

Responses

Response Schema: application/json
Array
defaultview_start
string

Name of the selected topology

Request samples

Content type
application/json
{
  • "detailview_start": "topology"
}

Response samples

Content type
application/json
[
  • {
    }
]

Personalization background

Personalization of the background image

Update background image.

Updates the current background image.

Authorizations:
bearer
Request Body schema: application/json

Backround image configuration to be updated

background_image
string <binary>

Responses

Request samples

Content type
application/json
{
  • "background_image": "string"
}

Response samples

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

Personalization default view

Get the current default-view

Get the current default-view

Requests the current default-view the user has selected.

Authorizations:
bearer

Responses

Response Schema: application/json
defaultview
string

Name of the selected topology

Response samples

Content type
application/json
{
  • "defaultview": "topology"
}

Background image

Get or delete the background image

Get the current default-view

Requests the current background image.

Authorizations:
bearer

Responses

Response Schema: application/json
string <base64>

Response samples

Content type
application/json
"string"

Deletes the backgound image

Delete the current background image.

Authorizations:
bearer

Responses

Locale Configuration

Email configuration

Locale settings

Requests the language and temperature unit configuration of the device.

Authorizations:
bearer

Responses

Response Schema: application/json
Array
language
string
Enum: "en" "de" "fr" "it" "es" "pt" "jp"

Language code

temperature_unit
string
Enum: "C" "F"

Temperature unit

Response samples

Content type
application/json
[
  • {
    }
]

Update locale settings

Updates the language and temperature unit configuration of the device.

Authorizations:
bearer
Request Body schema: application/json
language
string
Enum: "en" "de" "fr" "it" "es" "pt" "jp"

Language code

temperature_unit
string
Enum: "C" "F"

Temperature unit

Responses

Response Schema: application/json
Array
language
string
Enum: "en" "de" "fr" "it" "es" "pt" "jp"

Language code

temperature_unit
string
Enum: "C" "F"

Temperature unit

Request samples

Content type
application/json
{
  • "language": "en",
  • "temperature_unit": "C"
}

Response samples

Content type
application/json
[
  • {
    }
]

Report List

Reports

Get Reports

Get all reports

Authorizations:
bearer

Responses

Response Schema: application/json
Array of objects
object
object

Response samples

Content type
application/json
{}

Add Report

Add new report

Authorizations:
bearer
Request Body schema: application/json
id
integer

The ID of the report

name
string

The name of the Report

type
integer
Enum: 0 1

The type of report. 0 = all data, 1 = sum

interval_mode
integer
Enum: 1 2 3 4

The Interval in which the report is sent. 1 = daily, 2 = weekly, 3 = monthly, 4 = yearly

Responses

Request samples

Content type
application/json
{
  • "id": 1,
  • "name": "Example-Report",
  • "type": 0,
  • "interval_mode": 2
}

Response samples

Content type
application/json
{
  • "id": 1,
  • "name": "Example-Report",
  • "type": 0,
  • "interval_mode": 2
}

Report Names

Report Names

Get Report Names

Get all report names

Authorizations:
bearer

Responses

Response Schema: application/json
Array
id
integer

The ID of the report

name
string

The name of the Report

type
integer
Enum: 0 1

The type of report. 0 = all data, 1 = sum

interval_mode
integer
Enum: 1 2 3 4

The Interval in which the report is sent. 1 = daily, 2 = weekly, 3 = monthly, 4 = yearly

last_sent
integer

The Unix-timestamp of the last time this report was sent

created_at
string

The created timestamp

updated_at
string

The updated timestamp

tenant_id
string

The ID of the tenant [requires multitenancy]

Response samples

Content type
application/json
[
  • {
    }
]

Report Details

Report Details

Get Report Details

Get details of given Report

Authorizations:
bearer
path Parameters
report
required
integer

Report ID

Responses

Response Schema: application/json
id
integer

The ID of the report

name
string

The name of the Report

type
integer
Enum: 0 1

The type of report. 0 = all data, 1 = sum

interval_mode
integer
Enum: 1 2 3 4

The Interval in which the report is sent. 1 = daily, 2 = weekly, 3 = monthly, 4 = yearly

Response samples

Content type
application/json
{
  • "id": 1,
  • "name": "Example-Report",
  • "type": 0,
  • "interval_mode": 2
}

Update Report

Update given Report

Authorizations:
bearer
path Parameters
report
required
integer

Report ID

Request Body schema: application/json
id
integer

The ID of the report

name
string

The name of the Report

type
integer
Enum: 0 1

The type of report. 0 = all data, 1 = sum

interval_mode
integer
Enum: 1 2 3 4

The Interval in which the report is sent. 1 = daily, 2 = weekly, 3 = monthly, 4 = yearly

Responses

Response Schema: application/json
id
integer

The ID of the report

name
string

The name of the Report

type
integer
Enum: 0 1

The type of report. 0 = all data, 1 = sum

interval_mode
integer
Enum: 1 2 3 4

The Interval in which the report is sent. 1 = daily, 2 = weekly, 3 = monthly, 4 = yearly

Request samples

Content type
application/json
{
  • "id": 1,
  • "name": "Example-Report",
  • "type": 0,
  • "interval_mode": 2
}

Response samples

Content type
application/json
{
  • "id": 1,
  • "name": "Example-Report",
  • "type": 0,
  • "interval_mode": 2
}

Delete Report

Delete given Report

Authorizations:
bearer
path Parameters
report
required
integer

Report ID

Responses

Send Test Report

Send Test Report

Send Test Report

Send test report

Authorizations:
bearer
path Parameters
report
required
integer

Report ID

Responses

Factory Reset

Reset the device

Factory Reset

Initiate a factory reset. This will delete all data on the device and restore it to its factory defaults.

Authorizations:
bearer
Request Body schema: application/json

The device will reboot after the reset is complete. The device will not be reachable for a few minutes.

reboot
boolean

Reboot the Device.

reset_network
boolean

Reset the Network Settings.

Responses

Request samples

Content type
application/json
{
  • "reboot": true,
  • "reset_network": true
}

Reboot

Reboot the device

Reboot

Reboot the device.

Authorizations:
bearer

Responses

Satellites

Functions to get Satellites

Get a list of all satellites.

Request all the satellites.

Authorizations:
bearer

Responses

Response Schema: application/json
id
integer

ID of the satellite device.

type
integer

Numerical representation of the device type.

device_type
string

Textual representation of the device type.

name
string

Name of the satellite.

os_revision
integer

Device version. NOT Firmware version.

fw_version
string

Current firmware version of the satellite.

is_satellite
boolean

Shows if the device is a satellite or a manager.

mac_address
string

MAC address of the satellite.

address
string

Network address of the satellite.

update_available
boolean

Shows if a firmware update for this satellite is available.

update_state
integer

Indicates the current update state, if an update is running.

enable_sync
boolean

If set to false, this satellite is excluded from synchronizing with the master.

Response samples

Content type
application/json
{
  • "id": 43,
  • "type": 110,
  • "device_type": "KXP",
  • "name": "AccessManager Satellite",
  • "os_revision": 2,
  • "fw_version": "08.01.02 B00944",
  • "is_satellite": true,
  • "mac_address": "00:11:22:33:44:55",
  • "address": "192.168.100.224",
  • "update_available": false,
  • "update_state": 0,
  • "enable_sync": true
}

Satellites Settings

Functions to get and update the Satellite settings.

Get the satellites settings

Request the satellites settings.

Authorizations:
bearer

Responses

Response Schema: application/json
device_name
string

Name of the satellite.

is_active
boolean

Indicates if this satellite is enabled.

manager_address
string

Network address of the manager to which this slave is assigned.

Response samples

Content type
application/json
{
  • "device_name": "AccessManager",
  • "is_active": true,
  • "manager_address": "192.168.100.224"
}

Update the Satellite settings.

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

Authorizations:
bearer
Request Body schema: application/json

Satellite settings configuration to be updated.

is_active
boolean

Indicates if this satellite is enabled.

manager_address
string

Network address of the manager to which this slave is assigned.

Responses

Response Schema: application/json
Array
device_name
string

Name of the satellite.

is_active
boolean

Indicates if this satellite is enabled.

manager_address
string

Network address of the manager to which this slave is assigned.

Request samples

Content type
application/json
{
  • "is_active": true,
  • "manager_address": "192.168.100.224"
}

Response samples

Content type
application/json
[
  • {
    }
]

Satellite Synchronization

Functions to manage the Satellite synchronization process.

Get the synchronization status of the Satellites.

Get the synchronization status of the Satellites.

Authorizations:
bearer

Responses

Response Schema: application/json
has_satellites
boolean

Shows if this devices has assigned slaves.

is_runnig
boolean

Indicated if a synchronization is already running.

is_unsynced
boolean

The count of unsynchronized satellites.

Response samples

Content type
application/json
{
  • "has_satellites": true,
  • "is_runnig": false,
  • "is_unsynced": true
}

Start the Satellite data synchronization.

Start the Satellite data synchronization.

Authorizations:
bearer

Responses

Response samples

Content type
application/json
{
  • "has_satellites": true,
  • "is_runnig": false,
  • "is_unsynced": true
}

Satellite Update

Functions to get, delete and update Satellites

Get the status of the Satellites-Update.

Get the status of the Satellites-Update.

Authorizations:
bearer

Responses

Response Schema: application/json
is_running
boolean

True if an update is running on a device.

queued
integer

Sum of queued updates of the satellites connected with the device.

Response samples

Content type
application/json
{
  • "is_running": false,
  • "queued": 0
}

Checks for available updates.

THe device checks for each connected Satellite i there is an update available. If an update is available it will be added to the update-queue.

Authorizations:
bearer

Responses

Response samples

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

Delete all queued updates at once.

Delete all queued updates at once.

Authorizations:
bearer

Responses

Response samples

Content type
application/json
{
  • "name": "AccessManager Satellite",
  • "address": "192.168.100.224",
  • "enable_sync": true
}

Satellites Firmware

Function to get and modify firmwares.

Get a list of all stored firmware files.

Get a list of all stored firmware files.

Authorizations:
bearer

Responses

Response Schema: application/json
id
integer

ID of the satellite device.

type
integer

Numerical representation of the device type.

device_type
string

Textual representation of the device type.

name
string

Name of the satellite.

os_revision
integer

Device version. NOT Firmware version.

fw_version
string

Current firmware version of the satellite.

is_satellite
boolean

Shows if the device is a satellite or a manager.

mac_address
string

MAC address of the satellite.

address
string

Network address of the satellite.

update_available
boolean

Shows if a firmware update for this satellite is available.

update_state
integer

Indicates the current update state, if an update is running.

enable_sync
boolean

If set to false, this satellite is excluded from synchronizing with the master.

Response samples

Content type
application/json
{
  • "id": 43,
  • "type": 110,
  • "device_type": "KXP",
  • "name": "AccessManager Satellite",
  • "os_revision": 2,
  • "fw_version": "08.01.02 B00944",
  • "is_satellite": true,
  • "mac_address": "00:11:22:33:44:55",
  • "address": "192.168.100.224",
  • "update_available": false,
  • "update_state": 0,
  • "enable_sync": true
}

Upload a new firmware image for the satellite update.

Upload a new firmware image for the satellite update.

Authorizations:
bearer
Request Body schema: application/json

Firmware image for the satellite update.

firmware
string

The firmware file to be uploaded.

Responses

Request samples

Content type
application/json
{
  • "firmware": "Firmware string"
}

Response samples

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

Satellite specific Firmware

Function to delete a specific firmware.

Removes a specific firmware file.

Removes a specific firmware file via the ID.

Authorizations:
bearer
path Parameters
firmwares_id
required
string

ID of the Firmware to be queried

Responses

Satellite Firmware status

Get the current firmware status for the satellite update.

Current firmware status for the satellite update.

Get the current firmware status for the satellite update.

Authorizations:
bearer

Responses

Response Schema: application/json
status
integer

Represents the update-status.

Response samples

Content type
application/json
{
  • "status": 0
}

SD Card

SD Card

Get the SD card status

Get the SD card status

Responses

Response Schema: application/json
present
boolean

Describes if the SD card was inserted.

mounted
boolean

Describes if the SD card successfully was mounted.

label
string

The label of the SD card.

capacity
integer

The capacity of the SD card.

used
integer

The used space of the SD card.

available
integer

The available space of the SD card.

Response samples

Content type
application/json
{
  • "present": true,
  • "mounted": true,
  • "label": "SD_CARD",
  • "capacity": "16GB",
  • "used": "1GB",
  • "available": "15GB"
}

Erase the SD card

Erase the SD card

Responses

Response Schema: application/json
present
boolean

Describes if the SD card was inserted.

mounted
boolean

Describes if the SD card successfully was mounted.

label
string

The label of the SD card.

capacity
integer

The capacity of the SD card.

used
integer

The used space of the SD card.

available
integer

The available space of the SD card.

Response samples

Content type
application/json
{
  • "present": true,
  • "mounted": true,
  • "label": "SD_CARD",
  • "capacity": "16GB",
  • "used": "1GB",
  • "available": "15GB"
}

Communication Key

Security

Get communication key

Get the communication key.

Authorizations:
bearer

Responses

Response Schema: application/json
communication-key
string

The communication key of the device.

pinlength
integer [ 4 .. 10 ]

The length of the PIN.

rfid-mode
integer
Enum: 0 1 2

The RFID mode of the device. 0=disabled, 1=Kentix-Encryption, 2=Custom-Encryption.

Response samples

Content type
application/json
{
  • "communication-key": "myCommunicationKey0123456789",
  • "pinlength": 4,
  • "rfid-mode": 0
}

Update communication key

Update the communication key.

Authorizations:
bearer
Request Body schema: application/json
communication-key
string

The communication key of the device.

pinlength
integer [ 4 .. 10 ]

The length of the PIN.

rfid-mode
integer
Enum: 0 1 2

The RFID mode of the device. 0=disabled, 1=Kentix-Encryption, 2=Custom-Encryption.

Responses

Response Schema: application/json
communication-key
string

The communication key of the device.

pinlength
integer [ 4 .. 10 ]

The length of the PIN.

rfid-mode
integer
Enum: 0 1 2

The RFID mode of the device. 0=disabled, 1=Kentix-Encryption, 2=Custom-Encryption.

Request samples

Content type
application/json
{
  • "communication-key": "myCommunicationKey0123456789",
  • "pinlength": 4,
  • "rfid-mode": 0
}

Response samples

Content type
application/json
{
  • "communication-key": "myCommunicationKey0123456789",
  • "pinlength": 4,
  • "rfid-mode": 0
}

Output Switching

outputs

Switch output

Switches a specific output of the device.

Authorizations:
bearer
path Parameters
device_id
required
string

ID of the device, whose output should be switched

Request Body schema: application/json

Specification of the switching process

Array
output
required
string
Enum: "BUZZER" "LEDRED" "LEDGREEN" "DO1" "DO2" "DO3" "DO4" "DO5" "DO6" "DO7" "DO8"

The output to be switched

mode
required
string
Enum: "ON" "OFF" "PULSE"

Defines the switching mode. ON: Switches the output constantly on. OFF: Switches the output constantly off. PULSE: Toggles the output between on and off in a one second interval.

duration
number or null
Default: null

Period of time in seconds to signal on the selected output. Can be NULL or any integer number. Can be omitted, which will be evaluated the same as NULL or 0. If omitted or set to NULL, the signaling will be continuous.

delay
number or null
Default: null

Delay in seconds before this signaling command is executed. Can be NULL or any integer number. Can be omitted, which will be evaluated the same as NULL or 0. If omitted or set to NULL, the signaling will start instantly.

Responses

Request samples

Content type
application/json
[
  • {
    }
]

SNMP Settings

SNMP Settings

Get SNMP settings

Get a the system's SNMP settings

Responses

Response Schema: application/json
is_active
boolean

Describes if the SNMP service is active

trapreceiver_active
boolean

Describe if the SNMP trap receiver is active

Response samples

Content type
application/json
{
  • "is_active": true,
  • "trapreceiver_active": true
}

Update SNMP settings

Update the system's SNMP settings

Request Body schema: application/json

SNMP settings

is_active
boolean

Describes if the SNMP service is active

trapreceiver_active
boolean

Describe if the SNMP trap receiver is active

Responses

Response Schema: application/json
is_active
boolean

Describes if the SNMP service is active

trapreceiver_active
boolean

Describe if the SNMP trap receiver is active

Request samples

Content type
application/json
{
  • "is_active": true,
  • "trapreceiver_active": true
}

Response samples

Content type
application/json
{
  • "is_active": true,
  • "trapreceiver_active": true
}

SNMP credential List

SNMP Hosts

SNMP credentials

Get a list of all SNMP credentials

Responses

Response Schema: application/json
Array of objects
object
object

Response samples

Content type
application/json
{}

Create SNMP credential

Create a new SNMP credential

Request Body schema: application/json

SNMP credential

id
integer

The ID of the SNMP credential

is_active
boolean

Describes if the SNMP credential is active

version
integer
Enum: 2 3

SNMP version of the credential. 2 = SNMPv2, 3 = SNMPv3

mode
integer
Enum: 1 2 3

Operating mode of the credential. 1 = Provide data, 2 = Send traps, 3 = Poll data

address
string or null

The IP address of the SNMP credential. Only required for mode "Send traps" and "Poll Data". If in mode "Send traps" the address is the address trap receiver. If in mode "Poll Data" the address is the address of the device to poll.

port
integer or null

The port of the SNMP credential. Only required for mode "Send traps" and "Poll Data". If in mode "Send traps" the port is the port of the trap receiver. If in mode "Poll Data" the port is the port of the device to poll.

name
string

The name of the SNMP credential

send_cold_start_trap
boolean

Describes if the device sends a cold start trap to the configured trap receiver.

send_warm_start_trap
boolean

Describes if the device sends a warm start trap to the configured trap receiver.

send_login_trap
boolean

Describes if the device sends a login trap to the configured trap receiver.

send_alarm_trap
boolean

Describes if the device sends an alarm trap to the configured trap receiver.

send_structured_alarm_trap
boolean

Describes if the device sends a structured alarm trap to the configured trap receiver.

send_alarm_state_change_trap
boolean

Describes if the device sends an alarm state change trap to the configured trap receiver.

send_access_trap
boolean

Describes if the device sends an access trap to the configured trap receiver.

send_structured_access_trap
boolean

Describes if the device sends a structured access trap to the configured trap receiver.

username
string or null

The username of the SNMP credential. Only required for SNMPv3.

community
string or null

The community of the SNMP credential. Only required for SNMPv2.

authentication_protocol
integer or null
Enum: 1 2 3

The authentication protocol of the SNMP credential. Only required for SNMPv3. 1 = No authentication, 2 = HMAC-MD5, 3 = HMAC-SHA

authentication_password
string or null

The authentication password of the SNMP credential. Only required for SNMPv3.

privacy_protocol
integer or null
Enum: 1 2 3 4 9 20 21 22 23 24

The privacy protocol of the SNMP credential. Only required for SNMPv3. 1 = No privacy protocol, 2 = DES, 3 = 3DES, 4 = AES128, 9 = IDEA, 20 = AES192, 21 = AES256, 22 = AES128 3DES, 23 = AES192 3DES, 24 = AES256 3DES

privacy_password
string or null

The privacy password of the SNMP credential. Only required for SNMPv3.

heartbeat_interval
integer or null

The heartbeat interval of the SNMP credential. Only required for mode "Poll Data".

Responses

Response Schema: application/json
id
integer

The ID of the SNMP credential

is_active
boolean

Describes if the SNMP credential is active

version
integer
Enum: 2 3

SNMP version of the credential. 2 = SNMPv2, 3 = SNMPv3

mode
integer
Enum: 1 2 3

Operating mode of the credential. 1 = Provide data, 2 = Send traps, 3 = Poll data

address
string or null

The IP address of the SNMP credential. Only required for mode "Send traps" and "Poll Data". If in mode "Send traps" the address is the address trap receiver. If in mode "Poll Data" the address is the address of the device to poll.

port
integer or null

The port of the SNMP credential. Only required for mode "Send traps" and "Poll Data". If in mode "Send traps" the port is the port of the trap receiver. If in mode "Poll Data" the port is the port of the device to poll.

name
string

The name of the SNMP credential

send_cold_start_trap
boolean

Describes if the device sends a cold start trap to the configured trap receiver.

send_warm_start_trap
boolean

Describes if the device sends a warm start trap to the configured trap receiver.

send_login_trap
boolean

Describes if the device sends a login trap to the configured trap receiver.

send_alarm_trap
boolean

Describes if the device sends an alarm trap to the configured trap receiver.

send_structured_alarm_trap
boolean

Describes if the device sends a structured alarm trap to the configured trap receiver.

send_alarm_state_change_trap
boolean

Describes if the device sends an alarm state change trap to the configured trap receiver.

send_access_trap
boolean

Describes if the device sends an access trap to the configured trap receiver.

send_structured_access_trap
boolean

Describes if the device sends a structured access trap to the configured trap receiver.

username
string or null

The username of the SNMP credential. Only required for SNMPv3.

community
string or null

The community of the SNMP credential. Only required for SNMPv2.

authentication_protocol
integer or null
Enum: 1 2 3

The authentication protocol of the SNMP credential. Only required for SNMPv3. 1 = No authentication, 2 = HMAC-MD5, 3 = HMAC-SHA

authentication_password
string or null

The authentication password of the SNMP credential. Only required for SNMPv3.

privacy_protocol
integer or null
Enum: 1 2 3 4 9 20 21 22 23 24

The privacy protocol of the SNMP credential. Only required for SNMPv3. 1 = No privacy protocol, 2 = DES, 3 = 3DES, 4 = AES128, 9 = IDEA, 20 = AES192, 21 = AES256, 22 = AES128 3DES, 23 = AES192 3DES, 24 = AES256 3DES

privacy_password
string or null

The privacy password of the SNMP credential. Only required for SNMPv3.

heartbeat_interval
integer or null

The heartbeat interval of the SNMP credential. Only required for mode "Poll Data".

Request samples

Content type
application/json
{
  • "id": 5,
  • "is_active": true,
  • "version": 2,
  • "mode": 1,
  • "address": "192.168.100.222",
  • "port": 161,
  • "name": "My SNMP data provider",
  • "send_cold_start_trap": false,
  • "send_warm_start_trap": false,
  • "send_login_trap": false,
  • "send_alarm_trap": false,
  • "send_structured_alarm_trap": false,
  • "send_alarm_state_change_trap": false,
  • "send_access_trap": false,
  • "send_structured_access_trap": false,
  • "username": "myuser",
  • "community": "public",
  • "authentication_protocol": 1,
  • "authentication_password": null,
  • "privacy_protocol": 1,
  • "privacy_password": null,
  • "heartbeat_interval": 60
}

Response samples

Content type
application/json
{
  • "id": 5,
  • "is_active": true,
  • "version": 2,
  • "mode": 1,
  • "address": "192.168.100.222",
  • "port": 161,
  • "name": "My SNMP data provider",
  • "send_cold_start_trap": false,
  • "send_warm_start_trap": false,
  • "send_login_trap": false,
  • "send_alarm_trap": false,
  • "send_structured_alarm_trap": false,
  • "send_alarm_state_change_trap": false,
  • "send_access_trap": false,
  • "send_structured_access_trap": false,
  • "username": "myuser",
  • "community": "public",
  • "authentication_protocol": 1,
  • "authentication_password": null,
  • "privacy_protocol": 1,
  • "privacy_password": null,
  • "heartbeat_interval": 60
}

Delete SNMP credentials

Delete multiple SNMP credentials

Request Body schema: application/json

SNMP credential IDs to delete

Array
integer

Responses

Request samples

Content type
application/json
[
  • 0
]

SNMP credential names

SNMP Host Names

SNMP credential names

Get a shortened list of all SNMP credentials

Responses

Response Schema: application/json
Array
id
integer

The ID of the SNMP credential

created_at
string

The date and time when the SNMP credential was created

updated_at
string

The date and time when the SNMP credential was last updated

tenant_id
integer or null

The ID of the assigned tenant

mode
integer
Enum: 1 2 3

Operating mode of the credential. 1 = Provide data, 2 = Send traps, 3 = Poll data

version
integer
Enum: 2 3

SNMP version of the credential. 2 = SNMPv2, 3 = SNMPv3

is_active
boolean

Describes if the SNMP credential is active

name
string

The name of the SNMP credential

address
string or null

The IP address of the SNMP credential. Only required for mode "Send traps" and "Poll Data". If in mode "Send traps" the address is the address trap receiver. If in mode "Poll Data" the address is the address of the device to poll.

port
integer or null

The port of the SNMP credential. Only required for mode "Send traps" and "Poll Data". If in mode "Send traps" the port is the port of the trap receiver. If in mode "Poll Data" the port is the port of the device to poll.

send_cold_start_trap
boolean

Describes if the device sends a cold start trap to the configured trap receiver.

send_warm_start_trap
boolean

Describes if the device sends a warm start trap to the configured trap receiver.

send_login_trap
boolean

Describes if the device sends a login trap to the configured trap receiver.

send_alarm_trap
boolean

Describes if the device sends an alarm trap to the configured trap receiver.

send_structured_alarm_trap
boolean

Describes if the device sends a structured alarm trap to the configured trap receiver.

send_alarm_state_change_trap
boolean

Describes if the device sends an alarm state change trap to the configured trap receiver.

send_access_trap
boolean

Describes if the device sends an access trap to the configured trap receiver.

send_structured_access_trap
boolean

Describes if the device sends a structured access trap to the configured trap receiver.

community
string

The community name of the SNMP credential. Only required for SNMPv2.

username
string

The username of the SNMP credential. Only required for SNMPv3.

authentication_protocol
integer or null
Enum: 1 2 3

The authentication protocol of the SNMP credential. Only required for SNMPv3. 1 = No authentication, 2 = HMAC-MD5, 3 = HMAC-SHA

authentication_password
string or null

The authentication password of the SNMP credential. Only required for SNMPv3.

privacy_protocol
integer or null
Enum: 1 2 3 4 9 20 21 22 23 24

The privacy protocol of the SNMP credential. Only required for SNMPv3. 1 = No privacy protocol, 2 = DES, 3 = 3DES, 4 = AES128, 9 = IDEA, 20 = AES192, 21 = AES256, 22 = AES128 3DES, 23 = AES192 3DES, 24 = AES256 3DES

privacy_password
string or null

The privacy password of the SNMP credential. Only required for SNMPv3.

heartbeat_interval
integer or null
Enum: 0 60 180 300 600

The heartbeat interval in seconds. Only required for mode "Send Trap".

Response samples

Content type
application/json
[
  • {
    }
]

Test SNMP credential

SNMP Host Test

Test SNMP credential

Test SNMP credential settings

Request Body schema: application/json

Test SNMP credential settings

id
integer

The ID of the SNMP credential

is_active
boolean

Describes if the SNMP credential is active

version
integer
Enum: 2 3

SNMP version of the credential. 2 = SNMPv2, 3 = SNMPv3

name
string

The name of the SNMP credential

send_cold_start_trap
boolean

Describes if the device sends a cold start trap to the configured trap receiver.

send_warm_start_trap
boolean

Describes if the device sends a warm start trap to the configured trap receiver.

send_login_trap
boolean

Describes if the device sends a login trap to the configured trap receiver.

send_alarm_trap
boolean

Describes if the device sends an alarm trap to the configured trap receiver.

send_structured_alarm_trap
boolean

Describes if the device sends a structured alarm trap to the configured trap receiver.

send_alarm_state_change_trap
boolean

Describes if the device sends an alarm state change trap to the configured trap receiver.

send_access_trap
boolean

Describes if the device sends an access trap to the configured trap receiver.

send_structured_access_trap
boolean

Describes if the device sends a structured access trap to the configured trap receiver.

community
string

The community name of the SNMP credential. Only required for SNMPv2.

username
string

The username of the SNMP credential. Only required for SNMPv3.

mode
integer
Enum: 1 2 3

Operating mode of the credential. 1 = Provide data, 2 = Send traps, 3 = Poll data

address
string or null

The IP address of the SNMP credential. Only required for mode "Send traps" and "Poll Data". If in mode "Send traps" the address is the address trap receiver. If in mode "Poll Data" the address is the address of the device to poll.

port
integer or null

The port of the SNMP credential. Only required for mode "Send traps" and "Poll Data". If in mode "Send traps" the port is the port of the trap receiver. If in mode "Poll Data" the port is the port of the device to poll.

authentication_protocol
integer or null
Enum: 1 2 3

The authentication protocol of the SNMP credential. Only required for SNMPv3. 1 = No authentication, 2 = HMAC-MD5, 3 = HMAC-SHA

authentication_password
string or null

The authentication password of the SNMP credential. Only required for SNMPv3.

privacy_protocol
integer or null
Enum: 1 2 3 4 9 20 21 22 23 24

The privacy protocol of the SNMP credential. Only required for SNMPv3. 1 = No privacy protocol, 2 = DES, 3 = 3DES, 4 = AES128, 9 = IDEA, 20 = AES192, 21 = AES256, 22 = AES128 3DES, 23 = AES192 3DES, 24 = AES256 3DES

privacy_password
string or null

The privacy password of the SNMP credential. Only required for SNMPv3.

Responses

Request samples

Content type
application/json
{
  • "id": 5,
  • "is_active": true,
  • "version": 2,
  • "name": "My SNMP data provider",
  • "send_cold_start_trap": false,
  • "send_warm_start_trap": false,
  • "send_login_trap": false,
  • "send_alarm_trap": false,
  • "send_structured_alarm_trap": false,
  • "send_alarm_state_change_trap": false,
  • "send_access_trap": false,
  • "send_structured_access_trap": false,
  • "community": "public",
  • "username": "myuser",
  • "mode": 1,
  • "address": "192.168.100.100",
  • "port": 161,
  • "authentication_protocol": 1,
  • "authentication_password": null,
  • "privacy_protocol": 1,
  • "privacy_password": "myPrivPassword"
}

SNMP credential Details

Specific SNMP Host

SNMP credential

Get a specific SNMP credential by ID

path Parameters
host_id
required
integer

SNMP credential ID

Responses

Response Schema: application/json
id
integer

The ID of the SNMP credential

is_active
boolean

Describes if the SNMP credential is active

version
integer
Enum: 2 3

SNMP version of the credential. 2 = SNMPv2, 3 = SNMPv3

mode
integer
Enum: 1 2 3

Operating mode of the credential. 1 = Provide data, 2 = Send traps, 3 = Poll data

address
string or null

The IP address of the SNMP credential. Only required for mode "Send traps" and "Poll Data". If in mode "Send traps" the address is the address trap receiver. If in mode "Poll Data" the address is the address of the device to poll.

port
integer or null

The port of the SNMP credential. Only required for mode "Send traps" and "Poll Data". If in mode "Send traps" the port is the port of the trap receiver. If in mode "Poll Data" the port is the port of the device to poll.

name
string

The name of the SNMP credential

send_cold_start_trap
boolean

Describes if the device sends a cold start trap to the configured trap receiver.

send_warm_start_trap
boolean

Describes if the device sends a warm start trap to the configured trap receiver.

send_login_trap
boolean

Describes if the device sends a login trap to the configured trap receiver.

send_alarm_trap
boolean

Describes if the device sends an alarm trap to the configured trap receiver.

send_structured_alarm_trap
boolean

Describes if the device sends a structured alarm trap to the configured trap receiver.

send_alarm_state_change_trap
boolean

Describes if the device sends an alarm state change trap to the configured trap receiver.

send_access_trap
boolean

Describes if the device sends an access trap to the configured trap receiver.

send_structured_access_trap
boolean

Describes if the device sends a structured access trap to the configured trap receiver.

username
string or null

The username of the SNMP credential. Only required for SNMPv3.

community
string or null

The community of the SNMP credential. Only required for SNMPv2.

authentication_protocol
integer or null
Enum: 1 2 3

The authentication protocol of the SNMP credential. Only required for SNMPv3. 1 = No authentication, 2 = HMAC-MD5, 3 = HMAC-SHA

authentication_password
string or null

The authentication password of the SNMP credential. Only required for SNMPv3.

privacy_protocol
integer or null
Enum: 1 2 3 4 9 20 21 22 23 24

The privacy protocol of the SNMP credential. Only required for SNMPv3. 1 = No privacy protocol, 2 = DES, 3 = 3DES, 4 = AES128, 9 = IDEA, 20 = AES192, 21 = AES256, 22 = AES128 3DES, 23 = AES192 3DES, 24 = AES256 3DES

privacy_password
string or null

The privacy password of the SNMP credential. Only required for SNMPv3.

heartbeat_interval
integer or null

The heartbeat interval of the SNMP credential. Only required for mode "Poll Data".

Response samples

Content type
application/json
{
  • "id": 5,
  • "is_active": true,
  • "version": 2,
  • "mode": 1,
  • "address": "192.168.100.222",
  • "port": 161,
  • "name": "My SNMP data provider",
  • "send_cold_start_trap": false,
  • "send_warm_start_trap": false,
  • "send_login_trap": false,
  • "send_alarm_trap": false,
  • "send_structured_alarm_trap": false,
  • "send_alarm_state_change_trap": false,
  • "send_access_trap": false,
  • "send_structured_access_trap": false,
  • "username": "myuser",
  • "community": "public",
  • "authentication_protocol": 1,
  • "authentication_password": null,
  • "privacy_protocol": 1,
  • "privacy_password": null,
  • "heartbeat_interval": 60
}

Update SNMP credential

Update a specific SNMP credential by ID

path Parameters
host_id
required
integer

SNMP credential ID

Request Body schema: application/json

SNMP credential

id
integer

The ID of the SNMP credential

is_active
boolean

Describes if the SNMP credential is active

version
integer
Enum: 2 3

SNMP version of the credential. 2 = SNMPv2, 3 = SNMPv3

mode
integer
Enum: 1 2 3

Operating mode of the credential. 1 = Provide data, 2 = Send traps, 3 = Poll data

address
string or null

The IP address of the SNMP credential. Only required for mode "Send traps" and "Poll Data". If in mode "Send traps" the address is the address trap receiver. If in mode "Poll Data" the address is the address of the device to poll.

port
integer or null

The port of the SNMP credential. Only required for mode "Send traps" and "Poll Data". If in mode "Send traps" the port is the port of the trap receiver. If in mode "Poll Data" the port is the port of the device to poll.

name
string

The name of the SNMP credential

send_cold_start_trap
boolean

Describes if the device sends a cold start trap to the configured trap receiver.

send_warm_start_trap
boolean

Describes if the device sends a warm start trap to the configured trap receiver.

send_login_trap
boolean

Describes if the device sends a login trap to the configured trap receiver.

send_alarm_trap
boolean

Describes if the device sends an alarm trap to the configured trap receiver.

send_structured_alarm_trap
boolean

Describes if the device sends a structured alarm trap to the configured trap receiver.

send_alarm_state_change_trap
boolean

Describes if the device sends an alarm state change trap to the configured trap receiver.

send_access_trap
boolean

Describes if the device sends an access trap to the configured trap receiver.

send_structured_access_trap
boolean

Describes if the device sends a structured access trap to the configured trap receiver.

username
string or null

The username of the SNMP credential. Only required for SNMPv3.

community
string or null

The community of the SNMP credential. Only required for SNMPv2.

authentication_protocol
integer or null
Enum: 1 2 3

The authentication protocol of the SNMP credential. Only required for SNMPv3. 1 = No authentication, 2 = HMAC-MD5, 3 = HMAC-SHA

authentication_password
string or null

The authentication password of the SNMP credential. Only required for SNMPv3.

privacy_protocol
integer or null
Enum: 1 2 3 4 9 20 21 22 23 24

The privacy protocol of the SNMP credential. Only required for SNMPv3. 1 = No privacy protocol, 2 = DES, 3 = 3DES, 4 = AES128, 9 = IDEA, 20 = AES192, 21 = AES256, 22 = AES128 3DES, 23 = AES192 3DES, 24 = AES256 3DES

privacy_password
string or null

The privacy password of the SNMP credential. Only required for SNMPv3.

heartbeat_interval
integer or null

The heartbeat interval of the SNMP credential. Only required for mode "Poll Data".

Responses

Response Schema: application/json
id
integer

The ID of the SNMP credential

is_active
boolean

Describes if the SNMP credential is active

version
integer
Enum: 2 3

SNMP version of the credential. 2 = SNMPv2, 3 = SNMPv3

mode
integer
Enum: 1 2 3

Operating mode of the credential. 1 = Provide data, 2 = Send traps, 3 = Poll data

address
string or null

The IP address of the SNMP credential. Only required for mode "Send traps" and "Poll Data". If in mode "Send traps" the address is the address trap receiver. If in mode "Poll Data" the address is the address of the device to poll.

port
integer or null

The port of the SNMP credential. Only required for mode "Send traps" and "Poll Data". If in mode "Send traps" the port is the port of the trap receiver. If in mode "Poll Data" the port is the port of the device to poll.

name
string

The name of the SNMP credential

send_cold_start_trap
boolean

Describes if the device sends a cold start trap to the configured trap receiver.

send_warm_start_trap
boolean

Describes if the device sends a warm start trap to the configured trap receiver.

send_login_trap
boolean

Describes if the device sends a login trap to the configured trap receiver.

send_alarm_trap
boolean

Describes if the device sends an alarm trap to the configured trap receiver.

send_structured_alarm_trap
boolean

Describes if the device sends a structured alarm trap to the configured trap receiver.

send_alarm_state_change_trap
boolean

Describes if the device sends an alarm state change trap to the configured trap receiver.

send_access_trap
boolean

Describes if the device sends an access trap to the configured trap receiver.

send_structured_access_trap
boolean

Describes if the device sends a structured access trap to the configured trap receiver.

username
string or null

The username of the SNMP credential. Only required for SNMPv3.

community
string or null

The community of the SNMP credential. Only required for SNMPv2.

authentication_protocol
integer or null
Enum: 1 2 3

The authentication protocol of the SNMP credential. Only required for SNMPv3. 1 = No authentication, 2 = HMAC-MD5, 3 = HMAC-SHA

authentication_password
string or null

The authentication password of the SNMP credential. Only required for SNMPv3.

privacy_protocol
integer or null
Enum: 1 2 3 4 9 20 21 22 23 24

The privacy protocol of the SNMP credential. Only required for SNMPv3. 1 = No privacy protocol, 2 = DES, 3 = 3DES, 4 = AES128, 9 = IDEA, 20 = AES192, 21 = AES256, 22 = AES128 3DES, 23 = AES192 3DES, 24 = AES256 3DES

privacy_password
string or null

The privacy password of the SNMP credential. Only required for SNMPv3.

heartbeat_interval
integer or null

The heartbeat interval of the SNMP credential. Only required for mode "Poll Data".

Request samples

Content type
application/json
{
  • "id": 5,
  • "is_active": true,
  • "version": 2,
  • "mode": 1,
  • "address": "192.168.100.222",
  • "port": 161,
  • "name": "My SNMP data provider",
  • "send_cold_start_trap": false,
  • "send_warm_start_trap": false,
  • "send_login_trap": false,
  • "send_alarm_trap": false,
  • "send_structured_alarm_trap": false,
  • "send_alarm_state_change_trap": false,
  • "send_access_trap": false,
  • "send_structured_access_trap": false,
  • "username": "myuser",
  • "community": "public",
  • "authentication_protocol": 1,
  • "authentication_password": null,
  • "privacy_protocol": 1,
  • "privacy_password": null,
  • "heartbeat_interval": 60
}

Response samples

Content type
application/json
{
  • "id": 5,
  • "is_active": true,
  • "version": 2,
  • "mode": 1,
  • "address": "192.168.100.222",
  • "port": 161,
  • "name": "My SNMP data provider",
  • "send_cold_start_trap": false,
  • "send_warm_start_trap": false,
  • "send_login_trap": false,
  • "send_alarm_trap": false,
  • "send_structured_alarm_trap": false,
  • "send_alarm_state_change_trap": false,
  • "send_access_trap": false,
  • "send_structured_access_trap": false,
  • "username": "myuser",
  • "community": "public",
  • "authentication_protocol": 1,
  • "authentication_password": null,
  • "privacy_protocol": 1,
  • "privacy_password": null,
  • "heartbeat_interval": 60
}

Delete SNMP credential

Delete a specific SNMP credential by ID

path Parameters
host_id
required
integer

SNMP credential ID

Responses

Disable SNMP credentials

Disable multiple SNMP Hosts

Disable SNMP credentials

Disable multiple SNMP credentials

Request Body schema: application/json

SNMP credential IDs to disable

Array
integer

SNMP credential ID

Responses

Request samples

Content type
application/json
[
  • 0
]

Enable SNMP credentials

Enable multiple SNMP Hosts

Enable SNMP credentials

Enable multiple SNMP credentials

Request Body schema: application/json

SNMP credential IDs to enable

Array
integer

SNMP credential ID

Responses

Request samples

Content type
application/json
[
  • 0
]

System-Events

System-Event List

Get System-Events

Get a list of System-Events.

Authorizations:
bearer

Responses

Response Schema: application/json
Array of objects
object
object

Response samples

Content type
application/json
{}

System-Event Export

System-Event Export

Export System-Events

Export all System-Events.

Authorizations:
bearer

Responses

Response Schema: text/csv
string <binary>

System name

System name

Get system name

Gets the system name.

Responses

Response Schema: application/json
Array
name
string

The name of the system.

Response samples

Content type
application/json
[
  • {
    }
]

Update system name

Updates the system name.

Request Body schema: application/json
name
string

The name of the system.

Responses

Response Schema: application/json
name
string

The name of the system.

Request samples

Content type
application/json
{
  • "name": "My AlarmManager"
}

Response samples

Content type
application/json
{
  • "name": "My AlarmManager"
}

Systemanalysis

Systemanalysis

Get Status

Get the status of the Systemanalysis.

Authorizations:
bearer

Responses

Response Schema: application/json
state
integer
Enum: -1 0 1 2 3 4 5

The status of the systemanalysis. -1 => Error, 0 => OK, 1 => Already started/ stopped, 2 => Finished, 3 => System-information is being gathered, 4 => Processes are being logged, 5 => Systemanalysis is being completed.

message
String

The corresponding message to the state.

Response samples

Content type
application/json
{
  • "state": 0,
  • "message": "OK"
}

Toggle analysis

Start/ stop the systemanalysis.

Authorizations:
bearer
Request Body schema: application/json

Successful operation

action
string
Enum: "start" "stop"

Action to start/ stop the systemanalysis

timeout
integer

The length of the operation in minutes

pack_settings
boolean

Determine if the settings database shall be analyzed as well

Responses

Response Schema: application/json
state
integer
Enum: -1 0 1 2 3 4 5

The status of the systemanalysis. -1 => Error, 0 => OK, 1 => Already started/ stopped, 2 => Finished, 3 => System-information is being gathered, 4 => Processes are being logged, 5 => Systemanalysis is being completed.

message
String

The corresponding message to the state.

Request samples

Content type
application/json
{
  • "action": "start",
  • "timeout": 5,
  • "pack_settings": true
}

Response samples

Content type
application/json
{
  • "state": 0,
  • "message": "OK"
}

Systemanalysis Report

Systemanalysis Report

Get Report

Get the report of the Systemanalysis.

Authorizations:
bearer

Responses

Response Schema: text/ksr
string <binary>

Table View List

Table View List

Get the table views

Get Table Views.

Authorizations:
bearer

Responses

Response Schema: application/json
Array
id
integer

The ID of the table view

user_id
integer

The ID of the creating user

name
string

The name of the table view

Array of objects
is_global
boolean

If true the table view will be shown to all users

is_default
boolean

If true the table view will be set as default

Response samples

Content type
application/json
[
  • {
    }
]

Add a new table view

Add table view.

Authorizations:
bearer
Request Body schema: application/json

Successful operation

name
string

The name of the table view

Array of objects
is_global
boolean

If true the table view will be shown to all users

is_default
boolean

If true the table view will be set as default

Responses

Response Schema: application/json
Array
id
integer

The ID of the table view

user_id
integer

The ID of the creating user

name
string

The name of the table view

Array of objects
is_global
boolean

If true the table view will be shown to all users

is_default
boolean

If true the table view will be set as default

Request samples

Content type
application/json
{
  • "name": "DoorLocks",
  • "tables": [
    ],
  • "is_global": true,
  • "is_default": true
}

Response samples

Content type
application/json
[
  • {
    }
]

Table View

Table View Details

Get the details of given table view

Get Table View Details.

Authorizations:
bearer
path Parameters
tableview
required
string

Table View ID

Responses

Response Schema: application/json
id
integer

The ID of the table view

user_id
integer

The ID of the creating user

name
string

The name of the table view

Array of objects
is_global
boolean

If true the table view will be shown to all users

is_default
boolean

If true the table view will be set as default

Response samples

Content type
application/json
{
  • "id": 1,
  • "user_id": 1,
  • "name": "DoorLocks",
  • "tables": [
    ],
  • "is_global": true,
  • "is_default": true
}

Update a new table view

Update table view.

Authorizations:
bearer
path Parameters
tableview
required
string

Table View ID

Request Body schema: application/json

Successful operation

name
string

The name of the table view

Array of objects
is_global
boolean

If true the table view will be shown to all users

is_default
boolean

If true the table view will be set as default

Responses

Response Schema: application/json
Array
id
integer

The ID of the table view

user_id
integer

The ID of the creating user

name
string

The name of the table view

Array of objects
is_global
boolean

If true the table view will be shown to all users

is_default
boolean

If true the table view will be set as default

Request samples

Content type
application/json
{
  • "name": "DoorLocks",
  • "tables": [
    ],
  • "is_global": true,
  • "is_default": true
}

Response samples

Content type
application/json
[
  • {
    }
]

Delete table view

Delete table view.

Authorizations:
bearer
path Parameters
tableview
required
string

Table View ID

Responses

Response samples

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

Eventprofile List

Eventprofiles

Get Eventprofiles

Get a list of Eventprofiles.

Authorizations:
bearer

Responses

Response Schema: application/json
Array
Array of objects

The list of eventprofiles

object
object

Response samples

Content type
application/json
[]

Add Eventprofile

Add new Eventprofile.

Authorizations:
bearer
Request Body schema: application/json

Eventprofile Data

blockingprofiles
Array of integers

The related blockingprofiles

groups
Array of integers

The groups this eventprofile applies to

id
integer

The ID of the eventprofile (if not given, a new eventprofile with the given data will be added)

name
string

The name of the eventprofile

outputs
Array of integers

The outputs this eventprofile applies to

type
string
Enum: "group" "output"

The type of the eventprofile

Array of objects

The Events related to this eventprofile

Responses

Response Schema: application/json
Array
blockingprofiles
Array of integers

The related blockingprofiles

groups
Array of integers

The groups this eventprofile applies to

id
integer

The ID of the eventprofile (if not given, a new eventprofile with the given data will be added)

name
string

The name of the eventprofile

outputs
Array of integers

The outputs this eventprofile applies to

type
string
Enum: "group" "output"

The type of the eventprofile

Array of objects

The Events related to this eventprofile

Request samples

Content type
application/json
{
  • "blockingprofiles": [
    ],
  • "groups": [
    ],
  • "id": 1,
  • "name": "Example",
  • "outputs": [ ],
  • "type": "group",
  • "eventtimes": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

Mass-delete Eventprofiles

Delete all given Eventprofiles.

Authorizations:
bearer
Request Body schema: application/json

Mass-Delete eventprofiles

events
Array of integers

The ids of the eventprofiles to be deleted

Responses

Request samples

Content type
application/json
{
  • "events": [
    ]
}

Eventprofile Details

Eventprofile configuration

Get Details

Get the configuration of given Eventprofile.

Authorizations:
bearer
path Parameters
event
required
string

Eventprofile ID

Responses

Response Schema: application/json
Array
blockingprofiles
Array of integers

The related blockingprofiles

groups
Array of integers

The groups this eventprofile applies to

id
integer

The ID of the eventprofile (if not given, a new eventprofile with the given data will be added)

name
string

The name of the eventprofile

outputs
Array of integers

The outputs this eventprofile applies to

type
string
Enum: "group" "output"

The type of the eventprofile

Array of objects

The Events related to this eventprofile

Response samples

Content type
application/json
[
  • {
    }
]

Update configuration

Update the configuration of given MultiSensor.

Authorizations:
bearer
path Parameters
event
required
string

Eventprofile ID

Request Body schema: application/json

Eventprofile Data

blockingprofiles
Array of integers

The related blockingprofiles

groups
Array of integers

The groups this eventprofile applies to

id
integer

The ID of the eventprofile (if not given, a new eventprofile with the given data will be added)

name
string

The name of the eventprofile

outputs
Array of integers

The outputs this eventprofile applies to

type
string
Enum: "group" "output"

The type of the eventprofile

Array of objects

The Events related to this eventprofile

Responses

Response Schema: application/json
Array
blockingprofiles
Array of integers

The related blockingprofiles

groups
Array of integers

The groups this eventprofile applies to

id
integer

The ID of the eventprofile (if not given, a new eventprofile with the given data will be added)

name
string

The name of the eventprofile

outputs
Array of integers

The outputs this eventprofile applies to

type
string
Enum: "group" "output"

The type of the eventprofile

Array of objects

The Events related to this eventprofile

Request samples

Content type
application/json
{
  • "blockingprofiles": [
    ],
  • "groups": [
    ],
  • "id": 1,
  • "name": "Example",
  • "outputs": [ ],
  • "type": "group",
  • "eventtimes": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

Delete Eventprofile

Delete given Eventprofile.

Authorizations:
bearer
path Parameters
event
required
string

Eventprofile ID

Responses

Timeprofile List

Get timeprofiles

Get all timeprofiles

Requests all timeprofiles which the user has access to.

Authorizations:
bearer

Responses

Response Schema: application/json
Array
id
required
integer

Id of the timeprofile

name
required
string

Name of the timeprofile

tenant_id
integer or null

Id of the assigned tenant

Response samples

Content type
application/json
[
  • {
    }
]

Create timeprofile

Creates a new timeprofile.

Authorizations:
bearer
Request Body schema: application/json

Timeprofile configuration to be added

id
integer

Id of timeprofile name

created_at
string

ISO 8601 Timestamp when the timeprofile was created

updated_at
string

ISO 8601 Timestamp when the timeprofile was updated

name
string

Name of the timeprofile

flagstring
string

ISO 8601 Timestamp when the timeprofile was updated

tenant_id
integer or null

Id of the tenant

Responses

Response Schema: application/json
Array
id
integer

Id of timeprofile name

created_at
string

ISO 8601 Timestamp when the timeprofile was created

updated_at
string

ISO 8601 Timestamp when the timeprofile was updated

name
string

Name of the timeprofile

flagstring
string

ISO 8601 Timestamp when the timeprofile was updated

tenant_id
integer or null

Id of the tenant

Request samples

Content type
application/json
{
  • "id": 1,
  • "created_at": "2022-03-31T09:28:25+02:00",
  • "updated_at": "2022-03-31T16:09:08+02:00",
  • "name": "Timeprofile",
  • "flagstring": "0000000FFFFFFFFFFFF000000000000FFFFFFFFFFFF000000000000FFFFFFFFFFFF000000000000FFFFFFFFFFFF000000000000FFFFFFFFFFFF00000000000000000000000000000000000000000000000000000",
  • "tenant_id": 0
}

Response samples

Content type
application/json
[
  • {
    }
]

Timeprofile Details

Get a specific timeprofile by a Id

Get timeprofile by ID

Requests the timeprofile via its ID.

Authorizations:
bearer
path Parameters
timeprofile_id
required
string

ID of the timeprofile to be queried

Responses

Response Schema: application/json
Array
id
integer

Id of timeprofile name

created_at
string

ISO 8601 Timestamp when the timeprofile was created

updated_at
string

ISO 8601 Timestamp when the timeprofile was updated

name
string

Name of the timeprofile

flagstring
string

ISO 8601 Timestamp when the timeprofile was updated

tenant_id
integer or null

Id of the tenant

Response samples

Content type
application/json
[
  • {
    }
]

Update timeprofile by ID

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

Authorizations:
bearer
path Parameters
timeprofile_id
required
string

ID of the timeprofile to be queried

Request Body schema: application/json

Timeprofile configuration to be updated

id
integer

Id of timeprofile name

created_at
string

ISO 8601 Timestamp when the timeprofile was created

updated_at
string

ISO 8601 Timestamp when the timeprofile was updated

name
string

Name of the timeprofile

flagstring
string

ISO 8601 Timestamp when the timeprofile was updated

tenant_id
integer or null

Id of the tenant

Responses

Response Schema: application/json
Array
id
integer

Id of timeprofile name

created_at
string

ISO 8601 Timestamp when the timeprofile was created

updated_at
string

ISO 8601 Timestamp when the timeprofile was updated

name
string

Name of the timeprofile

flagstring
string

ISO 8601 Timestamp when the timeprofile was updated

tenant_id
integer or null

Id of the tenant

Request samples

Content type
application/json
{
  • "id": 1,
  • "created_at": "2022-03-31T09:28:25+02:00",
  • "updated_at": "2022-03-31T16:09:08+02:00",
  • "name": "Timeprofile",
  • "flagstring": "0000000FFFFFFFFFFFF000000000000FFFFFFFFFFFF000000000000FFFFFFFFFFFF000000000000FFFFFFFFFFFF000000000000FFFFFFFFFFFF00000000000000000000000000000000000000000000000000000",
  • "tenant_id": 0
}

Response samples

Content type
application/json
[
  • {
    }
]

Timeprofile Names

Get timeprofiles

Timeprofiles names

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

Authorizations:
bearer

Responses

Response Schema: application/json
Array
id
integer

Id of timeprofile name

name
string

Name of the timeprofile

Response samples

Content type
application/json
[
  • {
    }
]

Software Update

Software Update

Get update status

Gets the update status.

Responses

Response Schema: application/json
message
string

Detailed response

object

Response samples

Content type
application/json
{
  • "message": "Update finished",
  • "status": {
    }
}

Perform Update

Starts the update process with the given file.

Request Body schema: application/json

The update file to upload.

string <binary>

Responses

Request samples

Content type
application/json
"string"

OTA-Update

OTA-Update

Get update status

Gets the update status.

Responses

Response Schema: application/json
date
string

The date of the latest updates release

device_type
integer

The Board type of the device

os_revision
integer

The OS-Revision

releasenotes
String <HTML>

The Release notes of all updates (not installed)

version
string

The name of the latest version of KentixONE

Response samples

Content type
application/json
{
  • "date": "2023-02-20",
  • "device_type": 8,
  • "os_revision": 2,
  • "releasenotes": "<ul>\n<li>Test</li></ul>",
  • "version": "08.01.03 B00950"
}

Perform OTA-Update

Starts the update process.

Responses

Usergroup Names

Get Usergroup names

Requests all Usergroups.

Authorizations:
bearer

Responses

Response Schema: application/json
Array
id
integer

Id of the Usergroup.

name
string

Name of the Usergroup.

Response samples

Content type
application/json
[
  • {
    }
]

Usergroups

Get Usergroups

Get all Usergroups.

Authorizations:
bearer

Responses

Response Schema: application/json
Array
Array of objects

The list of Usergroups

object
object

Response samples

Content type
application/json
[]

Add Usergroup

Add a new Usergroup.

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

Describes the name of the Usergroup. Must be unique.

Array of objects

Describes the permissions the Usergroup have.

Responses

Response Schema: application/json
id
integer

Describes the ID of the Usergroup.

name
string

Describes the name of the Usergroup. Must be unique.

created_at
string <ISO 8601>

Describes the create date of the Usergroup.

updated_at
string <ISO 8601>

Describes the update date of the Usergroup.

Array of objects

Describes the permissions the Usergroup have.

Request samples

Content type
application/json
{
  • "name": "Manager",
  • "permissions": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 1,
  • "name": "Manager",
  • "created_at": "2023-01-05T16:24:46.000000Z",
  • "updated_at": "2023-01-07T16:30:28.000000Z",
  • "permissions": [
    ]
}

Delete Usergroups

Mass delete Usergroups.

Authorizations:
bearer
Request Body schema: application/json
usergroups
Array of integers

Responses

Request samples

Content type
application/json
{
  • "usergroups": [
    ]
}

Response samples

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

Usergroup

Get Usergroup

Get a specific Usergroup via its ID.

Authorizations:
bearer
path Parameters
usergroup_id
required
string

ID of the Usergroup to be queried

Responses

Response Schema: application/json
Array
id
integer

Describes the ID of the Usergroup.

name
string

Describes the name of the Usergroup. Must be unique.

created_at
string <ISO 8601>

Describes the create date of the Usergroup.

updated_at
string <ISO 8601>

Describes the update date of the Usergroup.

Array of objects

Describes the permissions the Usergroup have.

Response samples

Content type
application/json
[
  • {
    }
]

Update Usergroup

Update a specific Usergroup via its ID.

Authorizations:
bearer
path Parameters
usergroup_id
required
string

ID of the Usergroup to be queried

Request Body schema: application/json
name
string

Describes the name of the Usergroup. Must be unique.

Array of objects

Describes the permissions the Usergroup have.

Responses

Response Schema: application/json
id
integer

Describes the ID of the Usergroup.

name
string

Describes the name of the Usergroup. Must be unique.

created_at
string <ISO 8601>

Describes the create date of the Usergroup.

updated_at
string <ISO 8601>

Describes the update date of the Usergroup.

Array of objects

Describes the permissions the Usergroup have.

Request samples

Content type
application/json
{
  • "name": "Manager",
  • "permissions": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 1,
  • "name": "Manager",
  • "created_at": "2023-01-05T16:24:46.000000Z",
  • "updated_at": "2023-01-07T16:30:28.000000Z",
  • "permissions": [
    ]
}

Delete Usergroup

Delete a specific Usergroup via its ID.

Authorizations:
bearer
path Parameters
usergroup_id
required
string

ID of the Usergroup to be queried

Responses

Response samples

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

User List

User management

Get all users

Get a shortened list of all users

Responses

Response Schema: application/json
Array of objects
object
object

Response samples

Content type
application/json
{}

Create user

Create a new user

Request Body schema: application/json
id
integer

The current user's id

username
string

Distinct username of this user

password
string

The current user's password

password_confirmation
string

Password confirmation field

is_active
boolean

Describes if the current userprofile is active

unlock_at
string or null

Date when the user will be automatically nlocked

lock_at
string or null

Date when the user will be automatically locked

fullname
string

Full name of the user

email
string or null

Email address of the user

phone
string or null

Cellphone number of the user

description
string or null

Optional description text

is_admin
boolean

Describes if the user is an administrator

object
rfid_uid
string

RFID UID of the use. If set, the user can be identified by RFID. The RFID UID is a 32 character hex string. The RFID UID can be set to null to disable RFID authentication.

Array of objects

List of levelprofiles that are assigned to the user. The user will have the permissions of the levelprofiles.

pin
string

PIN code of the user. If set, the user can be identified by PIN. The PIN code can be set to null to disable PIN authentication.

emergency_access
boolean

Describes if the user has emergency access, if the assigned doorlocks are offline.

armdisarm_mode
integer [ 0 .. 2 ]

Describes if the user may arm/disarm an alarmsystem. 0: User can not arm/disarm an alarmsystem. 1: User only can disarm an alarmsystem. 2: User can arm and disarm an alarmsystem.

alarmgroups
Array of integers

List of alarmgroups that are assigned to the user. The user will receive alarms from the alarmgroups and can see all devices within the alarmgroups.

usergroup_id
integer

ID of the usergroup that is assigned to the user.

uses_cloud
boolean

Describes if the user has access to the KentixONE cloud. If true, the user can login to the KentixONE cloud via the app.

invoicegroups
Array of integers

List of invoicegroups that are assigned to the user. The user will receive invoice reports from the invoicegroups.

rfid_data
any

RFID data of the user.

Responses

Response Schema: application/json
id
integer

The current user's id

username
string

Distinct username of this user

is_active
boolean

Describes if the current userprofile is active

unlock_at
string or null

Date when the user will be automatically nlocked

lock_at
string or null

Date when the user will be automatically locked

fullname
string

Full name of the user

email
string or null

Email address of the user

phone
string or null

Cellphone number of the user

description
string or null

Optional description text

is_admin
boolean

Describes if the user is an administrator

api_token
string

API token of the user that can be used to authenticate against the API (Bearer Token)

object
rfid_uid
string

RFID UID of the use. If set, the user can be identified by RFID. The RFID UID is a 32 character hex string. The RFID UID can be set to null to disable RFID authentication.

Array of objects

List of levelprofiles that are assigned to the user. The user will have the permissions of the levelprofiles.

pin
string

PIN code of the user. If set, the user can be identified by PIN. The PIN code can be set to null to disable PIN authentication.

emergency_access
boolean

Describes if the user has emergency access, if the assigned doorlocks are offline.

armdisarm_mode
integer [ 0 .. 2 ]

Describes if the user may arm/disarm an alarmsystem. 0: User can not arm/disarm an alarmsystem. 1: User only can disarm an alarmsystem. 2: User can arm and disarm an alarmsystem.

alarmgroups
Array of integers

List of alarmgroups that are assigned to the user. The user will receive alarms from the alarmgroups and can see all devices within the alarmgroups.

usergroup_id
integer

ID of the usergroup that is assigned to the user.

uses_cloud
boolean

Describes if the user has access to the KentixONE cloud. If true, the user can login to the KentixONE cloud via the app.

invoicegroups
Array of integers

List of invoicegroups that are assigned to the user. The user will receive invoice reports from the invoicegroups.

rfid_data
any

RFID data of the user.

Request samples

Content type
application/json
{
  • "id": 1,
  • "username": "admin",
  • "password": "string",
  • "password_confirmation": "string",
  • "is_active": true,
  • "unlock_at": "2022-03-31T07:29:20.000000Z",
  • "lock_at": "2022-04-30T07:30:00.000000Z",
  • "fullname": "Administrator",
  • "email": "a.dministrator@example.com",
  • "phone": "+49123456789",
  • "description": "A very cool admin",
  • "is_admin": false,
  • "notification_channels": {
    },
  • "rfid_uid": 0,
  • "levelprofiles": [
    ],
  • "pin": 1234,
  • "emergency_access": true,
  • "armdisarm_mode": 0,
  • "alarmgroups": [
    ],
  • "usergroup_id": 1,
  • "uses_cloud": false,
  • "invoicegroups": [ ],
  • "rfid_data": null
}

Response samples

Content type
application/json
{
  • "id": 1,
  • "username": "admin",
  • "is_active": true,
  • "unlock_at": "2022-03-31T07:29:20.000000Z",
  • "lock_at": "2022-04-30T07:30:00.000000Z",
  • "fullname": "Administrator",
  • "email": "a.dministrator@example.com",
  • "phone": "+49123456789",
  • "description": "A very cool admin",
  • "is_admin": false,
  • "api_token": "1234567890ABCDEFGHIJKLMNOPQRSTUVWXYZ",
  • "notification_channels": {
    },
  • "rfid_uid": 0,
  • "levelprofiles": [
    ],
  • "pin": 1234,
  • "emergency_access": true,
  • "armdisarm_mode": 0,
  • "alarmgroups": [
    ],
  • "usergroup_id": 1,
  • "uses_cloud": false,
  • "invoicegroups": [ ],
  • "rfid_data": null
}

Mass-Delete users

Delete multiple users

Request Body schema: application/json
Array
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

User Details

User management

Get user

Get a specific user by ID

path Parameters
user_id
required
string

User ID

Responses

Response Schema: application/json
id
integer

The current user's id

username
string

Distinct username of this user

is_active
boolean

Describes if the current userprofile is active

unlock_at
string or null

Date when the user will be automatically nlocked

lock_at
string or null

Date when the user will be automatically locked

fullname
string

Full name of the user

email
string or null

Email address of the user

phone
string or null

Cellphone number of the user

description
string or null

Optional description text

is_admin
boolean

Describes if the user is an administrator

api_token
string

API token of the user that can be used to authenticate against the API (Bearer Token)

object
rfid_uid
string

RFID UID of the use. If set, the user can be identified by RFID. The RFID UID is a 32 character hex string. The RFID UID can be set to null to disable RFID authentication.

Array of objects

List of levelprofiles that are assigned to the user. The user will have the permissions of the levelprofiles.

pin
string

PIN code of the user. If set, the user can be identified by PIN. The PIN code can be set to null to disable PIN authentication.

emergency_access
boolean

Describes if the user has emergency access, if the assigned doorlocks are offline.

armdisarm_mode
integer [ 0 .. 2 ]

Describes if the user may arm/disarm an alarmsystem. 0: User can not arm/disarm an alarmsystem. 1: User only can disarm an alarmsystem. 2: User can arm and disarm an alarmsystem.

alarmgroups
Array of integers

List of alarmgroups that are assigned to the user. The user will receive alarms from the alarmgroups and can see all devices within the alarmgroups.

usergroup_id
integer

ID of the usergroup that is assigned to the user.

uses_cloud
boolean

Describes if the user has access to the KentixONE cloud. If true, the user can login to the KentixONE cloud via the app.

invoicegroups
Array of integers

List of invoicegroups that are assigned to the user. The user will receive invoice reports from the invoicegroups.

rfid_data
any

RFID data of the user.

Response samples

Content type
application/json
{
  • "id": 1,
  • "username": "admin",
  • "is_active": true,
  • "unlock_at": "2022-03-31T07:29:20.000000Z",
  • "lock_at": "2022-04-30T07:30:00.000000Z",
  • "fullname": "Administrator",
  • "email": "a.dministrator@example.com",
  • "phone": "+49123456789",
  • "description": "A very cool admin",
  • "is_admin": false,
  • "api_token": "1234567890ABCDEFGHIJKLMNOPQRSTUVWXYZ",
  • "notification_channels": {
    },
  • "rfid_uid": 0,
  • "levelprofiles": [
    ],
  • "pin": 1234,
  • "emergency_access": true,
  • "armdisarm_mode": 0,
  • "alarmgroups": [
    ],
  • "usergroup_id": 1,
  • "uses_cloud": false,
  • "invoicegroups": [ ],
  • "rfid_data": null
}

Update user

Update a user

path Parameters
user_id
required
string

User ID

Request Body schema: application/json
id
integer

The current user's id

username
string

Distinct username of this user

password
string

The current user's password

password_confirmation
string

Password confirmation field

is_active
boolean

Describes if the current userprofile is active

unlock_at
string or null

Date when the user will be automatically nlocked

lock_at
string or null

Date when the user will be automatically locked

fullname
string

Full name of the user

email
string or null

Email address of the user

phone
string or null

Cellphone number of the user

description
string or null

Optional description text

is_admin
boolean

Describes if the user is an administrator

object
rfid_uid
string

RFID UID of the use. If set, the user can be identified by RFID. The RFID UID is a 32 character hex string. The RFID UID can be set to null to disable RFID authentication.

Array of objects

List of levelprofiles that are assigned to the user. The user will have the permissions of the levelprofiles.

pin
string

PIN code of the user. If set, the user can be identified by PIN. The PIN code can be set to null to disable PIN authentication.

emergency_access
boolean

Describes if the user has emergency access, if the assigned doorlocks are offline.

armdisarm_mode
integer [ 0 .. 2 ]

Describes if the user may arm/disarm an alarmsystem. 0: User can not arm/disarm an alarmsystem. 1: User only can disarm an alarmsystem. 2: User can arm and disarm an alarmsystem.

alarmgroups
Array of integers

List of alarmgroups that are assigned to the user. The user will receive alarms from the alarmgroups and can see all devices within the alarmgroups.

usergroup_id
integer

ID of the usergroup that is assigned to the user.

uses_cloud
boolean

Describes if the user has access to the KentixONE cloud. If true, the user can login to the KentixONE cloud via the app.

invoicegroups
Array of integers

List of invoicegroups that are assigned to the user. The user will receive invoice reports from the invoicegroups.

rfid_data
any

RFID data of the user.

Responses

Response Schema: application/json
id
integer

The current user's id

username
string

Distinct username of this user

is_active
boolean

Describes if the current userprofile is active

unlock_at
string or null

Date when the user will be automatically nlocked

lock_at
string or null

Date when the user will be automatically locked

fullname
string

Full name of the user

email
string or null

Email address of the user

phone
string or null

Cellphone number of the user

description
string or null

Optional description text

is_admin
boolean

Describes if the user is an administrator

api_token
string

API token of the user that can be used to authenticate against the API (Bearer Token)

object
rfid_uid
string

RFID UID of the use. If set, the user can be identified by RFID. The RFID UID is a 32 character hex string. The RFID UID can be set to null to disable RFID authentication.

Array of objects

List of levelprofiles that are assigned to the user. The user will have the permissions of the levelprofiles.

pin
string

PIN code of the user. If set, the user can be identified by PIN. The PIN code can be set to null to disable PIN authentication.

emergency_access
boolean

Describes if the user has emergency access, if the assigned doorlocks are offline.

armdisarm_mode
integer [ 0 .. 2 ]

Describes if the user may arm/disarm an alarmsystem. 0: User can not arm/disarm an alarmsystem. 1: User only can disarm an alarmsystem. 2: User can arm and disarm an alarmsystem.

alarmgroups
Array of integers

List of alarmgroups that are assigned to the user. The user will receive alarms from the alarmgroups and can see all devices within the alarmgroups.

usergroup_id
integer

ID of the usergroup that is assigned to the user.

uses_cloud
boolean

Describes if the user has access to the KentixONE cloud. If true, the user can login to the KentixONE cloud via the app.

invoicegroups
Array of integers

List of invoicegroups that are assigned to the user. The user will receive invoice reports from the invoicegroups.

rfid_data
any

RFID data of the user.

Request samples

Content type
application/json
{
  • "id": 1,
  • "username": "admin",
  • "password": "string",
  • "password_confirmation": "string",
  • "is_active": true,
  • "unlock_at": "2022-03-31T07:29:20.000000Z",
  • "lock_at": "2022-04-30T07:30:00.000000Z",
  • "fullname": "Administrator",
  • "email": "a.dministrator@example.com",
  • "phone": "+49123456789",
  • "description": "A very cool admin",
  • "is_admin": false,
  • "notification_channels": {
    },
  • "rfid_uid": 0,
  • "levelprofiles": [
    ],
  • "pin": 1234,
  • "emergency_access": true,
  • "armdisarm_mode": 0,
  • "alarmgroups": [
    ],
  • "usergroup_id": 1,
  • "uses_cloud": false,
  • "invoicegroups": [ ],
  • "rfid_data": null
}

Response samples

Content type
application/json
{
  • "id": 1,
  • "username": "admin",
  • "is_active": true,
  • "unlock_at": "2022-03-31T07:29:20.000000Z",
  • "lock_at": "2022-04-30T07:30:00.000000Z",
  • "fullname": "Administrator",
  • "email": "a.dministrator@example.com",
  • "phone": "+49123456789",
  • "description": "A very cool admin",
  • "is_admin": false,
  • "api_token": "1234567890ABCDEFGHIJKLMNOPQRSTUVWXYZ",
  • "notification_channels": {
    },
  • "rfid_uid": 0,
  • "levelprofiles": [
    ],
  • "pin": 1234,
  • "emergency_access": true,
  • "armdisarm_mode": 0,
  • "alarmgroups": [
    ],
  • "usergroup_id": 1,
  • "uses_cloud": false,
  • "invoicegroups": [ ],
  • "rfid_data": null
}

Delete user

Delete a user

path Parameters
user_id
required
string

User ID

Responses

Response samples

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

Disable multiple users

User management

Mass-Disable users

Disable multiple users

Request Body schema: application/json
Array
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Response samples

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

Enable multiple users

User management

Mass-Enable users

(Re-)Enable multiple users

Request Body schema: application/json
Array
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Response samples

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

Webhook Names

Get Webhook names

Requests all Webhooks.

Authorizations:
bearer

Responses

Response Schema: application/json
Array
id
integer

Id of the Webhook.

name
string

Name of the Webhook.

Response samples

Content type
application/json
[
  • {
    }
]

Webhooks

Get Webhooks

Get all Webhooks.

Authorizations:
bearer

Responses

Response Schema: application/json
Array
Array of objects

The list of Webhooks.

object
object

Response samples

Content type
application/json
[]

Add Webhook

Add a new Webhook.

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

Describes the name of the Webhook.

is_active
boolean

Describes if the Webhook is en-/disabled.

request_type
integer [ 0 .. 3 ]

HTTP-Method for the request.
0 => POST
1 => GET
2 => PATCH
3 => DELETE

content_type
integer [ 0 .. 2 ]

Content-Type of the data.
0 => text/plain
1 => application/json
2 => application/xml

url
string <URL>

URL used for the request.
ATTENTION: Some parameters have to be encoded. For further information, please check the Webhook documentation.

data
string or null

Data which should be send.

authentication_mode
integer [ 0 .. 2 ]

Authentication for the request.
0 => No Authentication
1 => Basic Auth
2 => Bearer Token

username
string or null

When Authentication:
- Basic Auth => Describes username
- Bearer Token => Describes token

password
string or null

Describes the password for Basic Auth.

Responses

Response Schema: application/json
id
integer

Describes the ID of the Webhook.

name
string

Describes the name of the Webhook.

created_at
string <ISO 8601>

Describes the create date of the Webhook.

updated_at
string <ISO 8601>

Describes the update date of the Webhook.

is_active
boolean

Describes if the Webhook is en-/disabled.

request_type
integer [ 0 .. 3 ]

HTTP-Method for the request.
0 => POST
1 => GET
2 => PATCH
3 => DELETE

content_type
integer [ 0 .. 2 ]

Content-Type of the data.
0 => text/plain
1 => application/json
2 => application/xml

url
string <URL>

URL used for the request.
ATTENTION: Some parameters have to be encoded. For further information, please check the Webhook documentation.

data
string or null

Data which should be send.

authentication_mode
integer [ 0 .. 2 ]

Authentication for the request.
0 => No Authentication
1 => Basic Auth
2 => Bearer Token

username
string or null

When Authentication:
- Basic Auth => Describes username
- Bearer Token => Describes token

password
string or null

Describes the password for Basic Auth.

Request samples

Content type
application/json
{
  • "name": "Invoice",
  • "is_active": true,
  • "request_type": 0,
  • "content_type": 0,
  • "url": "https://192.168.0.1/",
  • "data": "Message from my Kentix device.",
  • "authentication_mode": 0,
  • "username": "root",
  • "password": "password"
}

Response samples

Content type
application/json
{
  • "id": 1,
  • "name": "Invoice",
  • "created_at": "2023-01-05T16:24:46.000000Z",
  • "updated_at": "2023-01-07T16:30:28.000000Z",
  • "is_active": true,
  • "request_type": 0,
  • "content_type": 0,
  • "url": "https://192.168.0.1/",
  • "data": "Message from my Kentix device.",
  • "authentication_mode": 0,
  • "username": "root",
  • "password": "password"
}

Delete Webhooks

Mass delete Webhooks.

Authorizations:
bearer
Request Body schema: application/json
webhooks
Array of integers

Responses

Request samples

Content type
application/json
{
  • "webhooks": [
    ]
}

Response samples

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

Webhook Test result

Get result of the last webhook configuration test.

Authorizations:
bearer

Responses

Response Schema: application/json
has_response
boolean

Indicates if a test result was received.

response_code
integer

0 => Test successful
1 => Server unreachable
2 => No permission
3 => Server moved permanently
4 => Requested resource was not found
5 => Unknown error

Response samples

Content type
application/json
{
  • "has_response": false,
  • "response_code": -1
}

Webhook

Get Webhook

Get a specific Webhook via its ID.

Authorizations:
bearer
path Parameters
webhook_id
required
string

ID of the Webhook to be queried

Responses

Response Schema: application/json
Array
id
integer

Describes the ID of the Webhook.

name
string

Describes the name of the Webhook.

created_at
string <ISO 8601>

Describes the create date of the Webhook.

updated_at
string <ISO 8601>

Describes the update date of the Webhook.

is_active
boolean

Describes if the Webhook is en-/disabled.

request_type
integer [ 0 .. 3 ]

HTTP-Method for the request.
0 => POST
1 => GET
2 => PATCH
3 => DELETE

content_type
integer [ 0 .. 2 ]

Content-Type of the data.
0 => text/plain
1 => application/json
2 => application/xml

url
string <URL>

URL used for the request.
ATTENTION: Some parameters have to be encoded. For further information, please check the Webhook documentation.

data
string or null

Data which should be send.

authentication_mode
integer [ 0 .. 2 ]

Authentication for the request.
0 => No Authentication
1 => Basic Auth
2 => Bearer Token

username
string or null

When Authentication:
- Basic Auth => Describes username
- Bearer Token => Describes token

password
string or null

Describes the password for Basic Auth.

Response samples

Content type
application/json
[
  • {
    }
]

Update Webhook

Update a specific Webhook via its ID.

Authorizations:
bearer
path Parameters
webhook_id
required
string

ID of the Webhook to be queried

Request Body schema: application/json
name
string

Describes the name of the Webhook.

is_active
boolean

Describes if the Webhook is en-/disabled.

request_type
integer [ 0 .. 3 ]

HTTP-Method for the request.
0 => POST
1 => GET
2 => PATCH
3 => DELETE

content_type
integer [ 0 .. 2 ]

Content-Type of the data.
0 => text/plain
1 => application/json
2 => application/xml

url
string <URL>

URL used for the request.
ATTENTION: Some parameters have to be encoded. For further information, please check the Webhook documentation.

data
string or null

Data which should be send.

authentication_mode
integer [ 0 .. 2 ]

Authentication for the request.
0 => No Authentication
1 => Basic Auth
2 => Bearer Token

username
string or null

When Authentication:
- Basic Auth => Describes username
- Bearer Token => Describes token

password
string or null

Describes the password for Basic Auth.

Responses

Response Schema: application/json
id
integer

Describes the ID of the Webhook.

name
string

Describes the name of the Webhook.

created_at
string <ISO 8601>

Describes the create date of the Webhook.

updated_at
string <ISO 8601>

Describes the update date of the Webhook.

is_active
boolean

Describes if the Webhook is en-/disabled.

request_type
integer [ 0 .. 3 ]

HTTP-Method for the request.
0 => POST
1 => GET
2 => PATCH
3 => DELETE

content_type
integer [ 0 .. 2 ]

Content-Type of the data.
0 => text/plain
1 => application/json
2 => application/xml

url
string <URL>

URL used for the request.
ATTENTION: Some parameters have to be encoded. For further information, please check the Webhook documentation.

data
string or null

Data which should be send.

authentication_mode
integer [ 0 .. 2 ]

Authentication for the request.
0 => No Authentication
1 => Basic Auth
2 => Bearer Token

username
string or null

When Authentication:
- Basic Auth => Describes username
- Bearer Token => Describes token

password
string or null

Describes the password for Basic Auth.

Request samples

Content type
application/json
{
  • "name": "Invoice",
  • "is_active": true,
  • "request_type": 0,
  • "content_type": 0,
  • "url": "https://192.168.0.1/",
  • "data": "Message from my Kentix device.",
  • "authentication_mode": 0,
  • "username": "root",
  • "password": "password"
}

Response samples

Content type
application/json
{
  • "id": 1,
  • "name": "Invoice",
  • "created_at": "2023-01-05T16:24:46.000000Z",
  • "updated_at": "2023-01-07T16:30:28.000000Z",
  • "is_active": true,
  • "request_type": 0,
  • "content_type": 0,
  • "url": "https://192.168.0.1/",
  • "data": "Message from my Kentix device.",
  • "authentication_mode": 0,
  • "username": "root",
  • "password": "password"
}

Delete Usergroup

Delete a specific Usergroup via its ID.

Authorizations:
bearer
path Parameters
webhook_id
required
string

ID of the Usergroup to be queried

Responses

Response samples

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

En-/Disable Webhooks

Disable Webhooks

Disable multiple Webhooks.

Authorizations:
bearer
Request Body schema: application/json
webhooks
Array of integers

Responses

Request samples

Content type
application/json
{
  • "webhooks": [
    ]
}

Response samples

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

Enable Webhooks

Enable multiple Webhooks.

Authorizations:
bearer
Request Body schema: application/json
webhooks
Array of integers

Responses

Request samples

Content type
application/json
{
  • "webhooks": [
    ]
}

Response samples

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

Test Webhook Configuration

Test Webhook

Test the configuration of a Webhook.

Authorizations:
bearer
Request Body schema: application/json
id
integer

Id of an existing webhook.

request_type
integer [ 0 .. 3 ]

HTTP-Method for the request.
0 => POST
1 => GET
2 => PATCH
3 => DELETE

content_type
integer [ 0 .. 2 ]

Content-Type of the data.
0 => text/plain
1 => application/json
2 => application/xml

url
string <URL>

URL used for the request.
ATTENTION: Some parameters have to be encoded. For further information, please check the Webhook documentation.

data
string or null

Data which should be send.

authentication_mode
integer [ 0 .. 2 ]

Authentication for the request.
0 => No Authentication
1 => Basic Auth
2 => Bearer Token

username
string or null

When Authentication:
- Basic Auth => Describes username
- Bearer Token => Describes token

password
string or null

Describes the password for Basic Auth.

Responses

Request samples

Content type
application/json
{
  • "id": 1,
  • "request_type": 0,
  • "content_type": 0,
  • "url": "https://192.168.0.1/",
  • "data": "Message from my Kentix device.",
  • "authentication_mode": 0,
  • "username": "root",
  • "password": "password"
}

Response samples

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