CiscoETDConnector

Cisco Secure Email Threat Defense (ETD) is a cloud-native email security service that detects and remediates email threats such as phishing, business email compromise, and malware. This collector ingests ETD message, audit, and blocked connection logs into Cortex XSIAM.

Analytics & SIEM · Cisco ETD Connector

Details

IDCiscoETDConnector
ProviderCisco
CategoryAnalytics & SIEM
From Version6.8.0
Docker Imagedemisto/fastapi:0.125.0.12689358
Supported ModulesXSIAM

README

Cisco ETD Connector

The Cisco ETD Connector ingests Cisco Secure Email Threat Defense (ETD) message, audit, and blocked connection logs into Cortex XSIAM for security analytics, monitoring, and threat investigation.

This integration uses the Cisco Secure Email Threat Defense Log Export API.

How Collection Works

Cisco ETD does not return events directly. Each API request returns pre-signed download links to hourly export files, which the collector then downloads and parses. This has a few consequences worth knowing:

  • Events become available on an hourly basis, and export files for a given hour continue to be generated for up to 20 minutes after that hour ends. The collector therefore re-reads the two most recent hours and skips export files it has already downloaded.
  • The hour currently in progress cannot be retrieved. Expect events to appear in Cortex XSIAM with a delay of up to roughly 90 minutes after they occur in Cisco ETD.
  • Log retention in Cisco ETD is 30 days. Events older than that cannot be recovered.
  • On the first fetch, only the most recent completed hour is collected. Historical data is not backfilled; use cisco-etd-get-events to retrieve a specific past time range.

Prerequisites

Log export must be enabled in the Cisco ETD UI before any events are returned. Navigate to Administration > Business > Export Log Preferences and select the log types you want to collect. Export begins 15 minutes after enabling connection and audit logs, and 20 minutes after enabling message event logs.

Blocked connection logs require Inline Mode and an ETD Advantage license.

Configure Cisco Email Threat Defense Connector in Cortex

Parameter Description Required
ETD API Base URL Regional base URL of the Cisco ETD API, for example https://api.us.etd.cisco.com. Yes
ETD API Key API key used to authenticate requests to Cisco ETD. Yes
Client ID Cisco ETD OAuth Client ID. Yes
Client Secret Cisco ETD OAuth Client Secret. Yes
Trust any certificate (not secure) Skips verification of the server TLS certificate. No
Use system proxy settings Routes requests through the system proxy. No
Fetch events Enables continuous event collection into Cortex XSIAM. No
Event Types Cisco ETD log types to collect (message, audit, connection). If none are selected, all types are collected. No
Max fetch Maximum number of events to collect per fetch cycle. Any remainder is collected on the following cycle. Default is 5000. No
Events Fetch Interval Interval, in minutes, between fetch cycles. Default is 60, matching the hourly publication of ETD export files. No

Regional Base URLs

Region Base URL
Americas https://api.us.etd.cisco.com
Europe https://api.de.etd.cisco.com
Australia https://api.au.etd.cisco.com
India https://api.in.etd.cisco.com
UAE https://api.ae.etd.cisco.com

Commands

cisco-etd-get-events

Retrieves Cisco ETD logs for an explicit time range.

Warning: Use this command for development and debugging only, as it may produce duplicate events, exceed API rate limits, or disrupt the fetch mechanism.

Base Command

cisco-etd-get-events

Input

Argument Name Description Required
start_time Start of the time range. Accepts a date, a timestamp, or a relative expression such as 3 hours ago. Rounded down to the start of the hour. Default is 1 hour ago. No
end_time End of the time range. Accepts a date, a timestamp, or a relative expression such as now. Rounded down to the start of the hour. The hour currently in progress cannot be retrieved. Default is now. No
log_type One or more log types to retrieve (message, audit, connection). If not provided, all types are retrieved. No
limit Maximum number of events to return. Default is 100. No
should_push_events If true, sends the retrieved events to Cortex XSIAM. Default is false. No

Context Output

There is no context output for this command. Retrieved events are displayed in the war room as a summary table, and are only ingested when should_push_events is set to true.

