HomeGuidesAPI Reference
API Reference

Create one or more remote log receivers

Creates new remote log receiver configurations for forwarding audit logs or alarms to external systems. Supports HTTP, HTTPS, Kafka, Syslog, and WebSocket receiver types. The id field must NOT be included in POST requests as IDs are auto-generated.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Array of receiver configuration objects. Each object must include common required fields (receiverType, enabled, name, logType) plus type-specific fields based on the receiverType.

Request body for creating a WebSocket-based remote log receiver. The key and url fields are auto-generated by the server.

integer
enum
required

Must be 4 for WEBSOCKET receiver.

Allowed:
boolean
required

Enable or disable the receiver for sending messages.

string
required
length ≥ 1

User-defined name for the receiver. Must be non-empty.

integer
enum
required

Type of log to forward. 0=AUDIT_LOG, 1=ALARM.

Allowed:
string

Comma-separated list of valid IP addresses allowed to connect. Leave empty to allow all IPs.

Responses

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json