Developer update

Public REST API and SDKs 4.0.0

Wodby now has a public REST API for Wodby 2 automation, SDKs 4.0.0 generated from the new OpenAPI schema, and a new JavaScript and TypeScript SDK on npm.

Wodby public REST API and SDK packages

This is the first versioned public API surface for customer integrations on Wodby 2. It is available as a REST API under /v1, with an OpenAPI reference that can be used for debugging, code generation, and direct integrations in languages we do not publish SDKs for yet.

The public API covers the core objects teams automate most often: organizations, projects, apps, app instances, app services, builds, deployments, clusters, databases, integrations, providers, stacks, backups, imports, tasks, routes, and environment variables.

SDKs 4.0.0 target Wodby 2

Version 4.0.0 and newer of the official SDK packages target the Wodby 2 public /v1 API. If you maintain an older integration built against the previous SDK surface, keep it pinned to a compatible 3.x package until you migrate.

The SDKs are generated from the same OpenAPI schema as the API reference, so package releases now track the public REST contract instead of the internal dashboard API.

LanguagePackageInstall
PHPwodby/wodby-sdk-phpcomposer require wodby/wodby-sdk-php
Pythonwodbypip install wodby
JavaScript and TypeScript@wodby/sdknpm install @wodby/sdk
Gogithub.com/wodby/wodby-sdk-go/v4/pkggo get github.com/wodby/wodby-sdk-go/v4/pkg

New JavaScript and TypeScript SDK

The newest addition is @wodby/sdk, our official JavaScript and TypeScript package. It gives Node.js scripts, internal tools, and CI helpers the same generated models and request helpers available in the PHP, Python, and Go SDKs.

const { Configuration, OrgsApi } = require('@wodby/sdk');

const api = new OrgsApi(new Configuration({
  basePath: 'https://api.wodby.com/v1',
  apiKey: process.env.WODBY_API_KEY,
}));

Authentication with API keys

API keys are created from User settingsin the Wodby dashboard. Each key belongs to one organization and authenticates as the user who created it, so requests run with that user's permissions inside that organization.

Send the key as X-API-KEY. For scripts and CI jobs, set it as WODBY_API_KEY and pass it into the SDK configuration or HTTP client.

API, SDK, or CLI?

Use the REST API directly for simple scripts, debugging, and unsupported languages. Use the official SDKs when you want generated models and request helpers. Use Wodby CLI for CI build, release, deploy, and one-off run workflows.

Read the docs

Start with the development overview, browse the Wodby 2 API reference, or open the SDK documentation.