REST Resource: projects.locations.instances.integrations.integrationInstances

Resource: IntegrationInstance

This service is available for customers who migrated SOAR to a customer managed project and have the Chronicle API enabled. Represents an instance of an Integration, including general configurations for execution of Playbook Actions, Connectors & Jobs.

JSON representation 
{
  "name": string,
  "environment": string,
  "displayName": string,
  "parameters": [
    {
      object (IntegrationInstanceParameter)
    }
  ],
  "integrationIdentifier": string,
  "identifier": string,
  "description": string,
  "configured": boolean,
  "remote": boolean,
  "agent": string,
  "systemDefault": boolean
}
Fields
name

string

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

string

Required. The integration instance environment.
displayName

string

Optional. The display name of the integration instance. Automatically generated if not assigned. Limited to 110 characters.
parameters[]

object (IntegrationInstanceParameter)

Optional. Integration's parameters.
integrationIdentifier

string

Output only. The integration identifier.
identifier

string

Output only. The integration instance identifier.
description

string

Optional. The integration instance description. Limited to 1500 characters.
configured

boolean

Output only. Determines whether the integration instance is configured.
remote

boolean

Output only. True if the integration instance is a remote instance. Instance is created with remote = false by default.
agent

string

Optional. The agent identifier for a remote integration instance
systemDefault

boolean

Output only. Indicates whether the integration instance is the system default.

IntegrationInstanceParameter

Represents an instance of an Integration, including general configurations for execution of Playbook Actions, Connectors & Jobs.

JSON representation 
{
  "id": string,
  "displayName": string,
  "type": enum (IntegrationParameterType),
  "description": string,
  "propertyName": string,
  "mandatory": boolean,
  "value": string
}
Fields
id

string (int64 format)

Output only. The unique id of the integration instance parameter.
displayName

string

Output only. The integration instance parameter display name.
type

enum (IntegrationParameterType)

Output only. The integration instance parameter type.
description

string

Output only. The integration instance parameter description.
propertyName

string

Output only. The integration instance parameter property name.
mandatory

boolean

Output only. Indicates if the parameter is required when configuring the integration instance.
value

string

Optional. The parameter's value.

IntegrationParameterType

The type of the integration instance parameter.

Enums
INTEGRATION_PARAMETER_TYPE_UNSPECIFIED The type of the integration instance parameter is unknown.
BOOLEAN The type of the integration instance parameter is boolean.
INT The type of the integration instance parameter is integer.
STRING The type of the integration instance parameter is string.
PASSWORD The type of the integration instance parameter is password.
IP The type of the integration instance parameter is IP.
IP_OR_HOST The type of the integration instance parameter is IP or host.
URL The type of the integration instance parameter is URL.
DOMAIN The type of the integration instance parameter is domain.
EMAIL The type of the integration instance parameter is email.
VALUES_LIST The type of the integration instance parameter is values list.
VALUES_AS_SEMICOLON_SEPARATED_STRING The type of the integration instance parameter is values as semicolon separated string.
MULTI_VALUES_SELECTION The type of the integration instance parameter is multi values selection.
SCRIPT The type of the integration instance parameter is script.
FILTER_LIST The type of the integration instance parameter is filter list.

Methods

create

 Create a IntegrationInstance.

delete

 Delete a IntegrationInstance.

executeTest

 Execute a test for a given IntegrationInstance.

fetchAffectedItems

 Fetch affected items for a given IntegrationInstance.

fetchDefaultInstance

 Execute a test for a given IntegrationInstance.

get

 Get IntegrationInstance for a given instance.

list

 List IntegrationInstances for a given instance.

patch

 Update a IntegrationInstance.