Skip to main content

API Versioning

Current prefix: /api/v1/

Rules​

  • Additive changes (new fields in responses, new endpoints) stay in the same version.
  • Breaking changes (removed fields, changed field types, changed semantics) require a version bump.
  • Old versions are supported for 12 months after deprecation notice.
  • Version is in the URL path, not headers (simpler for CLI clients).
  • Deprecation is announced via Sunset header and documentation.
  • Plugin protocol version is separate from API version (they evolve independently).