GuidesAPI ReferenceChangelogDiscussions
Log In
Guides

Versioning

Ampere exposes a versioned HTTP API. Partners should pin integrations to a documented major version.

What we provide

SurfacePath prefixStatus
v2/api/v2Supported production surface for partner integrations
Unversioned health/health, /Operational health checks only

/api redirects to /api/v2.

OpenAPI documentation is published for the active v2 surface (document version is independent of the URL major version and advances as the contract expands).

Compatibility rules partners can rely on

Within a major version (v2):

  • Additive, non-breaking changes may ship (new endpoints, optional fields, new enum values where documented).
  • Breaking changes are reserved for a new major version path.
  • Deprecations are communicated before removal.

Breaking changes include removing fields, renaming fields, changing response meaning, or tightening previously accepted inputs without a migration path.

Upgrade guidance

  1. Pin clients to /api/v2.
  2. Validate new fields as optional until you intentionally adopt them.
  3. Test against a staging environment before promoting client changes.
  4. Watch deprecation notices in release communications and OpenAPI descriptions.
  5. Do not hard-code assumptions against undocumented fields.

Did this page help you?