📣 Build, Automate, and Scale Content Operations with CMS REST API v1 - now live!
Now available for both CMS13 and CMS SaaS
We are excited to announce the v1 release of our CMS REST API—a major milestone in delivering a stable, production-ready foundation for automating and integrating with Optimizely’s CMS. This release will apply to both our recently released CMS13 on PaaS and our CMS SaaS platforms.
💡 Why this matters
Previous iterations of our CMS REST API were released as preview versions allowing us to make available these short term stable releases as we continue to mature the API. With v1, we are officially shifting to a commitment of stability, backward compatibility, and long-term support—providing our developer audience and partners the confidence to build their integrations with our CMS platforms at scale.
This release aligns closely with the capabilities of the Optimizely SaaS CMS UI, ensuring consistency between what users see and what developers can programmatically control. For CMS13 developers, only those features available in the CMS13 user experience will be covered by the CMS REST API.
An overview of migrating from Preview3 to v1 for the CMS REST API for SaaS can be found here:
Documentation for the CMS REST API v1 for CMS13 can be found here:
🆕 What’s Included in v1?
The v1 API delivers a comprehensive set of endpoints designed to support the full content lifecycle and schema management of the CMS platform programmatically. Any developers who have been using Preview3 endpoints will be familiar with many of the v1 endpoints. New to V1 are the following:
- Content: Manage content and versions (moved out of experimental status)
- Standalone content lifecycle endpoints (new)
- Content Types: Define structured schemas for pages, blocks for programmatic content modeling
- Content Sources: Create and manage external content sources (new)
- Content Type Bindings: Map relationships and property associations for external content sources (new)
- Blueprints: Create and manage content blueprints
- Locales: Manage supported content languages (new)
- Display templates: Create and manage style display templates for use in the CMS visual builder.
- Property groups: Create and manage content property groups.
- Manifest: Export and/or import a content manifest with content types, locales, display templates and property groups
- Credentials: Manage client credentials for secure API access (SaaS only)
The Packaging API remains under the /experimental/ prefix in v1. For more information about our policy regarding Experimental endpoints, please refer to the documentation found here.
Now, with the v1 CMS REST API, developers and development partners can depend upon Optimizely CMS API stability and continuity between SaaS and PaaS releases. Further, they will be able to trust the enterprise readiness, security, and performance of their applications at scale. This transition offers our developer audience the confidence they need to take the Optimizely CMS platform to scalable content operations beyond just our user interfaces.
V1 is just the start of big things to come! 🚀
Comments