Tool: list_integrations
Lists all SOAR Integrations for a given Chronicle instance. The name field in the response contains the resource name of the integration, ending with the integration ID (e.g., projects/.../integrations/{integration_id}). This integration ID is required to use the list_integration_actions and list_integration_instances tools.
Retrieves a paginated list of all configured integrations, which connect Chronicle SOAR to third-party tools and services. This is useful for discovering what capabilities are available for automation, enrichment, and response actions within playbooks.
Workflow Integration:
- Used to populate a UI with a list of available integrations for an analyst to review and manage.
- Enables automated systems to discover and verify that required integrations are present before executing a playbook that depends on them.
- Essential for auditing and managing the inventory of all third-party connections in the SOAR platform.
Use Cases:
- A security analyst lists available integrations to understand what tools can be used for an investigation (e.g., endpoint protection, threat intelligence feeds).
- A SOAR engineer reviews the list of all integrations to identify any that need to be updated, configured, or retired.
- An automated script queries for a specific integration by name to ensure it is installed before running a playbook that uses its actions.
Filtering and Ordering:
- The 'order_by' parameter controls the sorting of the returned integrations by fields like 'DisplayName', 'Version', or 'Custom'.
Example Usage:
list_integrations(projectId='123', region='us', customerId='abc')list_integrations(projectId='123', region='us', customerId='abc', filter='Identifier="SiemplifyUtilities"')
Next Steps (using MCP-enabled tools):
- Use the integration ID from an integration's
namewithlist_integration_instancesto list its configured instances and find theIntegrationInstanceGUID needed forexecute_manual_action. - Use 'list_integration_actions' to discover the specific actions (e.g., 'block_ip', 'get_user_details') available for a particular integration.
The following sample demonstrate how to use curl to invoke the list_integrations MCP tool.
| Curl Request |
|---|
curl --location 'https://chronicle.googleapis.com/mcp' \ --header 'content-type: application/json' \ --header 'accept: application/json, text/event-stream' \ --data '{ "method": "tools/call", "params": { "name": "list_integrations", "arguments": { // provide these details according to the tool's MCP specification } }, "jsonrpc": "2.0", "id": 1 }' |
Input Schema
Request message for ListIntegrations.
ListIntegrationsRequest
| JSON representation |
|---|
{ "projectId": string, "customerId": string, "region": string, "pageSize": integer, "pageToken": string, "filter": string, "orderBy": string } |
| Fields | |
|---|---|
projectId |
Required. Google Cloud project ID. |
customerId |
Required. Chronicle customer ID. |
region |
Required. Chronicle region (e.g., "us", "europe"). |
pageSize |
The maximum number of integrations to return. If unspecified, the server will use a default page size. |
pageToken |
A token for fetching a specific page of results, obtained from a previous call. |
filter |
A filter string to apply to the list of integrations. Supported filter fields are Id, Identifier, Custom, Certified, ProductionIdentifier, and Type. |
orderBy |
A comma-separated list of fields to sort the results by. Example: "displayName, version desc" |
Output Schema
ListIntegrationsResponse contains the list of Integrations.
ListIntegrationsResponse
| JSON representation |
|---|
{
"integrations": [
{
object ( |
| Fields | |
|---|---|
integrations[] |
The list of Integrations, ordered by display_name. |
nextPageToken |
Optional. A token, which can be sent as |
Integration
| JSON representation |
|---|
{ "name": string, "version": string, "displayName": string, "description": string, "imageBase64": string, "svgIcon": string, "pythonVersion": enum ( |
| Fields | |
|---|---|
name |
Identifier. The unique name of the integration. Format: projects/{project}/locations/{location}/instances/{instance}/integrations/{integration} |
version |
Output only. The version of the integration. |
displayName |
Required. The display name of the integration, limited to 150 characters. |
description |
Optional. The integration's description (maximum 1,500 characters). |
imageBase64 |
Optional. The integration's image, encoded as a base64 string (maximum size: 5 MB). A base64-encoded string. |
svgIcon |
Optional. The integration's SVG icon (maximum size: 1 MB). |
pythonVersion |
Optional. The integration's Python version. |
parameters[] |
Optional. Integration's parameters, limited to 50 parameters per integration. |
categories[] |
Optional. Integration's categories, limited to 50 categories per integration. |
productionIdentifier |
Output only. Integration's production identifier for staging integrations. For production integrations, this field will be null. |
identifier |
Output only. The integration's identifier. |
type |
Optional. The integration's type (response/extension). |
updateAvailable |
Output only. True if the integration has an update available. |
latestVersion |
Output only. The latest version of the integration. |
Union field
|
|
custom |
Output only. Determines if the integration is a custom integration or commercial integration. |
Union field
|
|
certified |
Output only. Determines if the integration is Chronicle certified or not. Custom integrations are not certified. Community integrations can be certified even when not commercial. |
Union field
|
|
staging |
Required. True if the integration is in staging mode. |
Union field
|
|
internal |
Output only. True if the integration is an internal integration. |
IntegrationParameter
| JSON representation |
|---|
{ "id": integer, "defaultValue": string, "displayName": string, "propertyName": string, "type": enum ( |
| Fields | |
|---|---|
id |
Identifier. The parameter's ID. |
defaultValue |
Optional. The default value of the parameter. |
displayName |
Required. The parameter display name, limited to 150 characters. |
propertyName |
Required. The integration instance parameter property name, limited to 150 characters. |
type |
Required. The parameter's type. |
description |
Optional. The parameter's description, limited to 400 characters. |
Union field
|
|
mandatory |
Required. Indicates if the parameter is required when configuring the integration instance. |
Tool Annotations
Destructive Hint: ❌ | Idempotent Hint: ✅ | Read Only Hint: ✅ | Open World Hint: ❌