Versioning, schemas & OpenAPI

How the Havoptic API evolves: the /v1 path, the date-based Havoptic-Version header, deprecation and Sunset headers, JSON Schemas and the OpenAPI 3.1 document.

Compatibility policy

• The path version is /v1. New fields and endpoints are added without a new path version, so ignore fields you do not know.
• Each response carries Havoptic-Version (on api.havoptic.com) and meta.api_version: the date of the current contract, e.g. 2026-11-01.
• Anything that would break a client gets at least 12 months of notice through Deprecation and Sunset headers and an entry in the API changelog.
• The www.havoptic.com/api/v1 alias is additive-only.

JSON Schemas

Every response object has a JSON Schema (2020-12) at GET /v1/schemas/{name}.json: release, release_summary, change, product, vendor, upgrade_report, digest, search_results, list, problem, meta, changelog, status and more.

curl "https://api.havoptic.com/v1/schemas/change.json"

OpenAPI 3.1

The OpenAPI document at /openapi.json is generated from the same schemas. The TypeScript SDK is generated from it; use it to generate a client in any other language.

Developer docs · API reference · OpenAPI · Havoptic