Method: legacyPlaybooks.download

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

Exports one or more playbook definitions as a ZIP file. Use this method to back up workflows or share automation logic across different SecOps instances.

HTTP request


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

Path parameters

Parameters
instance

string

Required. The instance to export the definitions for. Format: projects/{project}/locations/{location}/instances/{instance}

Query parameters

Parameters
identifiers

string

Required. Comma separated list of identifiers of the definitions to export.

Request body

The request body must be empty.

Response body

LegacyPlaybookExportDefinitionsResponse is a response for exporting the definitions.

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

JSON representation
{
  "media": {
    object (Media)
  }
}
Fields
media

object (Media)

The exported definitions. Zipped file with the definitions content.

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.export

For more information, see the IAM documentation.