DeactivateParser parity mapping

Supported in:

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

Protocol and mapping overview

Feature Legacy API (ArchiveCbnParser) Modern Chronicle API (DeactivateParser)
HTTP Method POST POST
Permissions Partner token or legacy API keys chronicle.googleapis.com/parsers.deactivate

Request payload field-by-field parity

The modern Chronicle API DeactivateParserRequest identifies target parsers using Google Cloud resource name paths rather than standalone config IDs.

Legacy Field (ArchiveCbnParserRequest) Modern Field (DeactivateParserRequest) Field type Parity & Migration Notes
config_id name (in HTTP path) string Google Cloud Scoping Context / Renaming: The legacy request passed config_id globally in the URL path. The modern API routes this using the standard Google Cloud resource tree structure: projects/{project}/locations/{region}/instances/{instance}/logTypes/{log_type}/parsers/{parser_id}.

Response payload field-by-field parity

In legacy backstory, ArchiveCbnParser returned the archived parser config object (CbnParser). The modern DeactivateParser API simplifies this by returning an empty confirmation response (google.protobuf.Empty).

Legacy Field (CbnParser response) Modern Field (google.protobuf.Empty) Field type Parity & Migration Notes
config_id / state / sha256 or others google.protobuf.Empty Empty Architectural Simplification: The legacy returned the modified CbnParser object (where state became ARCHIVED). The modern Chronicle API returns google.protobuf.Empty on successful deactivation. To verify updated parser states, invoke GetParser or ListParsers.

Key differences

  • Service Consolidation and Renaming:
    • Legacy parser operations were housed under ToolsService with names like ArchiveCbnParser.
    • Modern Chronicle API consolidates parser management under ParserService, using terminology aligned with parser lifecycles (DeactivateParser, ActivateParser).
  • Google Cloud Project Scoping Integration:
    • Scoped natively under parent project instance folder bindings.
  • Response Simplification:
    • Successful deactivations return empty payloads rather than echoing back the entire parser schema and byte contents.