HomeDocumentationAPI Reference
Log In
API Reference

Add syslog entry

post
https://{sandfly-api-host}/v4/alerts/syslog

Adds a syslog entry.

Body Params

Syslog json object to insert

string
required

A readable name for this syslog entry.

uri
required

hostname or IP address used with this syslog entry.

integer
required
-1 to 23
Defaults to -1

Integer Syslog Facility code for Pass Results

integer
required
-1 to 23
Defaults to -1

Integer Syslog Facility code for Alert Results

integer
required
-1 to 23
Defaults to -1

Integer Syslog Facility code for Audit Logs

integer
required
-1 to 23
Defaults to -1

Integer Syslog Facility code for Scan Error Logs

int32
required
Defaults to 514

Port number to use to send syslog data (despite 'udp' in the property name, this is also used for TCP connections).

string
enum
required
Defaults to udp

syslog transport to use - TCP or UDP.

Allowed:
boolean
required
Defaults to false

When using TCP transport, use TLS. This property has no effect if transport is 'udp'.

boolean
required
Defaults to false

When using TLS, set this property to true to disable certificate validation. This property has no effect unless transport=tcp and use_tls=true.

string
required

Optional base64-encoded PEM-format certificate to append to the system certificate pool to use for syslog TLS server certificate validation. This property has no effect unless transport=tcp, use_tls=true, and ignore_certs=false.

Responses
201

Added

Updated 3 months ago

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

Updated 3 months ago