HomeGuidesAPI Reference
API Reference

Update existing remote log receiver configurations

Updates one or more existing remote log receiver configurations. Each receiver object must include a valid id field referencing an existing receiver. Supports updating HTTP, HTTPS, Kafka, Syslog, and WebSocket receiver types.

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

Array of receiver configuration objects to update. Each object must include the id field and all required fields for the receiver type.

Request body for updating a WebSocket-based remote log receiver.

integer
required
≥ 1

ID of the existing receiver to update. Must reference a valid receiver.

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
200

Receivers updated successfully. No content is returned in the response body.

204

No receivers exist to update or no changes were applied.

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