API versioning and deprecation
The Tella Public API is versioned in the URL. The current version uses the/v1 base path:
Compatibility
Tella may add backward-compatible fields, endpoints, and optional parameters to the current API version without changing the version number. Breaking changes are released under a new version.Deprecation process
When Tella deprecates an API version or operation, we:- Document its replacement and mark the affected operation as deprecated in the OpenAPI specification.
- Include the standard
Deprecationheader in responses from the deprecated endpoint. - Publish the removal date in the documentation and include a
Sunsetheader once that date is scheduled. - Keep the deprecated endpoint available through its published sunset date.
Migrating from a deprecated endpoint
Monitor theDeprecation and Sunset response headers, then move to the documented replacement before the sunset date. Contact Tella support if you need help planning a migration.