Deprecation policy

Last updated: 13 October 2026

We know customers build products on CloudRF. This policy sets out how much notice we give before removing something you depend on.

Our commitment

We give at least 12 months’ notice before removing or making a breaking change to a published API.

What is covered

  • APIs: every endpoint, request parameter and response field documented in the OpenAPI reference for https://api.cloudrf.com

What counts as a breaking change

  • Removing an endpoint, or changing its path or method.
  • Removing or renaming a request parameter or response field.
  • Making an optional parameter mandatory.
  • Changing authentication.

Adding new endpoints, new optional parameters or new response fields is not a breaking change.

How we announce a deprecation

  1. The item is marked deprecated in the OpenAPI reference, with its replacement.
  2. The deprecation and its removal date are recorded in the changelog.

The 12 months run from the date of the changelog entry. The item keeps working until the removal date.

Versioning

The API version is published in the OpenAPI document, currently 3.36.

Exceptions

We may act sooner where a change is needed to fix a security vulnerability or to comply with the law. We will still give as much notice as we can.

Interfaces: the web interface, the 3D and phase tracing interfaces, the PNUT project interface and our published plugins are subject to regular change. Integrators should be building their own interface with our API.

Self-hosted SOOTHSAYER

A SOOTHSAYER server keeps the API of the release you have installed and is recommended for long term integrations. Changes arrive only when you upgrade, and are listed in the release notes.

Questions

Email support@cloudrf.com.