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.

CreateForwarder 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 (CreateForwarder) to the modern Chronicle API (CreateForwarder).

Protocol and mapping overview

Feature	Legacy API (`CreateForwarder`)	Modern Chronicle API (`CreateForwarder`)
HTTP method	`POST`	`POST`
Permissions	Partner token or legacy API keys	`chronicle.googleapis.com/forwarders.create`

Request payload field-by-field parity

The modern Chronicle API CreateForwarderRequest requires parent scoping and maps legacy forwarder attributes to equivalent fields.

Legacy field (`CreateForwarderRequest` / `Forwarder`)	Modern field (`CreateForwarderRequest` / `Forwarder`)	Field type	Parity and migration notes
—	`parent` (in HTTP path)	`string`	Google Cloud scoping hierarchy: Scopes the creation target using the standard resource path in the HTTP URL path. Pattern: `projects/{project}/locations/{location}/instances/{instance}`.
`forwarder.display_name`	`forwarder.display_name`	`string`	Parity mapped: Display name of the forwarder. Rename to `displayName` in JSON payloads.
`forwarder.config`	`forwarder.config`	`ForwarderConfig`	Parity mapped: Configuration settings mapping (metadata, compression, regular expression filters).
`forwarder.name`	`forwarder.name`	`string`	Ignored / output-only: Although the field exists in the modern Forwarder structure, it is generated by the server and shouldn't be provided in the request payload.
`forwarder.state`	`forwarder.state`	`enum`	Ignored / output-only: The state is set by the system and ignored during create requests.
`forwarder.create_time` / `update_time`	`forwarder.create_time` / `update_time`	`Timestamp`	Ignored / output-only: Timestamps are generated by the server upon resource creation/updating.

Response payload field-by-field parity

Both responses return the created Forwarder message 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}.