Versioning and Change Management
API versioning, backward compatibility, deprecation policy
What it is
WHMDC uses versioning and deprecation policies so you can build integrations reliably. For explicit guarantees, see the Extension Stability & Support Contract.
API versioning
The REST API uses a URL path version: /api/v1/. Future breaking changes will be released under a new path (e.g. /api/v2/). The current version remains supported until the deprecation period ends.
Backward compatibility
- Additive changes: New endpoints, new optional request fields, and new response fields are added without breaking existing clients.
- Breaking changes: Removing endpoints, changing field types, or removing required fields will trigger a new API version.
Deprecated endpoints
When an endpoint is deprecated, it will be documented in the release notes and marked in the API reference. Deprecated endpoints remain available for at least 12 months. Migrate to the replacement before the removal date.
Hooks deprecation
If a hook is deprecated, it will be announced in release notes and a replacement hook will be available. Deprecated hooks remain functional for at least 6 months.
Was this helpful?