---
title: API versioning and deprecation - Vitals Vault Developers
description: "Vitals Vault Educational API versioning: URL versions, a six-month deprecation notice, and Sunset/Deprecation response headers."
canonical: "https://www.vitalsvault.com/developers/versioning"
last-updated: 2026-08-22
---

# API versioning and deprecation - Vitals Vault Developers

> Vitals Vault Educational API versioning: URL versions, a six-month deprecation notice, and Sunset/Deprecation response headers.

Developers

# Versioning and deprecation

Vitals Vault Educational API versioning: URL versions, a six-month deprecation notice, and Sunset/Deprecation response headers.

## URL versioning

The Educational Biomarker API is versioned in the URL path. The current public surface is `/api/v1`. A future breaking release would ship as `/api/v2` rather than silently changing v1. Additive, backwards-compatible fields may appear on v1 without a new version.

## Deprecation notice

If we retire a versioned URL or a documented field, we will give at least **six months** of notice on the [developer portal](https://www.vitalsvault.com/developers) and in the OpenAPI document. During that window the old URL keeps working.

## Sunset and Deprecation headers

Deprecated endpoints will send HTTP `Deprecation` and `Sunset` headers (RFC 8594 / RFC 9745) so agents can detect a coming break without scraping this page. No Educational API route is deprecated today, so those headers are not present on current v1 responses.

Contract: https://www.vitalsvault.com/openapi.json. Auth: https://www.vitalsvault.com/auth.md.

---

Canonical HTML: https://www.vitalsvault.com/developers/versioning
- [llms.txt](https://www.vitalsvault.com/llms.txt)
- [sitemap.xml](https://www.vitalsvault.com/sitemap.xml)
- [Developer portal](https://www.vitalsvault.com/developers)
