Skip to main content
Version: 2025-01-01

Versioning

Our API is versioned. The API version name is based on the date when the API version was released. For example, 2023-01-01 was released on January 1, 2023.

Specifying an API version​

You should use the Scale-Version header to specify an API version. For example,

curl --header "Scale-Version: 2023-01-01" https://api.scaleaq.com/meta/sites/1

Requests without a specified version or those using no longer supported versions will be rejected with HTTP 400 Bad Request error.

Breaking Changes​

Scale considers the following changes to be breaking or backward-incompatible:

  • Removing an entire operation.
  • Removing or renaming a query parameter.
  • Removing or renaming a response field.
  • Adding a new required parameter to an operation.
  • Making a parameter required that was previously optional.
  • 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 changes may be available in the latest released version. These non-breaking (additive) changes include:

  • Adding a new operation.
  • Adding a new optional parameter.
  • Adding an optional request header.
  • Adding a new response field.
  • Adding a new enum value.
  • Changing response headers.
  • Changing the order of properties in existing responses.
  • Changing the length or format of opaque strings (like IDs, error messages, other human-readable strings).