API deprecation

API deprecation retires an API Version no Tenant needs: it posts a sunset date, sends Deprecation and Sunset headers, and lists each Tenant still pinned.

ContractCopy Anchor Link

Status planned, as Interface.deprecate and Interface.sunset. Deprecating v1 posts its sunset date to the Changelog and adds both headers to every v1 response. The pin report lists each Tenant whose apiVersion is v1, with its last call.

Sunset stops a version only when no Tenant pins it. Until then, every version a Tenant pins keeps serving, and nothing retires it.

To see who still calls a version today, list the Tenants pinned to it:

curl "https://api.sb/leaseline.app/tenants?where=apiVersion%20%3D%20v1" \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"

Versioning your API covers pins and gates.

VerbsCopy Anchor Link

None.

InterfacesCopy Anchor Link

None.

ExampleCopy Anchor Link

Leaseline ships v2 in month 6. Three months later Harbor Residential has moved its pin and no Tenant calls v1, so the pin report is empty and v1 can be retired.