---
title: "CloudPrint API versioning"
description: "Understand compatibility guarantees, additive v1 changes, breaking versions, deprecation notices and migration policy."
---
<nav class="docs-breadcrumb" aria-label="Breadcrumb"><a href="/docs/">CloudPrint Documentation</a><span aria-hidden="true">/</span><span>API reference</span></nav>

# CloudPrint API versioning

<p class="docs-lead">Understand compatibility guarantees, additive v1 changes, breaking versions, deprecation notices and migration policy.</p>

<div class="api-reference-actions"><span><strong>API version:</strong> v1</span><a href="/docs/api/v1/openapi.json">Download OpenAPI v1 JSON</a><a href="/docs/api/v1/explorer/">Open in the interactive API Explorer</a><a href="/docs/api/v1/versioning/index.md">View as Markdown</a></div>

## 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.

## Related documentation

<div class="docs-card-grid"><a class="docs-card" href="/docs/api/changelog/"><strong>CloudPrint API changelog</strong><span>Review changes to the CloudPrint Public API contract and documentation without confusing API and product releases.</span></a>
<a class="docs-card" href="/docs/api/v1/"><strong>CloudPrint API v1 reference</strong><span>Build a CloudPrint integration with versioned, indexable documentation for authentication, printers, documents, print jobs, errors and retries.</span></a>
<a class="docs-card" href="/docs/api/v1/explorer/"><strong>CloudPrint API v1 Explorer</strong><span>Interactively inspect the complete CloudPrint API v1 OpenAPI contract, schemas and code samples.</span></a></div>

<nav class="docs-resource-links" aria-label="Next steps"><a href="/docs/api/v1/explorer/">OpenAPI</a><a href="https://my.cloudprint.me">Open account</a><a href="/docs/legal/privacy/">Privacy Policy</a><a href="/docs/legal/terms/">Terms</a><a href="/docs/legal/payments-and-refunds/">Payment and refunds</a><a href="/docs/legal/data-processing/">DPA</a></nav>