Update syslog notifier

patch

https://{customer}.tenable.ad/api/syslogs/{id}

Updates the specified syslog notifier.

Requires one of the following license types: ioa, ioaPreview, or ioe. See License Types.

Requires the Edit permission on the Alerts by Syslog entity (edit:syslog). See Identity Exposure Permissions.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

^[0-9]+$

Specifies the ID of the syslog notifier.

Body Params

Validates the post /syslogs response

string

Specifies the IP address or hostname of the Syslog server.

port

integer

Specifies the port of the Syslog server.

protocol

string

enum

Specifies the protocol used to send messages to the Syslog server.

Allowed:

tls

boolean

Specifies whether to encrypt messages with TLS. Applies only when protocol is TCP.

criticityThreshold

integer

Specifies the minimum severity that triggers a notification.

description

string

Specifies a description of the notifier.

filterExpression

object

Specifies a query expression that filters the Active Directory changes to send. Applies when inputType is adObjectChanges. An expression is an AND or OR operator that holds a list of conditions, each pairing an attribute name with a value, such as {"AND": [{"cn": "admin"}]}. A single condition can also stand alone. A condition matches attribute values that contain the specified text, regardless of case, and an unrecognized operator matches nothing.

inputType

string

enum

Specifies what triggers a message: adObjectChanges for each Active Directory change, deviances for each new deviance, attacks for each attack, or healthChecks for each change in health check status.

Allowed:

directories

array of integers

length ≥ 1

Specifies the IDs of the directories to send notifications for.

directories

checkers

array of integers | null

Specifies the IDs of the checkers to send notifications for. Required when inputType is deviances.

checkers

profiles

array of integers | null

Specifies the IDs of the security profiles to send notifications for. Required when inputType is deviances or attacks.

profiles

attackTypes

array of integers | null

Specifies the IDs of the attack types to send notifications for. Required when inputType is attacks.

attackTypes

relayId

number | null

Specifies the ID of the relay that sends messages to the Syslog server, when the server is reachable only through a Secure Relay.

Responses

401

Returned if the API key specified in your request is invalid.

404

Returned if the specified syslog notifier could not be found.

500

Returned if an internal error occurred.

Language

Credentials

Header

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Returned if the syslog notifier was updated successfully.