Skip to content

CloudPrint API versioning

Understand compatibility guarantees, additive v1 changes, breaking versions, deprecation notices and migration policy.

Major versions in the URL

CloudPrint pins the compatibility boundary in /api/v1. Documentation uses the matching /docs/api/v1/ path. Application release numbers such as 0.7.1 are not API versions.

Compatible v1 changes

CloudPrint may add an endpoint, optional request field, response field, enum value or non-terminal job status in v1. Clients must ignore unknown response fields and tolerate unknown non-terminal statuses.

Breaking changes

Removing or renaming an operation or field, adding a required field, changing a type or changing authorization requirements requires a new major version and a migration guide.

Deprecation

A retiring version is announced in the API changelog and migration documentation. Where applicable, responses use standard Deprecation and Sunset headers before support ends.

Guides for integrating CloudPrint, connecting the local agent and operating print workflows.