Cyderes
LAST UPDATED: AUG 15, 2025
Overview
Cyderes positions itself as an MSSP that combines people, process, and platform—powered by AI and expert operations—to provide proactive cybersecurity, strong identity management, and rapid incident response capabilities.
D3 SOAR is providing REST operations to function with Cyderes.
Cyderes is available for use in:
Connection
To connect to Cyderes from D3 SOAR, follow this part to collect the required information below:
Parameter | Description | Example |
Server URL | The Cyderes Ticket System Integration API service base URL. | https://tsi-api.cyderes.io |
Token | The token used to authenticate the connection. | ***** |
API Version | The API version to use for the connection. | v2 |
Configuring Cyderes to Work with D3 SOAR
Contact the assigned Customer Success Manager to obtain the token required to connect to D3. Refer to Authentication for more information.
Configuring D3 SOAR to Work with Cyderes
Log in to D3 SOAR.
Find the Cyderes integration.
Navigate to Configuration on the top header menu.
Click on the Integration icon on the left sidebar.
Type Cyderes in the search box to find the integration, then click it to select it.
Click on the + Connection button on the right side of the Connections section. A new connection window will appear.
Configure the following fields to create a connection to Cyderes.
Connection Name: The desired name for the connection.
Site: The site on which to use the integration connection. Use the drop-down menu to select the site. The Share to Internal Sites option enables all internal sites to use the connection. Selecting a specific site will only enable that site to use the connection.
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.
Agent Name (Optional): 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.
Description (Optional): The description for the connection.
Tenant (Optional): When configuring the connection from a master tenant site, users can choose the specific tenant sites with which to share the connection. Once this setting is enabled, users can filter and select the desired tenant sites from the dropdowns to share the connection.
Active: The checkbox that enables the connection to be used when selected.
Configure User Permissions: Defines which users have access to the connection.
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. The default value is https://tsi-api.cyderes.io.
2. Input the Token from the Cyderes platform. Refer to Configuring Cyderes to Work with D3 SOAR.
3. Input the API Version. The default value is v2.
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.
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.
Test the connection.
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.
Click OK to close the alert window.
Click + Add to create and add the configured connection.
Commands
Cyderes 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 Cyderes API, refer to the Cyderes API reference.
Note for Time-related parameters
The input format of time-related parameters may vary based on user account settings, which may cause the sample data in commands to differ from what is displayed. To adjust the time format, follow these steps:
Navigate to Configuration Application Settings. Select Date/Time Format.
Choose the desired date and time format, then click on the Save button.
The selected time format will now be visible when configuring Date/Time command input parameters.
Add Comment to Ticket
Adds a comment to a specified Cyderes ticket.
READER NOTE
Ticket ID is a required parameter to run this command.
Run the List Tickets command to obtain the Ticket ID. Ticket IDs can be found in the raw data at $.Results[*].ticket_id.
Input
Input Parameter | Required/Optional | Description | Example |
Ticket ID | Required | The ID of the ticket. Ticket ID can be obtained using the List Tickets command. | NO SAMPLE DATA |
Author | Required | The name of the comment author. | NO SAMPLE DATA |
Comment | Required | The content of the comment. | NO SAMPLE DATA |
Output
To view the sample output data for all commands, refer to this article.
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.
Parts in Error | Description | Example |
Failure Indicator | Indicates the command failure that happened at a specific input and/or API call. | Add Comment to Ticket failed. |
Status Code | The response code issued by the third-party API server or the D3 SOAR system that can be used to locate the corresponding error category. For example, if the returned status code is 401, the selected connection is unauthorized to run the command. The user or system support would need to check the permission setting in the Cyderes portal. Refer to the HTTP Status Code Registry for details. | Status Code: 401. |
Message | The raw data or captured key error message from the integration API server about the API request failure. | Message: Unauthorized. |
Error Sample Data Add Comment to Ticket failed. Status Code: 401. Message: Unauthorized. |
Close Ticket
Closes a specified Cyderes ticket.
READER NOTE
Ticket ID is a required parameter to run this command.
Run the List Tickets command to obtain the Ticket ID. Ticket IDs can be found in the raw data at $.Results[*].ticket_id.
Input
Input Parameter | Required/Optional | Description | Example |
Ticket ID | Required | The ID of the ticket to close. Ticket ID can be obtained using the List Tickets command. | NO SAMPLE DATA |
Comment | Optional | A comment to include when closing the ticket. | NO SAMPLE DATA |
Output
To view the sample output data for all commands, refer to this article.
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.
Parts in Error | Description | Example |
Failure Indicator | Indicates the command failure that happened at a specific input and/or API call. | Close Ticket failed. |
Status Code | The response code issued by the third-party API server or the D3 SOAR system that can be used to locate the corresponding error category. For example, if the returned status code is 401, the selected connection is unauthorized to run the command. The user or system support would need to check the permission setting in the Cyderes portal. Refer to the HTTP Status Code Registry for details. | Status Code: 401. |
Message | The raw data or captured key error message from the integration API server about the API request failure. | Message: Unauthorized. |
Error Sample Data Close Ticket failed. Status Code: 401. Message: Unauthorized. |
Create Ticket
Creates a service request ticket.
Input
Input Parameter | Required/Optional | Description | Example |
Name | Required | The name of the ticket to be created. | NO SAMPLE DATA |
Priority | Required | The priority assigned to the ticket. | NO SAMPLE DATA |
Category | Optional | The category associated with the ticket. | NO SAMPLE DATA |
Type | Optional | The type of ticket to be created. | NO SAMPLE DATA |
Description | Optional | A brief summary of the ticket. | NO SAMPLE DATA |
Short Description | Optional | The short description of the ticket. | NO SAMPLE DATA |
Output
To view the sample output data for all commands, refer to this article.
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.
Parts in Error | Description | Example |
Failure Indicator | Indicates the command failure that happened at a specific input and/or API call. | Create Ticket failed. |
Status Code | The response code issued by the third-party API server or the D3 SOAR system that can be used to locate the corresponding error category. For example, if the returned status code is 401, the selected connection is unauthorized to run the command. The user or system support would need to check the permission setting in the Cyderes portal. Refer to the HTTP Status Code Registry for details. | Status Code: 401. |
Message | The raw data or captured key error message from the integration API server about the API request failure. | Message: Unauthorized. |
Error Sample Data Create Ticket failed. Status Code: 401. Message: Unauthorized. |
Fetch Event
Returns events from the platform based on specified criteria.
Input
Input Parameter | Required/Optional | Description | Example |
Start Time | Required | The start of the time range used to fetch events. The format must be yyyy-MM-dd HH:mm:ss. | 2025-01-01 00:00:00 |
End Time | Required | The end of the time range used to fetch events. The format must be yyyy-MM-dd HH:mm:ss. | 2025-07-01 00:00:00 |
Number of Event(s) Fetched | Optional | The maximum number of events to return. By default, all events matching the specified criteria are returned. | 20 |
Type | Optional | Filters the results by ticket type. Available options are:
By default, all tickets regardless of their type are returned. | All |
Priority | Optional | Filters the results by ticket priority. | NO SAMPLE DATA |
Escalated Only | Optional | Filters the results to include only escalated tickets when True. | No |
Output
To view the sample output data for all commands, refer to this article.
Fetch Event Field Mapping
Fetch Event commands require event field mapping. Field mapping plays a key role for data normalization within the event pipeline. Field mapping converts the original data fields from the different providers to standardized D3 fields as defined by the D3 Model. Refer to Event and Incident Intake Field Mapping for details.
To add a custom field, click on the + Add Field button. Users can also remove built-in field mappings by clicking x. Note that two underscore characters will automatically prefix the defined Field Name as the System Name for a custom field mapping. Additionally, if an input Field Name contains any spaces, they will automatically be replaced with underscores for the corresponding System Name.
As a system integration, the Cyderes integration has some pre-configured field mappings for default field mapping.
Default Event Source
The Default Event Source is the default set of field mappings that are applied when this fetch event command is executed. For out-of-the-box integrations, users will find a set of field mappings provided by the system. Default event source provides field mappings for common fields from the fetched data. The default event source has a "Main Event JSON Path" (i.e. $.Results) that is used to extract a batch of events from the response raw data. View the "Main Event JSON Path" by clicking on the Edit Event Source button.
Main Event JSON Path: $.Results
The Main Event JSON Path determines the root path where the system starts parsing raw response data into D3 event data. The JSON path begins with $, representing the root element. The path is formed by appending a sequence of child elements to $, each separated by a dot (.). Square brackets with nested quotation marks ([‘...’]) should be used to separate child elements in JSON arrays.
For example, the root node of a JSON Path is Results. The child node denoting the Unique Event Key field would be ticket_id. Putting it together, the JSON Path expression to extract the Unique Event Key is $.Results.ticket_id.
The pre-configured field mappings are detailed below:
Field Name | Source Field |
Unique Event Key | .ticket_id |
Start Time | .created |
Event Type | .type |
Source Priority | .priority |
Event category | .category |
Description | .description |
Event code | .number |
Status | .state |
Ticket Type | .ticket_type |
Alert Description | .alert_description |
SOAR Case ID | .soar_case_id |
SOAR Alert Ticket ID | .soar_alert_ticket_id |
Phishing Investigation | .phishing_investigation |
Analyst Notes | .analyst_notes |
Recommendations | .recommendations |
Case Outcome Code | .case_outcome_code |
Alert Insights | .alert_insights |
Raw Event Description | .raw_event_description |
Escalated | .escalated |
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.
Parts in Error | Description | Example |
Failure Indicator | Indicates the command failure that happened at a specific input and/or API call. | Fetch Event failed. |
Status Code | The response code issued by the third-party API server or the D3 SOAR system that can be used to locate the corresponding error category. For example, if the returned status code is 401, the selected connection is unauthorized to run the command. The user or system support would need to check the permission setting in the Cyderes portal. Refer to the HTTP Status Code Registry for details. | Status Code: 401. |
Message | The raw data or captured key error message from the integration API server about the API request failure. | Message: Unauthorized. |
Error Sample Data Fetch Event failed. Status Code: 401. Message: Unauthorized. |
Get Tickets Attachments
Retrieves attachments for the specified tickets.
READER NOTE
Ticket IDs is a required parameter to run this command.
Run the List Tickets command to obtain the Ticket IDs. Ticket IDs can be found in the raw data at $.Results[*].ticket_id.
Input
Input Parameter | Required/Optional | Description | Example |
Ticket IDs | Required | The IDs of the tickets whose attachments will be retrieved. Ticket IDs can be obtained using the List Tickets command. | NO SAMPLE DATA |
Output
To view the sample output data for all commands, refer to this article.
Error Handling
If the Return Data displays Partially Successful or 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.
Parts in Error | Description | Example |
Failure Indicator | Indicates the command failure that happened at a specific input and/or API call. | Get Tickets Attachments failed. |
Status Code | The response code issued by the third-party API server or the D3 SOAR system that can be used to locate the corresponding error category. For example, if the returned status code is 401, the selected connection is unauthorized to run the command. The user or system support would need to check the permission setting in the Cyderes portal. Refer to the HTTP Status Code Registry for details. | Status Code: 401. |
Message | The raw data or captured key error message from the integration API server about the API request failure. | Message: Unauthorized. |
Error Sample Data Get Tickets Attachments failed. Status Code: 401. Message: Unauthorized. |
Get Tickets Details
Retrieves details for the specified tickets.
READER NOTE
Ticket IDs is a required parameter to run this command.
Run the List Tickets command to obtain the Ticket IDs. Ticket IDs can be found in the raw data at $.Results[*].ticket_id.
Input
Input Parameter | Required/Optional | Description | Example |
Ticket IDs | Required | The IDs of the tickets to retrieve. Ticket IDs can be obtained using the List Tickets command. | NO SAMPLE DATA |
Output
To view the sample output data for all commands, refer to this article.
Error Handling
If the Return Data displays Partially Successful or 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.
Parts in Error | Description | Example |
Failure Indicator | Indicates the command failure that happened at a specific input and/or API call. | Get Tickets Details failed. |
Status Code | The response code issued by the third-party API server or the D3 SOAR system that can be used to locate the corresponding error category. For example, if the returned status code is 401, the selected connection is unauthorized to run the command. The user or system support would need to check the permission setting in the Cyderes portal. Refer to the HTTP Status Code Registry for details. | Status Code: 401. |
Message | The raw data or captured key error message from the integration API server about the API request failure. | Message: Unauthorized. |
Error Sample Data Get Tickets Details failed. Status Code: 401. Message: Unauthorized. |
List Tickets
Retrieves Cyderes tickets with optional filters.
Input
Input Parameter | Required/Optional | Description | Example |
Limit | Optional | The number of tickets to return. | 50 |
Skip | Optional | The number of tickets to skip from the beginning of the returned list. By default, the value is 0. | 0 |
Type | Optional | Filters the results by the specified ticket type. Available options are:
By default, all tickets regardless of their type are returned. | All |
Priority | Optional | Filters the results by the specified ticket priority. | NO SAMPLE DATA |
Escalated Only | Optional | Filters the results to include only escalated tickets when set to True. | No |
Output
To view the sample output data for all commands, refer to this article.
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.
Parts in Error | Description | Example |
Failure Indicator | Indicates the command failure that happened at a specific input and/or API call. | List Tickets failed. |
Status Code | The response code issued by the third-party API server or the D3 SOAR system that can be used to locate the corresponding error category. For example, if the returned status code is 401, the selected connection is unauthorized to run the command. The user or system support would need to check the permission setting in the Cyderes portal. Refer to the HTTP Status Code Registry for details. | Status Code: 401. |
Message | The raw data or captured key error message from the integration API server about the API request failure. | Message: Unauthorized. |
Error Sample Data List Tickets failed. Status Code: 401. Message: Unauthorized. |
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
Output Type | Description | Return Data Type |
Return Data | Indicates one of the possible command execution states: Successful or Failed. The Failed state can be triggered by any of the following errors:
More details about an error can be viewed in the Error tab. | String |
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.
Parts in Error | Description | Example |
Failure Indicator | Indicates the command failure that happened at a specific input and/or API call. | Test Connection failed. Failed to check the connector. |
Status Code | The response code issued by the third-party API server or the D3 SOAR system that can be used to locate the corresponding error category. For example, if the returned status code is 401, the selected connection is unauthorized to run the command. The user or system support would need to check the permission setting in the Cyderes portal. Refer to the HTTP Status Code Registry for details. | Status Code: 401. |
Message | The raw data or captured key error message from the integration API server about the API request failure. | Message: Unauthorized. |
Error Sample Data Test Connection failed. Failed to check the connector. Status Code: 401. Message: Unauthorized. |