Method: integrations.updateCustomIntegration

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

Updates a SOAR Custom Integration.

HTTP request


POST https://chronicle.africa-south1.rep.googleapis.com/v1alpha/{updateCustomIntegrationPayload.integration.name}:updateCustomIntegration

Path parameters

Parameters
updateCustomIntegrationPayload.integration.name

string

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

Query parameters

Parameters
updateMask

string (FieldMask format)

Optional. The list of fields to update.

This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".

Request body

The request body contains an instance of UpdateCustomIntegrationPayload.

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.

UpdateCustomIntegrationPayload

Payload message for updating a custom integration.

JSON representation 
{
  "integration": {
    object (Integration)
  },
  "dependenciesToRemove": [
    string
  ]
}
Fields
integration

object (Integration)

Required. The custom integration to update.
dependenciesToRemove[]

string

Optional. A list of dependencies to remove.

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