Skip to content

API Reference

Interactive OpenAPI reference for the RosettaHub platform.

The RosettaHub API is documented as an OpenAPI specification and served through a live Swagger UI. Every operation available in the RosettaHub Console, the desktop app, and the CLI is also available programmatically through the same API surface.

Open the Swagger UI

What you'll find

  • Every public endpoint across RosettaOps and RosettaCloud: organizations, users, projects, cloud accounts, formations, sessions, storages, images, keys, certificates, sharing, budgets, compliance, and reporting.
  • Request and response schemas with field-level descriptions and example payloads.
  • Try-it-out in the browser. Authenticate with an API key and call any method directly from the Swagger UI.
  • Tag groupings matching the RosettaHub object model, so you can scope quickly to the area you need.

Authenticating

API calls require an API key created in the RosettaHub Console. Keys can be scoped by method name or method tag, and can be configured with an expiration timeout.

See API Keys for how to create, scope, rotate, and revoke keys.

The OpenAPI surface is the canonical machine interface. RosettaHub also ships higher-level interfaces built on top of it:

Interface Use it for
RosettaHub CLI Shell automation, CI/CD pipelines, scripted operations
Python, Java, and JavaScript SDKs Typed programmatic access inside applications
MCP servers AI-assisted governance and resource operations through Claude, Cursor, and other MCP-aware clients
  • API Keys: create and manage credentials for the API
  • RosettaOps: governance, FinOps, and account lifecycle endpoints
  • RosettaCloud: resource, formation, and session endpoints
  • Actions Reference: the corresponding console actions for each API operation