Changelog
Versions and the stability promise
What changes in the API, when, and how much notice you get before anything you rely on goes away.
API versions
Each installation serves the API version of the platform release it runs. GET /api/v1/meta answers both: api_version and platform_version.
| API | Platform releases | Status |
|---|---|---|
| 1.0.0 | 1.0.176 and later | Current. Published 2026-10-02, with provider 1.0.0. |
The reference on this site is the contract of platform release 1.0.187. Before publication the contract of API 1.0.0 was still being shaped. Platform releases 1.0.155 to 1.0.175 serve the operations built by then, under the same paths and operation ids, but some request and response members and some error and warning codes there still carry earlier names; 1.0.176 renamed them, before the stability promise starts. An installation always serves its own contract at /api/v1/openapi.json, and GET /api/v1/meta reports its platform_version.
The v1 stability promise
Within v1 we may add, at any time and in any platform release:
- operations
- optional request parameters
- optional response members
- new enum values
- new error codes
Clients must treat unknown values and codes as unknown, not as errors: ignore a response member you do not know, and handle an enum value or an error code you have not seen as "something else", not as a failure of the client.
Description rewording is not a change. The wording of a summary or a description may improve at any time; what the operation does does not change with it.
Removals and type changes need 12 months' notice from the announcement. An operation, a parameter, a member or a value is first deprecated as described below, and is removed or changes type no earlier than 12 months after the deprecation was announced.
An Idempotency-Key is honoured for at least 24 hours. Within that time, a retry with the same key and the same request replays the stored answer instead of doing the work twice.
The provider follows semantic versioning on its own: a breaking change to a resource or an attribute needs a new major version of the provider.
The promise holds since publication: API 1.0.0 and provider 1.0.0, the provider's first public release, were published on 2026-10-02. Builds of the provider before 1.0.0 were never published.
Deprecations
A deprecation is announced in three places at once, from the announcement date:
- On this page, with what is deprecated, what replaces it, the date of the announcement and the earliest date it can be removed (12 months later at the soonest).
- In the contract: the operation, parameter or member is marked
deprecated: true, and the reference shows it as deprecated. - On the wire: the affected operations answer with
DeprecationandSunsetresponse headers, so a client can notice without reading this page.
Until the removal date, a deprecated part keeps working as documented.
Nothing in API v1 is deprecated.