Method: contextProperties.clearAll

Full name: projects.locations.instances.cases.alerts.contextProperties.clearAll

The method clears all context-properties set on a specific context.

HTTP request


Path parameters

Parameters
parent

string

Required. The context to remove the context-properties from. Format: projects/{project}/locations/{location}/instances/{instance}/contextProperties:clearAll projects/{project}/locations/{location}/instances/{instance}/cases/{case}/contextProperties:clearAll projects/{project}/locations/{location}/instances/{instance}/cases/{case}/alerts/{alert}/contextProperties:clearAll projects/{project}/locations/{location}/instances/{instance}/integrations/{integration}/connectors/{connector}/contextProperties:clearAll projects/{project}/locations/{location}/instances/{instance}/integrations/{integration}/jobs/{job}/contextProperties:clearAll

Request body

The request body contains data with the following structure:

JSON representation
{
 "contextId": string
}
Fields
contextId

string

Optional. The context-id (connector-id, job-id, alert-id, case-id) to remove the context-properties from. This value should be 4-63 characters and valid characters are /[a-z][0-9]-/.

Response body

If successful, the response body is an empty JSON object.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • chronicle.contextProperties.delete

For more information, see the IAM documentation.

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025年09月22日 UTC.