ListCollectors parity mapping

Supported in:

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

Protocol and mapping overview

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

Request payload field-by-field parity

The modern Chronicle API ListCollectorsRequest requires parenting info under standard Google Cloud locations.

Legacy field (ListCollectorsRequest) Modern field (ListCollectorsRequest) Field type Parity and migration notes
parent parent (in HTTP path) string Google Cloud scoping context: Scopes the list target using the standard resource path in the HTTP URL path. Pattern: projects/{project}/locations/{location}/instances/{instance}/forwarders/{forwarder_id}.
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 (ListCollectorsResponse message) Modern field (ListCollectorsResponse message) Field type Parity and migration notes
collectors collectors repeated Collector Parity mapped: Array list of collectors (with nested field translations evaluated under CreateCollector or GetCollector). Rename to collectors 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.
  • Resource path renaming:
    • Legacy path formats forwarders/<forwarder_id>/collectors/* are migrated to standard Google Cloud path parameters projects/{project}/locations/{location}/instances/{instance}/forwarders/{forwarder_id}/collectors.
  • Explicit paging token behavior:
    • While the legacy backstory endpoint defined pagination fields (page_size, page_token), it was not consistently supported across all systems in backstory v2. The Chronicle API provides standard Google Cloud paging checkpoint logic.