REST Resource: projects.locations.instances.marketplaceIntegrations

Resource: MarketplaceIntegration

This service is available for customers who migrated SOAR to a customer managed project and have the Chronicle API enabled. MarketplaceIntegration represents a MarketplaceIntegration.

JSON representation 
{
  "name": string,
  "title": string,
  "version": string,
  "installedVersion": string,
  "documentationUri": string,
  "description": string,
  "pythonVersion": enum (PythonVersion),
  "author": string,
  "itemUpdateStatus": enum (MarketplaceItemUpdateState),
  "categories": [
    string
  ],
  "integrationItemInfo": {
    object (IntegrationItemInfo)
  },
  "image": string,
  "svgIcon": string,
  "identifier": string,
  "availableVersions": [
    string
  ],
  "integrationSnapshots": [
    string
  ],
  "updateAvailable": boolean,
  "custom": boolean,
  "certified": boolean,
  "powerUp": boolean,
  "installed": boolean,
  "availableForCommunity": boolean
}
Fields
name

string

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

string

Output only. The title of the integration
version

string

Output only. The version of the integration.
installedVersion

string

Output only. The installed version of the integration, or null if not installed.
documentationUri

string

Output only. Official integration's documentation link.
description

string

Output only. The integration's description, limited to 1500 characters.
pythonVersion

enum (PythonVersion)

Output only. The integration's Python version.
author

string

Output only. Integration's author name in case the integration is uncertified.
itemUpdateStatus

enum (MarketplaceItemUpdateState)

Output only. Describes the status update.
categories[]

string

Output only. Integration's categories, limited to 50 categories per integration.
integrationItemInfo

object (IntegrationItemInfo)

Output only. Integration's items information
image

string

Output only. The integration's image in base64 string.
svgIcon

string

Output only. The integration's svg icon, limited to 1MB.
identifier

string

Output only. The integration's identifier.
availableVersions[]

string

Output only. Integration's available versions, limit is configurable by marketplace release pipeline.
integrationSnapshots[]

string

Output only. Integration's snapshots, limited to 1 per integration.
updateAvailable

boolean

Output only. Determines if there is an available update for this integration
custom

boolean

Output only. Determines if the integration is custom or commercial.
certified

boolean

Output only. Determines if the integration is officially certified by Google.
powerUp

boolean

Output only. Determines whether the integration represents a powerup.
installed

boolean

Output only. Describes if the integration is installed
availableForCommunity

boolean

Output only. Describes if the integration is available for a community license

PythonVersion

Python Versions

Enums
PYTHON_VERSION_UNSPECIFIED Python version unspecified
V2_7 Version 2.7
V3_7 Version 3.7
V3_11 Version 3.11

MarketplaceItemUpdateState

Marketplace Item Status

Enums
MARKETPLACE_ITEM_UPDATE_STATE_UNSPECIFIED UNSPECIFIED status
REGULAR Regular status
RECENTLY_UPDATED Recently updated status
NEW New status

IntegrationItemInfo

Integration's items information

JSON representation 
{
  "actions": [
    string
  ],
  "jobs": [
    string
  ],
  "connectors": [
    string
  ],
  "managers": [
    string
  ],
  "widgets": [
    string
  ],
  "customFamilies": [
    string
  ],
  "mappingRules": [
    string
  ],
  "releaseNotes": [
    {
      object (IntegrationReleaseNotes)
    }
  ]
}
Fields
actions[]

string

Output only. Integration's actions
jobs[]

string

Output only. Integration's jobs.
connectors[]

string

Output only. Integration's connectors.
managers[]

string

Output only. Integration's managers.
widgets[]

string

Output only. Integration's widgets.
customFamilies[]

string

Output only. Integration's custom families.
mappingRules[]

string

Output only. Integration's mapping rules.
releaseNotes[]

object (IntegrationReleaseNotes)

Output only. Integration's release notes.

IntegrationReleaseNotes

Integration's release notes.

JSON representation 
{
  "version": string,
  "publishTime": string,
  "changelogItems": [
    string
  ]
}
Fields
version

string

Output only. Release notes version.
publishTime

string

Output only. The time of publishing the newest release note.
changelogItems[]

string

Output only. Release notes items.

Methods

fetchCommercialDiff

 Fetches the diff between the commercial and the marketplace integration.

get

 Gets a MarketplaceIntegration.

install

 Installs a MarketplaceIntegration.

list

 Lists MarketplaceIntegrations.

uninstall

 Uninstalls a MarketplaceIntegration.