API Governance & Stability

NestBuddy API Versioning & Deprecation Policy

Our commitment to developers, platform partners, and autonomous agent builders: predictable semantic versioning, 12-month deprecation notices, and zero unexpected breaking changes.

Last Revised: August 2026Active Version: v1.0 (Stable)

1. URL Path Versioning Standard

Major versioning declared in URL paths

NestBuddy uses explicit URL path versioning (e.g. /api/v1/...). Any changes that alter required request schemas, remove fields, or fundamentally modify behavior will be released under a new major version path (such as /api/v2/...).

Non-breaking changes — including adding new optional fields, adding new supported trade categories, or introducing supplementary diagnostic prompt hints — are introduced backwards-compatibly within the active version.

2. 12-Month Notice Guarantee

Ample migration timelines for developers and agents

When a major API version is slated for retirement, NestBuddy provides a minimum of **12 months of advance notice** before the endpoint is shut down. During this deprecation window:

  • The deprecated endpoint continues to operate normally with zero performance degradation.
  • Standard HTTP Deprecation and Sunset headers are attached to all response payloads.
  • Comprehensive migration guides are published in the Developer Portal.

3. Standard Deprecation & Sunset Headers

RFC 8594 compliance for programmatic discovery

When an endpoint is in a deprecated state, NestBuddy returns standard IETF/RFC HTTP response headers:

Deprecation: @1800000000
Sunset: Sun, 01 Nov 2027 00:00:00 GMT
Link: <https://nestbuddy.com.au/docs/deprecation-policy>; rel="deprecation"

API Version Lifecycle Status

VersionRelease DateStatusSunset Date
v1.0 (REST & MCP)August 2026ACTIVE / STABLENone Scheduled

Have questions about upcoming features?

Contact our developer team for integration support.

Contact Developer Support