REST Resource: projects.locations.instances.integrations.connectors.connectorInstances

Resource: ConnectorInstance

This service is available for customers who migrated SOAR to a customer managed project and have the Chronicle API enabled. This resource describes the connector's instances as represented in the connectors management screen.

JSON representation 
{
  "name": string,
  "agent": string,
  "environment": string,
  "displayName": string,
  "description": string,
  "intervalSeconds": integer,
  "documentationLink": string,
  "allowList": [
    string
  ],
  "productFieldName": string,
  "eventFieldName": string,
  "timeoutSeconds": string,
  "connectorDefinitionName": string,
  "integrationVersion": string,
  "version": string,
  "loggingEnabledUntilUnixMs": string,
  "statistics": {
    object (ConnectorInstanceStatistics)
  },
  "parameters": [
    {
      object (ConnectorInstanceParameter)
    }
  ],
  "connectorId": string,
  "identifier": string,
  "id": string,
  "updateAvailable": boolean,
  "custom": boolean,
  "enabled": boolean,
  "remote": boolean,
  "status": enum (ConnectorConnectivityStatus),
  "integration": string
}
Fields
name

string

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

string

Optional. For a connector that runs on an agent, the agent identifier. This cannot be patched and must be defined when creating the instance
environment

string

Required. Connector instance environment. In case of a remote connector this cannot be patched
displayName

string

Required. Connector instance display name.
description

string

Optional. Connector instance description.
intervalSeconds

integer

Required. Connector instance execution interval in seconds.
allowList[]

string

Optional. Connector instance allow list.
productFieldName

string

Optional. Connector's device product.
eventFieldName

string

Optional. Connector's event name.
timeoutSeconds

string (int64 format)

Required. Set the timeout of a single Python script run.
connectorDefinitionName

string

Output only. Connector definition name.
integrationVersion

string

Optional. The integration version. Required on patch.
version

string (int64 format)

Optional. Determines the connector instance version.
loggingEnabledUntilUnixMs

string (int64 format)

Optional. Determines the timeout when log collecting will be disabled.
statistics

object (ConnectorInstanceStatistics)

Output only. Connector's instance statistics.
parameters[]

object (ConnectorInstanceParameter)

Optional. Connector instance parameters.
connectorId

string (int64 format)

Output only. Connector definition's Id, if does not exist then null.
identifier

string

Output only. The connector instance identifier.
id

string (int64 format)

Optional. The connector instance id.
updateAvailable

boolean

Output only. Indicates if the connector instance has an available update.
custom

boolean

Output only. Determines whether this connector instance is based on a custom connector definition.
enabled

boolean

Optional. Determines whether this connector is enabled or not.
remote

boolean

Output only. Determines whether this connector instance is executed over a remote agent. This cannot be patched and must be defined when creating the instance. It is based on the agentIdentifier's value, if the identifier is null then the // connector is local.
status

enum (ConnectorConnectivityStatus)

Output only. Connector's instance status.
integration

string

Output only. Parent integration identifier.

ConnectorConnectivityStatus

Connector instance connectivity status.

Enums
LIVE Connector instance is live.
NOT_LIVE Connector instance is not live.

ConnectorInstanceStatistics

Connector instance statistics.

JSON representation 
{
  "pastDayAlertsCount": integer,
  "avgAlertsPerDay": integer
}
Fields
pastDayAlertsCount

integer

Output only. The connector instance ingested alerts over the last 24 hours.
avgAlertsPerDay

integer

Output only. The average number of the daily ingested alerts by the connector instance.

ConnectorInstanceParameter

Connector instance parameter.

JSON representation 
{
  "value": string,
  "displayName": string,
  "description": string,
  "mandatory": boolean,
  "advanced": boolean,
  "type": enum (ParamType)
}
Fields
value

string

Optional. The value of the parameter.
displayName

string

Output only. The parameter's display name.
description

string

Output only. The parameter's description.
mandatory

boolean

Output only. Is parameter mandatory.
advanced

boolean

Output only. Describes if the parameter is an advanced parameter.
type

enum (ParamType)

Output only. The parameter's type.

ParamType

Parameter type options.

Enums
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_SEMI_COLON_SEPARATED_STRING Values as semi-colon separated string parameter type.
MULTI_VALUES_SELECTION Multi values selection parameter type.
SCRIPT Script parameter type.
FILTER_LIST Filter list parameter type.
NUMERICAL_VALUES Numerical values parameter type.

Methods

create

 Create a ConnectorInstance.

delete

 Delete a ConnectorInstance.

fetchLatestDefinition

 Fetch the latest definition of a connector.

get

 Get a ConnectorInstance.

list

 List ConnectorInstances.

patch

 Update a ConnectorInstance.

runOnDemand

 Run a connector on demand.

setLogsCollection

 Set the logs collection for a connector.