Method: instances.verifyRuleText

Full name: projects.locations.instances.verifyRuleText

Verifies the given rule text.

HTTP request

POST https://chronicle.googleapis.com/v1alpha/{instance}:verifyRuleText

Path parameters

Parameters
instance

string

Required. The Chronicle instance associated with the request. Format: projects/{project}/locations/{location}/instances/{instance}

Request body

The request body contains data with the following structure:

JSON representation 
{
  "rule_text": string
}
Fields
rule_text

string

Required. The rule text to verify as a UTF-8 string.

Response body

Response message for VerifyRuleText method.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "success": boolean,
  "compilation_diagnostics": [
    {
      object (CompilationDiagnostic)
    }
  ]
}
Fields
success

boolean

Whether or not the rule text was successfully verified.
compilation_diagnostics[]

object (CompilationDiagnostic)

A list of a rule's corresponding compilation diagnostic messages such as compilation errors and compilation warnings.

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

  • chronicle.rules.verifyRuleText

For more information, see the IAM documentation.