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

Relay information & management

Activate relay output

Control a relay output state. Use "state" to set a specific state (on/off), or omit to toggle. When state is "on", you can optionally provide "pulseDuration" to auto-turn off after the specified milliseconds.

post/v1/relays/{id}/outputs/{outputId}/activate

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/relays/:id/outputs/:outputId/activate/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

idstring required

The primary key of relay

Example:66d025b301ebc903e80003ea

outputIdinteger required

Output channel ID (0 or 1)

Request body

state'on' | 'off'

Desired output state. If omitted, toggles the current state.

pulseDurationinteger

Auto-off duration in milliseconds (only applies when state is "on"). If greater than 0, the output auto-turns off after the specified duration.

Response

The relay output activation was initiated successfully.

Changes

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