Skip to main content

List all data forwarders

GET 
/apis/v1/outbound/forwarders

Use this method to return a list of all forwarders.

XClarity One can forward data about events that occur in your environment to external services, based on criteria (filters) that you specify. EvEvery event generated is monitored to see if it matches the criteria. If it matches, the event is forwarded to the specified location using the indicated protocol. The following protocols are supported.

  • Email. Event data is forwarded to one or more email addresses using SMTP.
  • REST. Event data is forwarded over the network to a REST Web Service.
  • Syslog. Event data is forwarded over the network to a central log server where native tools can be used to monitor the syslog.

Common query parameters: This REST API supports query parameters for paginating, filtering, sorting, including data, and excluding data in the response. For more information about these common query parameters, see Paginating, filtering, including data, and excluding data in responses.

  • The following example returns list of all data forwarders.

    GET https://192.0.2.0/api/v1/outbound/forwarders

  • The following example returns list of all SMTP (email) forwarders.

    GET https://192.0.2.0/api/v1/outbound/forwarders?filterContains[][attributes]=type&filterContains[][values]=smtpForwarder

Request​

Responses​

Success