Changelog

Unreleased: API change policy updated

The 90-day deprecation window and the new-major-version guarantee no longer apply. Berank may add, change or remove endpoints, fields and modules at any time. Your API contract governs your access.

Unreleased: Outgoing event delivery retired

Outgoing event subscriptions, endpoint management and delivery history have been removed. No account used this feature. The /v1 REST endpoints, API keys and Business API-contract requirement remain unchanged.

1.0.0: Initial public release

  • API-key authentication (brnk_ keys)
  • Domain, catalog, and monitoring resources
  • Outgoing event delivery (retired 2026-09-06)
  • Rate limiting
  • OpenAPI documentation

Versioning & API changes

The major version is part of the URL path (/v1). Berank may add, change or remove endpoints, fields and modules at any time, within /v1 or under a new major path, with no minimum notice period. This policy is indicative: your API contract governs your access. Clients must tolerate unknown fields and unknown enum values.

Every /v1 response carries an X-Berank-Api-Version header. The current OpenAPI document is always available at https://api.berank.co/openapi.json.

When reasonably possible, changes are announced in this changelog. Deprecated endpoints may respond with Deprecation, Sunset, and Link headers, per RFC 9745 and RFC 8594.