Method: instances.translateYlRule

Full name: projects.locations.instances.translateYlRule

Translate natural language to a Yara-L rule.

HTTP request


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

Path parameters

Parameters
instance

string

Required. The name of the parent resource, which is the SecOps 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 
{
  "text": string,
  "udmQuery": string
}
Fields
text

string

Required. Natural language text description for the rule.
udmQuery
(deprecated)

string

Optional. Deprecated: UDM query generated from the text via instances.translateUdmQuery.

Response body

Response message for instances.translateYlRule.

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

JSON representation 
{
  "ruleText": string,
  "message": string
}
Fields
ruleText

string

The translated YARA-L rule text.
message

string

Optional. The message to be shown to the user if the translation was unsuccessful.

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.ais.translateYlRule

For more information, see the IAM documentation.