Berank API

Changelog

1.0.0 — Initial public release

  • API-key authentication (brnk_ keys)
  • Domain, catalog, and monitoring resources
  • Webhooks
  • Rate limiting
  • OpenAPI documentation

Versioning & deprecation policy

The major version is part of the URL path (/v1). Compatible additions — new endpoints, new optional response fields, new enum values — ship within /v1 without notice; clients must tolerate unknown fields and unknown enum values. Breaking changes only ship under a new major path (for example /v2), which runs side by side with /v1 during the coexistence period.

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

Deprecations carry a minimum 90-day window, announced in this changelog. Deprecated endpoints respond with Deprecation, Sunset, and Link headers, per RFC 9745 and RFC 8594. Nothing is removed before its Sunset date.