API Documentation

Source-first RESTful API reference generated via Utoipa route contracts.

Source-First API Contract & Exploration

The OmniGCloud API contract is derived directly from Rust handler source code via Utoipa. All 68 micro-workers declare typed schemas, path parameters, and RBAC tier entitlement constraints.

Launch In-App Swagger Portal API Explorer Redoc Reference OpenAPI Specifications

Authentication & Headers

Authorization: Bearer omni_sec_live_...

Content-Type: application/json

X-Tenant-Id: tenant_primary_...

Pass your API token as an HTTP Bearer header. Use Register or Sign in in the documentation portal; disposable test credentials remain environment-controlled and are never assumed.

Gateway contract endpoints

/api/v1/docs/uiEdge Swagger UI bundled with Utoipa assets /api/v1/docs/openapi.jsonCanonical fleet OpenAPI 3.1 specification

Choose the right journey

Register & sign inCreate a session, recover access, and return to the docs workspace.Safe request previewReview deterministic examples without provider calls or fabricated credentials.Authorized Try-itUse Swagger only after selecting an authorized environment and capability.Upgrade or downgradeBilling actions return to the account surface and preserve session context.Tenant & usageUse the authenticated shell for tenant selection, usage, and capability-aware data.Support & enterpriseEscalate unavailable provider or enterprise configuration states.

Request state semantics

Loading

The UI is checking session, tenant, or contract state.

401 / 403

Re-authenticate or upgrade; never treat denial as success.

409 / 429

Preserve idempotency and retry only when the contract permits it.

5xx / unavailable

Show degraded or retryable state; provider evidence is still required.

Need help?

OpenAPI documents describe the contract, not a grant of access. For tenant, billing, connector, or enterprise administration issues, use the authenticated shell or contact support.

Contact support View service status Read architecture

Tier-Gated OpenAPI Contract Views

Free TierPublic health, probes & auth Starter TierFree + tenants & billing Pro TierStarter + FinOps & AI Enterprise TierComplete fleet surface & audit