We've reorganized our documentation navigation structure to align directly with your operational workflows. See the release notes and the walkthrough video for more information.

GetForwarder parity mapping

Supported in:

Google secops SIEM

This guide details the request and response mapping specifications and property parity analysis for migrating from the legacy Backstory Ingestion Forwarder API (GetForwarder) to the modern Chronicle API (GetForwarder).

Protocol and mapping overview

Feature	Legacy API (`GetForwarder`)	Modern Chronicle API (`GetForwarder`)
HTTP method	`GET`	`GET`
Permissions	Partner token or legacy API keys	`chronicle.googleapis.com/forwarders.get`

Request payload field-by-field parity

The modern Chronicle API GetForwarderRequest targets resources using Google Cloud resource name paths.

Legacy field (`GetForwarderRequest`)	Modern field (`GetForwarderRequest`)	Field type	Parity and migration notes
`name`	`name` (in HTTP path)	`string`	Google Cloud scoping context: The legacy request used path format `forwarders/<forwarder_id>`. The modern API routes this using the standard Google Cloud resource tree structure: `projects/{project}/locations/{location}/instances/{instance}/forwarders/{forwarder_id}`.

Response payload field-by-field parity

Both responses return the retrieved Forwarder representation.

Legacy field (`Forwarder` message)	Modern field (`Forwarder` message)	Field type	Parity and migration notes
`name`	`name`	`string`	Parity mapped: Contains the standard canonical resource path: `projects/{project}/locations/{location}/instances/{instance}/forwarders/{forwarder_id}`.
`display_name`	`display_name`	`string`	Rename to `displayName` in JSON responses.
`config`	`config`	`ForwarderConfig`	Contains equivalent compression and filtering settings.
`state`	`state`	`enum`	Maps directly to `State` enum (values: `ACTIVE`, `SUSPENDED`).
`create_time`	`create_time`	`Timestamp`	Rename to `createTime` in JSON responses.
`update_time`	`update_time`	`Timestamp`	Rename to `updateTime` in JSON responses.

Key differences

Google Cloud project scoping integration:
- Scoped natively under parent project instance folder bindings.
Resource path renaming:
- Legacy path formats forwarders/<forwarder_id> are migrated to standard Google Cloud path parameters projects/{project}/locations/{location}/instances/{instance}/forwarders/{forwarder_id}.