Troubleshooting

Symptom Cause and resolution
Test succeeds but no events are collected Log export is likely not enabled in the ETD UI. Enable the relevant log types under Administration > Business > Export Log Preferences and wait 15 to 20 minutes for the first export files to be generated.
Cisco ETD denied the request. Verify the API Key... The x-api-key header was rejected. Confirm the API Key is correct and belongs to the same tenant as the Client ID and Client Secret.
The Cisco ETD access token expired and could not be refreshed... The Client ID or Client Secret is invalid or was rotated. Generate new API credentials in the ETD UI and update the instance.
The Cisco ETD API rate limit or daily quota was exceeded... The tenant exceeded its API quota. Increase the Events Fetch Interval, avoid running cisco-etd-get-events repeatedly, and contact Cisco support to request a quota increase.
Cisco ETD rejected the request. Verify the configured time range... The requested range extended into the current hour, exceeded 3 hours, or was older than the 30 day retention period.
The Cisco ETD API is temporarily unavailable... A transient service error. The affected hours are retried automatically on the next fetch cycle.
Warning about truncated download links in the logs Cisco ETD returns at most 200 download links per request and discards the rest, meaning some events for that hour cannot be collected. Contact Cisco support if the tenant consistently exceeds this volume.
Events appear with a delay Expected. Export files are published hourly and continue to be generated for up to 20 minutes after an hour ends.
Events are missing after an outage Use cisco-etd-get-events with should_push_events=true to recover a specific time range, as long as it falls within the 30 day retention period.

Configuration parameters

  • etd_base_url — ETD API Base URL (required)
  • api_key — (required)
  • client_id — Client ID (required)
  • client_secret — (required)
  • insecure — Trust any certificate (not secure)
  • proxy — Use system proxy settings
  • isFetchEvents — Fetch events
  • event_type — Event Types
  • max_fetch — Max fetch
  • eventFetchInterval — Events Fetch Interval

Commands (1)

  • cisco-etd-get-events

    Retrieves ETD logs from Cisco. Use this command for development and debugging only, as it may produce duplicate events, exceed API rate limits, or disrupt the fetch mechanism.

Cisco Secure Email Threat Defense (ETD) is a cloud-native email security service that detects and remediates threats such as phishing, business email compromise, and malware.

## Enable Log Export in Cisco ETD

Events are only available after log export is enabled in the Cisco ETD UI.

1. Sign in to the Cisco Secure Email Threat Defense portal.
2. Navigate to **Administration > Business**.
3. In the **Export Log Preferences** section, select the log types you want to collect: message event logs, audit logs, and blocked connection logs.
4. Wait for the first export files to be generated: 15 minutes for audit and connection logs, 20 minutes for message event logs.

Blocked connection logs require Inline Mode and an ETD Advantage license.

## Obtain API Credentials

1. In the Cisco Secure Email Threat Defense portal, navigate to **Administration > API Clients**.
2. Create a new API client.
3. Record the **Client ID**, **Client Secret**, and **API Key**. The Client Secret is shown only once.

## Configure the Instance

1. Set **ETD API Base URL** to the endpoint for your region:

   | Region | Base URL |
   | --- | --- |
   | Americas | `https://api.us.etd.cisco.com` |
   | Europe | `https://api.de.etd.cisco.com` |
   | Australia | `https://api.au.etd.cisco.com` |
   | India | `https://api.in.etd.cisco.com` |
   | UAE | `https://api.ae.etd.cisco.com` |

2. Enter the **ETD API Key**, **Client ID**, and **Client Secret** recorded above.
3. Select the **Event Types** to collect. These must match the log types enabled in the ETD UI.
4. Enable **Fetch events**.
5. Click **Test** to verify connectivity, then **Save**.

## Collection Behavior

Cisco ETD publishes logs as hourly export files, and the hour currently in progress cannot be retrieved. Events therefore appear in Cortex XSIAM with a delay of up to roughly 90 minutes. On the first fetch only the most recent completed hour is collected; historical data is not backfilled.