Evergreen Comply Public API

API versioning and deprecation policy

Stable major versions, machine-readable deprecation signals, and migration notice agents can rely on.

Stable versions

Stable endpoints include a major version in the URL, currently /api/public/v1. Backward-compatible additions may ship within v1. Removing or renaming a field, changing its meaning, or otherwise breaking a conforming client requires a new major version.

Deprecation and sunset signals

Before a stable route is removed, its responses advertise a structured Deprecation date, an HTTP-date Sunset, migration guidance through a Link with rel="deprecation", and a replacement through rel="successor-version". Evergreen Comply targets at least six months between a published deprecation date and sunset.

Current migration

The unversioned /api/public/courses, /api/public/courses/{courseId}, and /api/public/status compatibility routes are deprecated on February 1, 2027 and sunset on August 1, 2027. New integrations must use the equivalent paths under /api/public/v1.

Machine-readable policy

The same policy is available as Markdown. The canonical endpoint contract is the Evergreen Comply OpenAPI 3.1 document.