Method: legacySdk.legacyTrySetContextProperty

Full name: projects.locations.instances.legacySdk.legacyTrySetContextProperty

Attempts to set a technical metadata value for a specific key within an investigative context, returning success or failure based on the operation's outcome. Use this method for conditional programmatic updates of investigative properties.

HTTP request


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

Path parameters

Parameters
instance

string

Required. The instance of the legacy sdk. Format: projects/{project}/locations/{location}/instances/{instance}

Query parameters

Parameters
format

string

Optional. The format of the field names in the response. Could be snake or camel.

Request body

The request body contains an instance of Struct.

Response body

If successful, the response is a generic HTTP response whose format is defined by the method.

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.legacySdk.update

For more information, see the IAM documentation.