Reference
Look up specific endpoints, schemas, configuration values, and state transitions. These pages are the source of truth for ScaiControl's external surface.
API#
The HTTP API, grouped by tag — auto-generated from the OpenAPI spec the backend serves at /openapi.json.
| Group | Description |
|---|---|
| API overview | Conventions, auth, pagination, errors, idempotency |
| auth | Login, refresh, /auth/me |
| organization | Tenant and partner self-service |
| catalog | Browsing services + plans |
| subscriptions | Tenant-self subscription management |
| service-packs | Pack discovery + subscription |
| provisioning | DAG execution + status |
| billing | Tenant invoices + billing profile |
| service-billing | Service-token billing endpoints |
| metering | Usage ingestion + queries |
| notifications | Tenant in-app notifications |
| registry | Service self-registration + heartbeats |
| entrypoints | Service entrypoint discovery |
| uploads | Asset upload (logos, attachments) |
| webhooks | Inbound webhook receivers (Stripe, Mollie, etc.) |
| admin | Cross-cutting admin endpoints |
| admin-tenants, admin-partners, admin-users, admin-groups | Operator-side identity + org management |
| admin-subscriptions, admin-packs | Operator-side subscription + pack control |
| admin-billing, admin-accounting | Invoice/credit-note + accounting-integration admin |
| admin-provisioning, admin-platform, admin-usage, admin-lookups, admin-entrypoints, admin-webhook-subscriptions | Other operator surfaces |
| untagged | Endpoints not yet tagged |
Events#
The outbound webhook system: envelope, signing, retries, and the complete topic catalog.
| Page | Use it to |
|---|---|
| Events overview | Verify a signature, understand the envelope and headers, plan a subscriber inbox |
| Events catalog | Look up the exact payload shape for any of the 14 v1.0 topics |
| Webhooks reference | Operate the dispatcher: backoff schedule, retry, dead rows, idempotency |
Operations#
| Page | Use it to |
|---|---|
| Configuration | Look up an env var — every setting the backend reads |
| CLI | Use scaicontrol setup / sync / admin |
| State machines | Look up valid transitions for subscriptions, invoices, provisioning, registry, webhook deliveries |
For conceptual background, see Concepts. When something's wrong, see Troubleshooting.