REST Resource: projects.locations.instances.integrations

Resource: Integration

This service is available for customers who migrated SOAR to a customer managed project and have the Chronicle API enabled. Integration - Chronicle SOAR integration to a third party application. Types of Integration: Commercial - developed by Google Security Operations Community - published by users Custom - created by customer

JSON representation 
{
  "name": string,
  "version": string,
  "displayName": string,
  "description": string,
  "imageBase64": string,
  "svgIcon": string,
  "pythonVersion": enum (PythonVersion),
  "parameters": [
    {
      object (IntegrationParameter)
    }
  ],
  "categories": [
    string
  ],
  "productionIdentifier": string,
  "identifier": string,
  "type": enum (IntegrationType),
  "updateAvailable": boolean,
  "latestVersion": string,
  "custom": boolean,
  "certified": boolean,
  "staging": boolean
}
Fields
name

string

Identifier. The unique name of the integration. Format: projects/{project}/locations/{location}/instances/{instance}/integrations/{integration}
version

string

Output only. The version of the integration.
displayName

string

Required. The display name of the integration, limited to 150 characters.
description

string

Optional. The integration's description (maximum 1,500 characters).
imageBase64

string (bytes format)

Optional. The integration's image, encoded as a base64 string (maximum size: 5 MB).

A base64-encoded string.
svgIcon

string

Optional. The integration's SVG icon (maximum size: 1 MB).
pythonVersion

enum (PythonVersion)

Optional. The integration's Python version.
parameters[]

object (IntegrationParameter)

Optional. Integration's parameters, limited to 50 parameters per integration.
categories[]

string

Optional. Integration's categories, limited to 50 categories per integration.
productionIdentifier

string

Output only. Integration's production identifier for staging integrations. For production integrations, this field will be null.
identifier

string

Output only. The integration's identifier.
type

enum (IntegrationType)

Optional. The integration's type (response/extension).
updateAvailable

boolean

Output only. True if the integration has an update available.
latestVersion

string

Output only. The latest version of the integration.
custom

boolean

Output only. Determines if the integration is a custom integration or commercial integration.
certified

boolean

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.
staging

boolean

Required. True if the integration is in staging mode.

PythonVersion

Python Versions

Enums
PYTHON_VERSION_UNSPECIFIED Unspecified python version.
V2_7 Version 2.7
V3_7 Version 3.7
V3_11 Version 3.11

IntegrationParameter

Integration Parameter

JSON representation 
{
  "id": integer,
  "defaultValue": string,
  "displayName": string,
  "propertyName": string,
  "type": enum (ParamType),
  "description": string,
  "mandatory": boolean
}
Fields
id

integer

Identifier. The parameter's ID.
defaultValue

string

Optional. The default value of the parameter.
displayName

string

Required. The parameter display name, limited to 150 characters.
propertyName

string

Required. The integration instance parameter property name, limited to 150 characters.
type

enum (ParamType)

Required. The parameter's type.
description

string

Optional. The parameter's description, limited to 400 characters.
mandatory

boolean

Required. Indicates if the parameter is required when configuring the integration instance.

ParamType

Integration Parameter Type

Enums
PARAM_TYPE_UNSPECIFIED Unspecified parameter type.
BOOLEAN Boolean parameter type.
INT Integer parameter type.
STRING String parameter type.
PASSWORD Password parameter type.
IP IP parameter type.
IP_OR_HOST IP or host parameter type.
URL URL parameter type.
DOMAIN Domain parameter type.
EMAIL Email parameter type.
VALUES_LIST Values parameter type.
VALUES_AS_SEMICOLON_SEPARATED_STRING Values as semicolon separated string parameter type.
MULTI_VALUES_SELECTION Multi values selection parameter type.
SCRIPT Script parameter type.
FILTER_LIST Filter list parameter type.

IntegrationType

Integration Type If not specified, the default value is RESPONSE.

Enums
INTEGRATION_TYPE_UNSPECIFIED Unspecified type.
RESPONSE Response type.
EXTENSION Extension type.

Methods

create

 Creates a new custom SOAR Integration.

delete

 Deletes a specific custom Integration.

download

 Exports the entire integration package as a ZIP file.

downloadDependency

 Initiates the download of a Python dependency (e.g., a library from PyPI) for a custom integration.

exportIntegrationItems

 Exports specific items from an integration into a ZIP folder.

fetchAffectedItems

 Identifies all system items (e.g., connector instances, job instances, playbooks) that would be affected by a change to or deletion of this integration.

fetchAgentIntegrations

 Returns the set of integrations currently installed and configured on a specific agent.

fetchCommercialDiff

 Returns the difference between the current integration and its matching commercial version in the Marketplace.

fetchDependencies

 Returns the complete list of Python dependencies currently associated with a custom integration.

fetchRestrictedAgents

 Identifies remote agents that would be restricted from running an updated version of the integration, typically due to environment incompatibilities like unsupported Python versions.

get

 Gets a single Integration by its resource name.

getFetchProductionDiff

 Returns the difference between the staging integration and its matching production version.

getFetchStagingDiff

 Returns the difference between the production integration and its corresponding staging version.

import

 Imports a complete integration package from a ZIP file (up to 500MB).

importIntegrationDependency

 Uploads a raw dependency file (e.g., a wheel file or binary) to an existing custom integration.

importIntegrationItems

 Imports individual integration items (actions, jobs, connectors, etc.) from a ZIP file into an existing custom integration.

list

 Lists all Integrations installed in the instance.

patch

 Updates an existing Integration's metadata.

pushToProduction

 Transitions an integration from staging to production mode.

pushToStaging

 Transitions an integration from production back to staging mode.

updateCustomIntegration

 Updates a custom integration definition, including its parameters and dependencies.

upload

 Parses an integration ZIP file and returns its constituent items and metadata without importing it.