Versioning

​

About API Versioning

The Ivy API is versioned using semantic versioning MAJOR.MINOR.PATCH. Breaking changes are released in new major versions (e.g., 2.0.0). Breaking changes are changes that can potentially break an integration.

​

Breaking changes include:

• Removing an entire endpoint
• Removing or renaming a parameter
• Removing or renaming a response field
• Adding a new required parameter
• Making a previously optional parameter required
• Changing the type of a parameter or response field
• Removing enum values
• Adding a new validation rule to an existing parameter
• Changing authentication or authorization requirements

​

Non-breaking (additive) changes include:

• Adding a new endpoint
• Adding an optional parameter
• Adding an optional request header
• Adding a response field
• Adding a response header
• Adding enum values

When a new Ivy API version is released, the previous API version will be supported for at least 24 months following the release of the new API version.

​

Specifying API Versions

We currently only support one API Version so there is no possibility (and no need) to specify a API Version. We will introduce header-based Versioning, as soon as we introduce the first breaking change to our API.

​

Supported API Versions