Update syslog entry

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

Updates a syslog entry.

Path Params

name

string

required

syslog name to update

Body Params

Syslog json object to update

hostname

string

required

hostname or IP address used with this syslog entry.

send_all_alerts

boolean

Defaults to false

Boolean flag to send all events regardless of pass, alert, error.

udp_port

int32

required

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

transport

string

Defaults to udp

syslog transport to use - TCP or UDP.

use_tls

boolean

Defaults to false

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

ignore_certs

boolean

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.

ca_cert_b64

string

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

Updated

404

The requested syslog entry doesn't exist

xxxxxxxxxx
curl --request PUT \
     --url https://sandfly-api-host/v4/alerts/syslog/name \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '
{
  "send_all_alerts": false,
  "transport": "udp",
  "use_tls": false,
  "ignore_certs": false
}
'

defaultUnexpected error