API reference

OpenAPI and CLI commands

The Rails API is generated into OpenAPI and the CLI route coverage is checked against that API so docs can follow the shipped control-plane surface.

OpenAPI document

The generated API document is available from the running API and can be used by clients, SDK generation, and future interactive docs.

Open JSON

API areas

  • Authentication and current user session
  • Organizations, members, and invitations
  • Repository access and VCS operations
  • Idempotent stack submit, sync, batched lookup, and merge queues
  • Virtual-repository merge authority and queue policy
  • Virtual repository import baselines for Git/GitHub adoption
  • Hosting apps, environments, services, deployments, domains, and CDN
  • Static sites and deployment uploads
  • Image repositories, registry tokens, push/pull contracts, and tag listing

Stack and queue contracts

Signed-in browser sessions and bearer tokens with repository access can submit, sync, and look up stacks. Queue mutations require repository write access; pause, resume, and merge policy changes additionally require organization admin access where noted. Every queue and merge-policy mutation requires an optimistic expected version; stale versions return 409 instead of overwriting concurrent work.

  • POST /api/v1/organizations/<org>/repos/<repo>/vcs/stacks/submit
  • POST /api/v1/organizations/<org>/repos/<repo>/vcs/stacks/sync
  • GET /api/v1/organizations/<org>/repos/<repo>/vcs/stacks/lookup
  • GET /api/v1/organizations/<org>/repos/<repo>/vcs/merge_queues/<target>
  • GET /api/v1/virtual_repositories/<id>/merge_policy
View CLI command docs