REST Resource: projects.locations.instances.environments

Resource: Environment

This service is available for customers who migrated SOAR to a customer managed project and have the Chronicle API enabled. An environment is simply another word for your different networks or customers that are managed by the SOC or MSSP. This is useful for SOCs who provide services to several different networks, customers or business units within the organization. The Platform comes with a predefined environment named Default Environment.

JSON representation 
{
  "name": string,
  "displayName": string,
  "description": string,
  "contact": string,
  "contactEmails": string,
  "contactPhone": string,
  "base64Image": string,
  "retentionDuration": integer,
  "dynamicParameters": [
    {
      object (EnvironmentDynamicParameter)
    }
  ],
  "system": boolean,
  "aliasesJson": string,
  "instanceUri": string,
  "dataAccessScopesJson": string,
  "weight": integer
}
Fields
name

string

Identifier. The unique name(ID) of the Environment. Format: projects/{project}/locations/{location}/instances/{instance}/environments/{environment}
displayName

string

Required. Immutable. Replaces old prop name: "Name" MAX_NAME_LENGTH = 256
description

string

Required. MAX_NAME_LENGTH = 256 Description of the environment.
contact

string

Required. MAX_NAME_LENGTH = 256 Name of the contact for the environment.
contactEmails

string

Required. MAX_NAME_LENGTH = 256 Email of the contact for the environment.
contactPhone

string

Required. MAX_NAME_LENGTH = 256 Phone number of the contact for the environment.
base64Image

string

Optional. MAX_NAME_LENGTH = 1024 Environment icon.
retentionDuration

integer

Required. Environment data retention in months.
dynamicParameters[]

object (EnvironmentDynamicParameter)

Required. Additional custom properties for enriching the environment. For example: { "value": "value1", "dynamicParameterId": 123, "environmentId": 456 }
system

boolean

Required. Output only. Whether the environment is a system environment.
aliasesJson

string

Optional. Environment nicknames.
instanceUri

string

Optional. URL of the environment.
dataAccessScopesJson

string

Optional. data access scopes.
weight

integer

Optional. The weight of the environment, enabling customers to control distribution of resources between the separate environments in a single instance of Chronicle SOAR. Environments with higher weights get prioritized for processing in Chronicle SOAR via a lottery algorithm. Defaults to 1.

EnvironmentDynamicParameter

Dynamic parameter for the environment.

JSON representation 
{
  "value": string,
  "dynamicParameterId": string,
  "environmentId": string
}
Fields
value

string

Required. The value of the dynamic parameter.
dynamicParameterId

string (int64 format)

Required. The ID of the dynamic parameter.
environmentId

string (int64 format)

Required. The ID of the environment.

Methods

create

 Creates a Environment.

delete

 Deletes a Environment.

get

 Gets a Environment.

list

 Lists Environments.

patch

 Updates a Environment.

resetWeights

 Reset weights of all environments.