Method: integrations.updateCustomIntegration

Full name: projects.locations.instances.integrations.updateCustomIntegration

Updates a SOAR Custom Integration.

HTTP request


Path parameters

Parameters
integration.name

string

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

Request body

The request body contains data with the following structure:

JSON representation 
{
  "integration": {
    "name": string,
    "version": string,
    "displayName": string,
    "description": string,
    "imageBase64": string,
    "svgIcon": string,
    "custom": boolean,
    "pythonVersion": enum (PythonVersion),
    "certified": boolean,
    "parameters": [
      {
        "id": integer,
        "defaultValue": string,
        "displayName": string,
        "propertyName": string,
        "type": enum (ParamType),
        "description": string,
        "mandatory": boolean
      }
    ],
    "categories": [
      string
    ],
    "productionIdentifier": string,
    "staging": boolean,
    "identifier": string,
    "type": enum (IntegrationType),
    "updateAvailable": boolean,
    "latestVersion": string
  },
  "dependenciesToRemove": [
    string
  ]
}
Fields
integration.version

string

Output only. The version of the integration.
integration.displayName

string

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

string

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

string (bytes format)

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

A base64-encoded string.
integration.svgIcon

string

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

enum (PythonVersion)

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

object (IntegrationParameter)

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

string

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

string

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

string

Output only. The integration's identifier.
integration.type

enum (IntegrationType)

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

boolean

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

string

Output only. The latest version of the integration.
dependenciesToRemove[]

string

Optional. A list of dependencies to remove.
integration.custom

boolean

Output only. Determines if the integration is a custom integration or commercial integration.
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.
integration.staging

boolean

Required. True if the integration is in staging mode.

Response body

Request message for updating an integration.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "dependencies": [
    {
      object (DependencyInstallationStatus)
    }
  ],
  "successful": boolean,
  "integration": {
    object (Integration)
  }
}
Fields
dependencies[]

object (DependencyInstallationStatus)

The dependencies installation status, will be populated only if the update was failed.
successful

boolean

Whether the integration was updated successfully.
integration

object (Integration)

The updated integration will be populated only if the update was successful.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • chronicle.integrations.update

For more information, see the IAM documentation.

DependencyInstallationStatus

Dependency installation status.

JSON representation 
{
  "dependency": string,
  "installationErrorMessage": string,
  "status": enum (DependencyState)
}
Fields
dependency

string

The dependency name.
installationErrorMessage

string

The dependency installation message, will be populated only if the installation was failed.
status

enum (DependencyState)

The dependency installation status.

DependencyState

Dependency State

Enums
DEPENDENCY_STATE_UNSPECIFIED Unspecified dependency state.
FAILED Dependency failed to be installed
SUCCEEDED Dependency successfully installed
NOT_CHECKED Dependency not checked