Method: contextProperties.get

Full name: projects.locations.instances.contextProperties.get

Gets a single context property by its resource name. Use this method to retrieve the value of a specific key within a given context (e.g., a custom metadata tag for a case).

HTTP request


GET https://chronicle.africa-south1.rep.googleapis.com/v1alpha/{name}

Path parameters

Parameters
name

string

Required. The resource name of the ContextProperty to retrieve. Format: projects/{project}/locations/{location}/instances/{instance} projects/{project}/locations/{location}/instances/{instance}/cases/{case} projects/{project}/locations/{location}/instances/{instance}/cases/{case}/caseAlerts/{alert} projects/{project}/locations/{location}/instances/{instance}/integrations/{integration}/connectors/{connector} projects/{project}/locations/{location}/instances/{instance}/integrations/{integration}/jobs/{job}

Request body

The request body must be empty.

Response body

If successful, the response body contains an instance of ContextProperty.

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

  • chronicle.contextProperties.get

For more information, see the IAM documentation.