Method: legacyPlaybooks.legacyGetAiGenerationStatusByAlert

Full name: projects.locations.instances.legacyPlaybooks.legacyGetAiGenerationStatusByAlert

Retrieves the status of a playbook generation process initiated for a security alert. Use this method to track the progress and retrieve the final definition of an AI-generated playbook.

HTTP request


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

Path parameters

Parameters
instance

string

Required. The instance to get the status of the playbook generation for. Format: projects/{project}/locations/{location}/instances/{instance}

Request body

The request body contains data with the following structure:

JSON representation
{
  "caseId": string,
  "alertIdentifier": string
}
Fields
caseId

string (int64 format)

Required. The unique identifier of the security case.

alertIdentifier

string

Required. The unique identifier of the alert.

Response body

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

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.legacyPlaybooks.get

For more information, see the IAM documentation.