Changelog

Release notes, breaking changes, and deprecations for the SIMRelay platform and API. We publish here whenever something changes that an integrator might care about.

Format

Each entry is dated and tagged as one of:

  • Added — new capability or endpoint.
  • Changed — non-breaking modification.
  • Deprecated — still works, but will be removed in a future version. Migration path included.
  • Removed — gone. We don't remove things without a deprecation period unless security forces our hand.
  • Fixed — bug fix worth surfacing to integrators.
  • Security — security-relevant change. Read these first.

Recent entries

Public changelog publication is in progress. Until then, breaking changes and significant additions are announced via email to API key holders. Sign up for an account to be on the list.

Deprecation policy

Anything we deprecate stays functional for at least 12 months. We send email notice when deprecation starts and again 60 / 30 / 7 days before removal. We don't break unversioned URLs without a version bump.

How to consume this

This page is the source of truth. We also offer an RSS feed (link coming) so you can pipe changelog entries into your team's Slack or email digest.