API versioning policy

/api/v2 is stable. No fields are removed, the meaning of a field does not change, and no optional parameter becomes required.

New fields, optional parameters and endpoints can be added. Your integration should ignore fields it does not recognise.

How something is retired

Every retirement is announced in the release notes at least 6 months in advance. The notice says what is retired, from when, and what to use instead. During that period the endpoint will return the Deprecation and Sunset headers (RFC 8594).

Breaking changes

Breaking changes go to /api/v3. /api/v2 stays available for at least 12 months after /api/v3 is released.

Dedicated and on-premise instances

Dedicated and on-premise instances receive each change when they are updated, never before.

Announced retirements