API compatibility and deprecation policy

At least 90 days of notice

SimpleCloud will give at least 90 days of notice before removing a supported API endpoint. The notice period begins when a dated deprecation notice is published in the official documentation. Each notice will identify the affected endpoint, the earliest removal date, and the replacement or migration steps when a replacement is available.

Finding supported operations

The controller OpenAPI specification describes the current documented operations, parameters, responses, and authentication requirements. Endpoint references are listed in the developer documentation index. Versioned URL paths identify the API version; they are not a removal notice.

Deprecation notices

No endpoint removal is scheduled by this policy. When an endpoint is deprecated, its reference documentation and OpenAPI definition will identify it as deprecated and link to the dated notice. A deprecated endpoint remains available throughout its notice period.

Questions about migration

Contact SimpleCloud if you need help understanding a deprecation notice or migrating an integration.