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

- [Resource: IntegrationInstance](https://docs.cloud.google.com/chronicle/docs/reference/rest/v1beta/projects.locations.instances.integrations.integrationInstances#IntegrationInstance)
  - [JSON representation](https://docs.cloud.google.com/chronicle/docs/reference/rest/v1beta/projects.locations.instances.integrations.integrationInstances#IntegrationInstance.SCHEMA_REPRESENTATION)
  - [IntegrationInstanceParameter](https://docs.cloud.google.com/chronicle/docs/reference/rest/v1beta/projects.locations.instances.integrations.integrationInstances#IntegrationInstance.IntegrationInstanceParameter)
    - [JSON representation](https://docs.cloud.google.com/chronicle/docs/reference/rest/v1beta/projects.locations.instances.integrations.integrationInstances#IntegrationInstance.IntegrationInstanceParameter.SCHEMA_REPRESENTATION)
  - [IntegrationParameterType](https://docs.cloud.google.com/chronicle/docs/reference/rest/v1beta/projects.locations.instances.integrations.integrationInstances#IntegrationInstance.IntegrationParameterType)
- [Methods](https://docs.cloud.google.com/chronicle/docs/reference/rest/v1beta/projects.locations.instances.integrations.integrationInstances#METHODS_SUMMARY)

## 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 (`https://docs.cloud.google.com/chronicle/docs/reference/rest/v1beta/projects.locations.instances.integrations.integrationInstances#IntegrationInstance.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 (`https://docs.cloud.google.com/chronicle/docs/reference/rest/v1beta/projects.locations.instances.integrations.integrationInstances#IntegrationInstance.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 (`https://docs.cloud.google.com/chronicle/docs/reference/rest/v1beta/projects.locations.instances.integrations.integrationInstances#IntegrationInstance.IntegrationParameterType`), "description": string, "propertyName": string, "mandatory": boolean, "value": string } ``` |

| Fields ||
|---|---|
| `id` | `string (https://developers.google.com/discovery/v1/type-format format)` Output only. The unique id of the integration instance parameter. |
| `displayName` | `string` Output only. The integration instance parameter display name. |
| `type` | ``enum (`https://docs.cloud.google.com/chronicle/docs/reference/rest/v1beta/projects.locations.instances.integrations.integrationInstances#IntegrationInstance.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 ||
|---|---|
| ### `https://docs.cloud.google.com/chronicle/docs/reference/rest/v1beta/projects.locations.instances.integrations.integrationInstances/create` | Creates a new IntegrationInstance. |
| ### `https://docs.cloud.google.com/chronicle/docs/reference/rest/v1beta/projects.locations.instances.integrations.integrationInstances/delete` | Deletes a specific IntegrationInstance. |
| ### `https://docs.cloud.google.com/chronicle/docs/reference/rest/v1beta/projects.locations.instances.integrations.integrationInstances/executeTest` | Executes a connectivity test ("ping") for a specific integration instance. |
| ### `https://docs.cloud.google.com/chronicle/docs/reference/rest/v1beta/projects.locations.instances.integrations.integrationInstances/fetchAffectedItems` | Lists all playbooks that depend on a specific integration instance. |
| ### `https://docs.cloud.google.com/chronicle/docs/reference/rest/v1beta/projects.locations.instances.integrations.integrationInstances/fetchDefaultInstance` | Returns the system default configuration for a specific integration. |
| ### `https://docs.cloud.google.com/chronicle/docs/reference/rest/v1beta/projects.locations.instances.integrations.integrationInstances/get` | Gets a single IntegrationInstance by its resource name. |
| ### `https://docs.cloud.google.com/chronicle/docs/reference/rest/v1beta/projects.locations.instances.integrations.integrationInstances/list` | Lists all IntegrationInstances for a specific integration. |
| ### `https://docs.cloud.google.com/chronicle/docs/reference/rest/v1beta/projects.locations.instances.integrations.integrationInstances/patch` | Updates an existing IntegrationInstance. |