HomeGuidesAPI ReferenceChangelog
GuidesAPI ReferenceGitHubAirheads Developer CommunityLog In
API Reference

Add remote log receiver(s) with configuration provided in the request body

Post body is an array of objects WITHOUT id field.

Receiver Type Enum: HTTP(0), HTTPS(1), KAFKA(2), SYSLOG(3), WEBSOCKET(4)

Log Type Enum: AUDIT_LOG(0), ALARM(1)

WebsocketReceiverConfig:
{
"receiverType": integer,
"enabled": boolean,
"name": string,
"logType": integer,
"ipWhitelist": string
}

HTTP(S)ReceiverConfig:
{
"receiverType": integer,
"enabled": boolean,
"name": string,
"logType": integer,
"url": string
}

KAFKAProducerConfig:
{
"receiverType": integer,
"enabled": boolean,
"name": string,
"logType": integer,
"topic": string,
"brokers": string,
"acks": string,
"retries": integer,
"batchSize": integer,
"bufferSize": integer,
"lingerTime": integer
}

SYSLOGReceiverConfig:
{
"receiverType": integer,
"enabled": boolean,
"name": string,
"logType": integer,
"hostname": string,
"port": integer,
"protocol": integer,
"customData": string,
"auditFacility": integer,
"alarmFacility": integer,
"auditErrorSeverity": integer
"auditDebugSeverity": integer,
"auditInfoSeverity": integer,
"alarmCriticalSeverity": integer,
"alarmMajorSeverity": integer,
"alarmMinorSeverity": integer,
"alarmWarningSeverity": integer
}

Language
Click Try It! to start a request and see the response here!