Alarm hub information & management4

Alarm manager integration1

Arm profile management7

Bridge information & management3

Camera information & management9

Camera PTZ control & management3

Chime information & management3

Device asset file management2

Fob information & management3

Information about application1

Light information & management3

Link station information & management3

Live view management4

NVR information & management1

Protect User information2

Relay information & management4

Sensor information & management3

Siren information & management6

Speaker information & management4

UniFi Identity User information2

Viewer information & management3

WebSocket updates2

Alarm hub information & management

Trigger alarm hub output

Trigger an alarm hub output channel. Can be used to turn on/off connected devices like sirens, lights, or other actuators.

post/v1/alarm-hubs/{id}/outputs/{outputId}/trigger

Request

Base URL
https://api.ui.com/v1/connector/consoles/942A6FF664C0000000000964970E0000000009E710560000000068A9873F:9999999999/proxy/protect/integration
Auth
none declared
TypeScript
https://skmtc.dev/ubiquiti/apis/unifi-protect-api/docs/v1/alarm-hubs/:id/outputs/:outputId/trigger/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

idstring required

The primary key of linkStation

Example:66d025b301ebc903e80003ea

outputIdinteger required

Output channel ID (0 or 1)

Request body

enableboolean

Set to true to turn on, false to turn off. If omitted, toggles the current state.

delayinteger

Delay in milliseconds before the output activates

durationinteger

Duration in milliseconds to keep the output active. 0 means indefinite until manually turned off.

Example request

{
  "enable": true,
  "duration": 5000
}

Response

The output trigger was initiated successfully.

Changes

No recorded changes to this operation across all 1 revision of this API.