Method: legacySoarSettings.legacyGetAllEnvironmentCards

Full name: projects.locations.instances.legacySoarSettings.legacyGetAllEnvironmentCards

legacySoarSettings.legacyGetAllEnvironmentCards returns all the environment cards.

HTTP request


POST https://chronicle.africa-south1.rep.googleapis.com/v1alpha/{instance}/legacySoarSettings:legacyGetAllEnvironmentCards

Path parameters

Parameters
instance

string

Required. The instance to get all the environment cards for. Format: projects/{project}/locations/{location}/instances/{instance}

Request body

The request body contains data with the following structure:

JSON representation 
{
  "environmentInstancesFilterSettings": {
    object (LegacyEnvironmentInstancesFilterSettings)
  },
  "searchTerm": string,
  "pageSize": integer,
  "requestedPage": integer,
  "hideEmptyEnvironments": boolean
}
Fields
environmentInstancesFilterSettings

object (LegacyEnvironmentInstancesFilterSettings)

Optional. The environment instances filter settings
searchTerm

string

Optional. The search term.
pageSize

integer

Optional. The page size.
requestedPage

integer

Optional. The requested page.
hideEmptyEnvironments

boolean

Optional. Whether to hide empty environments.

Response body

Response message for LegacySoarSettingService.LegacyGetAllEnvironmentCards.

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

JSON representation 
{
  "objectsList": [
    {
      object (LegacyApiEnvironmentCard)
    }
  ],
  "metadata": {
    object (LegacyApiMetadata)
  }
}
Fields
objectsList[]

object (LegacyApiEnvironmentCard)

Output only. The objects list.
metadata

object (LegacyApiMetadata)

Output only. The metadata.

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 instance resource:

  • chronicle.legacySoarSettings.get

For more information, see the IAM documentation.

LegacyEnvironmentInstancesFilterSettings

The environment instances filter settings.

JSON representation 
{
  "environments": [
    string
  ],
  "integrations": [
    string
  ],
  "configuration": [
    string
  ],
  "remote": [
    string
  ]
}
Fields
environments[]

string

Optional. The environments.
integrations[]

string

Optional. The integrations.
configuration[]

string

Optional. The configuration.
remote[]

string

Optional. The remote.

LegacyApiEnvironmentCard

The api environment card.

JSON representation 
{
  "name": string,
  "displayName": string,
  "description": string,
  "base64Image": string,
  "numOfInstalledIntegrations": integer
}
Fields
name

string

Output only. The name.
displayName

string

Output only. The display name.
description

string

Output only. The description.
base64Image

string

Output only. The base64 image
numOfInstalledIntegrations

integer

Optional. The num of installed integrations.