Applicability
This policy applies to the following: Ably SDKs and associated APIs, including:- HTTP APIs
- Ably’s realtime protocol
Semantic versioning
Ably follows semantic versioning for all SDK releases:- Major version (X.0.0): Breaking changes that require code updates
- Minor version (0.X.0): New features that are backwards-compatible
- Patch version (0.0.X): Backwards-compatible bug fixes
Always check the changelog when updating to a new major version to understand what breaking changes may affect your application.
Deprecation timelines
Ably will support all releases for at least 12 months from the date of release of a version that supersedes it. Example: If version1.1.0 is released on 1st January 2025, version 1.0.X will be supported until at least 1st January 2026.
Maximum deprecation period: Releases will always be deprecated within 24 months of being superseded.
Deprecation timeline
New version released
A new version of an SDK or API is released that supersedes the previous version.
Sunset date
The sunset date is the date on which a version of an SDK or API will no longer function, at the end of the deprecation period. Ably will usually sunset features by a process of rejecting just a (gradually increasing) proportion of requests to avoid large-scale disruption where possible. However, this won’t always be the case, so you should assume that features or versions will stop working on the sunset date.Supportability
Ably will no longer provide the following when a version is deprecated:- Technical support for that version
- Bugfixes for that version
Communication of deprecations
Ably will communicate deprecations through multiple channels:- Email notifications: Sent to account owners and technical contacts
- Dashboard notifications: Visible in the Ably dashboard
- Documentation updates: Deprecation notices added to relevant documentation pages
- Release notes: Included in SDK release notes and changelogs
- GitHub: Announced in SDK repositories
Ensure your account contact information is up to date to receive deprecation notifications.
Migration guidance
When a version is deprecated, Ably provides:- Migration guides: Step-by-step instructions for upgrading
- Breaking changes documentation: Detailed list of changes that may affect your code
- Code examples: Updated examples demonstrating the new API
- Support assistance: Help from Ably’s support team during migration
Current deprecations
For information about current deprecations:Protocol v1
Deprecation of Ably’s realtime protocol version 1
TLS v1.1
Deprecation of TLS version 1.1 support
Best practices
To minimize the impact of deprecations:Stay updated
- Subscribe to Ably’s release announcements
- Regularly check for SDK updates
- Review release notes for deprecation notices
Plan migrations early
- Don’t wait until the sunset date approaches
- Test new versions in a staging environment
- Allocate time for migration in your development cycle
Monitor your dependencies
- Keep track of which SDK versions you’re using
- Set up automated dependency checks
- Review deprecation notices when they’re announced
Use latest stable versions
- Always use the latest stable version of SDKs when starting new projects
- Upgrade existing projects regularly
- Follow semantic versioning to understand the impact of updates
Questions and support
If you have questions about deprecations or need assistance with migrations:- Contact Ably support
- Review the migration guides
- Check SDK repositories on GitHub for community discussions
Next steps
SDK versions
View current SDK versions and release information
Current deprecations
Review current deprecation notices
Release notes
Stay updated with Ably’s latest releases
Support
Get help with migrations and updates