Method: contextProperties.clearAll

Full name: projects.locations.instances.integrations.connectors.contextProperties.clearAll

Deletes all context properties associated with a specific parent context. Use this method to quickly clear all supplemental data from a case, alert, or integration.

HTTP request


POST https://chronicle.africa-south1.rep.googleapis.com/v1alpha/{parent}/contextProperties:clearAll

Path parameters

Parameters
parent

string

Required. The context to remove the context-properties from. 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 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 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 parent resource:

  • chronicle.contextProperties.delete

For more information, see the IAM documentation.