BigPanda
LAST UPDATED: DECEMBER 18, 2025
Overview
BigPanda is an IT operations management (ITOM) platform designed to help organizations monitor, analyze, and resolve issues within their IT environments more efficiently. It primarily focuses on IT incident management and event correlation by aggregating alerts from various monitoring tools and systems into a single platform.
D3 SOAR is providing REST operations to function with BigPanda.
BigPanda is available for use in:
Connection
Gather the following information to connect D3 SOAR to BigPanda.
Parameter | Description | Example |
Server URL | The server URL of the BigPanda API server. | https://eu-api.bigpanda.io |
User API Key | The API key generated in the BigPanda UI. | ***** |
API Version | The API version used for the connection. By default, the value is v2.0. This integration does not support API version v1.0. | v2.0 |
Permission Requirements
Each endpoint in the BigPanda API requires a certain permission scope. The following are required scopes for the commands in this integration:
Command | Required Permissions |
Fetch Event | Environment - View |
List Environments | |
Test Connection |
As BigPanda is using role-based access control (RBAC), the User API Key is generated based on a specific user account and the application. Therefore, the command permissions are inherited from the user account’s role. Users need to configure their user profile from the BigPanda console for each command in this integration.
Configuring BigPanda to Work with D3 SOAR
To use the integration commands, users must be assigned the required role scopes and generate an API key. Refer to Environment Permissions and API Key Management for more information.
Configuring D3 SOAR to Work with BigPanda
Log in to D3 SOAR.
Find the BigPanda integration.
Navigate to Configuration on the top header menu.
Click on the Integration icon on the left sidebar.
Type BigPanda 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 BigPanda.
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.
Configure User Permissions: Defines which users have access to the connection.
Active: The checkbox that enables the connection to be used when selected.
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://api.bigpanda.io.
2. Input the User API Key from the BigPanda platform.
3. Input the API Version. The default value is v2.0. This integration does not support API version v1.0.
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
BigPanda 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 BigPanda API, refer to the BigPanda API reference.
READER NOTE
Certain permissions are required for each command. Refer to the Permission Requirements and Configuring BigPanda to Work with D3 SOAR sections for details.
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.
Fetch Event
Retrieves BigPanda incidents that match the specified query parameters within an environment and ingests them into D3 as events.
READER NOTE
Environment ID is a required parameter to run this command.
Run the List Environments command to obtain the Environment ID. Environment IDs can be found in the raw data at $[*].id.
Input
Input Parameter | Required/Optional | Description | Example |
Start Time | Optional | The start of the time range for fetching BigPanda incidents. Incidents active after this time (in UTC) will be returned. By default, the value is 24 hours before the End Time. | 04/15/2024 01:00 AM |
End Time | Optional | The end of the time range for fetching BigPanda incidents. Incidents active before this time (in UTC) will be returned. By default, the value is the current time. | 04/16/2024 01:00 AM |
Environment ID | Required | The ID of the environment that contains the incident records. Environment ID can be obtained using the List Environments command. | 63bd*****1cdf |
Number of Event(s) Fetched | Optional | The maximum number of most recently updated incidents to return. Valid values range from 1 to 100. By default, the value is 10. Setting the value to -1 returns all matching incidents, with a maximum limit of 10,000 incidents. | 10 |
Include Alerts | Optional | Indicates whether alert payloads and schemas are included in the returned data. When True, alert details will be included. By default, the value is set to False. It is recommended to avoid setting Number of Event(s) Fetched to -1 when this parameter is set to True. | True |
Folder | Optional | Filters incidents by folder. Valid options are:
By default, all incidents will be returned regardless of their folder. | Active |
Query | Optional | Filters incident using a BPQL query. Refer to BigPanda Query Language (BPQL) for the query syntax. | host=srv-1 AND (check=chk-1 OR (check=chk-2 AND status=critical)) |
Output
To view the sample output data for all commands, refer to this article.
Fetch Event Field Mapping
See Field Mappings.
The BigPanda system integration includes pre-configured field mappings for the default event source.
The Default Event Source is the default system-provided set of field mappings applied when the fetch event command is executed. It includes a Main Event JSON Path, which is the JSONPath expression that points to the base array of event objects. The source field path continues from this array to locate the required data.
The Main Event JSON Path can be viewed by clicking on the Edit Event Source button.
Main Event JSON Path: $.items
The items array contains the event objects. Within each object, the key id denotes the Unique Event code field. As such, the full JSONPath expression to extract the Event code is $.items.id.
The pre-configured field mappings are detailed below:
Field Name | Source Field |
Active | .active |
Environments | .environments |
Folders | .folders |
Maintenance | .maintenance |
Tags | .incident_tags |
End Time | .end |
Event code | .id |
Start Time | .start |
Severity | .severity |
Status | .status |
Sub Event | .alerts |
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 BigPanda 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. |
List Environments
Retrieves all environments.
Input
Input Parameter | Required/Optional | Description | Example |
Environment Name | Optional | Searches for environments by name. By default, all environments will be returned. | Card Services |
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 Environments 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 BigPanda 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 Environments 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 BigPanda 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. |