API Lifecycle

Give feedback on early iterations of new API endpoints

📘

Subscribe to API Updates

You can get sign up to get emails whenever a new API changelog post is made! Check out this page for details!

You can also sign up for a quarterly Developer Newsletter here!

Release Process

New Samsara APIs will go through a series of stages in order to get feedback, validation, and testing before being officially released.

Preview

📘

These APIs are published for feedback purposes only and should not be used in production.

Preview APIs are published when Samsara has designed a new API. These APIs have not yet been implemented and are subject to redesigns based on feedback. We'd love for you to send in feedback on preview API designs and use the form to let us know whether you'd be interested in beta testing! These endpoints are prefixed with /preview. The prefix will be removed when the endpoint moves out of this stage.

Beta

📘

These APIs are published for feedback and testing purposes only and should not be used in production.

APIs move from Preview into Beta once Samsara has deployed a working implementation of the new API. At this point, we highly encourage you to test the API, provide feedback, and use that feedback form to let us know if you're interested in being a beta-tester. As Samsara iterates on feedback, we may make changes to the API without releasing a new version. These endpoints are prefixed with /beta. The prefix will be removed when the endpoint moves out of this stage.

🚀 General Availability 🚀

These APIs are supported for full production use! 🎉

Once the API has been fully validated in the Preview and Beta API stages, the API will be officially released and become Generally Available (GA). These APIs are fully implemented, stable, and breaking changes will not be introduced without the creation of a new API version.

:warning: Deprecated :warning:

📘

Samsara currently does not have a deprecation policy for any APIs, including our v1 legacy APIs.

Samsara plans to deprecate the v1 API set in the future, so the best practice is to use our most recent v2 API set -- read more here. However, this is not happening any time soon and Samsara will provide an ample amount of heads up. If you need access to our v1 API set which isn't readily available on https://samsara.com/api, visit https://www.samsara.com/api-legacy

💡

If you had been testing with the Beta or Preview versions of the APIs, make sure to remove the /preview or /beta prefixes from your code when the GA version of the endpoint is released! (This will be announced via the changelog).


Did this page help you?