Skip to main content

Developer guide: API versioning and deprecation

Short answer: The version is in the path (/api/v1) and in the pvology-api-version answer header. Within v1 only additions are made (new endpoints, fields, optional parameters): ignore fields you do not know. A breaking change would come as /api/v2 with at least 12 months of overlap, Deprecation and Sunset headers, a changelog entry and a migration guide.

Verified for PVology 0.61.0 · updated 2026-10-11

When to use this

You plan for changes to the API.

Sign in to read the full help article

This is a free preview. Creating a PVology account is free.

Need more help? Contact PVology