Syslog Sender

LAST UPDATED: APRIL 21, 2025

Overview

The Syslog Sender integration sends event data to a specified remote syslog server using either TCP or UDP. Messages are formatted in accordance with RFC 5424. The integration supports both plain text and structured JSON message formats. It dynamically calculates the syslog priority based on the configured log level and facility.

D3 SOAR is providing REST operations to function with Syslog Sender.

Syslog Sender is available for use in:

Connection

To connect to the Syslog Sender integration from D3 SOAR, gather the following information:

Configuring D3 SOAR to Work with Syslog Sender

1. Log in to D3 SOAR.

2. Find the Syslog Sender integration.

   

   1. Navigate to Configuration on the top header menu.

   2. Click on the Integration icon on the left sidebar.

   3. Type Syslog Sender in the search box to find the integration, then click it to select it.

   4. Click on the + Connection button on the right side of the Connections section. A new connection window will appear.

3. Configure the following fields to create a connection to Syslog Sender.

   

   1. Connection Name: The desired name for the connection.

   2. Site: Specifies the site to use the integration connection. Use the drop-down menu to select the site. The Share to Internal Sites option enables all sites defined as internal sites to use the connection. Selecting a specific site will only enable that site to use the connection.

   3. Recipient site for events from connections Shared to Internal Sites: This field is displayed when Share to Internal Sites is selected for the Site field, allowing selection of the internal site for deploying the integration connection.

   4. Agent Name (Optional): Specifies the proxy agent required to build the connection. Use the dropdown menu to select the proxy agent from a list of previously configured proxy agents.

   5. Description (Optional): Add a description for the connection.

   6. Tenant (Optional): When configuring the connection from a master tenant site, users have the option to choose the specific tenant sites to share the connection with. Once this setting is enabled, users can filter and select the desired tenant sites from the dropdowns to share the connection.

      

   7. Configure User Permissions: Defines which users have access to the connection.

   8. Active: Check the checkbox to ensure the connection is available for use.

      

   9. System: This section contains the parameters defined specifically for the integration. These parameters must be configured to create the integration connection.
      1. Input the Server URL.
      2. Input the Port.
      3. Input the Protocol.

   10. Enable Password Vault: An optional feature that allows users to take the stored credentials from their own password vault. Refer to the password vault connection guide if needed.

   11. Connection Health Check: Periodically checks the connection status by scheduling the Test Connection command at the specified interval (in minutes). Available only for active connections, this feature also allows configuring email notifications for failed attempts.

4. Test the connection.

   1. Click on the Test Connection button to verify credentials and connectivity. A success alert displays Passed with a green checkmark. If the connection fails, review the parameters and retry.

   2. Click OK to close the alert window.

   3. Click + Add to create and add the configured connection.

Commands

Syslog Sender includes the following executable commands for users to set up schedules or create playbook workflows. With the Test Command function, users can execute these commands independently for playbook troubleshooting.

Integration API Note

For more information about the Syslog Sender API, refer to the Syslog Sender API reference.

Send Syslog

Sends a syslog event to the specified remote syslog server.

Input

{
    "event_type": "user_login",
    "user": "Chris",
    "status": "success",
    "ip": "192.168.50.100",
    "timestamp": "2025-04-09T11:00:00Z"
}

Output

Test Connection

Allows users to perform a health check on an integration connection. Users can schedule a periodic health check by selecting Connection Health Check when editing an integration connection.

Input

N/A

Output

Error Handling

If the Return Data displays Failed, an Error tab will appear in the Test Result window.

The error tab contains the details responded from D3 SOAR or third-party API calls, including Failure Indicator, Status Code, and Message. This can help locate the root cause of a command failure.