Method: forwarders.generateForwarderFiles

Full name: projects.locations.instances.forwarders.generateForwarderFiles

Generates a forwarder's configuration files.

HTTP request


Path parameters

Parameters
name

string

Required. The ID of the forwarder. Format: projects/{project}/locations/{location}/instances/{instance}/forwarders/{forwarder}

Request body

The request body must be empty.

Response body

forwarders.generateForwarderFiles response message. NEXT TAG: 3

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

JSON representation 
{
  "config": string,
  "auth": string
}
Fields
config

string

Contents of file used by Forwarder containing config-related settings.
auth

string

Contents of file used by Forwarder containing API credential(s).

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

  • chronicle.forwarders.generate

For more information, see the IAM documentation.