Method: integrations.import

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

Imports a complete integration package from a ZIP file (up to 500MB). The package must contain all necessary Python scripts, definitions, and dependencies. Use this method to deploy externally developed integrations.

HTTP request


* Upload URI, for media upload requests:
POST https://chronicle.africa-south1.rep.googleapis.com/upload/v1beta/{parent}/integrations:import * Metadata URI, for metadata-only requests:
POST https://chronicle.africa-south1.rep.googleapis.com/v1beta/{parent}/integrations:import

Path parameters

Parameters
parent

string

Required. The parent, which owns this collection of integrations. Format: projects/{project}/locations/{location}/instances/{instance}

Request body

The request body contains data with the following structure:

JSON representation 
{
  "media": {
    object (Media)
  },
  "mediaInfo": {
    object (MediaRequestInfo)
  },
  "staging": boolean
}
Fields
media

object (Media)

Information representing the imported data. Information representing the imported data
mediaInfo

object (MediaRequestInfo)

Metadata about the media upload request. Information representing the imported data
staging

boolean

Required. Whether the integration is in staging. Here is a doc that explains the staging concept: https://cloud.google.com/chronicle/docs/soar/respond/ide/test-integrations-in-staging-mode

Response body

Response message for importing an integration.

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

JSON representation 
{
  "integration": string,
  "integrationVersion": string,
  "failedDependencies": [
    {
      object (DependencyInstallationResult)
    }
  ],
  "mediaInfo": {
    object (MediaResponseInfo)
  }
}
Fields
integration

string

Required. The integration id of the imported integration.
integrationVersion

string

Required. The integration version of the imported integration.
failedDependencies[]

object (DependencyInstallationResult)

Optional. The failed dependencies of the imported integration.
mediaInfo

object (MediaResponseInfo)

Metadata about media upload response.

Authorization scopes

Requires one of the following OAuth scopes:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • chronicle.integrations.update

For more information, see the IAM documentation.

DependencyInstallationResult

Response message for importing an integration.

JSON representation 
{
  "dependencyId": string,
  "dependencyMessage": string
}
Fields
dependencyId

string

Output only. The dependency name.
dependencyMessage

string

Optional. The dependency message.