/api/v2. This page explains how
long a version stays supported, what triggers a notice, and how that notice
reaches you.
Versioning
Every endpoint is served under a versioned path, e.g.https://app.chainpatrol.io/api/v2. A new major version is introduced only
when we need to make breaking changes; the previous major version keeps
running, unchanged, for the length of its deprecation window.
Breaking vs. non-breaking changes
Non-breaking
New fields, new endpoints, and new optional parameters. These ship
without advance notice — existing integrations are unaffected.
Breaking
Removing or renaming a field/endpoint, changing a field’s type or
semantics, tightening validation, or making an optional parameter
required. These require a deprecation notice.
Deprecation window
Breaking changes require a minimum of 90 days’ advance notice. The deprecated version remains fully supported for the entire notice window — no functionality is removed or degraded before the window ends.Security exception: security-critical fixes may need to ship faster
than the standard 90-day window. When that happens, we give as much
advance notice as we can responsibly provide given the severity of the
issue.
How you’ll be notified
We notify you through all of the following channels for every breaking change:1
Sent to your organization’s designated technical contact.
2
Public changelog
Published to the ChainPatrol changelog.
3
HTTP response headers
Affected endpoints return
Deprecation and Sunset headers, per
RFC 8594, for the duration of
the deprecation window.Staying ahead of breaking changes
- Check the changelog periodically.
- Watch for
DeprecationandSunsetresponse headers on the endpoints you call, and alert on their appearance. - Keep your organization’s technical contact current so you don’t miss the email notice.