API Compatibility Policy

The Scale REST API is versioned via a prefix in the URL. Currently, we only support v1 of the API via https://api.scale.com/v1/. Within an API version, we strive to only make backward-compatible changes to the API. This means that a client that integrates with v1 of our REST API will continue to work when querying v1 in the future.

Backward-compatible changes

Backward-compatible changes can be made within an API version, and include:

Backward-incompatible changes

Backward-incompatible changes will only happen in a new version of the API, and include:

Deprecation policy

At times, we will deprecate and remove parts of our API that can no longer be supported. In this case, we will make a best effort to identify and notify affected users, and will continue to support the deprecated API during the migration process.

Updated about 1 month ago