Aurora releases a new API version when we make backward-incompatible changes to the Aurora API. The current and only version is 2018-01.
Your Aurora API version controls the API behavior you see and is set the first time you make an API request. When we change the API in a backward-incompatible way, something that you can expect to happen at least once a year starting in the second half of 2022, we release a new dated version and support it for a minimum of 12 months. To avoid breaking your code, we don’t change your version until you are ready to upgrade.
We continually evolve the Aurora API by making non-breaking changes to the latest version. If you’re running an older version of the API, upgrade to the latest version to take advantage of new functionality and improved performance. When you are confident that your code can handle the latest API version, use the Upgrade API (launching soon). Upgrading your API version will affect the parameters you can send and the structure of objects returned for the API calls. The Upgrade API switches the version used by API calls that don’t have the
To test a newer version for API calls, set the
Aurora-API-Version header. You can set the
Aurora-API-Version header to the latest available version only.
For 120 hours after you have upgraded your API version using the Upgrade API (launching soon), you can safely roll back to the version that you were upgrading from using the Rollback API (launching soon).
We publish information about non-breaking changes to the Aurora API and announcements about new API versions to the API product changelog. Subscribe to RSS updates to be notified about new changelog entries:
- RSS feed (https://docs.aurorasolar.com/changelog.rss)