API Compatibility

API Compatibility

The Solarize API is unversioned. Breaking changes are announced by email to all API key holders 30 days in advance, along with a detailed migration guide.

API-breaking changes are modifications that may introduce incompatibilities or disrupt existing integrations. These include, but are not limited to:

  • Alterations to resource URLs
  • Removal or renaming of response properties
  • Removal or renaming of request parameters
  • Deletion of enum values
  • Conversion of an optional request parameter to a required one
  • Changes to HTTP status codes

Additive changes do not introduce any incompatibilities and typically enhance the API’s functionality. These include:

  • Introduction of new resources
  • Addition of new request parameters
  • Introduction of new response properties
  • Inclusion of new enum values
Rate LimitsCustom Attributes