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.

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

Protocol and mapping overview

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

Request payload field-by-field parity

The modern Chronicle API ListForwardersRequest requires parent scoping.

Legacy field (`ListForwardersRequest`)	Modern field (`ListForwardersRequest`)	Field type	Parity and migration notes
—	`parent` (in HTTP path)	`string`	Google Cloud scoping context: Scopes the list target under parent projects using the standard resource name path in the URL. Pattern: `projects/{project}/locations/{location}/instances/{instance}`.
`page_size`	`page_size`	`int32`	Parity mapped: Pagination page size limits. Rename to `pageSize` in JSON payloads.
`page_token`	`page_token`	`string`	Parity mapped: Paging resumption token. Rename to `pageToken` in JSON payloads.

Response payload field-by-field parity

Both APIs return pagination results with matching nested models.

Legacy field (`ListForwardersResponse` message)	Modern field (`ListForwardersResponse` message)	Field type	Parity and migration notes
`forwarders`	`forwarders`	`repeated Forwarder`	Parity mapped: Array list of forwarders (with nested field translations evaluated under `CreateForwarder` or `GetForwarder`). Rename to `forwarders` in JSON.
`next_page_token`	`next_page_token`	`string`	Parity mapped: Next page resumption token. Rename to `nextPageToken` in JSON.

Key differences

Google Cloud project scoping integration:
- Scoped natively under parent project instance folder bindings.
Explicit paging token behavior:
- While the legacy backstory endpoint defined next_page_token and request pagers, pagination wasn't fully supported consistently in all backstory systems. The Chronicle API provides standard Google Cloud paging checkpoint logic.