Composerun public API

Public, user-facing endpoints exposed by the compose_run platform.

Authentication is performed with an org API key, either as a Bearer token (Authorization: Bearer <api_key>) on the project and stack endpoints, or as a token query parameter on the webhooks.

The typical flow is: create a project (which provisions a VM), create a stack inside it, push a docker compose onto the stack, then deploy.

Tags

Projects

Create and list projects. A project owns a VM; stacks live inside it.

Stacks

Create, configure and deploy stacks inside a project.

Webhooks

User-facing webhooks for triggering platform actions from external systems (CI/CD, schedulers, etc.).

Security Schemes

bearerAuth

Org-scoped API token passed as Authorization: Bearer <api_key>. The key must carry the all scope to grant general API access, and write permission for any mutating (POST/PUT/PATCH/DELETE) request.

http

webhookToken

Org API key passed as the token query parameter. Must carry the deploy scope. Used by the webhooks only.

apiKey

Servers

https://app.composerun.eu/api/v1

API endpoints