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),
  "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, limited to 1500 characters.
imageBase64

string (bytes format)

Optional. The integration's image in base64, limited to 5MB.

A base64-encoded string.
svgIcon

string

Optional. The integration's svg icon, limited to 1MB.
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).
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

 Create a SOAR Integration.

delete

 Deletes a SOAR Integration.

download

 Export items from existing integration to a zipped folder.

downloadDependency

 Download integration dependency.

fetchAffectedItems

 Get items that can be affected due to a change in the integration (for example, removal of the integration).

fetchAgentIntegrations

 Get the integrations that are installed on a specific agent.

fetchCommercialDiff

 Get a diff between the current integration and the matching commercial integration from the store

fetchDependencies

 List all of the downloaded dependencies of a custom integration.

fetchRestrictedAgents

 Returns a list of all agents that an integration update should be restricted on, due to possible incompatibility, such as: unsupported Python version.

get

 Get a SOAR Integration.

getFetchProductionDiff

 Get a diff between the current staging integration and the matching production integration

getFetchStagingDiff

 Get a diff between the current production integration and the matching staging

list

 Lists SOAR Integrations.

patch

 Updates a SOAR Integration.

pushToProduction

 Push an integration from Staging to Production mode.

pushToStaging

 Push an integration from Production to Staging mode.

upload

 Get the zip file content before importing an integration to the system