Inblog
Get started

API Versioning and Deprecation

Learn how Inblog supports API v1, announces future deprecations, and plans end-of-support.

Inblog versions its REST API in the URL path so that an automation can use a predictable contract.

Current support

v1 is the currently supported REST API version. Use endpoints under /api/v1/... and the OpenAPI document to build integrations.

We preserve backward compatibility within v1 for supported operations. Additive response fields and other non-breaking improvements may be introduced without creating a new URL version. There is no announced deprecation or sunset date for v1.

The API does not currently send Deprecation or Sunset response headers for v1 merely because this policy exists. Their absence means that no retirement signal has been announced.

Future lifecycle signals

If a supported API version is scheduled for retirement, Inblog may use these response headers:

  • Deprecation signals that the version is deprecated and may include the date on which deprecation takes effect.
  • Sunset signals the planned date after which the version will no longer be supported.

These are distinct signals: deprecation announces a lifecycle change, while sunset identifies the planned end of support. Clients should record both headers when present and follow the linked documentation or migration guidance.

Notice period

Our normal policy is to provide a minimum of 180 days' notice before removing v1 or making a breaking change to a supported API version. This is a conservative minimum, not a promise that a change will happen on that schedule.

A security vulnerability, legal requirement, or emergency may require a shorter notice period or an immediate change. In those security, legal, or emergency conditions, we will communicate the impact and available remediation as early as practical.

Client guidance

  • Pin requests to /api/v1 instead of inferring a version from response headers.
  • Treat additive fields as forward-compatible and ignore fields your client does not use.
  • Monitor Deprecation and Sunset headers, release notes, and this policy when planning migrations.
  • Use the OpenAPI document as the machine-readable source for the current contract.

Last updated 2026-08-25

PreviousAPI and MCP AuthenticationNextPricing