New Developer API Documentation (Beta) now available

June 8, 2026 · Permalink

We are pleased to announce the Beta release of our entirely redesigned public API Reference Documentation.

Built from the ground up to improve the developer experience (DX), this new portal transitions our API documentation to a modern, schema-driven architecture, making it faster and easier than ever to build automation on the UpCloud platform.

What's New

Our legacy documentation required manual updates, which could occasionally lead to drift between code and docs. This new portal solves that by generating documentation directly from our single source of truth: Our new (Beta) OpenAPI specification.

Key features of the new documentation portal include:

Responsive Layout and Dark Mode: The portal features a lightning-fast, responsive multi-panel layout with native dark mode support.
Intelligent Global Search: Quickly find endpoints, parameters, and structural schemas using a fast, built-in index.
Machine-Readable Access: You can now directly download the raw OpenAPI specification file to generate your own type definitions, custom SDKs, or local Postman collections.
cURL Snippets: Get instant access to cURL snippets to quickly test out API calls from your local CLI.

Coming Soon

Code Snippets: Get instant access to code snippets to quickly test out our official SDKs and popular programming languages.
Interactive API Playground: You can now test live API requests directly from your browser. The integrated playground handles authentication securely and lets you preview responses on the fly.

How to Get Started

Navigating and testing our endpoints in the new portal is straightforward:

Head over to the new UpCloud Beta API Reference Portal.
Read through the Get Started section to learn how to get an API token to authenticate your API calls.
Select an endpoint (such as List Zones under Zone), copy the cURL snippet from the right-hand panel, paste it into your local terminal, replace <token> in --header 'Authorization: Bearer <token>' with your API token and hit enter.

Important Notes

⚠️ Transition Safety: While this portal is new, our core platform remains unchanged. This is purely a documentation frontend update.

Main Source of Truth: The new OpenAPI-powered documentation portal will officially replace our legacy developer docs as the primary source of truth on September 1, 2026.
Legacy Preservation: The existing documentation (https://developers.upcloud.com) will be moved to a different location but remain available for historical reference.

OpenAPI® is a registered trademark of the Linux Foundation. Zudoku is an open-source framework licensed under the MIT License by Zuplo Inc.